Overview

A API do Facebook Ads do V4 Marketing permite que você acesse e gerencie dados de contas, campanhas, conjuntos de anúncios, anúncios e dimensões como plataformas, regiões, demografia e configurações.

Endpoints Disponíveis

GET /v1/facebook-ads/accounts: Contas do Facebook Ads

GET /v1/facebook-ads/campaigns: Campanhas com métricas de performance

GET /v1/facebook-ads/ad-sets: Conjuntos de anúncios (Ad Sets)

GET /v1/facebook-ads/ads: Anúncios com métricas e rankings

GET /v1/facebook-ads/actions: Ações agregadas por tipo

GET /v1/facebook-ads/demographics: Desempenho por faixa etária e gênero

GET /v1/facebook-ads/platforms: Desempenho por plataforma (Facebook, Instagram, etc.)

GET /v1/facebook-ads/regions: Desempenho por região/país

GET /v1/facebook-ads/creatives: Ativos criativos e metadados

GET /v1/facebook-ads/adset-config: Configurações de conjuntos de anúncio

GET /v1/facebook-ads/campaigns-config: Configurações de campanhas

Estrutura Hierárquica

O Facebook Ads segue uma estrutura hierárquica:

Campanha (Campaign)
├── Conjunto de Anúncios (Ad Set)
│   ├── Anúncio (Ad)
│   ├── Anúncio (Ad)
│   └── Anúncio (Ad)
└── Conjunto de Anúncios (Ad Set)
    ├── Anúncio (Ad)
    └── Anúncio (Ad)

Autenticação

Todos os endpoints requerem autenticação via Bearer token no header Authorization.

Parâmetros Comuns

workspaceId - ID do workspace

organizationId - ID da organização

userId - ID do usuário

page - Número da página (padrão: 1)

limit - Limite por página (padrão: 500, máximo: 5000)

orderBy - Campo para ordenação

orderDirection - Direção da ordenação (ASC/DESC)

dateStart - Data de início para filtro (YYYY-MM-DD)

dateEnd - Data de fim para filtro (YYYY-MM-DD)

Campos Específicos do Facebook

Campanhas

campaign_name - Nome da campanha

objective - Objetivo da campanha (ex: CONVERSIONS, REACH, etc.)

status - Status da campanha

date_start - Data de início

date_stop - Data de fim

Conjuntos de Anúncios (Ad Sets)

adset_name - Nome do conjunto de anúncios

campaign_id - ID da campanha pai

status - Status do conjunto de anúncios

Anúncios

ad_name - Nome do anúncio

adset_id - ID do conjunto de anúncios pai

campaign_id - ID da campanha pai

Métricas Disponíveis

clicks - Número de cliques

reach - Alcance

impressions - Número de impressões

spend - Valor gasto

Respostas

Todas as respostas seguem o padrão:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "total": 1000,
    "totalPages": 2,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Endpoints Disponíveis#

Estrutura Hierárquica#

Autenticação#

Parâmetros Comuns#

Campos Específicos do Facebook#

Campanhas#

Conjuntos de Anúncios (Ad Sets)#

Anúncios#

Métricas Disponíveis#

Respostas#