API de conversiones

Especificación de la carga útil

Integrar el sistema CRM con la API de conversiones de Meta y usar el objetivo de optimización para la conversión de clientes potenciales ofrece resultados de mejor calidad. En estos momentos, esta optimización solo admite anuncios para clientes potenciales nativos (formularios instantáneos) que se generan en Facebook o Instagram.

Esta guía proporciona la especificación de carga de los eventos del CRM que se subieron solo con el fin de optimizar los clientes potenciales de conversión. No uses esta especificación si se trata de eventos que no estén relacionados con esta optimización.

Consulta la documentación sobre la API de conversiones para obtener más información sobre cómo empezar a usar la API y otros recursos útiles.

Carga de evento

Parámetros

NombreDescripción

lead_id

entero

Obligatorio
El identificador que genera Facebook para cada cliente potencial. Es un número de 15 o 16 dígitos que se obtiene del campo leadgen_id del webhook de generación de clientes potenciales y se incluye en el parámetro user_data. Consulta Encontrar el ID del cliente potencial para obtener más información.
Para generar coincidencias, es obligatorio usar identificadores de clientes potenciales, no información de los clientes. Usa una variable para pasar los valores de identificadores de tu CRM.
Nota: No utilices el cifrado.

event_name

cadena

Obligatorio.
Campo sin formato para capturar las etapas que usas en el CRM.
Asegúrate de enviar todas las etapas, porque se actualizaron, incluso la etapa inicial de clientes potenciales.
Por ejemplo, es posible que tus etapas incluyan los siguientes tipos. Si un cliente potencial llega a la etapa "Convertido", es necesario que ya se hayan enviado todas las etapas anteriores.

  1. Cliente inicial de Facebook
  2. Cliente potencial calificado en marketing
  3. Oportunidad de venta
  4. Convertido

Usa una variable para pasarlas en las etapas de tu CRM. De manera alternativa, puedes realizar una llamada a la API separada por cada etapa.

event_time

entero

Obligatorio.
Una marca de tiempo Unix en segundos que indica cuándo tu CRM actualiza el evento de actualización de la etapa de cliente potencial.
Usa una variable para pasar los valores de la marca de tiempo Unix de tu base de datos.
Nota: El valor del parámetro event_time puede ser de hasta 7 días antes de enviar un evento a Meta. Además, la marca de tiempo debe ocurrir después de la hora de generación del cliente potencial, de lo contrario, el evento podría ser descartado.

action_source

cadena

Obligatorio.
Configura este parámetro al valor system_generated para todos los eventos de conversión de clientes potenciales.
En el caso de las integraciones de clientes potenciales de conversión, esto especifica dónde se generan las conversiones del sistema.

lead_event_source

cadena

Obligatorio.
Configura este parámetro con el nombre de la herramienta de la que provienen los clientes potenciales (por ejemplo, Hubspot, SAP, Oracle, Dynamics, CRM propio, etc. ), que se incluye en el parámetro custom_data.

event_source

cadena

Obligatorio.
Configura este parámetro en el valor crm para todos los eventos de conversiones de clientes potenciales.
En el caso de la integración de clientes potenciales de conversión, esto especifica el origen del evento como tu CRM en el parámetro custom_data.

Ejemplo:

El siguiente ejemplo brinda información sobre el formato de la carga del evento que se envía en la llamada a la 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"
    }
}

Más información