# Microsoft Conversions API

[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 [Universal Event Tracking (UET) framework](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 principales fonctionnalités suivantes :

* **Structure des events**: notre [Référence des events](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 bridgées vers les champs attendus de manière optimisée.
* **Mappings préconfigurés**: le mapping des données pour les destinations basées sur les events 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 envoyer librement des événements et des 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 [item](https://community.commandersact.com/platform-x/developers/tracking/events-reference#item) array est transmis à 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 la capture des données via 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) avec 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, ces fonctionnalités reposant sur la résolution de l’identité utilisateur. Plus de détails sont disponibles au lien suivant [LIEN](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 scénario où vous utilisez le même `UET Tag Id` (Voir [Configuration](#configuration)) 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 [LIEN](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13#custom-events), montrant comment définir la valeur pour le `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" `ID d’événement` . Les deux `event_id` and `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>Obligatoire</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>Obligatoire</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é dans 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 de destination 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 en génère un nouveau <code>msclkid</code> en cliquant sur une autre annonce, selon la première éventualité. Saisissez le nom de votre cookie qui contient la valeur. Par défaut : <code>_uetmsclkid</code>. Plus de détails sont disponibles au lien suivant <a href="https://help.ads.microsoft.com/#apex/ads/en/60000/2">LIEN</a>. Vous pouvez également ajouter la valeur dans une propriété et utiliser le champ "Smart Mapping" <code>Microsoft Msclkid</code> qui a priorité sur le <code>Click Id Cookie Name</code> . Cette destination essaie également d’obtenir la valeur depuis l’URL de la page en utilisant la propriété mappée dans le champ "Smart Mapping" <code>URL de la page</code> .</td></tr></tbody></table>

## Référence rapide

| Events Commanders Act    | Microsoft Event Types |
| ------------------------ | --------------------- |
| `page_view`              | `pageLoad`            |
| `[Tout autre événement]` | `custom`              |

## Mappings des champs

{% hint style="info" %}
Les propriétés peuvent être remappées à l'aide de notre [Smart Mapping](https://doc.commandersact.com/features/destinations/advanced-mapping#smart-mapping) fonctionnalité.
{% endhint %}

<table><thead><tr><th width="396.6685580062746">Propriétés Commanders Act</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.\
> **2.** Utilisé pour la déduplication. Voir [Configuration de la destination](#destination-setup) pour plus de détails.\
> **3.** Identifiant de chargement de page qui relie vos événements personnalisés provenant de la même page. Format en\
> UUID v4.\
> **4.** Défini dans le <mark style="color:bleu;">`userData`</mark> .\
> **5.** Normalisé et haché automatiquement via SHA256 lorsqu’il est fourni en texte clair.\
> **6.** Normalisé au format E.164 avec indicatif pays.\
> **7.** Priorité dans 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 à la place de la valeur par défaut `_uetmsclkid` . La valeur sera automatiquement récupérée à partir du <mark style="color:bleu;">`context.page.url`</mark> si présent.\
> **8.** Définir si <mark style="color:bleu;">`context.device.os.name`</mark> est défini avec `Android` (insensible à la casse).\
> **9.** Définir si <mark style="color:bleu;">`context.device.os.name`</mark> est défini avec `iOS` (insensible à la casse).\
> **10.** Défini dans le <mark style="color:bleu;">`customData`</mark> .\
> **11.** Tous les identifiants produit sont pris en compte.\
> **12.** Priorité dans la colonne de gauche. Ceci est défini en fonction des éléments suivants :\
> • 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> soit de <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> soit de <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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.commandersact.com/fr/fonctionnalites/destinations/destinations-catalog/microsoft/microsoft-conversions-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
