> For the complete documentation index, see [llms.txt](https://doc.commandersact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.commandersact.com/fr/fonctionnalites/destinations/destinations-catalog/branch-events.md).

# Branch Events

[Branch](https://www.branch.io/) (anciennement connue sous le nom de Branch Metrics) est une entreprise de logiciels mobiles spécialisée dans le deep linking mobile et l’attribution. Cette intégration permet le [suivi des événements server-side](https://help.branch.io/developers-hub/reference/events-api).

## Fonctionnalités clés

La destination Branch Events offre les principales fonctionnalités suivantes :

* **Structure des événements** : notre [référence des événements](https://doc.commandersact.com/developers/tracking/events-reference) correspond aux événements [standard](https://help.branch.io/developers-hub/reference/logstandardevents) et [personnalisés de Branch](https://help.branch.io/developers-hub/reference/logcustomevents), ce qui garantit que vos données sont correctement associées aux champs attendus, de manière optimisée.
* **Mappages prédéfinis**: le mappage des données pour les destinations basées sur les événements s’effectue automatiquement, ce qui simplifie la saisie.
* **Données enrichies** : vous pouvez librement transmettre des informations supplémentaires selon vos besoins spécifiques (par exemple, en ajoutant des événements personnalisés et des propriétés d’événement personnalisées).
* **Mappage intelligent**: le mappage des données peut être ajusté à l’aide des champs définis dans votre datalayer.
* **Mappage des événements** : modifiez le mappage standard entre les événements de vos partenaires et les vôtres, ou ajoutez de nouveaux mappages.
* **Prise en charge des données multi-éléments** : les informations incluses dans le tableau [item](https://doc.commandersact.com/developers/tracking/events-reference#item) sont envoyées à Branch.

## Configuration de la destination

{% hint style="info" %}
Avant de configurer cette destination, vous devez créer un [Dashboard Branch](https://dashboard.branch.io/).
{% endhint %}

### Configuration

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="300">Paramètres</th><th>Description</th></tr></thead><tbody><tr><td><code>Branch Key</code></td><td><em><strong><code>Obligatoire</code></strong></em><br>Branch Key de l’application source, disponible dans les <a href="https://help.branch.io/using-branch/docs/profile-settings">paramètres du compte</a>.</td></tr><tr><td><code>Content Schema</code></td><td>Catégorie/schéma du contenu inclus.</td></tr><tr><td><code>Propriétés d’événement personnalisées</code></td><td>Associez vos propriétés d’événement personnalisées en définissant leurs noms de champ dans <code>Branch property name</code> et en ajoutant le nom du champ contenant la valeur dans <code>Your event property</code>.</td></tr><tr><td><code>Event Mapping</code></td><td>Modifiez le mappage standard (voir la <a href="#quick-reference">référence rapide</a>) entre les événements Branch et les vôtres, ou ajoutez de nouveaux mappages.</td></tr></tbody></table>

## Référence rapide

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Événements Commanders Act</th><th>Événements Branch</th></tr></thead><tbody><tr><td><code>achieve_level</code></td><td><code>ACHIEVE_LEVEL</code></td></tr><tr><td><code>add_payment_info</code></td><td><code>ADD_PAYMENT_INFO</code></td></tr><tr><td><code>add_to_cart</code></td><td><code>ADD_TO_CART</code></td></tr><tr><td><code>add_to_wishlist</code></td><td><code>ADD_TO_WISHLIST</code></td></tr><tr><td><code>begin_checkout</code></td><td><code>INITIATE_PURCHASE</code></td></tr><tr><td><code>click_ad</code></td><td><code>CLICK_AD</code></td></tr><tr><td><code>complete_stream</code></td><td><code>COMPLETE_STREAM</code></td></tr><tr><td><code>complete_tutorial</code></td><td><code>COMPLETE_TUTORIAL</code></td></tr><tr><td><code>generate_lead</code></td><td><code>COMPLETE_REGISTRATION</code></td></tr><tr><td><code>initiate_stream</code></td><td><code>INITIATE_STREAM</code></td></tr><tr><td><code>invite</code></td><td><code>INVITE</code></td></tr><tr><td><code>login</code></td><td><code>LOGIN</code></td></tr><tr><td><code>purchase</code></td><td><code>PURCHASE</code></td></tr><tr><td><code>rate</code></td><td><code>RATE</code></td></tr><tr><td><code>search</code></td><td><code>SEARCH</code></td></tr><tr><td><code>share</code></td><td><code>SHARE</code></td></tr><tr><td><code>start_trial</code></td><td><code>START_TRIAL</code></td></tr><tr><td><code>spend_credits</code></td><td><code>SPEND_CREDITS</code></td></tr><tr><td><code>subscribe</code></td><td><code>SUBSCRIBE</code></td></tr><tr><td><code>unlock_achievement</code></td><td><code>UNLOCK_ACHIEVEMENT</code></td></tr><tr><td><code>view_ad</code></td><td><code>VIEW_AD</code></td></tr><tr><td><code>view_cart</code></td><td><code>VIEW_CART</code></td></tr><tr><td><code>view_item</code></td><td><code>VIEW_ITEM</code></td></tr><tr><td><code>view_items</code></td><td><code>VIEW_ITEMS</code></td></tr><tr><td><code>[Any Event]</code> <strong>[1]</strong></td><td><code>[Any Event]</code> <strong>[1]</strong></td></tr></tbody></table>

{% hint style="info" %}
**1.** Consultez <mark style="color:bleu;">`Event Mapping`</mark> dans [Configuration](#configuration) pour plus de détails.
{% endhint %}

## Correspondances des champs

{% hint style="warning" %}
Au moins un des éléments suivants doit être inclus :\
• <mark style="color:bleu;">`developer_identity`</mark>\
• <mark style="color:bleu;">`browser_fingerprint_id`</mark>\
• <mark style="color:bleu;">`idfa`</mark> OU <mark style="color:bleu;">`idfv`</mark> (SI <mark style="color:bleu;">`os`</mark> = <mark style="color:bleu;">`iOS`</mark> )\
• <mark style="color:bleu;">`aaid`</mark> OU <mark style="color:bleu;">`android_id`</mark> (SI <mark style="color:bleu;">`os`</mark> = <mark style="color:bleu;">`Android`</mark> )
{% endhint %}

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

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="281">Champs Smart Mapping</th><th width="342.6685580062746">Propriétés par défaut de Commanders Act</th><th width="275.3314419937253">Propriétés de Branch</th></tr></thead><tbody><tr><td><code>-</code></td><td><code>Branch Key</code></td><td><code>branch_key</code></td></tr><tr><td><code>Customer Event Alias</code></td><td><code>partners.branch.event_alias</code></td><td><code>customer_event_alias</code></td></tr><tr><td><code>Device OS</code></td><td><code>context.device.os.name</code></td><td><code>os</code> <strong>[1]</strong></td></tr><tr><td><code>Device OS Version</code></td><td><code>context.device.os.version</code></td><td><code>os_version</code> <strong>[1]</strong></td></tr><tr><td><code>Environment</code></td><td><code>partners.branch.env</code></td><td><code>environment</code> <strong>[1]</strong></td></tr><tr><td><code>Identifiant mobile de l’appareil</code></td><td><code>context.device.advertising_id</code></td><td><p><code>idfa</code> <strong>[1][5]</strong></p><p><code>aaid</code> <strong>[1][6]</strong></p></td></tr><tr><td><code>Android Hardware Id</code></td><td><code>partners.branch.hardware_id</code></td><td><code>android_id</code> <strong>[1]</strong></td></tr><tr><td><code>Device iOS IDFV</code></td><td><code>context.device.idfv</code></td><td><code>idfv</code> <strong>[1]</strong></td></tr><tr><td><code>Ad Tracking Enabled</code></td><td><code>context.device.ad_tracking_enabled</code></td><td><code>limit_ad_tracking</code> <strong>[1][7]</strong></td></tr><tr><td><code>Device User Agent</code></td><td><code>context.device.user_agent</code></td><td><code>user_agent</code> <strong>[1]</strong></td></tr><tr><td><code>Empreinte du navigateur Branch</code></td><td><code>partners.branch.fingerprint_id</code></td><td><code>browser_fingerprint_id</code> <strong>[1]</strong></td></tr><tr><td><code>Page URL</code></td><td><code>context.page.url</code></td><td><code>http_origin</code> <strong>[1]</strong></td></tr><tr><td><code>URL de provenance de la page</code></td><td><code>context.page.referrer</code></td><td><code>http_referrer</code> <strong>[1]</strong></td></tr><tr><td><code>ID utilisateur</code></td><td><code>user.id</code></td><td><code>developer_identity</code> <strong>[1]</strong></td></tr><tr><td><code>Pays de l’utilisateur</code></td><td><code>user.country</code></td><td><code>country</code> <strong>[1]</strong></td></tr><tr><td><code>Langue de l’utilisateur</code></td><td><code>context.page.lang</code></td><td><code>language</code> <strong>[1]</strong></td></tr><tr><td><code>Device IP</code></td><td><code>context.device.ip</code></td><td><code>ip</code> <strong>[1]</strong></td></tr><tr><td><code>IP locale de l’appareil</code></td><td><code>partners.branch.local_ip</code></td><td><code>local_ip</code> <strong>[1]</strong></td></tr><tr><td><code>Marque de l’appareil</code></td><td><code>context.device.manufacturer</code></td><td><code>brand</code> <strong>[1]</strong></td></tr><tr><td><code>Jeton d’appareil Branch</code></td><td><code>partners.branch.device_token</code></td><td><code>randomized_device_token</code> <strong>[1]</strong></td></tr><tr><td><code>App Version</code></td><td><code>context.app.version</code></td><td><code>app_version</code> <strong>[1]</strong></td></tr><tr><td><code>Modèle de l’appareil</code></td><td><code>context.device.model</code></td><td><code>model</code> <strong>[1]</strong></td></tr><tr><td><code>DPI de l’appareil</code></td><td><code>context.device.screen.density</code></td><td><code>screen_dpi</code> <strong>[1]</strong></td></tr><tr><td><code>Largeur de l’écran de l’appareil</code></td><td><code>context.device.screen.width</code></td><td><code>screen_width</code> <strong>[1]</strong></td></tr><tr><td><code>Hauteur de l’écran de l’appareil</code></td><td><code>context.device.screen.height</code></td><td><code>screen_height</code> <strong>[1]</strong></td></tr><tr><td><code>DMA EEE</code></td><td><code>partners.branch.dma_eea</code></td><td><code>dma_eea</code> <strong>[1]</strong></td></tr><tr><td><code>Personnalisation des annonces DMA</code></td><td><code>partners.branch.dma_ad_pers</code></td><td><code>dma_ad_personalization</code> <strong>[1]</strong></td></tr><tr><td><code>Données utilisateur des annonces DMA</code></td><td><code>partners.branch.dma_ad_user_data</code></td><td><code>dma_ad_user_data</code> <strong>[1]</strong></td></tr><tr><td><code>ID de transaction</code></td><td><code>id</code></td><td><code>transaction_id</code> <strong>[2]</strong></td></tr><tr><td><code>Chiffre d’affaires de la transaction</code></td><td><code>revenue</code></td><td><code>revenue</code> <strong>[2]</strong></td></tr><tr><td><code>Devise</code></td><td><code>currency</code></td><td><code>currency</code> <strong>[2]</strong></td></tr><tr><td><code>Montant des frais de livraison</code></td><td><code>shipping_amount</code></td><td><code>shipping</code> <strong>[2]</strong></td></tr><tr><td><code>Montant des taxes</code></td><td><code>tax_amount</code></td><td><code>tax</code> <strong>[2]</strong></td></tr><tr><td><code>Transaction Coupon</code></td><td><code>coupon</code></td><td><code>coupon</code> <strong>[2]</strong></td></tr><tr><td><code>Type de transaction</code></td><td><code>type</code></td><td><code>affiliation</code> <strong>[2]</strong></td></tr><tr><td><code>Description de la transaction</code></td><td><code>event_name</code></td><td><code>description</code> <strong>[2]</strong></td></tr><tr><td><code>Search Term</code></td><td><code>search_query</code></td><td><code>search_term</code> <strong>[2]</strong></td></tr><tr><td><code>-</code></td><td><code>Content Schema</code></td><td><code>$content_schema</code> <strong>[3]</strong></td></tr><tr><td><code>Item Title</code></td><td><code>item_title</code> <strong>[4]</strong></td><td><code>$og_title</code> <strong>[3]</strong></td></tr><tr><td><code>Item Image URL</code></td><td><code>product.image_url</code> <strong>[4]</strong></td><td><code>$og_image_url</code> <strong>[3]</strong></td></tr><tr><td><code>Item Canonical Identifier</code></td><td><code>product.canonical_identifier</code> <strong>[4]</strong></td><td><code>$canonical_identifier</code> <strong>[3]</strong></td></tr><tr><td><code>Item Publicly Indexable</code></td><td><code>product.publicly_indexable</code> <strong>[4]</strong></td><td><code>$publicly_indexable</code> <strong>[3]</strong></td></tr><tr><td><code>Item Publicly Indexable</code></td><td><code>product.locally_indexable</code> <strong>[4]</strong></td><td><code>$locally_indexable</code> <strong>[3]</strong></td></tr><tr><td><code>Prix de l’article</code></td><td><code>product.price</code> <strong>[4]</strong></td><td><code>$price</code> <strong>[3]</strong></td></tr><tr><td><code>Item Quantity</code></td><td><code>quantity</code> <strong>[4]</strong></td><td><code>$quantity</code> <strong>[3]</strong></td></tr><tr><td><code>ID de l’article</code></td><td><code>id</code> <strong>[4]</strong></td><td><code>$sku</code> <strong>[3]</strong></td></tr><tr><td><code>Item Name</code></td><td><code>product.name</code> <strong>[4]</strong></td><td><code>$product_name</code> <strong>[3]</strong></td></tr><tr><td><code>Item Brand</code></td><td><code>product.brand</code> <strong>[4]</strong></td><td><code>$product_brand</code> <strong>[3]</strong></td></tr><tr><td><code>Item Category</code></td><td><code>product.category_1</code> <strong>[4]</strong></td><td><code>$product_category</code> <strong>[3]</strong></td></tr><tr><td><code>Item Variant</code></td><td><code>variant</code> <strong>[4]</strong></td><td><code>$product_variant</code> <strong>[3]</strong></td></tr><tr><td><code>Item Rating Average</code></td><td><code>product.rating_average</code> <strong>[4]</strong></td><td><code>$rating_average</code> <strong>[3]</strong></td></tr><tr><td><code>Item Rating Count</code></td><td><code>product.rating_count</code> <strong>[4]</strong></td><td><code>$rating_count</code> <strong>[3]</strong></td></tr><tr><td><code>Item Rating Max</code></td><td><code>product.rating_max</code> <strong>[4]</strong></td><td><code>$rating_max</code> <strong>[3]</strong></td></tr><tr><td><code>Item Creation Timestamp</code></td><td><code>product.creation_timestamp</code> <strong>[4]</strong></td><td><code>$creation_timestamp</code> <strong>[3]</strong></td></tr><tr><td><code>Item Expiration Date</code></td><td><code>product.exp_date</code> <strong>[4]</strong></td><td><code>$exp_date</code> <strong>[3]</strong></td></tr><tr><td><code>Item Keywords</code></td><td><code>product.keywords</code> <strong>[4]</strong></td><td><code>$keywords</code> <strong>[3]</strong></td></tr><tr><td><code>Item Address Street</code></td><td><code>product.address_street</code> <strong>[4]</strong></td><td><code>$address_street</code> <strong>[3]</strong></td></tr><tr><td><code>Item Address City</code></td><td><code>product.address_city</code> <strong>[4]</strong></td><td><code>$address_city</code> <strong>[3]</strong></td></tr><tr><td><code>Item Address Region</code></td><td><code>product.address_region</code> <strong>[4]</strong></td><td><code>$address_region</code> <strong>[3]</strong></td></tr><tr><td><code>Item Address Country</code></td><td><code>product.address_country</code> <strong>[4]</strong></td><td><code>$address_country</code> <strong>[3]</strong></td></tr><tr><td><code>Item Address Postal Code</code></td><td><code>product.address_postal_code</code> <strong>[4]</strong></td><td><code>$address_postal_code</code> <strong>[3]</strong></td></tr><tr><td><code>Item Latitude</code></td><td><code>product.latitude</code> <strong>[4]</strong></td><td><code>$latitude</code> <strong>[3]</strong></td></tr><tr><td><code>Item Longitude</code></td><td><code>product.longitude</code> <strong>[4]</strong></td><td><code>$longitude</code> <strong>[3]</strong></td></tr><tr><td><code>Item Image Captions</code></td><td><code>product.image_captions</code> <strong>[4]</strong></td><td><code>$image_captions</code> <strong>[3]</strong></td></tr><tr><td><code>Item Condition</code></td><td><code>product.condition</code> <strong>[4]</strong></td><td><code>$condition</code> <strong>[3]</strong></td></tr></tbody></table>

{% hint style="info" %}
**1.** Défini dans <mark style="color:bleu;">`user_data`</mark> .\
**2.** Défini dans <mark style="color:bleu;">`event_data`</mark> .\
**3.** Défini dans <mark style="color:bleu;">`content_items.X`</mark> .\
**4.** Défini dans <mark style="color:bleu;">`items.X`</mark> .\
**5.** propriété définie lorsque <mark style="color:bleu;">`context.device.os.name`</mark> est <mark style="color:bleu;">`iOS`</mark> (sans distinction entre majuscules et minuscules).\
**6.** propriété définie lorsque <mark style="color:bleu;">`context.device.os.name`</mark> est <mark style="color:bleu;">`Android`</mark> (sans distinction entre majuscules et minuscules).\
**7.** booléen opposé à <mark style="color:bleu;">`context.device.ad_tracking_enabled`</mark> .
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.commandersact.com/fr/fonctionnalites/destinations/destinations-catalog/branch-events.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
