API Conversions pour les évènements d’application

L’API Conversions permet aux annonceurs d’envoyer des évènements Web, d’application, de boutiques physiques et de messages professionnels à Meta via un seul point de terminaison, plutôt que plusieurs sources. Cette consolidation vise à simplifier la pile technologique des annonceurs et à exploiter les ensembles de données pour obtenir une vision plus complète dans le Gestionnaire d’évènements Meta.

La présente documentation explique comment intégrer des évènements d’application dans l’API Conversions.

Conditions requises

1. Ensemble de données

Les évènements d’application envoyés par 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}/is_consolidated_container pour détecter si l’ensemble de données des annonceurs est consolidé, ce qui voudrait dire que des évènements d’application peuvent transiter par l’API Conversions.

2. 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

Envoyer des évènements d’application à l’API Conversions

a. Associer l’ID de l’ensemble de données et l’ID d’application

Dans le Gestionnaire d’évènements, il existe deux moyens d’associer votre application à un ensemble de données :

  • Sélectionnez l’onglet Sources de données, repérez l’onglet Paramètres de votre application et effectuez l’association.
  • Sélectionnez l’onglet Sources de données, dans l’onglet Aperçu de votre application, utilisez le bouton Associer à l’ensemble de données de la section Toutes les activités.

Une fois l’association terminée, l’ensemble de données comprend l’application connectée.



b. Champs obligatoires

Consultez cette page pour connaître les paramètres qui peuvent actuellement être envoyés via l’API Conversions. Pour envoyer des évènements d’application, les champs server_event suivants peuvent être partagés dans la charge utile :

  • Le paramètre action_source doit contenir la valeur app pour les évènements d’application.
  • L’event_id est requis dans les configurations de déduplication.
  • Champs app_data (données de l’application)
  • Champs user_data (données de l’utilisateur·ice)
  • Champs custom_data (données personnalisées)

Champs app_data

ParameterDescription
advertiser_tracking_enabled
boolean

Required for app events

Use this field to specify ATT permission on an iOS 14.5+ device. Set to 0 for disabled or 1 for enabled.

application_tracking_enabled
boolean

Required for app events

A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use 0 for disabled, 1 for enabled. `

extinfo
object

Please use the down arrow to the right to see the list of extinfo values.

Required for app events

Extended device information, such as screen width and height. This parameter is an array and values are separated by commas. When using extinfo, all values are required and must be in the order indexed below. If a value is missing, fill with an empty string as a placeholder.


Note:


  • version must be a2 for Android

  • version must be i2 for iOS

0

string

Required

extinfo version


Example: i2

1

string

app package name


Example: com.facebook.sdk.samples.hellofacebook

2

string

short version (int or string)


Example: 1.0

3

string

long version


Example: 1.0 long

4

string

Required

OS version


Example: 13.4.1

5

string

device model name


Example: iPhone5,1

6

string

locale


Example: En_US

7

string

timezone abbreviation


Example: PDT

8

string

carrier


Example: AT&T

9

string

screen width


Example: 320

10

string

screen height


Example: 568

11

string

screen density


Example: 2

12

string

CPU cores


Example: 2

13

string

external storage size in GB


Example: 13

14

string

free space on external storage in GB


Example: 8

15

string

device timezone


Example: USA/New York

campaign_ids
string

Optional

An encrypted string and non-user metadata appended to the outbound URL (for example, ad_destination_url) or deep link (for App Aggregated Event Manager) when a user clicked on a link from Facebook.


Graph API definition: Parameter passed via the deep link for Mobile App Engagement campaigns.

install_referrer
string

Optional
Third party install referrer, currently available for Android only, see here for more.

installer_package
string

Optional

Used internally by the Android SDKs

url_schemes
array

Optional

Used internally by the iOS and Android SDKs.

vendor_id
string

Optional

Vendor ID.

windows_attribution_id
string

Optional

Attribution token used for Windows 10.

Paramètres d’informations clientèle

ParamètreDescription
anon_id
chaîne

Ne pas hacher.
Votre ID d’installation. Ce champ représente des instances d’installation de l’application uniques.

madid
chaîne

Ne pas hacher.
Votre ID d’annonceur mobile, l’ID publicitaire d’un appareil Android ou l’identifiant publicitaire d’un appareil Apple (IDFA).

Champs custom_data

ParamètreDescription
description
chaîne

Facultatif.
Chaîne, description de l’évènement, personnalisée.

level
chaîne

Facultatif.
Chaîne, niveau d’un jeu, personnalisé.

max_rating_value

Facultatif.
Long, niveau supérieur d’une échelle d’évaluation (ex. : 5 étoiles sur 5), personnalisé.

success
booléen

Facultatif.
1 pour oui, 0 pour non, personnalisé.


En résumé, les évènements d’application partagés avec l’API Conversions nécessiteront les paramètres de données suivants :

  • action_source : la valeur doit être définie sur « app ». (En utilisant l’API Conversions, vous certifiez que le paramètre action_source est, à votre connaissance, exact.)
  • event_id : obligatoire pour les configurations de déduplication. Pour en savoir plus, consultez la section « Configurer la déduplication pour plusieurs canaux ».

Voici un exemple pour extinfo. Assurez-vous que tous les sous-paramètres ci-dessous sont remplis et renseignés selon un ordre séquentiel. Si une valeur est manquante, remplissez-la à l’aide d’une chaîne vide servant d’espace réservé.

Nom du sous-paramètreObligatoireType de donnéesExemple

version extinfo

Oui

chaîne

i2 (versions requises : a2 pour Android, i2 pour iOS)

Nom du package de l’application

Non

chaîne

com.facebook.sdk.samples.hellofacebook

Version courte

Non

chaîne

1.0

Version longue

Non

chaîne

1.0 long

Version du système d’exploitation

Oui

chaîne

13.4.1

Nom du modèle d’appareil

Non

chaîne

iPhone5,1

Paramètre linguistique

Non

chaîne

En_US

Abréviation du fuseau horaire

Non

chaîne

PDT

Opérateur

Non

chaîne

AT&T

Largeur de l’écran

Non

chaîne

320

Hauteur de l’écran

Non

chaîne

568

Densité de l’écran

Non

chaîne

2

Cœurs du processeur

Non

chaîne

2

Taille du stockage externe

Non

chaîne

13

Espace libre dans le stockage externe

Non

chaîne

8

Fuseau horaire de l’appareil

Non

chaîne

USA/New York


c. Configurer la déduplication pour plusieurs canaux

Le mécanisme de déduplication sera nécessaire pour supprimer le trafic d’évènements en double entre l’intégration de l’API Conversions et toutes les autres intégrations existantes impliquant des évènements d’application, notamment le SDK, les MMP et l’API App Events.

Pour les évènements d’application, nous appliquons la même fonctionnalité de déduplication que pour les évènements Web. La logique exploite les champs event_id et event_name pour la déduplication (évènements API Conversions et SDK/API App Events qui portent le même event_id). Le paramètre event_id est un identifiant permettant de distinguer les évènements similaires. Les ID d’évènement inexacts peuvent entraîner une déduplication incorrecte de votre conversion, qui aura un impact sur les rapports de conversion et les performances de campagne.

Vous pouvez consulter la documentation développeur suivante pour mettre en œuvre une configuration de déduplication :

Consultez l’exemple pour savoir comment consigner un évènement personnalisé. Transmettez le nom de l’évènement dans le paramètre AppEvents.Name dans le SDK iOS :

AppEvents.shared.logEvent(.achievedLevel, parameters: [AppEvents.ParameterName(rawValue: "event_id"): "123"])

Pour les évènements associés aux installations de l’application, un mécanisme de déduplication est déjà en place pour veiller à ce qu’une seule installation soit attribuée au cours des 90 derniers jours. Nous conservons le premier évènement et ignorons les suivants, quelle que soit l’origine de l’action qui les a déclenchés. Il est inutile de configurer la déduplication pour les évènements d’application liés aux installations de l’application.

d. Envoyer des évènements

Pour envoyer de nouveaux évènements, effectuez une requête POST vers 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 de nouveaux évènements de serveur d’application. Pour en savoir plus, consultez ce document développeur·se.

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

{
    "data": [
        {
            "event_name": "Purchase",
            "event_time": 1684389752,
            "action_source": "app",
            "user_data": {
                "em": [
                    "30a79640dfd8293d4f4965ec11821f640ca77979ca0a6b365f06372f81a3f602"
                ],
                "ph": [
                    "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b",
                    "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b"
                ],
                "madid": "bbbbbbbbbbbb",
      "anon_id": "cccccccc"
            },
            "custom_data": {
                "currency": "USD",
                "value": "142.52"
            },
            "app_data": {
                "advertiser_tracking_enabled": "True",
                "application_tracking_enabled": "True",
                "campaign_ids": "aaaaaaaaa",
                "extinfo": [
                    "a2",
                    "com.some.app",
                    "771",
                    "Version 7.7.1",
                    "10.1.1",
                    "OnePlus6",
                    "en_US",
                    "GMT-1",
                    "TMobile",
                    "1920",
                    "1080",
                    "2.00",
                    "2",
                    "128",
                    "8",
                    "USA/New York"
                ]
            }
        }
    ]
}

Dépannage

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

  • Choisissez app comme origine de l’action, le cas échéant
  • 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 de test des évènements du Gestionnaire d’évènements pour effectuer vos tests.