Como enviar eventos para o Pixel a partir do bot

Para transferir eventos do fluxo de trabalho do bot, você precisa ter uma conta comercial. Você pode se registrar aqui.

Como criar um novo pixel

Escolha API de Conversões.

Atenção! Se a seguinte janela abrir durante a configuração da API de Conversões, é melhor sair das configurações e começar novamente.

Se a seguinte janela abrir durante a configuração da API de Conversões, é melhor sair das configurações e começar novamente.

Escolha o Pixel que você precisa.

Gere um token de acesso e guarde-o em um local seguro.

Como transferir eventos para o Facebook

Para transferir eventos para o Facebook, você precisa ter seu próprio domínio configurado na mini-landing. Ele deve ser aprovado no Facebook, e Salvar valores de cookies em variáveis do cliente deve estar ativado para o Facebook nas configurações da mini-landing:

Agora, haverá uma variável _fbp preenchida automaticamente no cartão do cliente que veio da mini-landing. Esta variável pode ser transferida para o Pixel com o evento.

Você precisa configurar as seguintes opções no bloco através do qual deseja transferir o evento:

URL da função:

https://store.mavibot.ai/function/fb_pixel

Exemplo de parâmetros:

{
  "pixel_id": "#{pixel_id}",
  "access_token": "#{access_token}",
  "event_name": "Entrou no bot",
  "event_source_url": "https://my_best_site.com",
  "action_source": "chat",
  "fbp": "#{_fbp}",
  "fbc": "#{_fbc}"
}

Parâmetros obrigatórios

pixel_id — ID do pixel.

access_token — o token para acessar a API.

event_name — o nome do evento. Você pode usar nomes padrão como Lead, PageView, Purchase, e assim por diante (veja mais aqui), bem como seus próprios nomes, como Entrou no bot.

event_source_url — o domínio aprovado no Facebook.

fbp — o ID do navegador do cliente.

Parâmetros opcionais

action_source — (other por padrão) este campo permite especificar onde exatamente a conversão ocorreu. Informações sobre onde os eventos aconteceram ajudam a garantir que seus anúncios sejam mostrados para o público certo.

Você pode definir os seguintes valores no campo action_source:

Valor Descrição
email A conversão ocorreu por e-mail
website A conversão ocorreu em um site
phone_call A conversão ocorreu por telefone
chat A conversão ocorreu por mensageiro, SMS ou chat online
physical_store A conversão ocorreu em uma loja física
system_generated A conversão aconteceu automaticamente, ou seja, como resultado de uma renovação de assinatura mensal
business_messaging A conversão ocorreu em uma conversa após o cliente clicar em um anúncio Click-to-WhatsApp
other A conversão aconteceu de outra forma

Como testar eventos

Para testar eventos, adicione o parâmetro test_event_code com o texto armazenado na aba Mensagens de teste ao corpo da solicitação.

{
  "pixel_id": "#{pixel_id}",
  "access_token": "#{access_token}",
  "event_name": "Entrou no bot",
  "event_source_url": "https://my_best_site.com",
  "fbp": "#{_fbp}",
  "fbc": "#{_fbc}",
  "test_event_code": "TEST11421"
}

Atenção! Não se esqueça de excluir o parâmetro test_event_code da solicitação ao lançar a versão de produção.

Parâmetros opcionais adicionais

fn — primeiro nome.

ln — sobrenome.

email — o e-mail do cliente.

phone — o número de telefone do cliente.

fbc — ID do clique.

gender — o gênero do cliente (f — feminino, m — masculino).

country — país.

state — estado.

city — cidade.

index — o índice postal do cliente (código ZIP).

external_id — qualquer ID único do cliente, por exemplo, ID do usuário ou ID de arquivos de cookies de terceiros.

client_ip_address — o endereço IP do cliente.

client_user_agent — user agent do navegador do cliente.

Você também pode transferir seus próprios parâmetros para o Pixel. Para fazer isso, adicione o parâmetro opcional my_params e especifique seus próprios campos nele.

Exemplo:

{
  "my_params": {
    "value1": "Olá",
    "val2": "Oi"
  }
}

Exemplo completo

{
  "pixel_id": "#{pixel_id}",
  "access_token": "#{access_token}",
  "event_name": "Entrou no bot",
  "event_source_url": "https://my_best_site.com",
  "email": "[email protected]",
  "phone": "1234567890",
  "currency": "USD",
  "value": "142.52",
  "test_event_code": "TEST11421",
  "external_id": "#{client_id}",
  "fn": "#{name}",
  "gender": "m",
  "post_index": "12345",
  "my_params": {
    "value1": "Olá",
    "val2": "Oi"
  }
}

Atenção! Não se esqueça de excluir o parâmetro test_event_code da solicitação ao lançar a versão de produção.

Como adicionar uma conta promocional

Primeiro, você precisa abrir o acesso à sua conta.

Salve e vá para a aba Objetos Relacionados → Adicionar Objetos.

Em seguida, adicione sua conta promocional.

Conversões de anúncios Click-to-WhatsApp

Uma adição à documentação para a função fb_pixel_event().

A Meta* marca cada clique de um anúncio Click-to-WhatsApp com um identificador de clique ctwa_clid. Ele é recebido junto com a primeira mensagem do cliente no WhatsApp e é usado para atribuir uma conversão da conversa a um anúncio específico — semelhante a como os eventos de pixel são atribuídos a um clique no site.

Assinatura

fb_pixel_event(
    event_name,
    pixel_id,
    access_token,
    event_source_url,
    action_source,
    fbc,
    test_event_code,
    data,
    ctwa_clid,
    messaging_channel
)

Novos parâmetros

Parâmetro Descrição
ctwa_clid Identificador de clique para um anúncio Click-to-WhatsApp. Se este parâmetro não for fornecido, a variável de cliente ctwa_clid, que é salva automaticamente pelo bot, é usada. Opcional.
messaging_channel O canal de mensagens onde a conversão ocorreu. O padrão é whatsapp. Opcional.

Novo valor para action_source

O seguinte valor está disponível para action_source:

Valor Descrição
business_messaging A conversão ocorreu em uma conversa após o cliente clicar em um anúncio Click-to-WhatsApp.

Um evento é enviado como uma conversão de mensagens se pelo menos uma das seguintes condições for atendida:

  • action_source="business_messaging" é fornecido;
  • ctwa_clid é fornecido;
  • messaging_channel é fornecido.

Neste caso, a Meta* recebe a combinação action_source + messaging_channel + ctwa_clid. Sem essa combinação, o clique no anúncio não será atribuído à conversão.

O valor website não deve ser usado para conversões de mensagens: o evento chegará ao pixel, mas não será atribuído ao anúncio.

Variáveis do cliente

Quando um cliente envia uma mensagem no WhatsApp após clicar em um anúncio, o bot salva os dados do clique nas variáveis do cliente. Você não precisa preencher essas variáveis manualmente.

Variável Descrição
ctwa_clid Identificador de clique. Adicionado automaticamente ao evento.
ctwa_clid_time Hora em que o identificador foi recebido, no formato de tempo Unix. Pode ser usado para determinar quanto tempo se passou desde o clique.
wa_ads_data Dados do anúncio em formato JSON: URL do anúncio, ID do anúncio (source_id), título, descrição, tipo de criativo e URL do criativo.

O identificador de clique é automaticamente obtido da variável do cliente, então você não precisa passá-lo explicitamente para a função.

O número de telefone do cliente é adicionado automaticamente ao evento se não for fornecido em data.

O parâmetro event_source_url não é usado para conversões de mensagens.

Limitações

O identificador de clique é recebido apenas com a primeira mensagem do cliente após ele clicar no botão do anúncio. Ele não é incluído em mensagens subsequentes. Portanto, o evento pode ser enviado a qualquer momento durante a conversa, mas apenas se a primeira mensagem tiver origem no anúncio.

A Meta fornece ctwa_clid para cliques nos aplicativos do Facebook e Instagram no Android e iOS.

O identificador não é fornecido quando o cliente clica de um navegador ou clica em uma postagem regular em vez do botão do anúncio. Conversões de tais interações não podem ser atribuídas ao anúncio.

Se o cliente clicar em outro anúncio mais tarde, as variáveis são sobrescritas. A conversão é atribuída ao anúncio mais recente de onde o cliente veio.

Se o identificador de clique estiver ausente tanto nos parâmetros da função quanto nas variáveis do cliente, a função retorna o seguinte erro e o evento não é enviado:

Nenhuma variável ctwa_clid nas variáveis do cliente