{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.brasilsintetico.com/v1/schemas/pedido-calibracao","title":"Pedido de calibração","description":"A calibration request, version 3 of its contract; a version 2 request is still accepted and read as version 3. Its cenario is a campaign request, typed by that request's schema. The platform computes the series' hash from the rows and writes it in serie.sha256, so the request leaves it out. Every field is declared here; the rules a JSON Schema cannot state (between fields, the calendar, the size of a grid) and the checks against the series and the release are made by the server, with the same stable codes.","type":"object","additionalProperties":false,"properties":{"versao_contrato":{"const":3},"cenario":{"allOf":[{"$ref":"#/$defs/cenario_campanha"},{"properties":{"lancamento":{"properties":{"cenario_base":{"not":{"const":"calibracao"}}}}}}]},"serie":{"type":"object","additionalProperties":false,"properties":{"declaracao":{"type":"object","additionalProperties":false,"properties":{"versao_contrato":{"const":1},"granularidade":{"enum":["mes","dia"]},"medida":{"enum":["novos","acumulado"]},"eixos":{"type":"array","items":{"enum":["canal","grupo_idade","sexo","renda","escolaridade","raca"]},"uniqueItems":true},"unidade":{"enum":["municipio","area_ponderacao"]}},"required":["versao_contrato","granularidade","medida"]},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","not":{"pattern":"\n"},"description":"Left out: the platform computes the series' hash from the rows and writes it here"}},"required":["declaracao"]},"janela":{"type":"object","additionalProperties":false,"properties":{"inicio":{"type":"integer"},"fim":{"type":"integer"}},"required":["inicio","fim"]},"holdout":{"type":"object","additionalProperties":false,"properties":{"inicio":{"type":"integer"},"fim":{"type":"integer"}},"required":["inicio","fim"]},"parametros":{"type":"object","additionalProperties":false,"properties":{"beta0":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number"},"max":{"type":"number"},"passo":{"type":"number","exclusiveMinimum":0}},"required":["min","max"]},"logit_lancamento":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number"},"max":{"type":"number"},"passo":{"type":"number","exclusiveMinimum":0}},"required":["min","max"]},"dia_lancamento":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"integer","minimum":1,"maximum":65535},"max":{"type":"integer","minimum":1,"maximum":65535},"passo":{"type":"integer","exclusiveMinimum":0}},"required":["min","max"]},"beta_expo":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number"},"max":{"type":"number"},"passo":{"type":"number","exclusiveMinimum":0}},"required":["min","max"]},"amortecimento_saturacao":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number","minimum":0.0,"maximum":1.0},"max":{"type":"number","minimum":0.0,"maximum":1.0},"passo":{"type":"number","exclusiveMinimum":0}},"required":["min","max"]},"conversao_social":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number","minimum":0.0},"max":{"type":"number","minimum":0.0},"passo":{"type":"number","exclusiveMinimum":0}},"required":["min","max"]},"pesos_canais":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number","minimum":0.0},"max":{"type":"number","minimum":0.0},"passo":{"type":"number","exclusiveMinimum":0},"canais":{"type":"array","items":{"enum":["domicilio","turma","estabelecimento","vizinhanca","digital"]},"uniqueItems":true,"minItems":1}},"required":["min","max"]},"gamma_celulas":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number"},"max":{"type":"number"},"passo":{"type":"number","exclusiveMinimum":0},"agrupamento":{"anyOf":[{"const":"celula"},{"type":"array","items":{"enum":["regiao","faixa","sexo","raca","nivel","renda"]},"uniqueItems":true,"minItems":1}]}},"required":["min","max"]},"deslocamento_porte":{"type":"object","additionalProperties":false,"properties":{"min":{"type":"number","minimum":-5.0,"maximum":5.0},"max":{"type":"number","minimum":-5.0,"maximum":5.0},"passo":{"type":"number","exclusiveMinimum":0}},"required":["min","max"]}},"minProperties":1,"if":{"required":["beta_expo"]},"then":{"properties":{"pesos_canais":{"required":["canais"],"properties":{"canais":{"maxItems":4}}}}}},"holdout_espacial":{"type":"object","additionalProperties":false,"properties":{"metodo":{"enum":["plataforma","cliente","nenhum"]},"municipios":{"type":"array","items":{"type":"string","pattern":"^[0-9]{7}$|^[0-9]{10}$","not":{"pattern":"\n"}},"uniqueItems":true,"minItems":1}},"required":["metodo"],"if":{"properties":{"metodo":{"const":"cliente"}},"required":["metodo"]},"then":{"required":["municipios"]},"else":{"not":{"required":["municipios"]}}},"busca":{"type":"object","additionalProperties":false,"properties":{"metodo":{"enum":["grade","aleatoria","sequencial"]},"candidatos":{"type":"integer","minimum":1,"maximum":10000},"replicas":{"type":"integer","minimum":1,"maximum":20}},"required":["metodo"],"if":{"properties":{"metodo":{"const":"grade"}},"required":["metodo"]},"then":{"not":{"required":["candidatos"]}},"else":{"required":["candidatos"]}}},"required":["versao_contrato","cenario","serie","janela","holdout","parametros","busca"],"allOf":[{"if":{"properties":{"cenario":{"properties":{"familia":{"const":"adocao"}},"required":["familia"]}},"required":["cenario"]},"then":{"properties":{"parametros":{"propertyNames":{"enum":["beta0","logit_lancamento","dia_lancamento","beta_expo","amortecimento_saturacao","pesos_canais","gamma_celulas","deslocamento_porte"]}}}}},{"if":{"properties":{"cenario":{"properties":{"familia":{"const":"recepcao"}},"required":["familia"]}},"required":["cenario"]},"then":{"properties":{"parametros":{"propertyNames":{"enum":["beta0","beta_expo","conversao_social","pesos_canais","gamma_celulas"]}}}}},{"if":{"properties":{"serie":{"properties":{"declaracao":{"properties":{"granularidade":{"const":"mes"}},"required":["granularidade"]}},"required":["declaracao"]}},"required":["serie"]},"then":{"properties":{"janela":{"properties":{"inicio":{"minimum":100001,"maximum":999912},"fim":{"minimum":100001,"maximum":999912}}},"holdout":{"properties":{"inicio":{"minimum":100001,"maximum":999912},"fim":{"minimum":100001,"maximum":999912}}}}}},{"if":{"properties":{"serie":{"properties":{"declaracao":{"properties":{"granularidade":{"const":"dia"}},"required":["granularidade"]}},"required":["declaracao"]}},"required":["serie"]},"then":{"properties":{"janela":{"properties":{"inicio":{"minimum":10000101,"maximum":99991231},"fim":{"minimum":10000101,"maximum":99991231}}},"holdout":{"properties":{"inicio":{"minimum":10000101,"maximum":99991231},"fim":{"minimum":10000101,"maximum":99991231}}}}}},{"if":{"properties":{"busca":{"properties":{"metodo":{"const":"grade"}},"required":["metodo"]}},"required":["busca"]},"then":{"properties":{"parametros":{"properties":{"beta0":{"required":["passo"]},"logit_lancamento":{"required":["passo"]},"dia_lancamento":{"required":["passo"]},"beta_expo":{"required":["passo"]},"amortecimento_saturacao":{"required":["passo"]},"conversao_social":{"required":["passo"]},"pesos_canais":{"required":["passo"]},"gamma_celulas":{"required":["passo"]},"deslocamento_porte":{"required":["passo"]}}}}}}],"$defs":{"cenario_campanha":{"title":"Cenário de campanha","description":"A campaign request, version 3 of its contract; a version 2 request is still accepted and read as version 3. Every field is declared here; the rules a JSON Schema cannot state (between fields, against the release, the electoral reading of free text) are checked by the server, with the same stable codes.","type":"object","additionalProperties":false,"properties":{"versao_contrato":{"const":3},"release":{"type":"string","pattern":"^v[0-9]+\\.[0-9]+\\.[0-9]+$"},"familia":{"enum":["adocao","recepcao"]},"geografia":{"type":"object","additionalProperties":false,"properties":{"ufs":{"type":"array","items":{"enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SE","SP","TO"]},"uniqueItems":true,"minItems":1},"municipios":{"type":"array","items":{"type":"string","pattern":"^[0-9]{7}$"},"uniqueItems":true},"aps":{"type":"array","items":{"type":"string","pattern":"^[0-9]{10}$"},"uniqueItems":true}},"required":["ufs"]},"publico":{"type":"object","additionalProperties":false,"properties":{"idades":{"type":"array","items":{"type":"array","prefixItems":[{"enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80]},{"enum":[4,9,14,19,24,29,34,39,44,49,54,59,64,69,74,79,null]}],"minItems":2,"items":false}},"sexos":{"type":"array","items":{"enum":["masculino","feminino"]},"uniqueItems":true},"niveis_instrucao":{"type":"array","items":{"enum":["fundamental_incompleto","fundamental_completo","medio_completo","superior_completo"]},"uniqueItems":true},"faixas_renda":{"type":"array","items":{"type":"integer","minimum":0,"maximum":4},"uniqueItems":true},"racas":{"type":"array","items":{"enum":["branca","preta","amarela","parda","indigena"]},"uniqueItems":true}}},"canais":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"canal":{"enum":["digital","tv","radio","exterior"]},"dia_inicio":{"type":"integer","minimum":1,"maximum":65535},"dia_fim":{"type":"integer","minimum":1,"maximum":65535},"intensidade":{"type":"number","exclusiveMinimum":0,"maximum":1}},"required":["canal","dia_inicio","dia_fim","intensidade"]}},"mensagem":{"anyOf":[{"type":"null"},{"type":"object","additionalProperties":false,"properties":{"stim_id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"template_ver":{"type":"string","pattern":"\\S"},"politica":{"type":"string","pattern":"\\S"}},"required":["stim_id","template_ver","politica"]}]},"lancamento":{"anyOf":[{"type":"null"},{"type":"object","additionalProperties":false,"properties":{"dia":{"type":"integer","minimum":1,"maximum":65535},"cenario_base":{"enum":["pix","calibracao"]},"calibracao":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["dia","cenario_base"],"if":{"properties":{"cenario_base":{"const":"calibracao"}},"required":["cenario_base"]},"then":{"required":["calibracao"]},"else":{"not":{"required":["calibracao"]}}}]},"horizonte":{"type":"object","additionalProperties":false,"properties":{"data_inicio":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","format":"date"},"dias":{"type":"integer","minimum":1,"maximum":65535}},"required":["data_inicio","dias"]},"replicas":{"type":"integer","minimum":1,"maximum":20},"grupo_comparacao":{"type":"string","pattern":"^[a-z0-9][a-z0-9_.-]{0,63}$"},"kpis":{"type":"array","items":{"enum":["adotantes","alcance","ignora","absorve","repassa","rejeita"]},"uniqueItems":true,"minItems":1},"nome":{"type":"string","maxLength":80},"descricao":{"type":"string","maxLength":500},"saida_por_setor":{"type":"boolean"},"contrato_de_resposta":{"anyOf":[{"type":"null"},{"type":"object","additionalProperties":false,"properties":{"versao":{"const":1},"perguntas":{"type":"array","items":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"forma":{"enum":["quantos","quando","onde"]},"medida":{"enum":["adotantes","alcance","ignora","absorve","repassa","rejeita","adocao","exposta_social","exposta_midia_medida","exposta_midia_declarada","exposta_midia_ambas","ignora","absorve","repassa","rejeita"]},"publico":{"type":"object","additionalProperties":false,"properties":{"grupo_idade":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6},"uniqueItems":true},"sexo":{"type":"array","items":{"type":"integer","minimum":0,"maximum":1},"uniqueItems":true},"renda":{"type":"array","items":{"type":"integer","minimum":0,"maximum":4},"uniqueItems":true},"escolaridade":{"type":"array","items":{"type":"integer","minimum":0,"maximum":4},"uniqueItems":true},"raca":{"type":"array","items":{"type":"integer","minimum":0,"maximum":5},"uniqueItems":true},"faixa_etaria_5":{"type":"array","items":{"type":"integer","minimum":0,"maximum":16},"uniqueItems":true}}},"territorio":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"municipios":{"type":"array","items":{"type":"string","pattern":"^[0-9]{7}$"},"uniqueItems":true,"minItems":1,"maxItems":5000}},"required":["municipios"]},{"type":"object","additionalProperties":false,"properties":{"setores":{"type":"array","items":{"type":"string","pattern":"^[0-9]{15}$"},"uniqueItems":true,"minItems":1,"maxItems":5000}},"required":["setores"]},{"type":"object","additionalProperties":false,"properties":{"ponto":{"type":"array","prefixItems":[{"type":"number","minimum":-75,"maximum":-28},{"type":"number","minimum":-34,"maximum":6}],"minItems":2,"items":false},"raio_m":{"type":"integer","minimum":50,"maximum":50000}},"required":["ponto","raio_m"]}]},"momento":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"semana":{"type":"integer","minimum":1}},"required":["semana"]},{"type":"object","additionalProperties":false,"properties":{"parte":{"type":"number","exclusiveMinimum":0,"maximum":1}},"required":["parte"]}]},"ordem":{"enum":["maior","menor"]}},"required":["id","forma","medida","territorio","momento"],"allOf":[{"if":{"properties":{"forma":{"const":"quando"}},"required":["forma"]},"then":{"properties":{"momento":{"required":["parte"]}}},"else":{"properties":{"momento":{"required":["semana"]}}}},{"if":{"properties":{"forma":{"const":"onde"}},"required":["forma"]},"then":{},"else":{"not":{"required":["ordem"]}}}]},{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"forma":{"const":"comparar"},"variantes":{"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2,"uniqueItems":true},"pergunta":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"forma":{"enum":["quantos","quando","onde"]},"medida":{"enum":["adotantes","alcance","ignora","absorve","repassa","rejeita","adocao","exposta_social","exposta_midia_medida","exposta_midia_declarada","exposta_midia_ambas","ignora","absorve","repassa","rejeita"]},"publico":{"type":"object","additionalProperties":false,"properties":{"grupo_idade":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6},"uniqueItems":true},"sexo":{"type":"array","items":{"type":"integer","minimum":0,"maximum":1},"uniqueItems":true},"renda":{"type":"array","items":{"type":"integer","minimum":0,"maximum":4},"uniqueItems":true},"escolaridade":{"type":"array","items":{"type":"integer","minimum":0,"maximum":4},"uniqueItems":true},"raca":{"type":"array","items":{"type":"integer","minimum":0,"maximum":5},"uniqueItems":true},"faixa_etaria_5":{"type":"array","items":{"type":"integer","minimum":0,"maximum":16},"uniqueItems":true}}},"territorio":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"municipios":{"type":"array","items":{"type":"string","pattern":"^[0-9]{7}$"},"uniqueItems":true,"minItems":1,"maxItems":5000}},"required":["municipios"]},{"type":"object","additionalProperties":false,"properties":{"setores":{"type":"array","items":{"type":"string","pattern":"^[0-9]{15}$"},"uniqueItems":true,"minItems":1,"maxItems":5000}},"required":["setores"]},{"type":"object","additionalProperties":false,"properties":{"ponto":{"type":"array","prefixItems":[{"type":"number","minimum":-75,"maximum":-28},{"type":"number","minimum":-34,"maximum":6}],"minItems":2,"items":false},"raio_m":{"type":"integer","minimum":50,"maximum":50000}},"required":["ponto","raio_m"]}]},"momento":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"semana":{"type":"integer","minimum":1}},"required":["semana"]},{"type":"object","additionalProperties":false,"properties":{"parte":{"type":"number","exclusiveMinimum":0,"maximum":1}},"required":["parte"]}]},"ordem":{"enum":["maior","menor"]}},"required":["id","forma","medida","territorio","momento"],"allOf":[{"if":{"properties":{"forma":{"const":"quando"}},"required":["forma"]},"then":{"properties":{"momento":{"required":["parte"]}}},"else":{"properties":{"momento":{"required":["semana"]}}}},{"if":{"properties":{"forma":{"const":"onde"}},"required":["forma"]},"then":{},"else":{"not":{"required":["ordem"]}}}]}},"required":["id","forma","variantes","pergunta"]}]},"uniqueItems":true,"minItems":1,"maxItems":20}},"required":["versao","perguntas"]}]}},"required":["versao_contrato","release","familia","geografia","horizonte","replicas","grupo_comparacao","kpis"],"allOf":[{"if":{"properties":{"familia":{"const":"recepcao"}},"required":["familia"]},"then":{"required":["mensagem","canais"],"properties":{"mensagem":{"type":"object"},"canais":{"minItems":1},"lancamento":{"type":"null"},"kpis":{"items":{"enum":["alcance","ignora","absorve","repassa","rejeita"]}}}}},{"if":{"properties":{"familia":{"const":"adocao"}},"required":["familia"]},"then":{"required":["lancamento"],"properties":{"lancamento":{"type":"object"},"mensagem":{"type":"null"},"canais":{"maxItems":0},"kpis":{"items":{"enum":["adotantes"]}}}}}]}}}