Integração da API de Conversões e Pixel da MBE

O fluxo da API de Conversões e Pixel da Extensão da Meta para Empresas (MBE, pelas iniciais em inglês) permite que os usuários criem ou selecionem o Gerenciador de Negócios, a Página e o Pixel da Meta. Esse fluxo é recomendado para parceiros com recursos de hospedagem em site. Ao usar o pixel retornado após a conclusão desse fluxo, os parceiros podem enviar eventos ao Facebook em nome de seus clientes por meio do navegador ou da API de Conversões. Esse fluxo não possui recursos de Catálogo.

Antes de começar

Seu app deve pertencer a um Gerenciador de Negócios que seja uma empresa verificada. Saiba mais sobre como verificar a sua empresa.
Um app do Facebook é obrigatório com o nível de acesso, o recurso e as permissões a seguir:
- Nível de acesso: acesso avançado
- Recurso: Acesso Padrão ao Gerenciamento de Anúncios
- Permissões públicas: ads_management, pages_read_engagement e ads_read
- Permissões privadas: manage_business_extension — Esta é uma permissão privada que exige que o representante do Facebook adicione o seu app à lista de permissões.
- Token de acesso de usuário do sistema: o envio de eventos para a API de Conversões requer um token de acesso. Para gerar um token de acesso em nome do cliente, use o token de acesso retornado via FBE e converta-o em um token de acesso de usuário do sistema ao fazer uma chamada de API adicional.

Configurações obrigatórias

Extras

Campo Tipo Descrição

Campo	Tipo	Descrição
`setup`	setup	Obrigatório A configuração do Facebook do vendedor, como o identificador único (`external_business_id`) ou a moeda do catálogo (`currency`). Consulte detalhes de objetos de configuração.
`business_config`	business_config	Obrigatório Objeto de configuração que a Extensão do Facebook para Empresas usa para configurar o fluxo de trabalho da Extensão do Facebook para Empresas. Consulte detalhes do objeto `business_config`.
`repeat`	booliano	Obrigatório Defina esse valor como `false`.

setup

setup

Obrigatório

A configuração do Facebook do vendedor, como o identificador único (external_business_id) ou a moeda do catálogo (currency). Consulte detalhes de objetos de configuração.

business_config

business_config

Obrigatório

Objeto de configuração que a Extensão do Facebook para Empresas usa para configurar o fluxo de trabalho da Extensão do Facebook para Empresas. Consulte detalhes do objeto business_config.

repeat

booliano

Obrigatório

Defina esse valor como false.

Configuração

Use esse objeto para definir as configurações para a presença do usuário final no Facebook

Campo	Descrição
`external_business_id` string	Obrigatório identificação da empresa única para representar a empresa do seu cliente. Usamos isso como um identificador único. Por exemplo, se a empresa do vendedor se chama "Fubar", "fubar-123" poderá ser o seu `external_business_id`.
`timezone` string	Opcional O fuso horário em que a empresa está localizada. Consulte possíveis valores de fuso horário.
`currency` string	Opcional Código de moeda ISO de três letras da moeda-padrão usada nos itens do catálogo da empresa. Consulte os códigos de moeda compatíveis.
`business_vertical` enumeração	Obrigatório Vertical associado à empresa. Valor: `ECOMMERCE`
`merchant_settings_id` string	Opcional Usado ao fazer a atualização da Extensão do Facebook para Empresas 1.0. Entre em contato com o seu representante do Facebook se estiver migrando da v1 para a v2.
`domain` string	Obrigatório para os canais COMMERCE e COMMERCE_OFFSITE Domínio usado para aprovação manual do Instagram. Por exemplo: `https://exampleshop.partnersite.com`.
`channel` enumeração	Obrigatório Fornece uma forma para o parceiro configurar o fluxo da API de Conversões da FBE. Para o fluxo da API de Conversões, o valor deve ser `CONVERSIONS_API`. `CONVERSIONS_API` — Fluxo que permite aos usuários finais criar ou selecionar objetos do Gerenciador de Negócios, da conta de anúncios e do Pixel da Meta. A criação desses objetos permite que o usuário final envie eventos do próprio site para o Facebook por meio da API de Conversões ou do pixel do navegador.
`business_manager_id` string	Opcional Identificação do Gerenciador de Negócios existente do usuário que um parceiro pode inserir a fim de pré-selecionar para o usuário no fluxo de configuração.
`ad_account_id` string	Opcional Identificação da Conta de anúncios para a conta de anúncios existente do usuário que um parceiro pode inserir a fim de pré-selecionar para o usuário no fluxo de configuração.
`page_id` string	Opcional Identificação da Página para a Página do Facebook existente do usuário que o parceiro pode inserir a fim de pré-selecionar para o usuário no fluxo de configuração.
`ig_profile_id` string	Opcional Identificação do perfil comercial do Instagram existente do usuário que um parceiro pode inserir a fim de pré-selecionar para o usuário no fluxo de configuração.
`pixel_id` string	Opcional Identificação do Pixel existente do usuário que o parceiro pode inserir a fim de pré-selecionar para o usuário no fluxo de configuração.
`catalog_id` string	Opcional ID do Catálogo existente do usuário que o parceiro pode inserir a fim de pré-selecionar para o usuário no fluxo de configuração.

Configuração da empresa

Use este objeto para definir as configurações da empresa para um usuário final. Isso inclui CTAs e mais. Cada campo inclui um "tipo" vinculado às respectivas tabelas abaixo.

Campo	Descrição
`business` Tipo: FBEBusinessPropertiesConfigData	Obrigatório Informações para a empresa do usuário final
`messenger_chat` Tipo: FBEMessengerChatConfigData	Opcional Recursos de bate-papo do Messenger na página do usuário final do Facebook, como `enabled` e `domains`.
`catalog_feed_scheduled` Tipo: FBECatalogFeedConfigData	Opcional Determina se a Extensão do Facebook para Empresas deve usar uma abordagem de feed, que obtém itens do catálogo de uma `feed_url`.
`page_cta` Tipo: FBEPageCtaConfigData	Opcional Botão de chamada para ação (CTA) na página do usuário final, como `cta_button_text`, `cta_button_url`, entre outros.
`ig_cta` Tipo: FBEIGCtaConfigData	Opcional Recursos para o recurso de chamada para ação (CTA) do Instagram, como `enabled`, `cta_button_text`, `cta_button_url` e assim por diante.
`messenger_menu` Tipo: FBEMessengerMenuConfigData	Opcional Recursos para o menu persistente do Messenger, como `cta_button-text` e `cta_button_url`