V4 Marketing API
HomeAPI ReferenceChangelog
HomeAPI ReferenceChangelog
V4 Marketing
  1. API Reference
  • Guia Rápido
  • Facebook Ads
    • Overview
    • Accounts
    • Ads
    • Ad Sets
    • Campaigns
    • Actions
    • Ad Creatives
    • Demographics
    • Platforms
    • Regions
    • Ad Config
    • Ad Set Config
    • Campaigns Config
  • Google Ads
    • Overview
    • Accounts
    • Ad Group Ads
    • Ad Groups
    • Campaigns
    • Keywords
    • Age Range
    • Gender
    • Geographic
    • Conversions
    • Conversion Segmented Ad Group Ads
    • Conversion Segmented Ad Groups
    • Conversion Segmented Campaigns
    • Campaigns Criterion
    • Ad Group Criterion
  • Tray
    • Overview
    • List Tray customers
    • List Tray orders
    • List Tray order products
  • Shopify
    • Overview
    • List Shopify customers
    • List Shopify orders
    • List Shopify order items
    • List Shopify products
  1. API Reference

Guia Rápido

Visão Geral dos Dados Disponíveis#

Nossa API oferece acesso completo aos dados de mídia, CRM e ecommerces, organizados em diferentes níveis de granularidade e segmentação.

Características Importantes#

Cache: As respostas são armazenadas em cache por 30 minutos
Atualização: Os dados são atualizados diariamente
Latência de Mídia: Dados de mídia podem levar até 3 dias para ficarem totalmente consistentes com as plataformas (ideal para cargas incrementais)
Paginação: Todos os endpoints suportam paginação com limite máximo de 5000 registros por página

Parâmetros#

Obrigatórios#

workspaceId: Identificador do workspace (obrigatório em todos os endpoints)

Exemplo de Requisição#

Headers obrigatórios:
x-client-id: seu_client_id
x-client-secret: seu_client_secret

Resposta Padrão#

Todos os endpoints retornam dados no formato:
{
  "data": [
    {
      // registros dos dados solicitados
    }
  ],
  "meta": {
    "page": 1,
    "limit": 500,
    "total": 1250,
    "totalPages": 3,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Estrutura de Dados por Plataforma de Mídia#

Google Ads#

A API do Google Ads está organizada em diferentes categorias de dados:

1. Dados de Conta#

Informações básicas da conta, configurações de orçamento e status

2. Dados de Performance#

Campanhas: Métricas agregadas no nível de campanha
Grupos de Anúncios: Performance detalhada dos grupos
Anúncios: Dados granulares incluindo criativos e URLs
Palavras-chave: Performance com tipos de correspondência

3. Dados de Conversão#

Conversões por Ação: Detalhamento por tipo e categoria
Conversões Segmentadas: Disponível nos níveis de campanha, grupo e anúncio

4. Segmentação Demográfica e Geográfica#

Faixa Etária: Performance por idade do público
Gênero: Performance por gênero
Localização: Dados por estado e cidade

5. Configurações e Critérios#

Critérios de Campanha: Segmentações no nível de campanha
Critérios de Grupo: Segmentações no nível de grupo de anúncios
Nota: Endpoints de configuração não suportam filtros de data, pois retornam dados estruturais.

Facebook Ads#

A API do Facebook Ads oferece dados organizados da seguinte forma:

1. Dados de Conta#

Status da conta, saldo e limites de gastos

2. Dados de Performance#

Campanhas: Métricas de alcance, frequência e engajamento
Conjuntos de Anúncios: Performance com segmentações aplicadas
Anúncios: Dados detalhados incluindo rankings de qualidade

3. Conversões e Ações#

Detalhamento completo de ações por tipo (conversões, cliques, engajamentos)

4. Segmentação#

Demografia: Performance por idade e gênero com métricas de engajamento
Plataformas: Dados por Facebook, Instagram, Messenger e Audience Network
Regiões: Performance geográfica por país e região

5. Criativos#

Criativos Gerais: Informações de mídia e especificações
Criativos por Anúncio: Associação entre criativos e anúncios com filtros avançados

6. Configurações#

Campanhas: Objetivos, tipos de compra e orçamentos
Conjuntos: Segmentações detalhadas de público e plataformas
Anúncios: Configurações básicas e status

Modificado em 2025-11-20 17:59:00
Próxima página
Overview
Built with