API de Conversões

Especificação de carga

Integrar o CRM à API de Conversões da Meta e usar a meta de otimização dos anúncios de cadastro com os cadastros de conversão são ações que podem gerar resultados melhores. No momento, a otimização é compatível apenas com anúncios de cadastro nativos (formulários instantâneos) gerados no Facebook ou no Instagram.

Este guia fornece a especificação de carga para eventos de CRM carregados apenas para a otimização de cadastros de conversão. Não use esta especificação para eventos não relacionados com essa otimização.

Confira a documentação da API de Conversões para mais informações sobre como começar a usar a API e outros recursos úteis.

Carga do evento

Parâmetros

NomeDescrição

lead_id

inteiro

Obrigatório.
O ID gerado pelo Facebook para cada cadastro. É um número de 15 ou 16 dígitos obtido do campo leadgen_id no Webhook de geração de cadastros e incluído sob o parâmetro user_data. Consulte Como encontrar o ID de cadastro da Meta para obter mais informações.
É obrigatório usar IDs de cadastros em vez de informações do cliente para fazer a correspondência. Use uma variável para passar os valores de ID do seu CRM.
Nota: não converta em hashes.

event_name

string

Obrigatório.
Campo de forma livre para capturar os estágios que você usa dentro do seu CRM.
Certifique-se de enviar todos os estágios, incluindo o estágio inicial de cadastro.
Por exemplo, seus estágios podem incluir os seguintes tipos. Se um cadastro chega ao estágio final "Convertido", então todos os estágios anteriores já devem ter sido enviados.

  1. Cadastro inicial do Facebook
  2. Cadastro qualificado de marketing
  3. Oportunidade de vendas
  4. Convertido

Use uma variável para passar os estágios do seu CRM. Como alternativa, é possível criar uma chamada de API separada para cada estágio.

event_time

inteiro

Obrigatório.
Um carimbo de data e hora do Unix em segundos indicando quando o evento de atualização do estágio de cadastro foi atualizado pelo CRM.
Use uma variável para passar os valores de data e hora do Unix do banco de dados.
Nota: o valor do parâmetro event_time pode ser até 7 dias antes de enviar um evento para a Meta. O registro de data e hora também deve ocorrer após o tempo de geração de cadastro ou, caso contrário, o evento pode ser descartado.

action_source

string

Obrigatório.
Defina este parâmetro para o valor system_generated para todos os eventos de cadastros de conversão.
Para integrações de cadastros de conversão, isso especifica onde suas conversões são geradas pelo sistema.

lead_event_source

string

Obrigatório.
Defina este parâmetro para o nome da ferramenta de onde os cadastros estão vindo (ex.: Hubspot, SAP, Oracle, Dynamics, CRM interna, etc.), incluído sob o parâmetro custom_data.

event_source

string

Obrigatório.
Defina este parâmetro para o valor crm para todos os eventos de cadastros de conversão.
Para integração de cadastros de conversão, isso especifica a fonte do evento como o CRM sob o parâmetro custom_data.

Exemplo

Este exemplo ilustra o formato da carga do evento enviado na chamada de API.

{
    "event_name": "my lead stage",
    "event_time": 1617693833,
    "user_data": {
        "lead_id": 1234567890123456
    },
    "action_source": "system_generated",
    "custom_data": {
        "lead_event_source": "Salesforce",
        "event_source": "crm"
    }
}

Saiba mais