Como registrar eventos com a API de Eventos para mensagens com empresas

Descontinuação da API de Eventos de Mensagens

  • A API de Eventos de Mensagens ficará obsoleta em setembro de 2025. Para ajudar você a se preparar, encerraremos a compatibilidade da API de Eventos de Mensagens com qualquer versão futura da Graph API, começando com a versão 21.0, a partir de 24 de setembro de 2024.
  • Os parceiros que optarem por não atualizar para a Graph API mais recente ainda poderão acessar a API de Eventos de Mensagens chamando a versão 20.0 ou anterior da API até a descontinuação oficial do produto em setembro de 2025.
  • Para os parceiros que não atualizarem a Graph API, recomendamos usar a API de Conversões para novas integrações. Saiba mais sobre a API de Conversões.

Este guia descreve como registrar eventos de um app e de uma Página do Facebook para analisar a interação dos usuários com a experiência do Messenger.

Antes de começar

Você precisará do seguinte:

  • A permissão page_events
    • O acesso avançado será concedido automaticamente para essa permissão quando o app enviado para análise já tiver recebido o acesso avançado para pages_messaging e não tiver nenhuma violação da política nos últimos 90 dias.
  • Um token de acesso à Página solicitado pela pessoa que realizará a tarefa ANALYZE na Página sendo consultada

Limitações

No momento, essa API não está disponível para empresas ou clientes sediados na Europa ou no Japão.

Política e termos

Como registrar eventos

Os eventos são registrados quando uma solicitação POST é enviada à borda page_activities do app:

https://graph.facebook.com/

Exemplo de solicitação:

curl -X POST -H "Content-Type: application/json" -d '{
  "custom_events": [
    {
      "_eventName": "fb_mobile_purchase",
      "_valueToSum": 57.23,
      "fb_currency": "USD"
    }
  ],
  "advertiser_tracking_enabled": 1,
  "application_tracking_enabled": 1,
  "page_id": <PAGE_ID>,
  "page_scoped_user_id": <PSID>,
  "logging_source": "messenger_bot",
  "logging_target": "page"
}' https://graph.facebook.com/v21.0/<APP_ID>/page_activities?access_token=<PAGE_ACCESS_TOKEN>

Recomendamos usar eventos-padrão no campo _eventName. Apenas eventos-padrão são relatados no Gerenciador de Anúncios e, quando disponíveis, podem ser usados para direcionamento e otimização de anúncios.

Por exemplo, para registrar eventos de compra para atribuição no Gerenciador de Anúncios, use o nome de evento fb_mobile_purchase.

Consulte o guia API de Eventos do App (seção App Event Schema) para ver a lista completa de parâmetros e nomes de eventos-padrão.

A tabela a seguir descreve as propriedades e os valores a serem fornecidos ao ponto de extremidade para registrar eventos do Messenger:

PropriedadeDescriçãoValor

custom_events

Matriz de eventos que você deseja registrar. Consulte o guia API de Eventos do App para ver a lista de eventos-padrão e parâmetros aplicáveis. Também é possível usar os eventos do seu app. É possível especificar vários eventos na matriz.

Use uma matriz codificada em JSON para especificar os detalhes do evento personalizado.

page_id

Especifica a identificação da página associada ao evento.

Use a identificação da página do Facebook associada ao bot.

page_scoped_user_id

Especifica o número de identificação do usuário no escopo da página associado ao bot do Messenger que registrou o evento.

Use o número de identificação do usuário no escopo da página fornecido ao seu webhook.

advertiser_tracking_enabled

Especifica se o rastreamento de anúncios está habilitado.

Use 0 para desabilitar e 1 para habilitar o rastreamento.

application_tracking_enabled

Especifica se o rastreamento de anúncios está habilitado no nível do app.

Use 0 para desabilitar e 1 para habilitar o rastreamento.

logging_source

Especifica a origem do evento.

Use a string messenger_bot para indicar que o evento tem origem em um bot do Messenger.

logging_target

Especifica as entidades de direcionamento referentes ao evento que será registrado.

Use as strings app, page ou app_and_page para controlar qual entidade receberá o evento. Para mais detalhes, consulte as Perguntas frequentes sobre eventos do app.

Geração de relatórios sobre leads usando a API de Evento de Mensagem

Agora, os apps podem começar a gerar relatórios sobre envios de lead em conversas. O evento lead_submitted permite que apps automatizem a geração de relatórios sobre conversas que sejam consideradas um lead com interesse em vendas (por exemplo, o usuário compartilhou as informações de contato dele e pediu para ser contatado sobre a venda).

O evento é usado principalmente para distinguir usuários específicos como possíveis leads, o que ajuda as empresas a priorizar as conversas deles. Por exemplo, uma empresa pode configurar um fluxo automatizado que qualifique um usuário como um possível lead. Assim, esse evento será disparado quando o usuário realizar tal fluxo, sinalizando-o para um agente ao vivo como uma conversa de alto potencial.

No momento, esse recurso está disponível em versão beta pública, e os relatórios no Gerenciador de Anúncios estão integrados. Portanto, os dados de leads serão relatados na interface do usuário do Gerenciador de Anúncios.

Exemplo de chamada de API para relatar evento de lead ocorrendo em uma conversa:

curl -X POST -H "Content-Type: application/json" -d '{
  "custom_events": [
    {
      "_eventName": "lead_submitted"
    }
  ],
  "advertiser_tracking_enabled": 1,
  "application_tracking_enabled": 1,
  "page_id": <PAGE_ID>,
  "page_scoped_user_id": <PSID>,
  "logging_source": "messenger_bot",
  "logging_target": "page"
}' https://graph.facebook.com/v21.0/<APP_ID>/page_activities?access_token=<PAGE_ACCESS_TOKEN>

Geração de relatórios sobre leads usando a API de Insights de Anúncios

O evento de lead relatado pode ser visualizado usando a API de Insights sobre Anúncios. Com essa API, é possível criar um painel de análise avançada para ajudar a visualizar o lead atribuído a campanhas de CTX.

Pré-requisitos

Antes de usar a API, verifique se o app passou pelo processo de análise do app para a permissão ads_read e obtenha acesso avançado.

Execução

Uma amostra de chamada de insight no nível de campanha de anúncios tem esta aparência:

curl -G \
-d "date_preset=last_7d" \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<AD_CAMPAIGN_ID>/insights"
    

É possível fazer chamadas da API de Insight nos níveis de conta de anúncios, campanha e conjunto de anúncios, dependendo do nível de detalhamento desejado.

Esta é a chamada para obter o lead:

  • Leads (atribuídos)
    • /<OBJECT_ID>/insights?fields=actions
    • No resultado, action_type=onsite_converstion.lead_grouped

Para uma definição detalhada dos tipos de ação acima, consulte a referência sobre estatísticas de ação de anúncios.

Boas práticas para classificar leads

  1. O anunciante está em uma das verticais clássicas de geração de leads (setor automotivo, serviços profissionais, serviços financeiros, B2B, educação e saúde).
  2. O anunciante solicita informações de contato, como número de celular ou endereço de email, e o usuário as fornece.
  3. As perguntas sobre o número de celular ou endereço de email são antecedidas por algum tipo de qualificação (por exemplo, 1 ou 2 perguntas adicionais).
  4. Se você estiver oferecendo modelos de geração de leads no seu app, adicione este sinal ao fim dos fluxos de geração de leads por padrão.

Observação:não recomendamos marcar automaticamente cada conversa com um telefone ou endereço de email como lead, principalmente em mercados nos quais os números de telefone são compartilhados para fins de pagamento/comércio eletrônico.

Verificar o registro de eventos

O administrador da Página ou do app pode validar a configuração buscando os eventos no Gerenciador de Anúncios.

Considerações especiais sobre as análises do Messenger

  • Um único app pode registrar interações de diversas Páginas. Nesses casos, os eventos de interações com todas as Páginas ficam visíveis no mesmo app.
  • Diversos apps podem estar vinculados a uma única Página. Nesse caso, se a página for bloqueada, todos os apps vinculados receberão um evento fb_messenger_bot_stopped.
  • O número de exclusões de conversa de bot do Messenger pode ser maior que o número de novas atividades do usuário. As exclusões de conversa de bot do Messenger se referem ao número de vezes que um usuário excluiu uma conversa. A Página pode iniciar mais conversas depois que o usuário excluir uma conversa. As conversas adicionais podem ser excluídas por usuários, o que aumenta o número de exclusões de conversas de bot do Messenger.

Uso para fornecedores da plataforma

Como registrar o direcionamento

As plataformas que permitem a criação de experiências do Messenger por meio de interfaces visuais em geral usam um app para alimentar todas as páginas conectadas. Para permitir que os clientes vejam os próprios eventos, é necessário registrá-los nas Páginas definindo logging_target como page ou app_and_page.

Interface de usuário

No contexto de um editor visual, é possível oferecer um bloco arrastável que permita às pessoas escolher um evento e definir parâmetros adicionais. Com isso, os administradores da Página conseguem mapear o fluxo do Messenger com eventos adequados. Idealmente, os usuários poderiam selecionar o nome de evento-padrão de uma lista suspensa, já que apenas esse tipo de evento é relatado no Gerenciador de Anúncios e, quando disponível, pode ser usado para direcionamento e otimização de anúncios. Caso nenhum nome de evento-padrão esteja alinhado com a ação do usuário e o relatório de anúncios não seja necessário, recomendamos oferecer um campo em formato livre para que os usuários insiram parâmetros e um nome de evento personalizado.

Permissões

É obrigatório obter a permissão page_events durante o fluxo de Login do Facebook no seu app. É preciso adicioná-la ao escopo da permissão necessária do botão Entrar, à chamada do SDK do Facebook para JavaScript ou ao seu fluxo de login criado manualmente, conforme descrito neste guia.

Recursos adicionais