Pular para o conteúdo

GET /v1/ads/campaigns

GET
/v1/ads/campaigns
curl --request GET \
--url 'https://seu-endereco-da-api/v1/ads/campaigns?period=7&window=current' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler Meta Ads (ads:read).

accountId
string format: uuid

Conta conectada do tenant (exclusivo com adId)

adId
string

Id numérico do anúncio na Meta; devolve a árvore da conta dona com focus

period
string
Allowed values: 7 30 90
window
string
Allowed values: current previous
Media typeapplication/json
object
account
required
object
id
required
string
externalAccountId
required

Só dígitos; o act_ é prefixo de rota

string
name
required
string
currency
required
string
nullable
businessName
required
string
nullable
metaStatus
required

Reatualizado a cada leitura fresca da árvore na Meta

string
Allowed values: active disabled unsettled pending_risk_review pending_settlement in_grace_period pending_closure closed unknown
canManage
required
boolean
tokenStatus
required
string
Allowed values: valid expiring expired invalid unknown
missingScopes
required
Array<string>
Allowed values: ads_read ads_management business_management leads_retrieval pages_show_list pages_read_engagement pages_manage_metadata pages_manage_ads pages_messaging
period
required
string
Allowed values: 7 30 90
fetchedAt
required
string format: date-time
insightsAvailable
required

Falso quando as insights da Meta falharam; gasto e cliques vêm null

boolean
focus
required

Caminho do anúncio pedido por adId

object
campaignId
required
string
adsetId
required
string
adId
required
string
campaigns
required
Array<object>
object
id
required
string
name
required
string
status
required
string
Allowed values: ACTIVE PAUSED
effectiveStatus
required
string
Allowed values: ACTIVE PAUSED CAMPAIGN_PAUSED ADSET_PAUSED PENDING_REVIEW DISAPPROVED PREAPPROVED PENDING_BILLING_INFO IN_PROCESS WITH_ISSUES
objective
required
string
nullable
budget
required
object
kind
required
string
Allowed values: daily lifetime
amount
required

Centavos da moeda da conta

number
startTime
required
string
nullable
stopTime
required
string
nullable
metrics
required
object
spend
required

Centavos da moeda da conta

number
nullable
impressions
required
number
nullable
clicks
required
number
nullable
reach
required

Pessoas únicas; só no anúncio — conjunto e campanha devolvem null, porque somar alcance conta a mesma pessoa duas vezes

number
nullable
leads
required
number
conversations
required
number
deals
required
number
revenue
required

Escala de Deal.value

number
costPerLead
required

Centavos da moeda da conta

number
nullable
roas
required

Razão com duas casas

number
nullable
adsets
required
Array<object>
object
id
required
string
name
required
string
status
required
string
Allowed values: ACTIVE PAUSED
effectiveStatus
required
string
Allowed values: ACTIVE PAUSED CAMPAIGN_PAUSED ADSET_PAUSED PENDING_REVIEW DISAPPROVED PREAPPROVED PENDING_BILLING_INFO IN_PROCESS WITH_ISSUES
budget
required
object
kind
required
string
Allowed values: daily lifetime
amount
required

Centavos da moeda da conta

number
optimizationGoal
required
string
nullable
metrics
required
object
spend
required

Centavos da moeda da conta

number
nullable
impressions
required
number
nullable
clicks
required
number
nullable
reach
required

Pessoas únicas; só no anúncio — conjunto e campanha devolvem null, porque somar alcance conta a mesma pessoa duas vezes

number
nullable
leads
required
number
conversations
required
number
deals
required
number
revenue
required

Escala de Deal.value

number
costPerLead
required

Centavos da moeda da conta

number
nullable
roas
required

Razão com duas casas

number
nullable
ads
required
Array<object>
object
id
required
string
name
required
string
status
required
string
Allowed values: ACTIVE PAUSED
effectiveStatus
required
string
Allowed values: ACTIVE PAUSED CAMPAIGN_PAUSED ADSET_PAUSED PENDING_REVIEW DISAPPROVED PREAPPROVED PENDING_BILLING_INFO IN_PROCESS WITH_ISSUES
thumbnailUrl
required
string
nullable
metrics
required
object
spend
required

Centavos da moeda da conta

number
nullable
impressions
required
number
nullable
clicks
required
number
nullable
reach
required

Pessoas únicas; só no anúncio — conjunto e campanha devolvem null, porque somar alcance conta a mesma pessoa duas vezes

number
nullable
leads
required
number
conversations
required
number
deals
required
number
revenue
required

Escala de Deal.value

number
costPerLead
required

Centavos da moeda da conta

number
nullable
roas
required

Razão com duas casas

number
nullable

Example

{
"account": {
"metaStatus": "active",
"tokenStatus": "valid",
"missingScopes": [
"ads_read"
]
},
"period": "7",
"campaigns": [
{
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"budget": {
"kind": "daily"
},
"adsets": [
{
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"budget": {
"kind": "daily"
},
"ads": [
{
"status": "ACTIVE",
"effectiveStatus": "ACTIVE"
}
]
}
]
}
]
}