# Microsoft Conversions API

{% hint style="info" %}
Cette destination est actuellement en revue finale et sera bientôt disponible.
{% endhint %}

[Microsoft Advertising](https://ads.microsoft.com/) (anciennement Bing Ads, Microsoft adCenter et MSN adCenter) est une plateforme de publicité en ligne développée par Microsoft. En utilisant cette destination, vous pouvez exploiter [Microsoft Conversions API](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration) et le [framework Universal Event Tracking (UET)](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13#universal-event-tracking-uet) pour envoyer les actions des utilisateurs, sous forme d'événements, via des hits de tracking server-side, permettant des fonctionnalités telles que le suivi des conversions (par ex., achats ou leads), le ciblage d'audience (par ex., remarketing), les enchères automatisées et l'intégration avec Microsoft Bing for Commerce.

## Fonctionnalités clés

La destination Microsoft Conversions API fournit les fonctionnalités clés suivantes :

* **Structure des événements**: notre [référence des événements](https://community.commandersact.com/platform-x/developers/tracking/events-reference) prend en charge [les événements Server-side UET de Microsoft](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13#server-side-uet-events), ce qui signifie que vos données sont correctement rapprochées des champs attendus de manière optimisée.
* **Mappings préconfigurés**: le mapping des données pour les destinations basées sur des événements se fait automatiquement, ce qui simplifie les saisies utilisateur.
* **Hachage automatique**: les informations sont automatiquement hachées conformément aux spécifications du partenaire.
* **Événements et propriétés personnalisés**: vous pouvez librement envoyer des événements et propriétés personnalisés selon vos besoins spécifiques.
* **Smart Mapping**: le mapping des données peut être réajusté à l'aide des champs définis dans votre datalayer.
* **Prise en charge des données multi-éléments**: les informations incluses dans le tableau [item](https://community.commandersact.com/platform-x/developers/tracking/events-reference#item) sont transmises à Microsoft.
* **Prise en charge du mode batch**: envoyez plusieurs événements dans une seule requête.

## Configuration de la destination

Assurez-vous d'avoir accès à [Microsoft Advertising](https://ads.microsoft.com/). 

{% hint style="info" %}
Cette destination peut être utilisée seule ou avec le [tracking JavaScript UET client-side](https://help.ads.microsoft.com/#apex/ads/en/56686/2).\
Pendant que les données sont collectées à l'aide de cette destination, un pixel de synchronisation d'identification utilisateur client-side peut également être utilisé pour connecter Microsoft et les identifiants utilisateur attribués par le client. Le pixel de synchronisation se trouve [dans notre bibliothèque de templates client-side](https://doc.commandersact.com/features/sources/sources-catalog/web/containers/user-guides-for-browser-side-platform/tags/add-tags) sous le nom <mark style="color:bleu;">`Bing - Client-side id-sync and data capture`</mark>  et est recommandé pour la mesure des conversions car il est requis pour le remarketing et la création d'audiences, puisque ces fonctionnalités reposent sur la résolution de l'identité utilisateur. Plus de détails sont disponibles au [LINK](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13#client-side-id-sync).
{% endhint %}

{% hint style="warning" %}
Dans le cas où vous utilisez le même `UET Tag Id` (Voir [Configuration](#configuration)) à la fois pour le JavaScript UET client-side et cette destination, il est important de configurer la déduplication pour Microsoft `custom`  type d'événement (Voir [Référence rapide](#quick-reference)). Veuillez vous référer à ce [LINK](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13#custom-events), montrant comment définir la valeur de `event_id` dans le tag JavaScript UET client-side. Le `eventId` (Voir [Mappings des champs](#field-mappings)) peut être défini à l'aide du champ "Smart Mapping" `Event Id` . Les deux `event_id`  et `eventId` doivent être définis avec la même valeur.
{% endhint %}

### Configuration

<table><thead><tr><th width="300">Paramètres</th><th>Description</th></tr></thead><tbody><tr><td><code>Access Token</code></td><td><em><strong><code>Requis</code></strong></em><br>Saisissez votre <code>Access Token</code>. Vous pouvez le trouver dans <a href="https://help.ads.microsoft.com/apex/index/3/en/56705">Microsoft Advertising Ads UI</a> en sélectionnant <code>Conversions</code>  (menu de gauche) → <code>EUT tag</code> → survolez le nom du tag et cliquez sur le crayon → Dans <code>Edit UET tag</code> , cliquez sur <code>Save and next</code>  → Sélectionnez <code>Use Conversions API</code> .</td></tr><tr><td><code>UET Tag Id</code></td><td><em><strong><code>Requis</code></strong></em><br>Votre <code>UET Tag Id</code> . Vous pouvez le trouver dans <a href="https://help.ads.microsoft.com/apex/index/3/en/56705">Microsoft Advertising Ads UI</a> en sélectionnant <code>Conversions</code>  (menu de gauche) → <code>EUT tag</code>  → colonne <code>Tag ID</code> .</td></tr><tr><td><code>Click Id Cookie Name</code></td><td>Le <code>msclkid</code> (Click Id) est utilisé pour l'attribution des conversions et est généré au moment du clic sur l'annonce. Cet id est ajouté à l'URL de la page d'atterrissage lorsque <a href="https://help.ads.microsoft.com/#apex/ads/en/60125/2-500">Microsoft auto-tagging</a> est activé. Il doit être stocké dans un cookie first party et conservé pour chaque utilisateur pendant 90 jours ou jusqu'à ce que l'utilisateur génère un nouveau <code>msclkid</code> en cliquant sur une autre annonce, selon ce qui arrive en premier. Saisissez le nom de votre cookie qui contient la valeur. Par défaut : <code>_uetmsclkid</code>. Plus de détails sont disponibles au <a href="https://help.ads.microsoft.com/#apex/ads/en/60000/2">LINK</a>. Vous pouvez également ajouter la valeur dans une propriété et utiliser le champ "Smart Mapping" <code>Microsoft Msclkid</code> qui a la priorité sur le <code>Click Id Cookie Name</code> . Cette destination tente également d'obtenir la valeur depuis l'URL de la page à l'aide de la propriété mappée dans le champ "Smart Mapping" <code>Page URL</code> .</td></tr></tbody></table>

## Référence rapide

| Commanders Act Events | Microsoft Event Types |
| --------------------- | --------------------- |
| `page_view`           | `pageLoad`            |
| `[Any other event]`   | `custom`              |

## Mappings des champs

{% hint style="info" %}
La plupart des propriétés peuvent être remappées à l'aide de notre fonctionnalité "Smart Mapping".
{% endhint %}

<table><thead><tr><th width="396.6685580062746">Commanders Act Properties</th><th>Microsoft Properties</th></tr></thead><tbody><tr><td><code>(event_name)</code></td><td><code>eventType</code> <strong>[1]</strong></td></tr><tr><td><code>context.event_id</code></td><td><code>eventId</code> <strong>[2]</strong></td></tr><tr><td><code>event_name</code></td><td><code>eventName</code></td></tr><tr><td><code>context.event_timestamp</code></td><td><code>eventTime</code></td></tr><tr><td><code>context.page.url</code></td><td><code>eventSourceUrl</code></td></tr><tr><td><code>context.device.lifecycle.session_id</code></td><td><code>pageLoadId</code> <strong>[3]</strong></td></tr><tr><td><code>context.page.referrer</code></td><td><code>referrerUrl</code></td></tr><tr><td><code>context.page.title</code></td><td><code>pageTitle</code></td></tr><tr><td><code>partners.microsoft.keyword</code></td><td><code>keywords</code></td></tr><tr><td><code>partners.microsoft.ad_storage_consent</code></td><td><code>adStorageConsent</code></td></tr><tr><td><code>context.device.user_agent</code></td><td><code>clientUserAgent</code> <strong>[4]</strong></td></tr><tr><td><code>user.consistent_anonymous_id</code></td><td><code>anonymousId</code></td></tr><tr><td><code>user.id</code></td><td><code>externalId</code></td></tr><tr><td><code>user.email</code></td><td><code>em</code> <strong>[5]</strong></td></tr><tr><td><code>user.phone</code></td><td><code>ph</code> <strong>[5][6]</strong></td></tr><tr><td><code>context.device.ip</code></td><td><code>clientIpAddress</code></td></tr><tr><td><p><code>partners.microsoft.msclkid</code></p><p><code>Click Id Cookie Name</code></p><p><code>(context.page.url)</code></p></td><td><code>msclkid</code> <strong>[7]</strong></td></tr><tr><td><code>context.device.advertising_id</code></td><td><code>gaid</code> <strong>[8]</strong></td></tr><tr><td><code>context.device.advertising_id</code></td><td><code>idfa</code> <strong>[9]</strong></td></tr><tr><td><code>event_category</code></td><td><code>eventCategory</code> <strong>[10]</strong></td></tr><tr><td><code>event_label</code></td><td><code>eventLabel</code> <strong>[10]</strong></td></tr><tr><td><code>value</code></td><td><p><code>eventValue</code> <strong>[10]</strong></p><p><code>ecommTotalValue</code> <strong>[10]</strong></p><p><code>hotelData.totalPrice</code> <strong>[10]</strong></p></td></tr><tr><td><code>revenue</code></td><td><code>value</code>  <strong>[10]</strong><br><code>hotelData.basePrice</code> <strong>[10]</strong></td></tr><tr><td><code>search_term</code></td><td><code>searchTerm</code> <strong>[10]</strong></td></tr><tr><td><code>id</code></td><td><code>transactionId</code> <strong>[10]</strong></td></tr><tr><td><code>currency</code></td><td><code>currency</code> <strong>[10]</strong></td></tr><tr><td><code>items.X.id</code></td><td><code>items.X.id</code> <strong>[10]</strong></td></tr><tr><td><code>items.X.product.price</code></td><td><code>items.X.price</code> <strong>[10]</strong></td></tr><tr><td><code>items.X.quantity</code></td><td><code>items.X.quantity</code> <strong>[10]</strong></td></tr><tr><td><code>items.X.product.name</code></td><td><code>items.X.name</code> <strong>[10]</strong></td></tr><tr><td><code>items.X.id</code></td><td><code>itemIds</code> <strong>[10][11]</strong></td></tr><tr><td><p><code>(page_type)</code></p><p><code>(event_name)</code></p></td><td><code>pageType</code> <strong>[10][12]</strong></td></tr><tr><td><code>item_list_name</code></td><td><code>ecommCategory</code> <strong>[10]</strong></td></tr><tr><td><code>partners.microsoft.hotel_checkin_date</code></td><td><code>hotelData.checkinDate</code> <strong>[10]</strong></td></tr><tr><td><code>partners.microsoft.hotel_checkout_date</code></td><td><code>hotelData.checkoutDate</code> <strong>[10]</strong></td></tr><tr><td><code>partners.microsoft.hotel_length_stay</code></td><td><code>hotelData.lengthOfStay</code> <strong>[10]</strong></td></tr><tr><td><code>partners.microsoft.hotel_partner_id</code></td><td><code>hotelData.partnerHotelId</code> <strong>[10]</strong></td></tr></tbody></table>

{% hint style="info" %}

> **\[1]** Voir [Référence rapide](#quick-reference) pour plus de détails.\
> \&#xNAN;**\[2]** Utilisé pour la déduplication. Voir [Configuration de la destination](#destination-setup) pour plus de détails.\
> \&#xNAN;**\[3]** Identifiant de chargement de page qui relie vos événements personnalisés provenant de la même page. Format :\
> un UUID v4.\
> **\[4]** Défini dans <mark style="color:bleu;">`userData`</mark> .\
> \&#xNAN;**\[5]** Normalisé et haché automatiquement via SHA256 lorsqu'il est fourni en clair.\
> \&#xNAN;**\[6]** Normalisé au format E.164 avec indicatif pays.\
> \&#xNAN;**\[7]** Priorité sur la colonne de gauche. Vous utilisez le champ <mark style="color:bleu;">`Click Id Cookie Name`</mark>  (Voir [Configuration](#configuration)) pour définir un autre nom de cookie au lieu du cookie par défaut `_uetmsclkid` . La valeur sera automatiquement récupérée depuis le <mark style="color:bleu;">`context.page.url`</mark> si présent.\
> \&#xNAN;**\[8]** Défini si <mark style="color:bleu;">`context.device.os.name`</mark>  est défini avec `Android`  (insensible à la casse).\
> \&#xNAN;**\[9]** Défini si <mark style="color:bleu;">`context.device.os.name`</mark>  est défini avec `iOS`  (insensible à la casse).\
> \&#xNAN;**\[10]** Défini dans <mark style="color:bleu;">`customData`</mark> .\
> \&#xNAN;**\[11]** Tous les identifiants de produits sont pris en compte.\
> \&#xNAN;**\[12]** Priorité sur la colonne de gauche. Ceci est défini en fonction de ce qui suit :\
> • Si <mark style="color:bleu;">`page_type`</mark>  est <mark style="color:bleu;">`home`</mark> , <mark style="color:bleu;">`product`</mark> , <mark style="color:bleu;">`cart`</mark> , <mark style="color:bleu;">`category`</mark> , <mark style="color:bleu;">`other`</mark> , <mark style="color:bleu;">`purchase`</mark> ou <mark style="color:bleu;">`searchresults`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est défini avec la même valeur .\
> • Si <mark style="color:bleu;">`page_type`</mark>  est <mark style="color:bleu;">`product_list`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`category`</mark> .\
> • Si <mark style="color:bleu;">`page_type`</mark>  est <mark style="color:bleu;">`funnel_confirmation`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`purchase`</mark> .\
> • Si <mark style="color:bleu;">`page_type`</mark>  est <mark style="color:bleu;">`search`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`searchresults`</mark> .\
> • Si <mark style="color:bleu;">`event_name`</mark>  est <mark style="color:bleu;">`search`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`searchresults`</mark> .\
> • Si <mark style="color:bleu;">`event_name`</mark>  est <mark style="color:bleu;">`view_item_list`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`category`</mark> .\
> • Si <mark style="color:bleu;">`event_name`</mark>  est <mark style="color:bleu;">`view_item`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`product`</mark> .\
> • Si <mark style="color:bleu;">`event_name`</mark>  est <mark style="color:bleu;">`view_item`</mark>  ou <mark style="color:bleu;">`add_to_cart`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`product`</mark> .\
> • Si <mark style="color:bleu;">`event_name`</mark>  est <mark style="color:bleu;">`view_cart`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`cart`</mark> .\
> • Si <mark style="color:bleu;">`event_name`</mark>  est <mark style="color:bleu;">`purchase`</mark>  alors <mark style="color:bleu;">`pageType`</mark>  est <mark style="color:bleu;">`purchase`</mark> .
> {% endhint %}