Envoyer des évènements hors ligne via l’API Conversions

L’API Conversions est la méthode d’intégration recommandée pour envoyer des évènements hors ligne et de boutique physique à Meta qui seront utilisés pour les mesures, l’attribution et le ciblage. Cette page décrit comment envoyer des évènements hors ligne via une intégration directe ou de partenaire de l’API Conversions.

Conditions requises

Ensemble de données

Les évènements hors ligne envoyés via l’API Conversions doivent être associés à un ensemble de données.

Datasets allow advertisers to connect and manage event data from web, app, store and business messaging event sources to the Conversions API. Datasets may show event data from any of these integrations that you choose to set up:

  • Meta Pixel (website events)
  • App Events API (app events, including Facebook SDK for iOS or Android, mobile measurement partners (MMPs))
  • Offline Conversions API (Meta’s legacy API for offline events)
  • Messaging Events API (messaging events)

Datasets enable you to view all customer activities from a single interface. They also allow you to reduce the effort to build and maintain multiple API integrations.

In Events Manager, advertisers have different options to create a dataset depending on their starting point. Or you can create a brand new dataset in Events Manager by linking during offline event set creation or through an existing mobile app or during messaging event set creation information. Note that linking a dataset to an application is required before sending mobile app events to the Conversions API and only one application can be linked to a dataset. See more details and instructions here.

Vous pouvez exécuter un appel GET vers https://graph.facebook.com/v16.0/{ads-pixel-id}/?fields=is_consolidated_container pour détecter si l’ensemble de données de l’annonceur est consolidé, ce qui voudrait dire que des évènements hors ligne peuvent transiter par l’API Conversions.

Autorisations

  • Pour mettre en œuvre une intégration directe en tant qu’annonceur, suivez les instructions de cette page pour connaître les critères à respecter et les autorisations à obtenir.

  • Pour mettre en œuvre une intégration en tant que plateforme partenaire, suivez les instructions de cette page pour connaître les critères à respecter et les autorisations à obtenir.

Configuration

1. Définir les paramètres des évènements hors ligne

Les annonceurs peuvent utiliser cette configuration et consulter les paramètres qui peuvent actuellement être envoyés via l’API Conversions. Pour envoyer des évènements hors ligne et de boutique, les champs suivants peuvent être partagés dans la charge utile :

  • Les annonceurs doivent envoyer physical_store comme action_source pour tous les évènements hors ligne et de boutique. Veuillez noter que ce paramètre est obligatoire pour tous les types d’évènements de serveur. En utilisant l’API Conversions, vous reconnaissez que le paramètre action_source est exact, à votre connaissance.
  • Tous les champs d’évènement de serveur obligatoires pour l’API Conversions doivent être renseignés.
  • Paramètres d’informations clientèle (voir liste des paramètres pour les évènements hors ligne et de boutique ci-dessous)
  • Paramètres de données personnalisés (voir liste des paramètres pour les évènements hors ligne et de boutique ci-dessous)
  • Paramètre facultatif : le paramètre upload_tag est encore pris en charge pour les importations d’évènements hors ligne pour les annonceurs qui utilisent l’ancienne API.

Paramètres d’informations clientèle

Voici la liste des paramètres d’informations clientèle qui sont généralement utilisés pour les évènements hors ligne et de boutique :

Noms des paramètres Paramètre Hachage obligatoire

Adresse(s) e-mail

email

OUI

Numéro(s) de téléphone

phone

OUI

Genre

gen

OUI

Date de naissance

db

OUI

Nom

ln

OUI

Prénom

fn

OUI

Ville

ct

OUI

États des États-Unis

st

OUI

Codes postaux

zip

OUI

Pays

country

OUI

Identifiant publicitaire Apple

madid

OUI

ID de publicité Android

madid

OUI

ID utilisateur tiers

external_id

Fortement recommandé

ID de prospect des publicités à formulaire

lead_id

Ne PAS hacher

Paramètres de données personnalisés

La section suivante contient les paramètres personnalisés couramment utilisés par les évènements hors ligne et de boutique. Vous trouverez la liste complète des champs de données personnalisés acceptés pour l’API Conversions sur cette page.

ParamètreDescription

event_time

type : nombre entier

Obligatoire

Horodatage UNIX de l’évènement de conversion.


Exemple :
'1456870055'


event_name
type : chaîne

Obligatoire

Type d’évènement.


Exemple :
ViewContent, Search, AddToCart, AddToWishlist, InitiateCheckout, AddPaymentInfo, Purchase, Lead, Other


store_data
type : dictionnaire JSON

Facultatif

Stocker les données de localisation concernant l'évènement de conversion.


Exemple :

"store_data":
    {
        "store_page_id": 8576093908, // FBID
        "brand_page_id": 10236898932// FBID
    }

currency
type : chaîne

Obligatoire

Code de devise ISO à trois lettres pour cet évènement de conversion. Obligatoire pour les évènements Purchase.


Exemple :
USD


value
type : double

Obligatoire

Valeur de l’évènement de conversion. Obligatoire pour les évènements Purchase.


Exemple :
16.00


content_type type : chaîne

Facultatif

Toute publicité de catalogue Advantage+content_type valide.


Exemple :
product


contents

type : ensemble JSON

Facultatif. Obligatoire si vous intégrez vos publicités au catalogue.

Obligatoires : id, quantity


Recommandés : price, brand, category

Obligatoire : [ {id: "A", quantity: 1}, {id: "B", quantity: 2}, {id: "C", quantity: 1}]


Recommandé : [ {id: "A", quantity: 1, brand: "Brand_A", category: "", price: 10.0}]


custom_data

type : dictionnaire JSON

Facultatif.

Informations concernant cet évènement de conversion.

Exemple : {category: 'ICECREAM'}


order_id

type : chaîne

Facultatif.

Identifiant unique de chaque transaction ou commande effectuée dans un ensemble d’évènements hors ligne. Par exemple, un ID de reçu pour un établissement de vente au détail.

Exemple : ATN10001, 123456


item_number

type : chaîne

Facultatif.

Identifiant unique permettant de distinguer les évènements dans la même commande ou la même transaction.

Exemple : 1, a



2. Envoyer des évènements

Pour envoyer de nouveaux évènements, envoyez une requête POST à l’API Conversions à partir du chemin suivant : https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}

Lorsque vous publiez dans cette arête, Meta crée des évènements hors ligne et de boutique. Pour en savoir plus, consultez ce document pour développeur.

Découvrez comment les paramètres s’intègrent dans la charge utile globale :

curl -X POST \
  -F 'data=[
       {
  "event_name": "Purchase",
  "event_time": 1674000041,
  "user_data": {
    "em": [
      "309a0a5c3e211326ae75ca18196d301a9bdbd1a882a4d2569511033da23f0abd"
    ],
    "ph": [
      "254aa248acb47dd654ca3ea53f48c2c26d641d23d7e2e93a1ec56258df7674c4",
      "6f4fcb9deaeadc8f9746ae76d97ce1239e98b404efe5da3ee0b7149740f89ad6"
    ]
  },
  "custom_data": {
    "currency": "usd",
    "value": 123.45,
    "contents": [{
      "id": "product123",
      "quantity": 1
    }]
  },
  "action_source": "physical_store"
}
]' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v15.0/<DATASET_ID>/events

Pour une optimisation optimale, nous recommandons d’importer les données en temps réel ou tous les jours afin qu’elles puissent être comparées efficacement aux performances des publicités que vous diffusez.

La valeur du paramètre event_time peut remonter jusqu’à 7 jours avant l’envoi d’un évènement à Meta. Si une valeur event_time dans data remonte à plus de 7 jours, une erreur est renvoyée pour l’ensemble de la requête, et aucun évènement n’est traité. Pour les évènements hors ligne et de boutique avec physical_store comme action_source, vous devez importer les transactions dans les 62 jours suivant la conversion.

Les données que vous importez étant traitées en temps réel, les résultats s’affichent généralement dès que vous avez terminé l’importation. Consultez les recommandations relatives aux données des évènements hors ligne dans les pages d’aide.

3. Configurer la déduplication

Contrairement aux évènements du pixel Meta et de l’API Conversions, les évènements hors ligne peuvent être dédupliqués par rapport à d’autres évènements hors ligne uniquement. Nous prenons en charge deux méthodes de déduplication : en fonction du paramètre order_id ou du paramètre user. La déduplication est réalisée d’après une combinaison de champs (dataset_id, event_time, event_name, item_number) et le champ de clé basé sur la méthode dans la charge utile de l’évènement.

La déduplication par défaut utilise le paramètre order_id ainsi que plusieurs des champs ci-dessus. Si order_id n’est pas présent dans la charge utile, la logique de déduplication basée sur le paramètre user sera utilisée.

Prenons l’exemple de deux commandes avec des paramètres event_time et event_name identiques et ayant le même order_id ou le même ensemble de paramètres d’informations clientèle sans order_id. Dans ce cas, nous considérons qu’il s’agit de doublons et prenons en compte le premier évènement. La méthode de déduplication basée sur le paramètre user ne fonctionne que lorsque les champs de paramètres d’informations clientèle sont identiques dans les deux charges utiles.

La période de déduplication ne peut pas excéder 7 jours.

4. Résoudre les problèmes liés aux évènements

Vous pouvez utiliser l’outil Assistant Charge utile pour générer des données de charge utile :

  • Choisissez physical_store comme origine de l’action, le cas échéant. En utilisant l’API Conversions, vous reconnaissez que le paramètre action_source est exact, à votre connaissance.
  • Indiquez les informations sur les évènements qui seront envoyées à Meta.
  • Une charge utile sera générée pour les évènements, qui pourra être utilisée comme modèle pour votre intégration de l’API Conversions

Utilisez l’outil d’évènements de test du Gestionnaire d’évènements pour effectuer vos tests. Veuillez noter que cet outil ne prend en charge que les évènements Web et d’application.