|
name
obrigatório
|
string |
Nome da campanha (até 120 caracteres). |
|
goal
obrigatório
|
string |
traffic, awareness, engagement, video_views, conversions, lead_generation ou whatsapp_messages. |
|
status
|
string |
paused (padrão) ou active: como a campanha nasce depois de aprovada. |
|
budget.type
|
string |
daily (padrão) ou lifetime (total, exige schedule.end_date). |
|
budget.amount_cents
obrigatório
|
integer |
Valor em centavos (5000 = R$ 50,00). A diária respeita a mínima da conta. |
|
schedule.start_date
|
string |
AAAA-MM-DD no fuso da conta (padrão: hoje). |
|
schedule.end_date
|
string |
AAAA-MM-DD, depois do início. Obrigatória no orçamento total. |
|
tracking.pixel_id
|
string |
Pixel que marca "Eventos do site" nos anúncios, em qualquer objetivo (nas conversões, é também o Pixel que elas otimizam). Obrigatório: todo anúncio novo sai com ele. Sem pixel_id, vale o padrão da conta (default_pixel_id em GET /ad-account) e, sem padrão, o único que ela enxerga (GET /ad-account/pixels), que passa a ser o padrão. Com vários Pixels e nenhum padrão, sem nenhum Pixel ou com a consulta fora do ar, a campanha é recusada com 422 neste campo. Nas respostas, mostra o Pixel escolhido. |
|
tracking.conversion_event
|
string |
PURCHASE (padrão), LEAD, COMPLETE_REGISTRATION, ADD_TO_CART ou INITIATED_CHECKOUT. |
|
special_ad_category
|
string |
HOUSING, EMPLOYMENT, CREDIT, FINANCIAL_PRODUCTS_SERVICES ou ISSUES_ELECTIONS_POLITICS (anúncios desses temas têm segmentação restrita pela Meta). |
|
persona_id
|
integer |
Persona da conta: a base do público (targeting sobrescreve campo a campo). |
|
targeting.countries
|
string[] |
Países (padrão BR). Com cidades, o país sai delas. |
|
targeting.cities
|
object[] |
Cidades {key, name, country_code} de GET /targeting/cities (até 25). |
|
targeting.age_min
|
integer |
13 a 65 (padrão 18). |
|
targeting.age_max
|
integer |
13 a 65, maior ou igual à mínima (padrão 65). |
|
targeting.gender
|
string |
all (padrão), male ou female. |
|
targeting.interests
|
object[] |
Interesses {id, name} de GET /targeting/interests (até 25): basta ter um deles (OU). |
|
targeting.narrow_interests
|
object[][] |
Grupos que o público também precisa ter: um interesse de cada grupo (E), além de um da lista principal (OU). Até 3 grupos de até 25 interesses {id, name}. Não combina com Advantage+ público. Com persona, [] tira os grupos dela. |
|
targeting.cities[].radius_km
|
integer |
Raio em volta da cidade: 17, 25, 40, 50, 80 km (sem raio, só a cidade). |
|
targeting.audience_id
|
string |
Público da conta a incluir (platform_audience_id de GET /audiences). |
|
targeting.excluded_audience_ids
|
string[] |
Públicos a excluir (até 10), como quem já comprou. |
|
targeting.excluded_cities
|
object[] |
Cidades a excluir {key, name} de GET /targeting/cities (até 25). |
|
targeting.languages
|
string[] |
pt, es, en (sem idioma, todos). |
|
targeting.advantage_audience
|
boolean |
Deixa a Meta ampliar o público além do definido (Advantage+ público). Padrão false. Não vale com targeting.narrow_interests. |
|
placements
|
string[] |
Posicionamentos manuais (veja GET /reference). Vazio ou ausente: automáticos, o recomendado. |
|
tracking.url_tags
|
object[] |
UTMs extras {key, value}, somadas ao link de todos os anúncios. Os 4 padrão vão sempre (utm_source=facebook, utm_medium=paid, utm_campaign={{campaign.name}}, utm_content={{ad.name}}): ausente ou [], a campanha sai só com eles. Um extra com a chave de um dos 4 troca o valor dele (ex.: utm_campaign=blackfriday); os demais vêm depois, na ordem enviada. Até 10 extras: as chaves dos 4 não contam, então reenviar a lista de uma resposta passa. Aceita as macros da Meta, como {{campaign.name}} e {{ad.name}}. Vale em todo objetivo, inclusive cadastro e WhatsApp. Nas respostas, mostra a lista efetiva: os 4 (com o valor trocado, quando houver) e os extras. |
|
instagram_account_id
|
string |
Perfil do Instagram do anúncio (GET /ad-account/instagram-accounts). Sem ele, o ligado à Página. Não vale no WhatsApp. |
|
bidding.strategy
|
string |
COST_CAP (custo por resultado), LOWEST_COST_WITH_BID_CAP (lance máximo) ou LOWEST_COST_WITH_MIN_ROAS (ROAS mínimo, só vendas com Compra). Sem ela, lance automático. |
|
bidding.amount_cents
|
integer |
Valor em centavos, obrigatório em COST_CAP e LOWEST_COST_WITH_BID_CAP. |
|
bidding.roas_floor
|
number |
Retorno mínimo (2.5 = 2,5x), obrigatório em LOWEST_COST_WITH_MIN_ROAS. |
|
format
|
string |
single (padrão) ou carousel, o formato antigo do carrossel sozinho (segue aceito): um criativo só (texto principal, título e botão) e as imagens em carousel.cards. Para juntar o carrossel com arte ou vídeo, use creatives[].cards. |
|
carousel.cards[].media_id
|
string |
Formato antigo: imagem pronta da biblioteca de cada cartão (2 a 10 cartões). |
|
carousel.cards[].headline
|
string |
Título do cartão (obrigatório em cada cartão). |
|
carousel.cards[].description
|
string |
Descrição do cartão. |
|
carousel.cards[].link_url
|
string |
Link do cartão (padrão: link_url). |
|
carousel.cards[].call_to_action
|
string |
Botão do cartão (padrão: o do criativo). |
|
carousel.optimize_order
|
boolean |
true (padrão): a Meta reordena os cartões pelo desempenho. false: ordem fixa, até 5 cartões. |
|
text_variations.headlines
|
string[] |
Até 4 títulos alternativos que a Meta alterna (só num anúncio simples: um criativo, sem carrossel, objetivos com link). |
|
text_variations.bodies
|
string[] |
Até 4 textos principais alternativos. |
|
link_url
|
string |
URL https de destino. Obrigatória nos objetivos com link (veja needs_link em GET /reference). |
|
creatives[].media_id
|
string |
Arte ou vídeo pronto da biblioteca (POST /media): o tipo do anúncio sai da mídia. Cada item de creatives é um anúncio do mesmo conjunto, até 10. Cada item leva media_id ou cards, nunca os dois. |
|
creatives[].headline
obrigatório
|
string |
Título (até 255). Obrigatório no primeiro item; nos demais, sem ele, vale o do primeiro. |
|
creatives[].body
obrigatório
|
string |
Texto principal (até 2000). Obrigatório no primeiro item; nos demais, sem ele, vale o do primeiro. |
|
creatives[].description
|
string |
Descrição (até 255). Do segundo item em diante, sem ela, vale a do primeiro; envie null para o anúncio sair sem descrição. |
|
creatives[].call_to_action
|
string |
Botão (padrão LEARN_MORE; veja GET /reference). Do segundo item em diante, sem ele, vale o do primeiro; null volta ao LEARN_MORE. No WhatsApp, ignorado. |
|
creatives[].cards
|
object[] |
Carrossel: de 2 a 10 cartões, só imagens. Um carrossel por campanha, ao lado de artes e vídeos. Vale em todos os objetivos, menos video_views. |
|
creatives[].cards[].media_id
|
string |
Imagem (JPG ou PNG) da biblioteca para o cartão (obrigatória em cada cartão). |
|
creatives[].cards[].headline
|
string |
Título do cartão (obrigatório em cada cartão). |
|
creatives[].cards[].description
|
string |
Descrição do cartão. |
|
creatives[].cards[].link_url
|
string |
Link do cartão (padrão: link_url). No WhatsApp, não envie: o toque no cartão abre a conversa. |
|
creatives[].cards[].call_to_action
|
string |
Botão do cartão (padrão: o do anúncio). No WhatsApp, não envie: o botão é sempre o de conversa. |
|
creatives[].optimize_order
|
boolean |
No item com cards: true (padrão), a Meta reordena os cartões pelo desempenho; false, ordem fixa, até 5 cartões. |
|
whatsapp.greeting
|
string |
Boas-vindas da empresa na conversa (objetivo whatsapp_messages). |
|
whatsapp.prefill
|
string |
Mensagem que já vem digitada para o cliente enviar. |
|
whatsapp.phone_number
|
string |
Número em E.164 (+5511999998888); sem ele, o da Página. |
|
lead_form_id
|
string |
Formulário existente (platform_form_id de GET /ad-account/lead-forms), no objetivo lead_generation. |
|
lead_form.name
|
string |
Nome do formulário novo (padrão: o da campanha). |
|
lead_form.fields
|
string[] |
Campos padrão: FULL_NAME, EMAIL, PHONE, CITY, STATE, ZIP, COMPANY_NAME, JOB_TITLE (nome e telefone sempre entram). |
|
lead_form.questions
|
object[] |
Até 3 perguntas {question, options[]} (sem options, resposta livre). |
|
lead_form.privacy_policy_url
|
string |
Política de privacidade (padrão: a de Leads › Configurações; a Meta exige). |
|
lead_form.thank_you.title
|
string |
Título da tela final (obrigatório com lead_form). |
|
lead_form.thank_you.body
|
string |
Texto da tela final (obrigatório com lead_form). |