Implémentation de bout en bout de l’API Conversions

L’API Conversions soutient les efforts des annonceurs qui visent à offrir aux consommateur·ices une transparence et un contrôle appropriés des données, tout en les aidant à fournir des expériences personnelles. Grâce à l’API, vous pouvez partager des données directement à partir de votre serveur, plutôt que de passer par un navigateur.

Avantages de l’intégration

• Visibilité plus loin dans le funnel : l’API Conversions vous permet de partager davantage de données que le pixel Meta. Grâce à l’API, vous pouvez prendre des décisions en tenant compte de plus d’informations, telles que les données CRM, les évènements du bas du funnel (y compris les prospects qualifiés) et les chemins de conversion multisite sur un site Web et dans un emplacement physique.

• Contrôle des données : lorsqu’elle est utilisée via une implémentation uniquement sur serveur (par exemple, sans le pixel Meta), l’API Conversions vous donne un contrôle supplémentaire sur les données que vous partagez. Vous pouvez choisir d’ajouter des insights à vos évènements, en fournissant des données telles que les marges des produits ou un historique, comme les scores de valeur client·e.

• Fiabilité et résilience du signal : le partage des données via l’API Conversions peut être plus fiable que les méthodes basées uniquement sur le navigateur, comme le pixel Meta. L’API est conçue pour être moins sensible à des problèmes tels qu’un plantage du navigateur ou des soucis de connectivité. Les nouvelles restrictions en matière de transmission des données par secteur peuvent limiter l’efficacité des cookies et du suivi du pixel. L’API Conversions vous permet donc de contrôler le partage des signaux qui ne sont plus détectés par le pixel.

Présentation

Vous pouvez procéder à l’intégration de votre API Conversions en deux étapes principales :

• Préparation — Sélectionnez le type d’intégration qui vous convient, définissez les évènements à envoyer, puis examinez les options d’optimisation disponibles.

• Exécution — Découvrez comment implémenter l’API. Pour cette étape, vous pouvez également utiliser une intégration de partenaire.

Voici un aperçu du processus d’intégration complet :

Utilisateur·ices existant·es du pixel

Si vous avez déjà intégré le pixel Meta, vous devez intégrer l’API Conversions comme une extension de l’intégration du pixel, et non comme une connexion complètement distincte.

Consentement général

Si vous avez une logique pour contrôler le consentement en ce qui concerne le partage des données du pixel, utilisez la même logique pour le partage des données via l’API Conversions.

Alternatives

• Si vous souhaitez optimiser vos publicités pour les évènements d’application, utilisez l’API App Events.

Préparation

Choix du type d’intégration

Pour commencer, sélectionnez l’option d’intégration que vous souhaitez utiliser :

Définition des évènements à envoyer

Une fois que vous avez choisi votre approche d’intégration, vous pouvez définir les évènements que vous souhaitez envoyer. Les signaux sont plus utiles lorsqu’ils correspondent aux identifiants des utilisateur·ices de Meta. Il est donc important de réfléchir aux paramètres que vous nous envoyez avec un évènement et à la fréquence à laquelle vous souhaitez les envoyer.

Options des évènements

Envoyez les évènements les plus pertinents pour votre entreprise. Consultez la liste exhaustive des évènements Meta standard et personnalisés.

Paramètres d’évènement

Vous pouvez envoyer plusieurs paramètres pour chaque évènement. Pour en savoir plus sur ces champs, découvrez les paramètres utilisés par l’API Conversions.

Vous pouvez ajouter plusieurs types d’ID à vos évènements, tels que event_id, external_id et order_id. Il est important de connaître la différence entre les paramètres suivants :

Actualisation des données

Nous vous recommandons d’envoyer les évènements en temps réel ou en lots selon un calendrier spécifique via l’API Conversions. L’envoi de vos évènements en temps réel ou dans un délai d’une heure permet de s’assurer qu’ils peuvent être utilisés pour l’attribution et optimisés pour la diffusion des publicités.

L’envoi de vos évènements plus de deux heures après qu’ils se soient produits risque d’entraîner une baisse significative des performances des publicités optimisées pour ces évènements. Les évènements envoyés dans un délai de 24 heures ou plus peuvent connaître des problèmes importants d’attribution et de diffusion optimisée des publicités.

Si vous envoyez des évènements possédant de longues fenêtres de conversion, faites-le le plus près possible du moment où la conversion a été entièrement achevée.

Passez à l’étape suivante après avoir effectué les actions ci-dessous :

• Dressé une liste d’évènements à envoyer.
• Défini les champs que vous souhaitez envoyer avec chaque évènement.
• Déterminé la fréquence d’envoi des évènements.

Types d'optimisation disponibles

L’API Conversions offre les types d’optimisation suivants :

Exécution

Vous pouvez implémenter votre intégration de deux manières :

• Intégration directe — En tant qu’annonceur, vous implémentez directement l’API Conversions.
• Intégration comme plateforme — En tant que partenaire marketing, vous proposez l’API Conversions comme service à votre clientèle.

Intégration directe

Étape 1 : Définir les prérequis

Avant d’utiliser l’API Conversions, configurez les éléments suivants :

Passez à l’étape d’implémentation de l’API dès que vos éléments sont prêts. N’oubliez pas de conserver les ID de vos éléments, car vous en aurez besoin pour vos appels d’API.

Étape 2 : Implémenter l’API

Une fois que vous en avez terminé avec les prérequis, commencez le processus d’implémentation. Consultez systématiquement la documentation pour les développeur·ses lorsque vous travaillez sur l’API Conversions.

Appels tests (facultatifs)

Si c’est la première fois que vous utilisez l’API, commencez par effectuer un appel test. Pour ce faire, vous avez besoin d’une charge utile et d’une méthode pour passer des appels d’API. Une fois l’appel terminé, consultez le Gestionnaire d’évènements pour vérifier que l’appel a fonctionné comme prévu.

{
  "data": [
   {
    "event_name": "Purchase",
    "event_time": 1601673450,
    "user_data": {
      "em": "7b17fb0bd173f625b58636fb796407c22b3d16fc78302d79f0fd30c2fc2fc068",
      "ph": null
     },
    "custom_data": {
      "currency": "USD",
      "value": "142.52"
    }
   }
  ]
}

{
  "events_received": 1,
  "messages": [],
  "fbtrace_id": <FB-TRACE-ID>
}

À la suite de votre premier appel, vérifiez vos évènements dans Gestionnaire d’évènements > Votre pixel > Aperçu.

Passez à l’étape Envoyer et vérifier les évènements après avoir testé vos évènements dans le Gestionnaire d’évènements.

Envoyer et vérifier les évènements

Pour commencer à envoyer des évènements, effectuez une requête POST à l’arête /events de l’API. Joignez une charge utile à votre appel. Si vous avez besoin d’aide pour générer votre charge utile, consultez l’Assistant charge utile. Consultez les ressources suivantes pour obtenir plus d’informations et des exemples de code :

• Utilisation de l’API > Envoyer des requêtes
• Évènements annulés
• Délai d’importation et heure de transaction de l’évènement
• Requêtes groupées
• Hachage

Une fois que vous avez commencé à envoyer des évènements, accédez au Gestionnaire d’évènements et vérifiez que nous avons bien reçu les évènements envoyés. Découvrez comment vérifier vos évènements.

Si votre implémentation est complétée par un pixel de navigateur, passez à l’étape des paramètres de déduplication. Si ce n’est pas le cas, vous avez terminé. Consultez l’assistance si vous avez encore des questions.

Étape 3 : Ajouter des paramètres pour la déduplication

Si vous envoyez des évènements identiques à partir de votre pixel et via l’API Conversions, vous devez configurer la déduplication pour vos évènements envoyés via ces deux canaux. Tout d’abord, consultez la documentation pour les développeur·ses afin de comprendre la logique de la déduplication.

Déduplication basée sur les évènements

Si nous détectons la même combinaison de clés de serveur (event_id, event_name) et la même combinaison de clés de navigateur (eventID, event) envoyées au même ID de pixel dans un délai de 48 heures, nous abandonnons les derniers évènements en double.

Pour assurer la déduplication de vos évènements :

• Pour les évènements correspondants, veillez à ce que les paramètres suivants soient définis sur la même valeur :

  • event_id pour l’évènement de votre serveur et eventID pour l’évènement de votre navigateur
  • event_name pour les évènements de votre serveur et de votre navigateur
• Après avoir envoyé les évènements en double, vérifiez dans le Gestionnaire d’évènements si les bons évènements sont annulés.
• Assurez-vous que chaque évènement unique envoyé à la fois via le pixel et l’API Conversions possède son propre event_id. Cet ID ne doit pas être utilisé pour d’autres évènements.

Alternative à la déduplication basée sur les évènements

Si l’ID d’évènement restera toujours le meilleur moyen de dédupliquer des évènements, son implémentation est assez complexe. Vous pouvez recourir à des solutions alternatives en utilisant les paramètres external_id ou fbp. Si vous avez configuré les paramètres external_id ou fbp pour qu’ils soient transmis à la fois par le navigateur et le serveur, nous dédupliquons automatiquement vos évènements si nous détectons un évènement possédant les mêmes paramètres external_id ou fbp dans un délai de 48 heures.

Étape 4 facultative : Explorer les fonctionnalités du SDK pour les entreprises

Le SDK Meta Business comporte des fonctionnalités avancées conçues spécialement pour les utilisateur·ices de l’API Conversions :

• Requêtes asynchrones : utilisez cette fonctionnalité si vous ne souhaitez pas bloquer l’exécution de votre programme en attendant qu’une requête soit traitée. Avec cette méthode, vous envoyez votre requête et recevez un signal du serveur une fois qu’elle a été traitée. Dans l’attente de la réponse, l’exécution du programme se poursuit.
• Regroupement des lots : tirez parti des requêtes asynchrones pour augmenter le débit en utilisant les ressources de manière plus efficace. Créez des requêtes groupées pour prendre en charge des cas d’utilisation comme les workers de requêtes d’évènements, les tâches cron, et bien plus encore.
• Interface du service HTTP : remplacez le service HTTP par défaut du SDK pour les entreprises et implémentez votre propre service personnalisé avec votre méthode ou bibliothèque préférée.

Intégration en tant que plateforme

Les instructions suivantes s’adressent aux partenaires qui fournissent l’API Conversions en tant que service à des annonceurs.

Étape 1 : Définir les prérequis

Votre application doit présenter les caractéristiques et autorisations suivantes :

• Niveau d’accès : accès avancé
• Fonctionnalité : accès standard au Gestionnaire de publicités.
• Autorisations : ads_management, pages_read_engagement et ads_read.

Étape 2 : Envoyer des évènements au nom de votre clientèle

Suivez tout d’abord les étapes de l’intégration directe et testez votre intégration. Vous pouvez ensuite demander l’autorisation d’envoyer des évènements au nom de votre clientèle. Vous disposez des options d’authentification suivantes :

Extension Meta Business (recommandée)

L’extension Meta Business renvoie toutes les informations nécessaires à l’envoi des évènements au nom de votre client·e selon le processus suivant. L’extension Meta Business fournit un point de terminaison pour récupérer les tokens d’accès de l’utilisateur système créés dans le Business Manager du client ou de la cliente. Ce processus comprend des autorisations pour envoyer automatiquement et de manière sécurisée des évènements de serveur.

Le point de terminaison nécessite un token d’accès utilisateur·ice comme paramètre d’entrée. Si vous utilisez pour la première fois l’extension Meta Business, appelez le point de terminaison pour récupérer le token d’accès de l’utilisateur·ice système une fois que vous avez fini de configurer l’extension. Les utilisateur·ices existant·es doivent demander une nouvelle authentification avant d’appeler le nouveau point de terminaison de l’API.

Token d’accès d’utilisateur système de votre client·e

Demandez à votre client·e de créer manuellement un token d’accès d’utilisateur système via l’API Conversions depuis les paramètres du pixel. Envoyez ensuite les évènements au pixel de l’annonceur avec ce token.

Une personne utilisatrice système ou utilisatrice système admin doit installer l’application qui sera utilisée pour générer le token d’accès. Avec cette configuration, votre application est autorisée à appeler des API au nom de cette personne utilisatrice système ou utilisatrice système admin.

Le client ou la cliente partage son pixel avec le Business Manager de son partenaire

Avec cette option, le client ou la cliente partage son pixel avec son partenaire via les paramètres de Business Manager ou l’API. Vous pouvez ensuite attribuer l’utilisateur système partenaire au pixel du client ou de la cliente et générer un token d’accès pour envoyer les évènements de serveur.

Étape 3 : Attribuer des évènements à votre plateforme

Pour attribuer les évènements de l’API Conversions à votre plateforme, utilisez le champ partner_agent. Cela vous permet de définir votre propre identifiant de plateforme lorsque vous envoyez des évènements au nom d’un·e client·e. Si vous êtes un partenaire géré, convenez avec votre représentant·e Meta d’un identifiant pour votre plateforme. Votre identifiant doit comporter moins de 23 caractères et au moins deux lettres. Envoyez-le ensuite avec chaque évènement de serveur.

Assistance

Pour tous les partenaires

Consultez les informations sur le débogage et les articles des pages d’aide pour les entreprises.

Pour les partenaires gérés

Fournissez les informations suivantes à votre représentant·e Meta, afin qu’il ou elle puisse vous aider à tester les intégrations et à résoudre les problèmes qui se présentent : ID Business Manager, ID d’application et ID du pixel.

Documentation API

• Premiers pas - Tester l’API depuis votre Business Manager
• Utilisation de l’API
• Recommandations - API Conversions
• Configurer l’API Conversions en tant que plateforme
• Évènements Meta standard
• Évènements Meta personnalisés
• Paramètres
• Assistant charge utile
• Options de traitement des données pour l’API Conversions et l’API Conversions hors ligne
• Si vous souhaitez optimiser les évènements d’application, utilisez l’API App Events