Ctrlk
Platform XDocumentationWelcome to Success
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Facebook Conversions API

Aka Facebook CAPI

Facebook est un service de médias sociaux et de réseautage social en ligne détenu par Meta. Cette destination vous permet d'envoyer directement vers Facebook tout type d'événement via API : en envoyant des conversions en ligne et hors ligne, vous pouvez augmenter la portée et la précision de vos campagnes.

Vous pouvez, par exemple, ne pas envoyer aux utilisateurs ayant déjà acheté un produit donné les campagnes liées à ce produit, ou envoyer aussi des campagnes aux utilisateurs ayant acheté un produit spécifique dans une logique de cross-sell.

Comment envoyer des événements à Facebook ?

Facebook a développé une API appelée 'Facebook Conversions API' https://developers.facebook.com/docs/marketing-api/conversions-api

Vous avez besoin d'un compte Facebook Business Manager https://business.facebook.com/

Puis, dans le menu, cliquez sur 'Events Manager' :

Events Manager

Ici, vous devez créer un nouveau Pixel web :

Nouveau Pixel web

Sélectionnez Conversions API et donnez un nom à votre connexion :

Votre pixel est maintenant créé et vous aurez accès aux ID nécessaires sur notre connecteur.

Où puis-je trouver le Pixel ID ?

Vous devez renseigner le Pixel ID dans notre connecteur ; c'est l'ID du pixel que vous venez de créer aux étapes ci-dessus.

Vous pouvez trouver cet ID en cliquant sur le nom du pixel, puis à droite des activités du graphique. Vous pouvez aussi le trouver dans l'onglet des paramètres.

Trouver le Pixel ID

Vous pouvez maintenant copier et coller cet ID dans notre connecteur.

Ensuite, vous avez besoin du jeton d'accès

Où puis-je trouver le jeton d'accès ?

Vous pouvez configurer votre jeton d'accès de deux façons :

  1. Facebook Login For Business Authentication

  2. Générez un jeton à longue durée de vie

Si vous configurez les deux, « Facebook Login For Business Authentication » sera prioritaire.

Facebook Login For Business Authentication

C'est la méthode d'authentification recommandée.

  1. Dans votre compte Commanders Act, accédez à (1) Administration → (2) Identifiants du connecteur ou cliquez sur le lien ajoutez un nouveau compte dans les paramètres de la destination. \

  2. Cliquez (3) Ajouter des identifiants de connecteur en haut à droite : \

  3. Sélectionnez (4) Facebook Ads \

  4. Connectez-vous avec les identifiants de votre compte Facebook.

  5. Allez dans les paramètres de votre destination et sélectionnez vos identifiants ajoutés dans le menu déroulant sous (5) Authentification API → (6) Identifiants

  6. Enregistrez les paramètres de votre destination.

Générez un jeton à longue durée de vie

  1. Allez sur Meta Event Manager

  2. Dans le menu de gauche, sélectionnez (1) Sources de données .

  1. Localisez votre (2) jeu de données existant et sélectionnez-le ou créez un nouveau jeu de données.

  1. Cliquez sur l'onglet (3) Paramètres

  1. Localisez le lien (4) Générer le jeton d'accès et cliquez dessus pour générer un jeton d'accès

Si vous ne pouvez pas cliquer sur le lien "Generate access token", alors vous n'avez pas les droits d'administrateur.

  1. Copiez et collez votre jeton d'accès dans le champ Jeton d'accès API dans votre destination et enregistrez les paramètres de votre destination.

Comment gérer les consentements ?

  • Seuls les événements avec un consentement seront envoyés à Facebook

  • Seules les conversions contenant des informations personnelles (e-mail et/ou numéro de téléphone...) seront envoyées à Facebook

Pour les clients utilisant notre produit TRUST Commander :

TRUST Commander est notre Consent Management Platform. (Plus d'informations : https://www.commandersact.com/en/solutions/trustcommander/)

Sur le connecteur, le consentement est géré avec le champ 'User Consent Category'. Vous devez renseigner un ID de catégorie, celui correspondant à Facebook (advertising) dans les catégories de consentement Trust.

Pour les clients ne disposant pas de notre produit TRUST Commander :

Nous devons distinguer 3 cas :

  • Vos événements en ligne sont collectés via notre tag d'événement Commanders Act : vous devez fournir, dans les tags d'événement, la liste des ID de catégories consenties par l'utilisateur, via la consent_categories propriété.

  • Vous nous envoyez vos événements via API ou fichier CSV : un champ consent_categories doit être ajouté au JSON ou au CSV pour préciser les ID de catégorie de consentement de l'utilisateur. Ensuite, dans le paramètre du connecteur, utilisez le champ 'User Consent Category' pour saisir un ID de catégorie, celui correspondant à Facebook (advertising)

  • Vous gérez déjà les consentements de votre côté et vous ne nous envoyez, depuis votre serveur,

    que les événements ayant obtenu le consentement pour la catégorie advertising. Dans ce cas, ne remplissez pas le champ « User Consent Category » dans le connecteur.

Comment la déduplication entre le pixel et le serveur est-elle gérée ?

Utiliser à la fois le pixel et le serveur est recommandé par Facebook, car cela peut éviter une perte de données.

Pour que cela fonctionne, vous devez avoir la même configuration pour le pixel et le serveur, en utilisant les mêmes paramètres Facebook.

event_id doit être le même

Sur le pixel, event_id est généré automatiquement par notre Commanders Act Tag et nous récupérons la même valeur pour le serveur sur integrations.facebook.event_id. En conséquence, ces 2 valeurs doivent être identiques. Event_name doit aussi être identique.

Fbp le paramètre est récupéré automatiquement pour conserver la même valeur entre le pixel et le serveur.

La déduplication fonctionne lorsque le même événement est envoyé d'abord depuis le navigateur et ensuite depuis le serveur, sinon cela crée un doublon. Les événements sont envoyés en temps réel.

Exemples

Sur le pixel :

eventID: tC.uniqueEventId est généré automatiquement.

Sur le serveur :

integrations.facebook.event_id récupère automatiquement la valeur eventID provenant du pixel (eventID: tC.uniqueEventId) pour les événements standards.

Correspondances vers les événements standards Facebook

La Facebook CAPI Destination transformera le Commanders Act événement comme...

...en Facebook CAPI événements comme :

Les mappages suivants sont entièrement automatisés et ne nécessitent, par défaut, aucune configuration supplémentaire. Vous pouvez néanmoins personnaliser chacun d'eux comme suit.

Correspondance : (racine)

LogoServer Event Parametersdevelopers.facebook.com

La plupart des propriétés peuvent être remappées à l'aide de notre fonctionnalité "Smart Mapping".

Propriétés Commanders Act
Propriétés Facebook

event_id [2][3]

event_id [1]

event_name

event_name [4]

context.event_timestamp

event_time [5]

context.page.url

event_source_url

context.page.referrer

referrer_url

Activer le suivi de l'application

type

action_source [6]

opt_out [3]

opt_out [7]

data_processing_options [3]

data_processing_options [7]

data_processing_options_country [3]

data_processing_options_country [7]

data_processing_options_state [3]

data_processing_options_state [7]

1. Défini en fonction des propriétés disponibles, dans l'ordre indiqué à gauche. Par défaut, une valeur générée aléatoirement à partir de l'horodatage. 2. À la racine de votre événement. 3. Dans integrations.facebook de votre événement. 4. Voir Correspondance : event_name pour plus de détails. 5. Si aucune valeur n'est fournie, l'horodatage actuel est utilisé. 6. Voir Correspondance : action_source pour plus de détails. 7. Voir plus de détails via ce LIEN.

Correspondance : event_name

Facebook Pixel spécifie Standard Events dont la sémantique correspond aux événements du Standard Commanders Act

Si la destination reçoit un Commanders Act Event avec event_name correspondant à la liste, il sera automatiquement envoyé sous le nom du Facebook Standard Event associé. Sinon, il sera envoyé sans aucune transformation

Événements Commanders Act
Événements Facebook

begin_checkout

InitiateCheckout

purchase

Purchase

add_to_cart

AddToCart

view_item

ViewContent

view_item_list

ViewContent

search

Search

add_payment_info

AddPaymentInfo

add_to_wishlist

AddToWishlist

generate_lead

Lead

page_view

PageView

sign_up

CompleteRegistration

contact

Contact

customize_product

CustomizeProduct

donate

Donate

find_location

FindLocation

schedule

Schedule

search

Search

start_trial

StartTrial

submit_application

SubmitApplication

subscribe

Subscribe

Exemples :

  • Si la destination voit un add_to_cart événement (DANS la liste), elle enverra un AddToCart à Facebook CAPI

  • Si la destination voit un custom_name événement (PAS DANS la liste), elle enverra un custom_name à Facebook CAPI (aucune transformation)

Remarque : Vous pouvez personnaliser event_name à l'aide de Transformations de propriétés dans les paramètres de la destination.

Correspondance : action_source

LogoServer Event Parametersdevelopers.facebook.com

Par défaut, action_source sera défini sur 'website' (la plupart des événements sont liés à l'activité en ligne). SI Activer le suivi de l'application est coché ALORS action_source='app'

Spécificité des conversions hors ligne :

  • SI votre événement a la propriété type='offline'

  • ALORS le Facebook Event aura action_source='physical_store'

  • SINON le Facebook Event aura action_source='website'

Exemple :

Si vous devez écraser cette valeur, vous pouvez actuellement utiliser Transformation de propriétés pour définir integrations.facebook.action_source.

Correspondance : user_data

LogoCustomer Information Parametersdevelopers.facebook.com

La plupart des propriétés peuvent être remappées à l'aide de notre fonctionnalité "Smart Mapping".

Propriétés Commanders Act
Propriétés Facebook

user.id (haché) context.device.sdk_id user.tcId , user.tcid ou user.tc_id

user_data.external_id [1]

user.email

user_data.em (e-mail, haché)

user.phone

user_data.ph (téléphone, haché)

user.gender

user_data.ge (genre, haché)

user.birthdate

user_data.db (date de naissance, haché)

user.lastname

user_data.ln (nom de famille, haché)

user.firstname

user_data.fn (prénom, haché)

user.city

user_data.ct (ville, haché)

user.state

user_data.st (état, haché)

user.zipcode

user_data.zp (code postal, haché)

user.country

user_data.country (haché)

ip [3][4]

user_data.client_ip_address

user_agent [3][4]

user_data.client_user_agent

fbc [2] Le cookie "_fbc" [5]

user_data.fbc (Click ID)

fbp [2] Le cookie "_fbp" [5]

user_data.fbp (Browser ID)

advertising_id [3]

user_data.anon_id [6] user_data.madid [6]

partners.facebook.fb_login_id

user_data.fb_login_id [7]

user_data[Nom de la propriété] [8]

user_data[Nom de la propriété]

1. Chaîne séparée par des virgules : valeurs dans l’ordre fourni à gauche. 2. Dans integrations.facebook ou à la racine de vos events, le premier ayant la priorité. 3. Dans context.device de votre événement. 4. Défini automatiquement s’il est généré par Commanders Act OneTag. 5. Créé automatiquement par le tag Facebook Pixel client-side. 6. Uniquement pour les events d’app. 7. L’identifiant émis par Meta lorsqu’une personne se connecte pour la première fois à une instance d’une application. Il est aussi connu sous le nom de App-Scoped ID. 8. Dans integrations.facebook de votre événement.

Chaque propriété peut être remplacée en utilisant integrations.facebook.user_data.<property>

Informations minimales requises

Les events ne peuvent être utilisés que s’il y a suffisamment d’informations pour faire correspondre un utilisateur. Facebook attend au moins une propriété, mais recommande fortement d’en envoyer autant que possible. user_data propriété, mais recommande fortement d’en envoyer autant que possible.

Voici nos conditions pour envoyer les events :

  • au moins 1 de ces champs : em, ph, external_id, fbp, fbc

  • au moins 3 des autres champs

Remarque : external_id, fbp, fbc permettront d’associer un event à d’autres events. Mais pour associer un utilisateur, l’un de ces events doit contenir des informations supplémentaires (em et ph sont les plus adaptés à l’association)

Correspondance : custom_data

LogoStandard Parametersdevelopers.facebook.com

La plupart des propriétés peuvent être remappées à l’aide de notre fonctionnalité "Smart Mapping". Les champs custom_data.contents et custom_data.content_ids sont mutuellement exclusifs, ce qui signifie qu’un seul d’entre eux peut être présent selon la logique suivante :

  • Si toutes ces propriétés sont présentes et définies dans items : product.id , quantity , et product.price , alors custom_data.contents est défini avec toutes les informations produit.

  • sinon, custom_data.content_ids est défini avec toutes les product.id .

Champs Smart Mapping
Propriétés par défaut de Commanders Act
Propriétés Facebook

Valeur

valeur

custom_data.value

Devise

-

devise

items.0.currency

custom_data.currency

Revenu net

partners.facebook.net_revenue

custom_data.net_revenue

ID de commande

id

custom_data.order_id

-

search_term

custom_data.search_string

-

items.X.product.id

custom_data.contents.X.id [1]

-

items.X.quantity

custom_data.contents.X.quantity [1]

-

items.X.product.price

custom_data.contents.X.item_price [1]

-

items.0.product.name

custom_data.content_name

-

items.0.product.category_1

custom_data.content_category

-

items.X.product.id

custom_data.content_ids [2]

Type de contenu

-

partners.facebook.content_type

Valeur du type de contenu

custom_data.content_type [3] custom_data.fb_content_type [4]

-

status

custom_data.status

Articles

items.length

custom_data.num_items

-

Envoyez toutes les propriétés de votre event en tant que données personnalisées

custom_data[Nom de la propriété] [5]

Données personnalisées supplémentaires

custom_data[Nom de la propriété] [6]

custom_data[Nom de la propriété]

1. Mutuellement exclusif avec custom_data.content_ids et défini si toutes les propriétés suivantes sont présentes et valides : items.X.product.id , items.X.product.price , items.x.quantity . 2. Tableau contenant tous les identifiants de produit. Mutuellement exclusif avec custom_data.contents. 3. Défini lorsque action_source est website ou physical_store . Selon la valeur sélectionnée pour Valeur du type de contenu , qui se trouve sous Paramètres avancés , il s’agit soit de product ou non défini. Le champ Smart Mapping Type de contenu a priorité sur Valeur du type de contenu . 4. Défini lorsque action_source est app . 5. Lorsque Envoyez toutes les propriétés de votre event en tant que données personnalisées c’est coché, toutes les propriétés de votre event de type "string", "number" et "boolean" seront incluses dans custom_data avec le même nom de propriété. 6. Dans integrations.facebook dans votre event.

Comportement par défaut

Facebook définit des règles pour les propriétés standard. Le reste est entièrement libre.

Par défaut, nous remplissons custom_data comme suit :

  1. Nous copions toutes les propriétés de l’event Commanders Act dans custom_data (sauf certains champs de contexte comme source_key)

  2. Ensuite, nous faisons correspondre les propriétés standard selon le tableau ci-dessus (peut écraser les valeurs)

  3. Enfin, nous remplaçons par integrations.facebook.custom_data.<property> si elle existe

Remplacer custom_data

Le meilleur choix serait d’utiliser Transformation de propriétés pour modifier les propriétés de votre event qui seront copiées dans custom_data.

Mais vous pouvez remplacer la valeur finale en utilisant integrations.facebook.custom_data.<property>.

Exemple :

Correspondance : app_data

LogoApp Data Parametersdevelopers.facebook.com

La plupart des propriétés peuvent être remappées à l'aide de notre fonctionnalité "Smart Mapping".

Propriétés Commanders Act
Propriétés Facebook

ad_tracking_enabled [1]

advertiser_tracking_enabled [*]

application_tracking_enabled [1]

application_tracking_enabled [*]

context.campaign.name

campaign_ids

install_referrer [2]

install_referrer

installer_package [2]

installer_package

url_schemes [2]

url_schemes

windows_attribution_id [2]

windows_attribution_id

type [1]

extinfo[0] [3]

app.namespace [1]

extinfo[1]

app.build [1]

extinfo[2]

app.version [1]

extinfo[3]

os.version [1]

extinfo[4]

model [1]

extinfo[5]

language [1]

extinfo[6]

[No default field] [4]

extinfo[7]

network.carrier [1]

extinfo[8]

screen.width [1]

extinfo[9]

screen.height [1]

extinfo[10]

screen.density [1]

extinfo[11]

[No default field] [5]

extinfo[12]

[No default field] [6]

extinfo[13]

[No default field] [7]

extinfo[14]

timezone [1]

extinfo[15]

* Propriété obligatoire. 1. Dans context.device de votre événement. 2. Dans integrations.facebook ou à la racine de vos events, le premier ayant la priorité. 3. Lorsque context.device.type est défini avec Android ou iOS (insensible à la casse), cela est défini avec a2 ou i2 respectivement. 4. Peut être défini dans Smart Mapping → App Data → Fuseau horaire abrégé de l’appareil . 5. Peut être défini dans Smart Mapping → App Data → Cœurs CPU . 6. Peut être défini dans Smart Mapping → App Data → Taille du stockage externe . 7. Peut être défini dans Smart Mapping → App Data → Taille du stockage disponible .

integrations.facebook.* Dépréciation

integrations.facebook.* son utilisation sera dépréciée. La fonctionnalité fonctionne toujours, mais il est recommandé d’utiliser les paramètres de destination à la place pour des raisons de maintenance et de fiabilité.

Vérifiez les résultats dans l’interface Facebook

Pour voir la qualité de l’association dans l’interface Facebook, allez ici : Events manager > sélectionnez l’event > View Details > Event Matching > Rating Background

Comment envoyer des conversions offline

La méthode recommandée consiste à utiliser la HTTP Tracking API source pour envoyer vos events offline depuis vos serveurs (ou tout autre émetteur). Il vous suffit d’envoyer un event d’achat avec la type propriété égale à offline Plus de détails sur le mapping automatique ici : Mapping action_source

PrécédentFacebook
SuivantComment faire – Envoyer une valeur de profit protégée via Meta (Facebook CAPI)

Mis à jour

Ce contenu vous a-t-il été utile ?