ChatGPT Ads

Adicionando a fonte de dados

Requisitos

  • Acesso de administrador (ou permissão para gerar chaves de API) na conta de anúncios do ChatGPT Ads.

Como conectar

  1. Acesse ads.openai.com e entre na conta de anúncios que deseja conectar.
  2. No menu, abra Settings.
  3. Gere (ou copie) a chave de API da conta.
  4. Na Kondado, crie um novo conector ChatGPT Ads e cole o valor no campo Chave de API.
  5. Salve e crie a integração desejada.

A chave de API pertence a uma única conta de anúncios. Se você gerencia várias contas, crie um conector separado, com a chave própria de cada uma.

Pipelines

Resumo

Diagrama de relacionamento

Clique para expandir

Metadados dos anúncios

Esta integracao e gratuita

Tipo de replicacao: Integral

Relacionamentos:

Campo Tipo

id

text

[pt] Identificador do anúncio.

ad_group_id

text

[pt] Identificador do grupo de anúncios.

    Metadados dos grupos de anúncios > > id

campaign_id

text

[pt] Identificador da campanha.

    Metadados das campanhas > > id

name

text

[pt] Nome interno do anúncio.

status

text

[pt] Situação do anúncio.

review_status

text

[pt] Resultado da revisão do anúncio (em revisão, aprovado ou reprovado). Um anúncio só é exibido depois de aprovado e com campanha e grupo ativos.

review_status_detail

text

[pt] Situação detalhada da revisão do anúncio.

review_reason

text

[pt] Motivo informado na revisão do anúncio.

creative_type

text

[pt] Formato do criativo (por exemplo, cartão de conversa ou modelo de anúncio de produto).

creative_title

text

[pt] Título exibido no anúncio.

creative_body

text

[pt] Texto principal exibido no anúncio.

creative_target_url

text

[pt] Endereço de destino do anúncio, com os parâmetros de rastreamento (UTM) configurados.

creative_file_id

text

[pt] Identificador interno do arquivo de imagem enviado para o anúncio; não é um endereço de imagem.

creative_image_url

text

[pt] Endereço da imagem usada no anúncio. Fica vazio quando a imagem foi enviada por upload em vez de referenciada por endereço.

creative_price

text

[pt] Texto de preço exibido no anúncio, quando o formato usa preço.

serving_issues

text

[pt] Motivos pelos quais o anúncio não está sendo exibido, em formato JSON (lista). Vazio quando não há impedimento.

created_at

timestamp

[pt] Data e hora de criação do registro.

updated_at

timestamp

[pt] Data e hora da última alteração do registro.

Metadados das campanhas

Esta integracao e gratuita

Tipo de replicacao: Integral

Campo Tipo

id

text

[pt] Identificador da campanha.

name

text

[pt] Nome da campanha.

description

text

[pt] Descrição da campanha.

status

text

[pt] Situação da campanha.

mode

text

[pt] Modo de operação da campanha.

created_at

timestamp

[pt] Data e hora de criação do registro.

updated_at

timestamp

[pt] Data e hora da última alteração do registro.

start_time

timestamp

[pt] Início programado da campanha.

end_time

timestamp

[pt] Fim programado da campanha.

bidding_type

text

[pt] Estratégia de lance da campanha.

billing_event_type

text

[pt] Evento pelo qual a campanha é cobrada (por exemplo, clique).

objective

text

[pt] Objetivo da campanha (por exemplo, cliques ou conversões).

product_feed_id

text

[pt] Identificador do catálogo de produtos usado pela campanha, quando ela anuncia produtos.

budget_lifetime_spend_limit

float

[pt] Limite de investimento total da campanha, na moeda da conta.

budget_daily_spend_limit

float

[pt] Limite de investimento diário da campanha, na moeda da conta.

conversion_event_setting_ids

text

[pt] Identificadores dos eventos de conversão associados à campanha, em formato JSON (lista de textos).

targeting_locations

text

[pt] Países incluídos na segmentação da campanha, em formato JSON (lista de códigos de país).

Metadados dos eventos de conversão

Esta integracao e gratuita

Tipo de replicacao: Integral

Relacionamentos:

Campo Tipo

id

text

[pt] Identificador da configuração de evento de conversão.

name

text

[pt] Nome da configuração de evento de conversão.

event_type

text

[pt] Tipo de evento de conversão.

custom_event_name

text

[pt] Nome do evento personalizado, quando houver.

attribution_window_days

int

[pt] Janela de atribuição em dias configurada para o evento.

view_through_attribution_window_days

int

[pt] Janela de atribuição por visualização, em dias: quantos dias após ver o anúncio (sem clicar) uma conversão ainda é atribuída a ele.

ad_account_id

text

[pt] Identificador da conta de anúncios.

    Metadados da conta de anúncios > > id

source_ids

text

[pt] Identificadores das origens (pixels ou integrações) que alimentam o evento, em formato JSON (lista de textos).

sources

text

[pt] Fontes de dados de conversão (pixel ou integração servidor a servidor) ligadas a este evento, em formato JSON (lista de objetos com identificador e nome).

campaigns

text

[pt] Campanhas associadas a esta configuração de evento de conversão, em formato JSON (lista de objetos com identificador e nome).

archived

boolean

[pt] Indica se a configuração está arquivada.

version

int

[pt] Versão da configuração do evento.

Metadados da conta de anúncios

Esta integracao e gratuita

Tipo de replicacao: Integral

Campo Tipo

id

text

[pt] Identificador da conta de anúncios.

name

text

[pt] Nome da conta de anúncios.

url

text

[pt] Site principal associado à conta.

preview_url

text

[pt] Link de prévia da conta.

status

text

[pt] Situação da conta de anúncios.

timezone

text

[pt] Fuso horário da conta. Define como os dias dos relatórios são recortados.

currency_code

text

[pt] Moeda da conta. Todos os valores monetários do conector estão nesta moeda.

review_status

text

[pt] Situação da revisão da conta.

review_reason

text

[pt] Motivo informado na revisão da conta.

Metadados dos grupos de anúncios

Esta integracao e gratuita

Tipo de replicacao: Integral

Relacionamentos:

Campo Tipo

id

text

[pt] Identificador do grupo de anúncios.

campaign_id

text

[pt] Identificador da campanha.

    Metadados das campanhas > > id

name

text

[pt] Nome do grupo de anúncios.

description

text

[pt] Descrição do grupo de anúncios.

status

text

[pt] Situação do grupo de anúncios.

created_at

timestamp

[pt] Data e hora de criação do registro.

updated_at

timestamp

[pt] Data e hora da última alteração do registro.

context_hints

text

[pt] Sinais de contexto usados para direcionar o grupo de anúncios.

product_set_product_feed_id

text

[pt] Feed de produtos associado ao grupo de anúncios.

bidding_config_billing_event_type

text

[pt] Evento cobrado no grupo de anúncios.

bidding_config_strategy

text

[pt] Estratégia de lance do grupo de anúncios (por exemplo, maximizar conversões).

max_bid

float

[pt] Lance máximo do grupo de anúncios, na moeda da conta.

user_external_id

text

[pt] Identificador externo do grupo de anúncios definido pelo anunciante ou pela ferramenta que o criou.

Performance dos anúncios

Tipo de replicacao: Incremental com janela de atualizacao

Parametros:

  • Janela de atualização (dias): Quantos dias para trás os dados são reprocessados a cada execução. Conversões podem ser atribuídas até 30 dias após o clique.
  • Detalhamento: Segmentação opcional das métricas. Com detalhamento, as métricas de receita não estão disponíveis.
  • Período de agrupamento: Hora, dia ou mês. Hora não aceita detalhamento nem métricas de conversão/receita.
  • Data inicial: A partir de quando ler os dados. A API só disponibiliza os últimos 5 anos.
  • Conta de anúncios: Conta alcançada pela chave de API informada no conector.
  • Entidade: Nível em que as métricas serão agregadas. Cada nível traz também id e nome dos níveis acima.

Relacionamentos:

Campo Tipo

ad_account_id

text

[pt] Identificador da conta de anúncios.

    Metadados da conta de anúncios > > id

metric_date

date

[pt] Dia a que a linha se refere, no fuso horário da conta de anúncios. No agrupamento por mês é o primeiro dia do mês.

campaign_id

text

[pt] Identificador da campanha.

    Metadados das campanhas > > id

ad_group_id

text

[pt] Identificador do grupo de anúncios.

    Metadados dos grupos de anúncios > > id

ad_id

text

[pt] Identificador do anúncio.

    Metadados dos anúncios > > id

product_feed_id

text

[pt] Identificador do feed de produtos.

item_id

text

[pt] Identificador do item dentro do feed de produtos.

product_title

text

[pt] Título do produto.

product_description

text

[pt] Descrição curta do produto.

product_body

text

[pt] Descrição longa do produto.

product_target_url

text

[pt] Link de destino do produto.

product_image_url

text

[pt] Imagem do produto.

product_brand

text

[pt] Marca do produto.

product_seller_name

text

[pt] Nome do vendedor do produto.

product_price

text

[pt] Preço do produto, em texto formatado (não numérico).

product_availability

text

[pt] Disponibilidade do produto no feed.

hour

int

[pt] Hora do dia (0 a 23) a que a linha se refere, no fuso horário da conta. Presente apenas no agrupamento por hora.

timezone

text

[pt] Fuso horário da conta de anúncios, no qual estão as datas e horas deste relatório.

ad_account_name

text

[pt] Nome da conta de anúncios.

ad_account_url

text

[pt] Site principal associado à conta de anúncios.

campaign_name

text

[pt] Nome da campanha.

campaign_description

text

[pt] Descrição da campanha.

campaign_status

text

[pt] Situação da campanha (ativa, pausada, arquivada).

campaign_start_time

timestamp

[pt] Início programado da campanha.

campaign_end_time

timestamp

[pt] Fim programado da campanha.

campaign_budget_lifetime

float

[pt] Limite de investimento total da campanha, na moeda da conta. Vazio quando a campanha usa apenas limite diário.

campaign_budget_daily

float

[pt] Limite de investimento diário da campanha, na moeda da conta. Útil para acompanhar o ritmo de gasto (pacing) contra o teto.

ad_group_name

text

[pt] Nome do grupo de anúncios.

ad_group_description

text

[pt] Descrição do grupo de anúncios.

ad_group_status

text

[pt] Situação do grupo de anúncios.

ad_name

text

[pt] Nome interno do anúncio.

ad_title

text

[pt] Título exibido do anúncio.

ad_copy

text

[pt] Texto do anúncio.

ad_link

text

[pt] Link de destino do anúncio.

ad_status

text

[pt] Situação do anúncio.

ad_review_status

text

[pt] Resultado da revisão do anúncio (em revisão, aprovado ou reprovado). Um anúncio só é exibido depois de aprovado e com campanha e grupo ativos.

impressions

int

[pt] Impressões — número de vezes que o anúncio foi exibido.

clicks

int

[pt] Cliques — número de cliques no anúncio. Só vem preenchido quando pedido explicitamente na projeção.

spend

float

[pt] Investimento no período, na moeda da conta.

ctr

float

[pt] Taxa de cliques — cliques divididos por impressões. Taxa da própria linha: não é somável — ao agregar dias ou entidades, recalcule a partir das somas de investimento, cliques, impressões e conversões. No dia corrente pode divergir dos totais até o fechamento do dia.

cpc

float

[pt] Custo por clique — investimento dividido por cliques. Taxa da própria linha: não é somável — ao agregar dias ou entidades, recalcule a partir das somas de investimento, cliques, impressões e conversões. No dia corrente pode divergir dos totais até o fechamento do dia.

cpm

float

[pt] Custo por mil impressões — investimento dividido por impressões, vezes mil. Taxa da própria linha: não é somável — ao agregar dias ou entidades, recalcule a partir das somas de investimento, cliques, impressões e conversões. No dia corrente pode divergir dos totais até o fechamento do dia.

conversions

int

[pt] Conversões atribuídas no período. Equivale às conversões por clique — não some com as demais colunas de conversão.

cpa

float

[pt] Custo por conversão: investimento dividido pelo número de conversões. Vazio quando não houve conversão. Taxa da própria linha: não é somável — ao agregar dias ou entidades, recalcule a partir das somas de investimento, cliques, impressões e conversões. No dia corrente pode divergir dos totais até o fechamento do dia. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

post_click_cvr

float

[pt] Taxa de conversão após o clique: conversões divididas por cliques. Taxa da própria linha: não é somável — ao agregar dias ou entidades, recalcule a partir das somas de investimento, cliques, impressões e conversões. No dia corrente pode divergir dos totais até o fechamento do dia. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

roas

float

[pt] Retorno sobre o investimento em anúncios: receita atribuída dividida pelo investimento. Taxa da própria linha: não é somável — ao agregar dias ou entidades, recalcule a partir das somas de investimento, cliques, impressões e conversões. No dia corrente pode divergir dos totais até o fechamento do dia. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

attributed_sales_amount

float

[pt] Valor das vendas atribuídas aos anúncios no período. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

attributed_sales_count

int

[pt] Quantidade de vendas atribuídas aos anúncios no período. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

attributed_sales_currency

text

[pt] Moeda em que o valor das vendas atribuídas é expresso (código ISO, ex.: BRL). Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

order_created_attributed_sales

float

[pt] Valor das vendas atribuídas considerando o evento de pedido criado. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

order_created_attributed_sales_currency

text

[pt] Moeda do valor de vendas atribuídas por pedido criado (código ISO). Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

order_created_roas

float

[pt] Retorno sobre investimento calculado a partir das vendas por pedido criado. Disponível apenas para datas a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança); períodos anteriores ficam vazios.

view_through_conversions

int

[pt] Conversões atribuídas a uma visualização do anúncio (sem clique), com janela de um dia. É complementar à coluna de conversões — que já conta só as conversões por clique — e não deve ser somada a ela para fins de custo por aquisição. Disponível no agrupamento por dia, sem detalhamento.

country_name

text

[pt] País de origem da impressão.

device_type

text

[pt] Tipo de dispositivo em que a impressão ocorreu.

platform

text

[pt] Plataforma em que o anúncio foi exibido (aplicativo Android, aplicativo iOS ou web).

Prévia dos anúncios

Tipo de replicacao: Integral

Relacionamentos:

Campo Tipo

ad_id

text

[pt] Identificador do anúncio a que esta prévia se refere.

    Metadados dos anúncios > > id

body

text

[pt] Trecho HTML com um iframe que exibe a prévia do anúncio. ATENÇÃO: o endereço dentro do iframe EXPIRA 24 HORAS depois de ter sido gerado — passado esse prazo o quadro aparece vazio. A tabela é regravada por inteiro a cada execução justamente por causa disso; para a prévia continuar funcionando, a integração precisa rodar pelo menos uma vez por dia.

fetched_at

timestamp

[pt] Momento em que esta prévia foi gerada. Serve para saber se o iframe ainda está válido: passadas 24 horas deste horário, ele já expirou.

Metadados dos públicos personalizados

Esta integracao e gratuita

Tipo de replicacao: Integral

Campo Tipo

id

text

[pt] Identificador do público personalizado.

name

text

[pt] Nome do público personalizado.

description

text

[pt] Descrição do público personalizado.

status

text

[pt] Situação do público personalizado.

created_at

timestamp

[pt] Data e hora de criação do registro.

updated_at

timestamp

[pt] Data e hora da última alteração do registro.

hash_spec_version

text

[pt] Versão da especificação de hash usada no envio dos identificadores.

uploaded_identifier_count_range

text

[pt] Faixa aproximada da quantidade de identificadores enviados (ex.: '1000-5000'). O número exato não é divulgado, por privacidade.

matched_identifier_count_range

text

[pt] Faixa de identificadores correspondidos. Também é uma faixa em texto, não um número.

matched_user_count_range

text

[pt] Faixa de usuários correspondidos. Também é uma faixa em texto, não um número.

invalid_identifier_count_range

text

[pt] Faixa de identificadores inválidos. Também é uma faixa em texto, não um número.

membership_revision

int

[pt] Número da revisão atual da lista de membros do público.

Catálogos de produtos

Esta integracao e gratuita

Tipo de replicacao: Integral

Campo Tipo

feed_id

text

[pt] Identificador do catálogo de produtos (feed). É o mesmo valor que aparece como catálogo nas campanhas, nos grupos de anúncios e no detalhamento por produto do relatório.

name

text

[pt] Nome do catálogo de produtos.

countries

text

[pt] Países em que o catálogo é usado, em formato JSON (lista de códigos de país).

currencies

text

[pt] Moedas dos preços do catálogo, em formato JSON (lista de códigos de moeda). Pode vir vazia.

product_count

int

[pt] Quantidade de produtos do catálogo, segundo a OpenAI no momento da leitura.

campaign_count

int

[pt] Quantidade de campanhas que usam este catálogo.

is_shopify_managed

boolean

[pt] Indica se o catálogo é mantido pela integração com a Shopify.

hosted_url_configured

boolean

[pt] Indica se o catálogo é atualizado a partir de um endereço (URL) de arquivo.

sftp_configured

boolean

[pt] Indica se o catálogo recebe arquivos por SFTP.

is_search_eligible_respected

boolean

[pt] Indica se o catálogo respeita a marcação de elegibilidade para busca de cada produto.

created_at

timestamp

[pt] Data e hora de criação do catálogo, em UTC.

updated_at

timestamp

[pt] Data e hora da última alteração das configurações do catálogo, em UTC. Não muda a cada envio de produtos.

Envios dos catálogos de produtos

Esta integracao e gratuita

Tipo de replicacao: Integral

Relacionamentos:

Campo Tipo

upload_id

text

[pt] Identificador do envio de arquivo do catálogo.

feed_id

text

[pt] Identificador do catálogo que recebeu o envio.

    Catálogos de produtos > > feed_id

status

text

[pt] Situação do processamento do envio (por exemplo, completed, completed_with_errors, failed).

uploaded_at

timestamp

[pt] Data e hora em que o arquivo foi recebido, em UTC.

completed_at

timestamp

[pt] Data e hora em que o processamento terminou, em UTC. Vazia enquanto o envio é processado.

rows_accepted

int

[pt] Linhas do arquivo aceitas no catálogo.

rows_rejected

int

[pt] Linhas do arquivo recusadas.

rows_ads_eligible

int

[pt] Produtos aceitos que podem ser anunciados. Vazio quando a OpenAI não informa.

diagnostics

text

[pt] Avisos e erros do processamento do arquivo, em formato JSON (lista com código, gravidade, campo e quantidade de linhas afetadas).

Produtos dos catálogos

Tipo de replicacao: Integral

Relacionamentos:

Campo Tipo

feed_id

text

[pt] Identificador do catálogo de produtos ao qual o produto pertence.

    Catálogos de produtos > > feed_id

product_id

text

[pt] Identificador do produto dentro do catálogo, atribuído pela OpenAI.

item_id

text

[pt] Identificador do item informado pelo anunciante no arquivo do catálogo (o mesmo item_id do detalhamento por produto do relatório).

offer_id

text

[pt] Identificador da oferta, quando o catálogo informa.

title

text

[pt] Título do produto.

body

text

[pt] Descrição do produto.

brand

text

[pt] Marca do produto.

target_url

text

[pt] Endereço da página do produto.

image_url

text

[pt] Endereço da imagem do produto.

price

text

[pt] Preço do produto como texto, com a moeda (por exemplo, "99.90 BRL").

price_amount

float

[pt] Preço do produto como número, sem a moeda.

price_currency

text

[pt] Moeda do preço do produto (código de três letras, por exemplo BRL).

variant

text

[pt] Variante do produto (por exemplo, tamanho ou cor), quando o catálogo informa.

availability

text

[pt] Disponibilidade do produto (por exemplo, in_stock).

product_category

text

[pt] Categoria do produto informada no catálogo.

seller_name

text

[pt] Nome do vendedor informado no catálogo.

condition

text

[pt] Condição do produto (por exemplo, new).

age_group

text

[pt] Faixa etária do produto informada no catálogo.

filter_values

text

[pt] Todos os atributos do produto que podem ser usados para filtrar conjuntos de produtos nos grupos de anúncios, em formato JSON. Inclui atributos que não viraram coluna.

Notas

Pontos importantes sobre os dados do ChatGPT Ads:

  • A API disponibiliza apenas os últimos 5 anos de dados.
  • O que cada período de agrupamento entrega: por dia, todas as métricas (mídia, conversões, receita e ROAS); por mês, mídia e receita/ROAS, sem a coluna de conversões (a API só calcula conversões por dia); por hora, só as métricas de mídia (impressões, cliques, investimento, CTR, CPC, CPM), sem conversão nem receita.
  • O agrupamento por hora também não aceita detalhamento (produto, país, dispositivo ou plataforma).
  • Com qualquer detalhamento, as métricas de receita e ROAS não são retornadas. A coluna de conversões continua disponível apenas nos detalhamentos por país e dispositivo, e só no agrupamento por dia; por produto e plataforma ficam só as métricas de mídia.
  • Métricas de receita e ROAS (CPA, vendas atribuídas, pedidos) têm um piso de data próprio: só existem a partir de 15/04/2026 (limite da plataforma de anúncios, sujeito a mudança), diferente do limite geral de 5 anos que vale para mídia e conversões. Períodos anteriores ao piso trazem essas colunas vazias.
  • Não existe detalhamento por idade ou gênero na API do ChatGPT Ads.
  • As taxas do dia corrente (CTR, CPC, CPM, CPA, ROAS) são taxas da própria linha, não são somáveis e só convergem no fechamento do dia. Para agregar, recalcule a partir das somas de investimento, cliques, impressões e conversões.
  • Conversões podem ser atribuídas até 30 dias após o clique; por isso a janela de atualização padrão é de 30 dias.
  • A tabela de prévia dos anúncios entrega um iframe HTML que expira em 24 horas; a integração precisa rodar ao menos uma vez por dia para a prévia continuar válida.
  • Parte desta documentacao foi gerada automaticamente por IA e pode conter erros. Recomendamos verificar informacoes críticas

Escrito por·Publicado em 2026-09-11·Atualizado em 2026-09-17