agency_client_declaration exige privilegios de administrador para todas as operações a partir da versão 10.0 e será obrigatório para todas as versões a partir de 25 de maio de 2021.curl -G
-d "access_token=<access_token>"
"https://graph.facebook.com/<API_VERSION>/act_<ad_account_ID>/ads_volume"
{"data":[{"ads_running_or_in_review_count":2}]}
effective_status, configured_status e o status da conta de anúncios:effective_status de um anúncio for 1 - active, isso significa que o estado dele é em veiculação ou em análise.configured_status de um anúncio for active e o effective_status for 9 - pending review, ou 17 - pending processing, isso significa que o anúncio está em veiculação ou em análise.1 - active, 8 - pending settlement, 9 - in grace period.show_breakdown_by_actor ao ponto de extremidade act_123/ads_volume para que você possa consultar informações relacionadas ao volume e aos limites de anúncios de cada página. Para obter mais detalhes, consulte Detalhamento por atores.| Limite | Valor |
|---|---|
Número máximo de contas de anúncios por pessoa | 25 |
Número máximo de pessoas com acesso por conta de anúncios | 25 |
Número máximo de anúncios por conta de anúncios comum | 6.000 anúncios não arquivados e não excluídos |
Número máximo de anúncios por conta de anúncios em massa | 50.000 anúncios não arquivados e não excluídos |
Número máximo de anúncios arquivados por conta de anúncios | 100 mil anúncios arquivados |
Número máximo de conjuntos de anúncios por conta de anúncios comum | 6.000 conjuntos de anúncios não arquivados e não excluídos |
Número máximo de conjuntos de anúncios por conta de anúncios em massa | 10 mil conjuntos de anúncios não arquivados e não excluídos |
Número máximo de conjuntos de anúncios arquivados por conta de anúncios | 100.000 conjuntos de anúncios arquivados |
Número máximo de campanhas de anúncios por conta de anúncios comum | 6 mil campanhas de anúncios não arquivadas e não excluídas |
Número máximo de campanhas de anúncios por conta de anúncios em massa | 10 mil campanhas de anúncios não arquivadas e não excluídas |
Número máximo de campanhas de anúncios arquivadas por conta de anúncios | 100.000 campanhas de anúncios arquivadas |
Número máximo de imagens por conta de anúncios | Ilimitado |
GraphRequest request = GraphRequest.newGraphPathRequest(
accessToken,
"/act_<AD_ACCOUNT_ID>",
new GraphRequest.Callback() {
@Override
public void onCompleted(GraphResponse response) {
// Insert your code here
}
});
Bundle parameters = new Bundle();
parameters.putString("fields", "default_dsa_payor,default_dsa_beneficiary");
request.setParameters(parameters);
request.executeAsync();
iOS SDK
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/act_<AD_ACCOUNT_ID>"
parameters:@{ @"fields": @"default_dsa_payor,default_dsa_beneficiary",}
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection, id result, NSError *error) {
// Insert your code here
}];
Javascript SDK:
FB.api(
'/act_<AD_ACCOUNT_ID>',
'GET',
{"fields":"default_dsa_payor,default_dsa_beneficiary"},
function(response) {
// Insert your code here
}
);
curl -X GET \
"https://graph.facebook.com/v25.0/act_<AD_ACCOUNT_ID>?fields=default_dsa_payor%2Cdefault_dsa_beneficiary&access_token=<ACCESS_TOKEN>"
{"default_dsa_payor":"payor2","default_dsa_beneficiary":"bene2","id":"act_426197654150180"}
| Campo | Descrição |
|---|---|
idstring |
A string act_{ad_account_id}.
padrão |
account_idstring numérica |
A identificação da conta de anúncios.
padrão |
account_statusunsigned int32 |
Status da conta: 1 = ACTIVE2 = DISABLED3 = UNSETTLED7 = PENDING_RISK_REVIEW8 = PENDING_SETTLEMENT9 = IN_GRACE_PERIOD100 = PENDING_CLOSURE101 = CLOSED201 = ANY_ACTIVE202 = ANY_CLOSED |
Campos de ordem de compra da solicitação de criação de conta de anúncios associados a esta conta.
| |
agefloat |
O tempo decorrido desde a criação da conta de anúncios, em dias.
|
Os detalhes da agência que anuncia em nome dessa conta de cliente, se aplicável. Exige privilégios de administrador do Gerenciador de Negócios.
| |
amount_spentstring numérica |
Valor atual usado pela conta com relação a spend_cap. Ou o valor total na ausência de spend_cap. Consulte por que o valor usado é diferente no limite de gastos da conta de anúncios para obter mais informações.
|
attribution_speclista<AttributionSpec> |
Consulte o registro de alterações para saber mais.
|
balancestring numérica |
Valor devido da fatura para esta conta de anúncios.
|
brand_safety_content_filter_levelslista<string> |
Níveis de filtro de conteúdo de segurança para marcas definidos para anúncios no conteúdo (vídeos in-stream do Facebook e anúncios no Facebook Reels) e Audience Network juntamente com anúncios de feed (Facebook Feed, feed do Instagram, feed do Facebook Reels e feed do Instagram Reels), se aplicável.
Consulte Direcionamento de posicionamento para ver uma lista de valores compatíveis.
|
O Gerenciador de Negócios, caso a conta de anúncios seja de propriedade de um.
| |
business_citystring |
Cidade do endereço comercial
|
business_country_codestring |
Código do país do endereço comercial
|
business_namestring |
O nome comercial da conta.
|
business_statestring |
Abreviação do estado para o endereço comercial
|
business_streetstring |
Primeira linha do endereço comercial da conta.
|
business_street2string |
Segunda linha do endereço comercial da conta.
|
business_zipstring |
Código postal do endereço comercial
|
can_create_brand_lift_studybooliano |
Se for possível criar um novo estudo de brand lift automatizado na conta de anúncios.
|
capabilitieslista<string> |
Lista dos recursos possíveis de uma conta de anúncios. Veja os recursos.
|
created_timedatetime |
O horário em que a conta foi criada, no formato ISO 8601.
|
currencystring |
A moeda usada na conta, com base no valor correspondente nas configurações. Consulte as moedas aceitas |
default_dsa_beneficiarystring |
Este é o valor padrão para criar um objeto L2 de dsa_beneficiary.
|
default_dsa_payorstring |
Este é o valor padrão para criar um objeto L2 de dsa_payor.
|
direct_deals_tos_acceptedbooliano |
Indica se os Termos de Serviço de DirectDeals foram aceitos.
|
disable_reasonunsigned int32 |
O motivo pelo qual a conta foi desabilitada. Os motivos possíveis são: 0 = NONE1 = ADS_INTEGRITY_POLICY2 = ADS_IP_REVIEW3 = RISK_PAYMENT4 = GRAY_ACCOUNT_SHUT_DOWN5 = ADS_AFC_REVIEW6 = BUSINESS_INTEGRITY_RAR7 = PERMANENT_CLOSE8 = UNUSED_RESELLER_ACCOUNT9 = UNUSED_ACCOUNT10 = UMBRELLA_AD_ACCOUNT11 = BUSINESS_MANAGER_INTEGRITY_POLICY12 = MISREPRESENTED_AD_ACCOUNT13 = AOAB_DESHARE_LEGAL_ENTITY14 = CTX_THREAD_REVIEW15 = COMPROMISED_AD_ACCOUNT |
end_advertiserstring numérica |
A entidade para a qual os anúncios serão direcionados. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook.
|
end_advertiser_namestring |
O nome da entidade para a qual os anúncios serão direcionados.
|
existing_customerslista<string> |
Identificações de público personalizado usadas pelos anunciantes para definir os clientes atuais. Essa definição é usada principalmente por anúncios de compras automatizados.
|
ID = identificação da forma de pagamentoCOUPON = Detalhes do cupom de anúncios do Facebook da forma de pagamentoCOUPONS = lista de cupons de anúncios ativos do Facebook na conta de anúnciosCOUPON_ID = ID do cupom de anúncios do FacebookAMOUNT = valor do cupom de anúncios do FacebookCURRENCY = Moeda do cupom de anúncios do FacebookDISPLAY_AMOUNT = como o valor do cupom de anúncios do Facebook é exibidoEXPIRATION = quando o cupom expirouSTART_DATE = quando o cupom foi iniciadoDISPLAY_STRING = como a forma de pagamento é exibidaCAMPAIGN_IDS = lista de campanhas às quais o cupom pode ser aplicado, ficará vazio se o cupom for aplicado no nível da conta de anúncios.ORIGINAL_AMOUNT = Valor do cupom de anúncios do Facebook quando emitidoORIGINAL_DISPLAY_AMOUNT = como o cupom de anúncios do Facebook é exibido quando emitidoTYPE = tipo de forma de pagamento0 = UNSET1 = CREDIT_CARD2 = FACEBOOK_WALLET3 = FACEBOOK_PAID_CREDIT4 = FACEBOOK_EXTENDED_CREDIT5 = ORDER6 = INVOICE7 = FACEBOOK_TOKEN8 = EXTERNAL_FUNDING9 = FEE10 = FX11 = DISCOUNT12 = PAYPAL_TOKEN13 = PAYPAL_BILLING_AGREEMENT14 = FS_NULL15 = EXTERNAL_DEPOSIT16 = TAX17 = DIRECT_DEBIT18 = DUMMY19 = ALTPAY20 = STORED_BALANCE
Para acessar esse campo, o usuário responsável pela chamada de API precisa ter uma permissão de tarefa MANAGE para a conta de anúncios em questão. Consulte Ad Account, Assigned Users para saber mais.
| |
O grupo de fatura de crédito estendido ao qual a conta de anúncios pertence.
| |
Falha nas verificações de veiculação
| |
fb_entityunsigned int32 |
fb_entity
|
funding_sourcestring numérica |
Identificação da forma de pagamento. Se a conta não tiver uma forma de pagamento, ainda será possível criar anúncios, mas eles não serão veiculados. Não é disponibilizado se a conta estiver desabilitada.
|
ID = identificação da forma de pagamentoCOUPON = Detalhes do cupom de anúncios do Facebook da forma de pagamentoCOUPONS = lista de cupons de anúncios ativos do Facebook na conta de anúnciosCOUPON_ID = ID do cupom de anúncios do FacebookAMOUNT = valor do cupom de anúncios do FacebookCURRENCY = Moeda do cupom de anúncios do FacebookDISPLAY_AMOUNT = como o valor do cupom de anúncios do Facebook é exibidoEXPIRATION = quando o cupom expiraráSTART_DATE = quando o cupom iniciaDISPLAY_STRING = como a forma de pagamento é exibidaCAMPAIGN_IDS = lista de campanhas às quais o cupom pode ser aplicado, ficará vazio se o cupom for aplicado no nível da conta de anúncios.ORIGINAL_AMOUNT = Valor do cupom de anúncios do Facebook quando emitidoORIGINAL_DISPLAY_AMOUNT = como o cupom de anúncios do Facebook é exibido quando emitidoTYPE = tipo de forma de pagamento0 = UNSET1 = CREDIT_CARD2 = FACEBOOK_WALLET3 = FACEBOOK_PAID_CREDIT4 = FACEBOOK_EXTENDED_CREDIT5 = ORDER6 = INVOICE7 = FACEBOOK_TOKEN8 = EXTERNAL_FUNDING9 = FEE10 = FX11 = DISCOUNT12 = PAYPAL_TOKEN13 = PAYPAL_BILLING_AGREEMENT14 = FS_NULL15 = EXTERNAL_DEPOSIT16 = TAX17 = DIRECT_DEBIT18 = DUMMY19 = ALTPAY20 = STORED_BALANCE
Para acessar esse campo, o usuário responsável pela chamada de API precisa ter uma permissão de tarefa MANAGE para a conta de anúncios em questão. Consulte Ad Account, Assigned Users para saber mais.
| |
has_migrated_permissionsbooliano |
Indica se a conta tem permissões migradas.
|
has_page_authorized_adaccountbooliano |
Indica se a Página do Facebook autorizou a conta de anúncios para veicular anúncios com conteúdo político. Caso você tente publicar um anúncio com conteúdo político usando a conta de anúncios para esta página, e a página não tenha autorizado a conta para anúncios com conteúdo político, o anúncio será reprovado. Consulte Alterações disruptivas, API de Marketing, Anúncios com conteúdo político e Políticas de Publicidade do Facebook.
|
io_numberstring numérica |
O número do pedido de inserção (IO, pelas iniciais em inglês).
|
is_attribution_spec_system_defaultbooliano |
Se a especificação de atribuição da conta de anúncios for gerada a partir dos valores padrão do sistema
|
is_direct_deals_enabledbooliano |
Indica se a conta está habilitada para executar negociações diretas.
|
is_in_3ds_authorization_enabled_marketbooliano |
Se a conta estiver em um mercado que exige autorização 3DS para realizar o processo de pagamento
|
is_notifications_enabledbooliano |
Obter o status de notificações do usuário para esta conta de anúncios. Isso retornará verdadeiro ou falso dependendo de as notificações estarem habilitadas ou não.
|
is_personalunsigned int32 |
Indica se essa conta de anúncios está sendo usada para fins privados e não comerciais. Isso afeta a forma como o imposto sobre valor agregado (IVA) é calculado. Observação: isso não tem relação com o vínculo entre uma conta de anúncios e uma empresa.
|
is_prepay_accountbooliano |
Indica se a conta de anúncios é pré-paga. A outra opção seria uma conta pós-paga.
Para acessar esse campo, o usuário responsável pela chamada de API precisa ter uma permissão de tarefa ADVERTISE ou MANAGE para a conta de anúncios em questão. Consulte Ad Account, Assigned Users para saber mais.
|
is_tax_id_requiredbooliano |
Indica se a identificação fiscal da conta de anúncios é necessária ou não.
Para acessar esse campo, o usuário responsável pela chamada de API precisa ter uma permissão de tarefa ADVERTISE ou MANAGE para a conta de anúncios em questão. Consulte Ad Account, Assigned Users para saber mais.
|
line_numberslista<integer> |
Os números de linha
|
media_agencystring numérica |
A agência, que pode ser a própria empresa. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook. Caso não haja uma, é possível usar NONE ou UNFOUND.
|
min_campaign_group_spend_capstring numérica |
O limite mínimo de gastos exigido para a campanha de anúncios.
|
min_daily_budgetunsigned int32 |
O orçamento diário mínimo para esta conta de anúncios.
|
namestring |
Nome da conta. Caso não seja definido, o nome do primeiro administrador visível ao usuário será retornado.
|
offsite_clo_signal_statusint32 |
offsite_clo_signal_status
|
offsite_pixels_tos_acceptedbooliano |
Indica se o contrato de Termos de Serviço do pixel externo foi assinado. Este recurso pode ser acessado antes da versão 2.9.
|
opportunity_scorefloat |
Em uma escala de 0 a 100, essa pontuação representa o nível de otimização das campanhas, conjuntos de anúncios e anúncios da conta de anúncios no geral.
Consulte Pontuação de oportunidade para saber mais.
|
ownerstring numérica |
A identificação do proprietário da conta.
|
partnerstring numérica |
Pode ser o Parceiro de Marketing do Facebook, se houver. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook. Caso não haja uma, é possível usar NONE ou UNFOUND.
|
rf_specReachFrequencySpec |
Configuração de limites de alcance e frequência. Consulte alcance e frequência |
show_checkout_experiencebooliano |
Se a experiência de finalização da compra pré-paga será exibida para um anunciante. Se true, o anunciante está qualificado para finalização da compra ou já está inscrito na finalização da compra e não foi promovido para o pós-pagamento.
|
spend_capstring numérica |
O valor máximo que pode ser gasto por essa conta de anúncios. Quando o valor for atingido, toda a veiculação será interrompida. Um valor de 0 significa que não há limite de gastos. Ao definir um novo limite de gastos, você irá gastar o tempo no momento em que o limite for definido. Valor especificado na unidade básica da moeda, por exemplo "centavos" para USD.
|
tax_idstring |
Número de identificação fiscal
|
tax_id_statusunsigned int32 |
Código de status de IVA da conta. 0: desconhecido1: IVA não necessário – EUA/Canadá2: informações de IVA necessárias3: informações sobre o IVA enviadas4: falha na validação do IVA offline5: a conta é pessoal.
|
tax_id_typestring |
Tipo de identificação fiscal
|
timezone_idunsigned int32 |
A identificação do fuso horário da conta de anúncios.
|
timezone_namestring |
Nome do fuso horário.
|
timezone_offset_hours_utcfloat |
Diferença de fuso horário em relação ao UTC (Horário Coordenado Universal).
|
tos_acceptedmap<string, int32> |
Verifica se a conta de anúncios específica assinou os contratos dos Termos de Serviço. Retorna 1 se os termos forem aceitos.
|
user_taskslista<string> |
user_tasks
|
user_tos_acceptedmap<string, int32> |
Verifica se um usuário assinou os contratos de Termos de Serviço relacionados à empresa que contém uma conta de anúncios específica. É necessário incluir o token de acesso do usuário para obter informações. Essa verificação não é válida para usuários do sistema.
|
| Borda | Descrição |
|---|---|
account_controlsBorda<AdAccountBusinessConstraints> |
Os controles de conta são para campanhas de compras Advantage+ em que os anunciantes podem definir controles de público para idade mínima e localização geográfica excluída.
|
activitiesBorda<AdActivity> |
As atividades da conta de anúncios.
|
adcreativesBorda<AdCreative> |
Os criativos do anúncio dessa conta de anúncios.
|
ads_reporting_mmm_reportsBorda<AdsReportBuilderMMMReport> |
Relatórios de marketing mix modeling (MMM) gerados para esta conta de anúncios.
|
ads_reporting_mmm_schedulersBorda<AdsReportBuilderMMMReportScheduler> |
Obter todos os programadores de relatórios de MMM por conta de anúncios
|
Todos os apps anunciáveis associados à conta.
| |
advideosBorda<Video> |
Os vídeos associados à conta.
|
applicationsBorda<Application> |
Apps conectados às contas de anúncios
|
asyncadcreativesBorda<AdAsyncRequestSet> |
As solicitações assíncronas de criação de criativos do anúncio associadas à conta de anúncios.
|
broadtargetingcategoriesBorda<BroadTargetingCategories> |
É possível usar categorias de direcionamento amplo (BCTs, pelas iniciais em inglês) para direcionamento.
|
connected_instagram_accountsBorda<ShadowIGUser> |
Contas do Instagram conectadas à conta de anúncios
|
customaudiencesBorda<CustomAudience> |
Os Públicos Personalizados que pertencem ou são compartilhados com essa conta de anúncios.
|
customaudiencestosBorda<CustomAudiencesTOS> |
São os Termos de Serviço para públicos personalizados disponíveis para a conta de anúncios.
|
customconversionsBorda<CustomConversion> |
As conversões personalizadas que pertencem ou são compartilhadas com essa conta de anúncios.
|
delivery_estimateBorda<AdAccountDeliveryEstimate> |
A estimativa de veiculação de uma determinada configuração de conjunto de anúncios para essa conta de anúncios.
|
deprecatedtargetingadsetsBorda<AdCampaign> |
Conjuntos de anúncios com opções de direcionamento que se tornaram obsoletas para esta conta de anúncios
|
dsa_recommendationsBorda<AdAccountDsaRecommendations> |
dsa_recommendations
|
generatepreviewsBorda<AdPreview> |
Gerar prévias para uma especificação de criativo
|
impacting_ad_studiesBorda<AdStudy> |
Os estudos de anúncio que contêm essa conta de anúncios ou qualquer um dos objetos de anúncio descendentes.
|
instagram_accountsBorda<ShadowIGUser> |
Contas do Instagram conectadas às contas de anúncios
|
mcmeconversionsBorda<AdsMcmeConversion> |
mcmeconversions
|
minimum_budgetsBorda<MinimumBudget> |
Retorna valores mínimos do orçamento diário por moeda.
|
promote_pagesBorda<Page> |
Todas as Páginas que foram promovidas na conta de anúncios.
|
reachestimateBorda<AdAccountReachEstimate> |
A estimativa de alcance de uma determinada especificação de direcionamento para esta conta de anúncios.
|
saved_audiencesBorda<SavedAudience> |
Os públicos salvos na conta.
|
targetingbrowseBorda<AdAccountTargetingUnified> |
Navegação unificada
|
targetingsearchBorda<AdAccountTargetingUnified> |
Pesquisa unificada
|
targetingsuggestionsBorda<AdAccountTargetingUnified> |
Sugestões unificadas
|
targetingvalidationBorda<AdAccountTargetingUnified> |
Validação unificada
|
| Código de erro | Descrição |
|---|---|
200 | Erro de permissões |
613 | As chamadas para esta API ultrapassaram o limite de volume. |
100 | Parâmetro inválido |
190 | Token de acesso OAuth 2.0 inválido |
80004 | Houve muitas chamadas para esta conta de anúncios. Espere um pouco e tente de novo. Para obter mais informações, consulte /docs/graph-api/overview/rate-limiting#ads-management. |
3018 | A data de início do período não pode ultrapassar 37 meses a partir da data atual. |
2.500 | Erro ao analisar a consulta da Graph API. |
1150 | Ocorreu um erro desconhecido. |
2635 | Você está chamando uma versão obsoleta da API de Anúncios. Atualize para a versão mais recente. |
368 | A ação tentada foi considerada abusiva ou não é permitida. |
name, currency, timezone_id, end_advertiser, media_agency e partner. Forneça end_advertiser, media_agency e partner:
20531316728.
NONE.
UNFOUND.
end_advertiser como um valor diferente de NONE ou UNFOUND, não é possível alterá-lo.curl \
-F "name=MyAdAccount" \
-F "currency=USD" \
-F "timezone_id=1" \
-F "end_advertiser=<END_ADVERTISER_ID>" \
-F "media_agency=<MEDIA_AGENCY_ID>" \
-F "partner=NONE" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/adaccount"invoice como true, e associaremos sua nova conta de anúncios a essa linha de crédito.
{
"id": "act_<ADACCOUNT_ID>",
"account_id": "<ADACCOUNT_ID>",
"business_id": "<BUSINESS_ID>",
"end_advertiser_id": "<END_ADVERTISER_ID>",
"media_agency_id": "<MEDIA_AGENCY_ID>",
"partner_id": "NONE"
}POST /v25.0/act_<AD_ACCOUNT_ID>/product_audiences HTTP/1.1 Host: graph.facebook.com name=Test+Iphone+Product+Audience&product_set_id=%3CPRODUCT_SET_ID%3E&inclusions=%5B%7B%22retention_seconds%22%3A86400%2C%22rule%22%3A%7B%22and%22%3A%5B%7B%22event%22%3A%7B%22eq%22%3A%22AddToCart%22%7D%7D%2C%7B%22userAgent%22%3A%7B%22i_contains%22%3A%22iPhone%22%7D%7D%5D%7D%7D%5D&exclusions=%5B%7B%22retention_seconds%22%3A172800%2C%22rule%22%3A%7B%22event%22%3A%7B%22eq%22%3A%22Purchase%22%7D%7D%7D%5D
| Parâmetro | Descrição |
|---|---|
associated_audience_idint64 |
SELF_EXPLANATORY
|
creation_paramsdicionário { string : <string> } |
SELF_EXPLANATORY
|
descriptionstring |
SELF_EXPLANATORY
|
enable_fetch_or_createbooleano |
enable_fetch_or_create
|
event_sourcesmatriz<JSON object> |
event_sources
idint64
id
obrigatório typeenum {APP, OFFLINE_EVENTS, PAGE, PIXEL}
type
obrigatório Show child parameters |
exclusionslista<Object> |
SELF_EXPLANATORY
booking_windowObjetomin_secondsint64max_secondsint64Show child parameters countObjetoeventstringtypeenum {CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, EXCLUSION, MESSENGER_SUBSCRIBER_LIST}retentionObjetomin_secondsinteiroobrigatório max_secondsinteiroobrigatório Show child parameters retention_daysint64retention_secondsinteiroruleObjetopixel_idint64Show child parameters |
inclusionslista<Object> |
SELF_EXPLANATORY
booking_windowObjetomin_secondsint64max_secondsint64Show child parameters countObjetoeventstringtypeenum {CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, EXCLUSION, MESSENGER_SUBSCRIBER_LIST}retentionObjetomin_secondsinteiroobrigatório max_secondsinteiroobrigatório Show child parameters retention_daysint64retention_secondsinteiroruleObjetopixel_idint64Show child parameters |
namestring |
SELF_EXPLANATORY
obrigatório |
opt_out_linkstring |
SELF_EXPLANATORY
|
parent_audience_idint64 |
SELF_EXPLANATORY
|
product_set_idstring numérica ou número inteiro |
SELF_EXPLANATORY
obrigatório |
subtypeenum {CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, EXCLUSION, MESSENGER_SUBSCRIBER_LIST} |
SELF_EXPLANATORY
|
Struct {
id: numeric string,
message: string,
}
| Código de erro | Descrição |
|---|---|
100 | Parâmetro inválido |
2654 | Falha ao criar o público personalizado. |
| Parâmetro | Descrição |
|---|---|
adaccountslist<numeric string> |
Matriz de identificações de novas contas de anúncios que receberão acesso ao público personalizado.
|
permissionsstring | targeting ou targeting_and_insights. Se targeting, a conta de anúncios do destinatário poderá direcionar o público nos anúncios. targeting_and_insights também permite que a conta do destinatário veja o público na ferramenta de insights sobre o público.
|
relationship_typematriz<string> |
relationship_type
|
replacebooleano | true ou false. Se true, a lista de adaccounts fornecida na chamada substituirá o conjunto existente de contas de anúncios com as quais esse público é compartilhado.
|
Struct {
success: bool,
sharing_data: List [ Struct {
ad_acct_id: string,
business_id: numeric string,
audience_share_status: string,
errors: List [string],
}],
}
| Código de erro | Descrição |
|---|---|
200 | Erro de permissões |
| Parâmetro | Descrição |
|---|---|
ad_account_created_from_bm_flagbooleano |
ad_account_created_from_bm_flag
|
currencyCódigo de moeda ISO 4217 |
A moeda usada na conta.
obrigatório |
end_advertiser |
A entidade para a qual os anúncios serão direcionados. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook. Caso não haja uma, é possível usar NONE ou UNFOUND. Depois que um valor diferente de NONE ou UNFOUND for definido, não será mais possível modificá-lo.
obrigatório |
funding_idstring numérica ou número inteiro |
ID da forma de pagamento. Se a conta não tiver uma forma de pagamento, ainda será possível criar anúncios, mas eles não serão veiculados.
|
invoicebooleano |
Se o Gerenciador de Negócios tiver uma linha de crédito normal própria registrada no CRM do Facebook, ele vinculará a conta de anúncios a essa linha de crédito.
|
invoice_group_idstring numérica |
O ID do grupo de fatura no qual a conta de anúncios deve ser inscrita.
|
invoicing_emailsmatriz<string> |
Emails para os quais as faturas serão enviadas.
|
iobooleano |
Se o canal corporativo for de vendas diretas.
|
media_agencystring |
A agência, que pode ser a própria empresa. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook. Caso não haja uma, é possível usar NONE ou UNFOUND.
obrigatório |
namestring |
O nome da conta de anúncios.
obrigatório |
partnerstring |
O parceiro de publicidade da conta, se houver. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook. Caso não haja uma, é possível usar NONE ou UNFOUND.
obrigatório |
po_numberstring |
Número da ordem de compra
|
timezone_idunsigned int32 |
ID do fuso horário. Veja aqui.
obrigatório |
Struct {
id: token with structure: AdAccount ID,
account_id: numeric string,
business_id: numeric string,
end_advertiser_id: string,
media_agency_id: string,
partner_id: string,
seer_ad_account_restricted_by_soft_desc_challenge: bool,
soft_desc_challenge_credential_id: string,
soft_desc_challenge_localized_auth_amount: int32,
}
| Código de erro | Descrição |
|---|---|
100 | Parâmetro inválido |
3979 | No momento, você excedeu o número de contas de anúncios permitidas para seu Gerenciador de Negócios. |
3980 | No momento, uma ou mais das contas de anúncios no seu Gerenciador de Negócios estão com problemas ou em análise. Todas as suas contas devem ter a reputação em dia para que você possa criar novas contas de anúncios. |
415 | Autenticação de dois fatores necessária. O usuário precisa inserir um código de um gerador de códigos TOTP ou SMS para passar na autenticação de dois fatores. Isso poderia acontecer ao acessar um ativo protegido pela autenticação de dois fatores, como uma página que pertence a um Gerenciador de Negócios protegido por esse recurso. |
3902 | Ocorreu um problema técnico e sua nova conta de anúncios não foi criada. Tente novamente. |
457 | A sessão tem uma origem inválida. |
190 | Token de acesso OAuth 2.0 inválido |
23007 | Este cartão de crédito não pode ser definido como a forma de pagamento principal da conta, porque ela está configurada para ser cobrada após os anúncios terem sido veiculados. Essa configuração não pode ser alterada. Tente usar outro cartão ou forma de pagamento. |
| Parâmetro | Descrição |
|---|---|
adaccount_idstring |
Identificação da conta de anúncios.
obrigatório |
Struct {
access_status: string,
}
| Código de erro | Descrição |
|---|---|
3979 | No momento, você excedeu o número de contas de anúncios permitidas para seu Gerenciador de Negócios. |
3994 | Contas pessoais que não têm histórico de atividade não são qualificadas para migração para um Gerenciador de Negócios. Em vez disso, crie uma conta de anúncios dentro do seu Gerenciador de Negócios. |
100 | Parâmetro inválido |
3980 | No momento, uma ou mais das contas de anúncios no seu Gerenciador de Negócios estão com problemas ou em análise. Todas as suas contas devem ter a reputação em dia para que você possa criar novas contas de anúncios. |
415 | Autenticação de dois fatores necessária. O usuário precisa inserir um código de um gerador de códigos TOTP ou SMS para passar na autenticação de dois fatores. Isso poderia acontecer ao acessar um ativo protegido pela autenticação de dois fatores, como uma página que pertence a um Gerenciador de Negócios protegido por esse recurso. |
3936 | Você já tentou reivindicar esta conta de anúncios. Você verá uma notificação se sua solicitação for aceita. |
368 | A ação tentada foi considerada abusiva ou não é permitida. |
3944 | Seu Gerenciador de Negócios já tem acesso a este objeto. |
default_dsa_payor e default_dsa_beneficiary podem ser definidos como ambos ou nenhum deles. A API não permite que apenas um deles exista no armazenamento de dados.| Parâmetro | Descrição |
|---|---|
agency_client_declarationdicionário { string : <string> } |
Os detalhes da agência que anuncia em nome dessa conta de cliente, se aplicável. Exige privilégios de administrador do Gerenciador de Negócios.
|
attribution_speclista<Object> |
Consulte o registro de alterações para saber mais.
event_typeenum {CLICK_THROUGH, VIEW_THROUGH, ENGAGED_VIDEO_VIEW}obrigatório window_daysint64obrigatório Show child parameters |
business_infodicionário { string : <string> } |
Informações da empresa
|
custom_audience_infoObjeto JSON |
Informações sobre o público personalizado para anúncios de compras automatizados.
new_customer_tagstring
Valor de rótulo para novos clientes no parâmetro de URL do tipo de público personalizado dos Anúncios Automatizados de Compras.
existing_customer_tagstring
Valor de rótulo para cliente existente no parâmetro de URL do tipo de público personalizado dos Anúncios Automatizados de Compras.
audience_type_param_namestring
nome do campo referente ao tipo de público no parâmetro de UTM do tipo de público personalizado de anúncios de compras automatizados.
Show child parameters |
default_dsa_beneficiarystring |
Este é o valor padrão para criar o direcionamento L2 do beneficiário da UE.
|
default_dsa_payorstring |
Este é o valor padrão para criar o direcionamento L2 do pagador na UE.
|
end_advertiserstring |
A entidade para a qual os anúncios serão direcionados. Deve ser um alias de Página do Facebook, uma identificação de Página do Facebook ou um ID de app do Facebook.
|
is_notifications_enabledbooleano |
Indica se as notificações estão habilitadas para a conta.
|
media_agencystring |
O ID de uma página ou app do Facebook. Depois de definido para qualquer valor que não seja NONE ou UNFOUND, ele não poderá mais ser modificado.
|
namestring |
O nome da conta de anúncios.
|
partnerstring |
O ID de uma página ou app do Facebook. Depois de definido para qualquer valor que não seja NONE ou UNFOUND, ele não poderá mais ser modificado.
|
spend_capfloat |
O valor total que a conta pode gastar. Depois disso, todas as campanhas serão pausadas, com base em amount_spent. Um valor de 0 significa que não há limite de gastos, e a configuração de um novo limite de gastos só será aplicada aos gastos feitos DEPOIS da configuração. Valor especificado na denominação padrão da moeda. Por exemplo, 23.50 para US$ 23,50.
|
spend_cap_actionstring |
Ao definir este parâmetro como reset, a amount_spent será definida de volta para 0. Ao definir como delete, a spend_cap será removida da conta.
|
Struct {
success: bool,
}
| Código de erro | Descrição |
|---|---|
100 | Parâmetro inválido |
200 | Erro de permissões |
368 | A ação tentada foi considerada abusiva ou não é permitida. |
190 | Token de acesso OAuth 2.0 inválido |
80004 | Houve muitas chamadas para esta conta de anúncios. Espere um pouco e tente de novo. Para obter mais informações, consulte /docs/graph-api/overview/rate-limiting#ads-management. |
| Parâmetro | Descrição |
|---|---|
tasksarray<enum {MANAGE, ADVERTISE, ANALYZE, DRAFT, AA_ANALYZE}> |
Tarefas de permissão da conta de anúncios a serem atribuídas ao usuário.
|
userUID |
Número de identificação do usuário comercial ou número de identificação do usuário do sistema
obrigatório |
Struct {
success: bool,
}
| Código de erro | Descrição |
|---|---|
100 | Parâmetro inválido |
200 | Erro de permissões |
2620 | Chamada inválida para atualizar as permissões da conta. |
| Parâmetro | Descrição |
|---|---|
account_idstring numérica |
SELF_EXPLANATORY
obrigatório |
businessstring numérica ou número inteiro |
SELF_EXPLANATORY
obrigatório |
Struct {
success: bool,
}
| Código de erro | Descrição |
|---|---|
100 | Parâmetro inválido |
| Parâmetro | Descrição |
|---|---|
adaccountslist<numeric string> |
Matriz de identificações de contas de anúncios para revogar o acesso ao público personalizado.
|
Struct {
success: bool,
}
| Código de erro | Descrição |
|---|---|
100 | Parâmetro inválido |