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.
Você precisará do seguinte:
page_events
pages_messaging
e não tiver nenhuma violação da política nos últimos 90 dias.ANALYZE
na Página sendo consultadaNo momento, essa API não está disponível para empresas ou clientes sediados na Europa ou no Japão.
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:
Propriedade | Descrição | Valor |
---|---|---|
| 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. |
| Especifica a identificação da página associada ao evento. | Use a identificação da página do Facebook associada ao bot. |
| 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. |
| Especifica se o rastreamento de anúncios está habilitado. | Use |
| Especifica se o rastreamento de anúncios está habilitado no nível do app. | Use |
| Especifica a origem do evento. | Use a string |
| Especifica as entidades de direcionamento referentes ao evento que será registrado. | Use as strings |
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.
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>
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.
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.
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:
/<OBJECT_ID>/insights?fields=actions
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.
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.
O administrador da Página ou do app pode validar a configuração buscando os eventos no Gerenciador de Anúncios.
fb_messenger_bot_stopped
.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.
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.
É 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.