> 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 connu sous le nom de Branch Metrics) est une société de logiciels mobiles spécialisée dans le deep linking mobile et l’attribution. Cette intégration permet [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 fonctionnalités clés suivantes :

* **Structure des événements**: notre [Référence des événements](https://doc.commandersact.com/developers/tracking/events-reference) correspond à Branch [standard](https://help.branch.io/developers-hub/reference/logstandardevents) et [événements personnalisés](https://help.branch.io/developers-hub/reference/logcustomevents), ce qui signifie que vos données sont correctement reliées aux champs attendus de manière optimisée.
* **Mappages prédéfinis**: le mappage des données pour les destinations basées sur des événements se fait automatiquement, ce qui simplifie la saisie utilisateur.
* **Données affinées** : vous pouvez ajouter librement des informations supplémentaires selon vos besoins spécifiques (par ex. en ajoutant des événements personnalisés et des propriétés d’événement personnalisées).
* **Smart Mapping**: le mappage des données peut être réajusté à l'aide de vos champs définis dans le data layer.
* **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-items** : les informations incluses dans le [item](https://doc.commandersact.com/developers/tracking/events-reference#item) le tableau est envoyé à Branch.

## Configuration de la destination

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

### Configuration

<table><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 et obtenue en accédant à votre <a href="https://help.branch.io/using-branch/docs/profile-settings">Paramètres du compte</a>.</td></tr><tr><td><code>Schéma de contenu</code></td><td>Catégorie/Schéma pour le contenu inclus.</td></tr><tr><td><code>Propriétés d'événements personnalisées</code></td><td>Associez vos propriétés d'événements personnalisées en définissant leurs noms de champ dans <code>Nom de propriété Branch</code> et en ajoutant le nom du champ contenant la valeur dans <code>Votre propriété d'événement</code>.</td></tr><tr><td><code>Mappage des événements</code></td><td>Modifiez le mappage standard (voir <a href="#quick-reference">Référence rapide</a>) entre les événements de Branch et les vôtres, ou ajoutez de nouveaux mappages.</td></tr></tbody></table>

## Référence rapide

| Propriétés Commanders Act   | Branch Events               |
| --------------------------- | --------------------------- |
| `achieve_level`             | `ACHIEVE_LEVEL`             |
| `add_payment_info`          | `ADD_PAYMENT_INFO`          |
| `add_to_cart`               | `ADD_TO_CART`               |
| `add_to_wishlist`           | `ADD_TO_WISHLIST`           |
| `begin_checkout`            | `INITIATE_PURCHASE`         |
| `click_ad`                  | `CLICK_AD`                  |
| `complete_stream`           | `COMPLETE_STREAM`           |
| `complete_tutorial`         | `COMPLETE_TUTORIAL`         |
| `generate_lead`             | `COMPLETE_REGISTRATION`     |
| `initiate_stream`           | `INITIATE_STREAM`           |
| `invite`                    | `INVITE`                    |
| `login`                     | `LOGIN`                     |
| `purchase`                  | `PURCHASE`                  |
| `rate`                      | `RATE`                      |
| `search`                    | `SEARCH`                    |
| `share`                     | `SHARE`                     |
| `start_trial`               | `START_TRIAL`               |
| `spend_credits`             | `SPEND_CREDITS`             |
| `subscribe`                 | `SUBSCRIBE`                 |
| `unlock_achievement`        | `UNLOCK_ACHIEVEMENT`        |
| `view_ad`                   | `VIEW_AD`                   |
| `view_cart`                 | `VIEW_CART`                 |
| `view_item`                 | `VIEW_ITEM`                 |
| `view_items`                | `VIEW_ITEMS`                |
| `[Tout événement]` **\[1]** | `[Tout événement]` **\[1]** |

{% hint style="info" %}
**1.** Voir <mark style="color:bleue;">`Mappage des événements`</mark> dans [Configuration](#configuration) pour plus de détails.
{% endhint %}

## Mappages de champs

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

{% 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="404.6685580062746">Propriétés Commanders Act</th><th>Propriétés Branch</th></tr></thead><tbody><tr><td><code>Branch Key</code></td><td><code>branch_key</code></td></tr><tr><td><code>partners.branch.event_alias</code></td><td><code>customer_event_alias</code></td></tr><tr><td><code>context.device.os.name</code></td><td><code>os</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.os.version</code></td><td><code>os_version</code> <strong>[1]</strong></td></tr><tr><td><code>partners.branch.env</code></td><td><code>environment</code> <strong>[1]</strong></td></tr><tr><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>partners.branch.hardware_id</code></td><td><code>android_id</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.idfv</code></td><td><code>idfv</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.ad_tracking_enabled</code></td><td><code>limit_ad_tracking</code> <strong>[1][7]</strong></td></tr><tr><td><code>context.device.user_agent</code></td><td><code>user_agent</code> <strong>[1]</strong></td></tr><tr><td><code>partners.branch.fingerprint_id</code></td><td><code>browser_fingerprint_id</code> <strong>[1]</strong></td></tr><tr><td><code>context.page.url</code></td><td><code>http_origin</code> <strong>[1]</strong></td></tr><tr><td><code>context.page.referrer</code></td><td><code>http_referrer</code> <strong>[1]</strong></td></tr><tr><td><code>user.id</code></td><td><code>developer_identity</code> <strong>[1]</strong></td></tr><tr><td><code>user.country</code></td><td><code>country</code> <strong>[1]</strong></td></tr><tr><td><code>context.page.lang</code></td><td><code>language</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.ip</code></td><td><code>ip</code> <strong>[1]</strong></td></tr><tr><td><code>partners.branch.local_ip</code></td><td><code>local_ip</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.manufacturer</code></td><td><code>brand</code> <strong>[1]</strong></td></tr><tr><td><code>partners.branch.device_token</code></td><td><code>randomized_device_token</code> <strong>[1]</strong></td></tr><tr><td><code>context.app.version</code></td><td><code>app_version</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.model</code></td><td><code>model</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.screen.density</code></td><td><code>screen_dpi</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.screen.width</code></td><td><code>screen_width</code> <strong>[1]</strong></td></tr><tr><td><code>context.device.screen.height</code></td><td><code>screen_height</code> <strong>[1]</strong></td></tr><tr><td><code>partners.branch.dma_eea</code></td><td><code>dma_eea</code> <strong>[1]</strong></td></tr><tr><td><code>partners.branch.dma_ad_pers</code></td><td><code>dma_ad_personalization</code> <strong>[1]</strong></td></tr><tr><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</code></td><td><code>transaction_id</code> <strong>[2]</strong></td></tr><tr><td><code>revenu</code></td><td><code>revenu</code> <strong>[2]</strong></td></tr><tr><td><code>devise</code></td><td><code>devise</code> <strong>[2]</strong></td></tr><tr><td><code>shipping_amount</code></td><td><code>shipping</code> <strong>[2]</strong></td></tr><tr><td><code>tax_amount</code></td><td><code>tax</code> <strong>[2]</strong></td></tr><tr><td><code>coupon</code></td><td><code>coupon</code> <strong>[2]</strong></td></tr><tr><td><code>type</code></td><td><code>affiliation</code> <strong>[2]</strong></td></tr><tr><td><code>event_name</code></td><td><code>description</code> <strong>[2]</strong></td></tr><tr><td><code>search_query</code></td><td><code>search_term</code> <strong>[2]</strong></td></tr><tr><td><code>Schéma de contenu</code></td><td><code>$content_schema</code> <strong>[3]</strong></td></tr><tr><td><code>item_title</code> <strong>[4]</strong></td><td><code>$og_title</code> <strong>[3]</strong></td></tr><tr><td><code>product.image_url</code> <strong>[4]</strong></td><td><code>$og_image_url</code> <strong>[3]</strong></td></tr><tr><td><code>product.canonical_identifier</code> <strong>[4]</strong></td><td><code>$canonical_identifier</code> <strong>[3]</strong></td></tr><tr><td><code>product.publicly_indexable</code> <strong>[4]</strong></td><td><code>$publicly_indexable</code> <strong>[3]</strong></td></tr><tr><td><code>product.locally_indexable</code> <strong>[4]</strong></td><td><code>$locally_indexable</code> <strong>[3]</strong></td></tr><tr><td><code>product.price</code> <strong>[4]</strong></td><td><code>$price</code> <strong>[3]</strong></td></tr><tr><td><code>quantity</code> <strong>[4]</strong></td><td><code>$quantity</code> <strong>[3]</strong></td></tr><tr><td><code>ID</code> <strong>[4]</strong></td><td><code>$sku</code> <strong>[3]</strong></td></tr><tr><td><code>product.name</code> <strong>[4]</strong></td><td><code>$product_name</code> <strong>[3]</strong></td></tr><tr><td><code>product.brand</code> <strong>[4]</strong></td><td><code>$product_brand</code> <strong>[3]</strong></td></tr><tr><td><code>product.category_1</code> <strong>[4]</strong></td><td><code>$product_category</code> <strong>[3]</strong></td></tr><tr><td><code>variant</code> <strong>[4]</strong></td><td><code>$product_variant</code> <strong>[3]</strong></td></tr><tr><td><code>product.rating_average</code> <strong>[4]</strong></td><td><code>$rating_average</code> <strong>[3]</strong></td></tr><tr><td><code>product.rating_count</code> <strong>[4]</strong></td><td><code>$rating_count</code> <strong>[3]</strong></td></tr><tr><td><code>product.rating_max</code> <strong>[4]</strong></td><td><code>$rating_max</code> <strong>[3]</strong></td></tr><tr><td><code>product.creation_timestamp</code> <strong>[4]</strong></td><td><code>$creation_timestamp</code> <strong>[3]</strong></td></tr><tr><td><code>product.exp_date</code> <strong>[4]</strong></td><td><code>$exp_date</code> <strong>[3]</strong></td></tr><tr><td><code>product.keywords</code> <strong>[4]</strong></td><td><code>$keywords</code> <strong>[3]</strong></td></tr><tr><td><code>product.address_street</code> <strong>[4]</strong></td><td><code>$address_street</code> <strong>[3]</strong></td></tr><tr><td><code>product.address_city</code> <strong>[4]</strong></td><td><code>$address_city</code> <strong>[3]</strong></td></tr><tr><td><code>product.address_region</code> <strong>[4]</strong></td><td><code>$address_region</code> <strong>[3]</strong></td></tr><tr><td><code>product.address_country</code> <strong>[4]</strong></td><td><code>$address_country</code> <strong>[3]</strong></td></tr><tr><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>product.latitude</code> <strong>[4]</strong></td><td><code>$latitude</code> <strong>[3]</strong></td></tr><tr><td><code>product.longitude</code> <strong>[4]</strong></td><td><code>$longitude</code> <strong>[3]</strong></td></tr><tr><td><code>product.image_captions</code> <strong>[4]</strong></td><td><code>$image_captions</code> <strong>[3]</strong></td></tr><tr><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:bleue;">`user_data`</mark> .\
**2.** Défini dans <mark style="color:bleue;">`event_data`</mark> .\
**3.** Défini dans <mark style="color:bleue;">`content_items.X`</mark> .\
**4.** Défini dans <mark style="color:bleue;">`items.X`</mark> .\
**5.** propriété définie lorsque <mark style="color:bleue;">`context.device.os.name`</mark> est <mark style="color:bleue;">`iOS`</mark> (insensible à la casse).\
**6.** propriété définie lorsque <mark style="color:bleue;">`context.device.os.name`</mark> est <mark style="color:bleue;">`Android`</mark> (insensible à la casse).\
**7.** opposé booléen de <mark style="color:bleue;">`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 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/branch-events.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.