API Setup Quality

Cette API est en phase bêta. Pour y accéder, veuillez contacter votre représentant·e Meta.

Les annonceurs qui partagent des évènements de serveur avec l’API Conversions peuvent voir la qualité de correspondance des évènements dans le Gestionnaire d’évènements. Cependant, cela ne fonctionne que sur une base individuelle et il est difficile de l'adapter dans les cas où un fournisseur de technologies partenaire, une agence partenaire ou un annonceur gère des centaines, voire des milliers de pixels Meta pour leur entreprise. L’API Setup Quality peut aider à résoudre ce problème en consolidant les indicateurs de qualité de configuration par programmation à l'échelle.

À propos de la qualité de correspondance des évènements

Qualité de correspondance des évènements

La qualité de correspondance des évènements (EMQ) est un score (sur 10) qui indique l'efficacité des informations clientèle envoyées depuis votre serveur pour faire correspondre les instances d'évènement avec un compte Facebook. Une qualité élevée de correspondance des évènements peut améliorer l’attribution et la performance des publicités. Notez que cet indicateur est en cours de développement.

Méthode de calcul

La qualité de correspondance des évènements est calculée en examinant les paramètres d'informations clientèle provenant de votre serveur via une intégration de l'API Conversions, la qualité des informations reçues et le pourcentage d'instances d'évènement qui correspondent à un compte Meta.

Utilisation

La qualité de correspondance des évènements est utilisée pour évaluer si vous envoyez via l’API Conversions les bonnes informations clientèle pour faire correspondre vos évènements avec un compte Meta, et si vous avez configuré correctement vos paramètres d'informations clientèle. Les paramètres d'informations clientèle permettent de faire correspondre vos évènements avec un compte Meta afin que vous puissiez attribuer les conversions à vos publicités et les diffuser auprès des personnes les plus susceptibles d’effectuer une conversion.

La qualité de correspondance des évènements est calculée en temps réel. Pour en savoir plus sur l’EMQ, consultez nos recommandations.

La qualité de correspondance des évènements n’est actuellement disponible que pour les évènements Web. Pour d'autres types d'évènements tels que les évènements hors ligne et en magasin physique, les évènements d'application, les prospects de conversion ou toute intégration en phase alpha ou bêta, contactez votre représentant·e Meta pour obtenir des conseils sur l'amélioration de la qualité des correspondances.

Cas d’utilisation courants

Les partenaires et les agences peuvent utiliser l'API Setup Quality pour fournir un tableau de bord et des statistiques de qualité, tout en aidant leurs annonceurs à améliorer et optimiser leurs intégrations. Les partenaires peuvent également utiliser cette intégration pour surveiller la stabilité de l’intégration de leur API Conversions. Les annonceurs peuvent utiliser ce point de terminaison pour regrouper les données de qualité de configuration à intégrer dans leur surveillance.

Authentification

Authentification des annonceurs via Business Manager

Dans Business Manager, allez dans la section Utilisateurs et sélectionnez l'onglet Utilisateur système. Cliquez sur l’utilisateur·ice système que vous utilisez pour l’API Conversions.
Accédez à la boîte de dialogue Affecter des ressources et choisissez Pixels. Sélectionnez ensuite les pixels pour lesquels vous souhaitez envoyer des évènements au nom de votre client·e.
Pour chaque pixel, sélectionnez l’autorisation Manage Pixel (Gérer le pixel), puis cliquez sur Enregistrer les modifications.
Revenez à la page d’informations de l’utilisateur·ice système. Vérifiez que les pixels sélectionnés apparaissent.
Pour générer le token d’accès, suivez ces instructions.

Authentification de la plateforme partenaire

Vous devez d’abord demander l’autorisation d’envoyer des évènements au nom de votre clientèle. Vous disposez des options d’authentification suivantes :

Facebook Login for Business (recommandé)

Facebook Login for Business est la solution d'authentification et d'autorisation préférée des fournisseurs de technologies et des développeurs d'applications professionnelles qui ont besoin d'accéder aux éléments de leur clientèle. Cet outil vous permet de spécifier le type de token d’accès, les types d’éléments et les autorisations dont votre application a besoin, puis de les enregistrer dans un ensemble (configuration). Vous pouvez ensuite présenter cet ensemble à votre clientèle professionnelle qui peut alors terminer le processus et autoriser l’accès de votre application à ses éléments professionnels.

Extension Meta Business (recommandé)

Avec cette option, l’Extension Meta Business (MBE) renvoie toutes les informations nécessaires pour envoyer des évènements au nom de votre client·e. MBE fournit un point de terminaison pour récupérer les tokens d’accès d’utilisateur·ice système créés dans le Business Manager de votre client·e. Ce processus comprend des autorisations pour envoyer automatiquement et de manière sécurisée des évènements de serveur. MBE est actuellement en phase bêta, veuillez contacter votre représentant·e Meta pour y accéder.

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

Partage d’un pixel Meta avec le Business Manager du partenaire par le ou la client·e

Avec cette option, le ou la client·e partage son pixel Meta avec le partenaire depuis les paramètres Business Manager ou via l’API. Ensuite, le partenaire peut affecter l’utilisateur·ice système du partenaire au pixel de votre client·e et générer un token d’accès pour envoyer des évènements de serveur.

Récupération des informations sur la qualité de configuration du pixel

Vous pouvez surveiller le score de qualité de correspondance des évènements par évènement, ainsi que les clés de correspondance envoyées, à l'aide du point de terminaison, des paramètres et des champs de l'API suivants :

Point de terminaison

https://graph.facebook.com/v20.0/<pixel_id>/setup_quality

Paramètres

Paramètre Description

Paramètre	Description
`agent_name` chaîne	Facultatif. La valeur normalisée du champ partner_agent est utilisée pour filtrer uniquement les évènements envoyés avec le paramètre partner_agent dans une requête POST /{pixel_id}/events (voir les recommandations d’attribution de vos évènements ici et ici). Par exemple, si votre valeur partner_agent est `[partner_name]_[majorversion]_[minorVersion]`, votre valeur de chaîne d’agent normalisée sera `partner_name` en minuscules. `agent_name` 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/une agence géré(e), convenez avec votre représentant·e Meta d’un identifiant pour votre plateforme. Si vous êtes un annonceur, la plupart du temps, vous n’avez pas besoin de vous préoccuper de l'attribution `agent_name`. Si vous ne fournissez pas de `agent_name`, tous les évènements, qu'ils aient été envoyés ou non par un agent, seront inclus dans le calcul de l’EMQ.

agent_name

chaîne

Facultatif.
La valeur normalisée du champ partner_agent est utilisée pour filtrer uniquement les évènements envoyés avec le paramètre partner_agent dans une requête POST /{pixel_id}/events (voir les recommandations d’attribution de vos évènements ici et ici).

Par exemple, si votre valeur partner_agent est [partner_name]_[majorversion]_[minorVersion], votre valeur de chaîne d’agent normalisée sera partner_name en minuscules.

agent_name 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/une agence géré(e), convenez avec votre représentant·e Meta d’un identifiant pour votre plateforme.

Si vous êtes un annonceur, la plupart du temps, vous n’avez pas besoin de vous préoccuper de l'attribution agent_name.

Si vous ne fournissez pas de agent_name, tous les évènements, qu'ils aient été envoyés ou non par un agent, seront inclus dans le calcul de l’EMQ.

Champs

Champ	Description
`event_name` chaîne	Nom d’un évènement standard ou personnalisé.
`event_match_quality` AdsPixelCAPIEMQ	La qualité de correspondance des évènements indique dans quelle mesure les paramètres d’informations clientèle envoyés depuis votre serveur sont efficaces pour faire correspondre des instances d'évènements avec un compte Facebook.

Exemple

Explorateur de l’API Graph

GET/v20.0/<PIXEL_ID>/setup_quality?fields=event_match_quality,event_name&agent_name=<AGENT_NAME>&access_token=<ACCESS_TOKEN>

cURL

curl -X GET -G \
  -d 'fields="event_match_quality,event_name"' \
  -d 'agent_name="&lt;AGENT_NAME&gt;"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<LATEST_VERSION>/<PIXEL_ID>/setup_quality

Réponse de l’API

{
  "data": [
    {
      "event_match_quality": {
        "composite_score": 6.2,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "ip_address",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          }
        ]      
      },
      "event_name": "pLTVPurchase"
    },
    {
      "event_match_quality": {
        "composite_score": 7.2,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "ip_address",
            "coverage": {
              "percentage": 99.9
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "phone",
            "coverage": {
              "percentage": 69.1
            }
          },
          {
            "identifier": "fbp",
            "coverage": {
              "percentage": 96.7
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "fbc",
            "coverage": {
              "percentage": 3.2
            }
          }
        ]
      },
      "event_name": "CompleteRegistration"
    }
  ]
}

Questions/réponses

What is the access token used for?

The access token is used when partners send signal events or access the Setup Quality API on behalf of advertisers. The client system user access token onboarding method is not compatible with the EMQ API at the moment.

Permalien

How should the partner_agent field be formatted?

The partner_agent value in your API GET request should be a normalized lowercase format. This field is now optional.

Permalien

En savoir plus

Recommandations relatives à l’API Conversions.
Améliorer les performances avec une configuration optimisée de l’API Conversions.
Recommandations relatives à l’intégration de l’API Conversions pour les partenaires
Conseils relatifs à la qualité de la configuration de l’API Conversions issus des pages d’aide Meta Business :

Recommandations relatives à l’API Conversions visant à améliorer les performances publicitaires. Les recommandations relatives à l’API Conversions permettent aux entreprises d’améliorer leurs performances publicitaires en réduisant leur coût par action. Nous vous suggérons de suivre ces recommandations lors de la configuration initiale, mais elles peuvent également être utilisées pour mettre à jour les configurations existantes.

Voir les détails des évènements de serveur dans le Gestionnaire d’évènements Meta. Après avoir configuré l'API Conversions, les entreprises peuvent utiliser cet article pour savoir comment surveiller les évènements et les paramètres afin de s'assurer que leur configuration fonctionne efficacement et d'identifier les possibilités d'amélioration. Cet article leur permet également de savoir comment utiliser les détails des évènements du serveur (correspondance des évènements [Event Match Quality/EMQ], actualisation des données, présentation et déduplication des évènements) dans le Gestionnaire d'évènements afin d'améliorer la configuration de leur API Conversions.