Changelog
Cada versão do documento OpenAPI vale para o caminho /v1. Esta página lista o que cada versão contém.
Primeira versão publicada da API de leitura.
Autenticação
- Troca de chave de API por token de acesso em
POST /v1/token. - Chave de API com escopo por cliente e por conta de anúncio, prazo obrigatório (padrão 90 dias, máximo 365) e revogação.
- Token de acesso com validade de dois minutos.
Rotas de leitura, todas sob /v1/t/{tenantID}/:
- Desempenho:
summary,insights/daily,campaigns,conversions. - Contas e conexões:
accounts,conexoes. - Auditoria e orçamento:
audit/revisions,pacing. - Plano de mídia:
plano/funil,plano/vocabulario,plano/acoes. - Canais complementares:
busca-organica,google-analytics,google-business,merchant-center. - Sugestões:
sugestoes-de-desempenho. - Público:
publicos,publicos/{id},publicos/taxonomia,publicos/redes. - Criativos:
creatives.
Convenções
- Dinheiro e conversões em micros.
- Métricas derivadas não são entregues: você as calcula a partir dos totais.
- Janelas de data por
sinceeuntil(oudeeate,inicioefim, conforme a rota), no máximo de 400 dias. - Erros no formato
{ "error": { "code", "message", "trace_id" } }.
O que a versão não contém
- Nenhuma rota de escrita.
- Nenhuma paginação por cursor.
- Nenhum limite numérico de requisições publicado.
Como acompanhar mudanças
Seção intitulada “Como acompanhar mudanças”A especificação OpenAPI completa e atual está em Referência. Novas versões do documento serão listadas aqui, da mais recente para a mais antiga.