API Conversions

Spécification de la charge utile

Obtenez de meilleurs résultats en intégrant votre CRM avec l’API Conversions de Meta et en utilisant l’objectif d’optimisation Prospects de conversion pour vos publicités à formulaire. Pour l’heure, cette optimisation ne prend en charge que les publicités à formulaire natives (formulaires instantanés) générées sur Facebook ou Instagram.

Ce guide spécifie la charge utile pour les évènements CRM importés dans le cadre de l’optimisation des prospects de conversion uniquement. N’utilisez pas cette spécification pour les évènements sans lien avec cette optimisation.

Pour en savoir plus sur l’utilisation de l’API et accéder à d’autres ressources utiles, consultez la documentation sur l’API Conversions.

Charge utile de l’évènement

Paramètres

NomDescription

lead_id

entier

Obligatoire.
ID généré par Facebook pour chaque prospect. Il s’agit d’un nombre à 15 ou 16 chiffres provenant du champ leadgen_id du Webhook de génération de prospects et inclus dans le paramètre user_data. Consultez la page Comment rechercher l’ID du prospect Meta pour plus d’informations.
Vous devez utiliser les ID de prospect plutôt que les informations clientèle pour la recherche. Utilisez une variable pour transmettre les valeurs d’ID de votre CRM.
Remarque : N’utilisez pas de hachage.

event_name

chaîne

Obligatoire.
Champ de formulaire libre permettant de capturer les étapes utilisées dans votre CRM.
Assurez-vous d’envoyer toutes les étapes telles que mises à jour, y compris la première étape de prospection.
Vos étapes peuvent, par exemple, inclure les types suivants. Lorsqu’un prospect atteint la dernière étape « Converti », toutes les étapes précédentes doivent avoir été préalablement envoyées.

  1. Prospect initial de Facebook
  2. Prospect qualifié par le marketing
  3. Opportunité de ventes
  4. Converti

Utilisez une variable pour transmettre les étapes de votre CRM. Vous pouvez également créer un appel d’API distinct pour chaque étape.

event_time

entier

Obligatoire.
Horodatage Unix exprimé en secondes de la mise à jour de l’étape de prospection par votre CRM.
Utilisez une variable pour transmettre les valeurs de l’horodatage Unix de votre base de données.
Remarque : La valeur du paramètre event_time peut remonter jusqu’à sept jours avant l’envoi d’un évènement à Meta. L’horodatage doit par ailleurs être postérieur à l’heure de génération du prospect. À défaut, l’évènement risque d’être abandonné.

action_source

chaîne

Obligatoire.
Définissez ce paramètre sur la valeur system_generated pour tous les évènements Prospects de conversion.
Pour les intégrations Prospects de conversion, ce paramètre indique où vos conversions sont générées par le système.

lead_event_source

chaîne

Obligatoire.
Définissez ce paramètre sur le nom de l’outil à l’origine des prospects (ex. : Hubspot, SAP, Oracle, Dynamics, CRM interne, etc.), inclus dans le paramètre custom_data.

event_source

chaîne

Obligatoire.
Définissez ce paramètre sur la valeur crm pour tous les évènements Prospects de conversion.
Pour l’intégration des prospects de conversion, ce paramètre indique votre CRM comme étant la source de l’évènement dans le paramètre custom_data.

Exemple

Découvrez ci-dessous le format de la charge utile de l’évènement dans l’appel d’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"
    }
}

En savoir plus