# Piano Analytics Collection API

[Piano Analytics](https://piano.io/) est le successeur de AT Internet Analytics Suite 2 (AS2).\
C’est un outil centré sur l’utilisateur qui simplifie les analytics produit et marketing, tout en garantissant la qualité des données.\
Vos données seront envoyées en server-side pour tirer le meilleur parti de Piano Analytics' [Collection API](https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/collection-api) et sous forme de [des événements](https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/standard-events).

{% hint style="info" %}
Le [Collection API](https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/collection-api) est disponible uniquement pour [Piano Analytics](https://developers.atinternet-solutions.com/piano-analytics/#what-is-piano-analytics).\
Vous pouvez consulter le [tableau de compatibilité](https://developers.atinternet-solutions.com/piano-analytics/#before-i-start) pour obtenir davantage de Insights sur les fonctionnalités prises en charge par produit.
{% endhint %}

## Fonctionnalités clés

La destination Piano Analytics Collection 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) correspond à [le one](https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/standard-events), 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 les événements se fait automatiquement, ce qui simplifie les saisies utilisateur.
* **Événements personnalisés**: vous pouvez envoyer librement des événements personnalisés selon vos besoins spécifiques.
* **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 de Piano Analytics est envoyé à Piano Analytics.
* **Identifiant utilisateur**: vous pouvez sélectionner librement un champ d’identifiant utilisateur pour les utilisateurs connectés.
* **Prise en charge des événements autopromo**: incluez des événements autopromo préconfigurés dans vos requêtes. Voir [Autopromo events](#autopromo-events) pour plus de détails.
* **Envoyer toutes les propriétés**: envoyez toutes les propriétés de vos événements à Piano Analytics en un seul clic.

## Configuration de la destination

Avant de commencer avec cette destination, assurez-vous d’avoir accès à [Piano Analytics](https://developers.atinternet-solutions.com/piano-analytics/#what-is-piano-analytics).

{% hint style="info" %}
L’identifiant unique de visiteur côté client est recommandé et est récupéré en prenant la valeur du [**`_pcid`**](https://developers.atinternet-solutions.com/piano-analytics/data-collection/general/cookie-storage#since-670) **,** [**`pa_vid`**](https://developers.atinternet-solutions.com/piano-analytics/data-collection/general/cookie-storage#piano-analytics-mobile-sdks) , [**`atuserid`**](https://developers.atinternet-solutions.com/piano-analytics/data-collection/general/cookie-storage#legacy-cookie-management) , ou <mark style="color:bleu;">**`xtidc`**</mark> cookie dans cet ordre de priorité.
{% endhint %}

### Configuration

<table><thead><tr><th width="283">Paramètres</th><th>Description</th></tr></thead><tbody><tr><td><code>Side Id</code></td><td><em><strong><code>Obligatoire</code></strong></em><br>L’identifiant du site auquel les données appartiennent (ex. <code>628087</code>). Vous pouvez le trouver dans l’interface Piano Analytics en suivant <img src="https://3282103337-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-5aed90690b9e24f27ec864bad486d53d8dda30e9%2F1.png?alt=media" alt=""> ➜ <code>SETTINGS</code> ➜ <code>Data Collection Portal</code> ➜ <code>Tools</code> ➜ <code>Site Management</code> et en sélectionnant votre site. Ce paramètre prend en charge des valeurs dynamiques <strong>[1].</strong></td></tr><tr><td><code>Secured Collection Domain</code></td><td><em><strong><code>Obligatoire</code></strong></em><br>Le domaine SSL sur lequel les informations sont collectées (ex. <code>logs1412.xiti.com</code>). Vous pouvez le trouver dans l’interface Piano Analytics en suivant <img src="https://3282103337-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-5aed90690b9e24f27ec864bad486d53d8dda30e9%2F1.png?alt=media" alt=""> ➜ <code>SETTINGS</code><br><code>Data Collection Portal</code> ➜ <code>Tools</code> ➜ <code>Site Management</code> et en sélectionnant votre site.</td></tr><tr><td><code>User Identifier</code></td><td>Vous pouvez définir votre identifiant utilisateur pour les utilisateurs connectés. Plus de détails sont disponibles en suivant ce <a href="https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/collection-api#users">LIEN</a>.</td></tr><tr><td><code>Custom Property</code></td><td>Lors de la sélection de "[Custom Property]" comme valeur pour le <code>User Identifier</code>, ce champ apparaîtra afin que vous puissiez spécifier un champ personnalisé contenant la valeur de l’identifiant utilisateur <strong>[2]</strong>.</td></tr><tr><td><code>Client Identifier</code></td><td>Vous pouvez définir un identifiant client spécifique comme notre <code>context.device.sdk_id</code> ou une propriété personnalisée contenant sa valeur. Lorsque la valeur "Default" est conservée, ou si les premières options mentionnées ne donnent pas de valeur valide, il s’agit de votre identifiant unique de visiteur côté client provenant des cookies, comme détaillé dans le <a href="#destination-setup">Configuration de la destination</a>. Si aucun cookie n’est disponible, la propriété <code>user.tcId</code> est utilisée. Plus de détails sont disponibles en suivant ce <a href="https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/collection-api#pattern-1">LIEN</a>.</td></tr><tr><td><code>Custom Property</code></td><td>Lors de la sélection de "[Custom Property]" comme valeur pour le <code>Client Identifier</code>, ce champ apparaîtra afin que vous puissiez spécifier un champ personnalisé contenant la valeur de l’identifiant client <strong>[2]</strong>.</td></tr><tr><td><code>Custom Event Mapping:</code><br><code>"view_item" associé</code><br><code>avec Piano</code><br><code>"product.page_display"</code></td><td>L’activation de cette option associera votre <code>view_item</code> event avec Piano <code>product.page_display</code> event. Voir <a href="#quick-reference">Référence rapide</a> pour plus d’informations sur le mapping des events.</td></tr><tr><td><code>Envoyer les événements Autopromo</code></td><td>Cela active les événements autopromo. Voir <a href="#autopromo-events">Autopromo events</a> pour plus de détails.</td></tr><tr><td><code>Envoyer toutes les propriétés</code></td><td>Lors de l’activation de cette option, toutes les propriétés incluses à la racine de vos événements sont également envoyées, <strong>sans aucune modification</strong>, à Piano Analytics dans l’ <mark style="color:bleu;"><code>data</code></mark> object. Plus de détails sont disponibles en suivant ce <a href="https://developers.atinternet-solutions.com/piano-analytics/data-collection/how-to-send-events/collection-api#event-object">LIEN</a>.</td></tr><tr><td><code>Do Not Overwrites</code></td><td>Lorsque <code>Envoyer toutes les propriétés</code> est coché, vous pouvez éviter d’écraser des propriétés déjà définies/présentes.</td></tr><tr><td><code>Propriétés d’événement personnalisées</code></td><td><p>Mappez vos propriétés d’événement personnalisées en définissant leurs noms de champ dans <code>Nom de la propriété Piano Analytics</code> et en ajoutant le nom du champ contenant la valeur dans <code>Your event property</code> . Ex. si vous saisissez <code>size</code> dans la <code>Nom de la propriété Piano Analytics</code> et <code>items.0.product.size</code> dans <code>Your event property</code> , vous aurez une propriété d’event personnalisée dans Piano Analytics appelée <code>size</code> avec une valeur basée sur le contenu du champ <code>items.0.product.size</code> <strong>[2]</strong>.</p><p>Dans la colonne <code>Votre chemin de propriété d’event</code> vous devez conserver la valeur par défaut <code>Default (root)</code> car elle correspond mieux à la plupart des cas. Si vous sélectionnez <code>In "items" {items.X}</code> ou <code>In "product" {items.X.product}</code> cette destination recherchera la propriété d’event en entrée à partir du niveau <a href="https://community.commandersact.com/platform-x/developers/tracking/events-reference#item">items </a>ou <a href="https://community.commandersact.com/platform-x/developers/tracking/events-reference#product">product </a>respectivement et ajoutera ses valeurs comme propriété d’item personnalisée.</p><p><br>Pour que les propriétés d’event personnalisées soient prises en compte par Piano Analytics, vous devez d’abord les créer en suivant <img src="https://3282103337-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-5aed90690b9e24f27ec864bad486d53d8dda30e9%2F1.png?alt=media" alt=""> ➜ <code>SETTINGS</code> ➜ <code>Data Management</code> ➜ <code>Data Model</code> ➜ <code>Properties</code> .</p></td></tr><tr><td><code>Custom User Properties</code></td><td><p>Mappez vos propriétés utilisateur personnalisées en définissant leurs noms de champ dans <code>User property name</code> et en ajoutant le nom du champ contenant la valeur dans <code>Commanders Act event property or static value</code> .<br>Ex. si vous saisissez <code>customer_zipcode</code> dans <code>User property name</code> et <code>user.zipcode</code> <strong>[2]</strong> dans <code>Commanders Act event property or static value</code> , vous aurez une propriété utilisateur personnalisée dans Piano Analytics appelée <code>customer_zipcode</code> avec une valeur basée sur le contenu du champ <code>user.zipcode</code> . Vous avez également la possibilité de définir une valeur statique chaîne/numérique dans <code>Commanders Act event property or static value</code> .<br></p><p>Pour que les propriétés utilisateur personnalisées soient prises en compte par Piano Analytics, vous devez d’abord les créer en suivant <img src="https://3282103337-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-5aed90690b9e24f27ec864bad486d53d8dda30e9%2F1.png?alt=media" alt=""> ➜ <code>SETTINGS</code> ➜ <code>Data Management</code> ➜ <code>Data Model</code> ➜ <code>Properties</code> .</p></td></tr></tbody></table>

{% hint style="info" %}

> **\[1]** Cette fonctionnalité vous permet de définir une propriété d’événement contenant une valeur dynamique en ajoutant deux accolades ouvrantes ( `{{` ) devant le nom de votre propriété et deux accolades fermantes ( `}}` ) à la fin (par ex. `{{myEventPropertyPathAndName}}` ).\
> \&#xNAN;**\[2]** En utilisant des "points" (".") vous pouvez naviguer plus en profondeur vers le champ spécifique dont vous souhaitez obtenir la valeur. Voir [Référence des événements](https://community.commandersact.com/platform-x/developers/tracking/events-reference) pour plus de détails sur les noms de champs standard par event. Vous pouvez aussi définir librement des champs personnalisés : il n’y a aucune limite.
> {% endhint %}

## Référence rapide

{% hint style="info" %}
[Piano Analytics video/audio](https://developers.atinternet-solutions.com/piano-analytics-tagging-en/event-tagging-piano-analytics-en/standard-event-tagging-en/#audio-video_31) events sont pris en charge par [notre event model](https://doc.commandersact.com/developers/tracking/events-reference/video-event-reference).
{% endhint %}

| Événements Commanders Act                                                                                                                                                           | Piano Analytics Events                                                                                                   |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `add_payment_info`                                                                                                                                                                  | `cart.payment`                                                                                                           |
| `add_shipping_info`                                                                                                                                                                 | `cart.delivery`                                                                                                          |
| `add_to_cart`                                                                                                                                                                       | `product.add_to_cart`                                                                                                    |
| `add_to_wishlist`                                                                                                                                                                   | `product.add_to_wishlist` **\[\*]**                                                                                      |
| `begin_checkout`                                                                                                                                                                    | `cart.begin_checkout` **\[\*]**                                                                                          |
| `generate_lead`                                                                                                                                                                     | `generate_lead` **\[\*]**                                                                                                |
| `login`                                                                                                                                                                             | `user.login` **\[\*]**                                                                                                   |
| `page_view`                                                                                                                                                                         | `page.display` ou `product.page_display` **\[1]**                                                                        |
| `purchase`                                                                                                                                                                          | `transaction.confirmation` et `product.purchased` **\[2]**                                                               |
| `refund`                                                                                                                                                                            | `refund` **\[\*]**                                                                                                       |
| `remove_from_cart`                                                                                                                                                                  | `product.remove_from_cart`                                                                                               |
| `search`                                                                                                                                                                            | `internal_search_result.display`                                                                                         |
| `select_content`                                                                                                                                                                    | `select_content` **\[\*]**                                                                                               |
| `select_item`                                                                                                                                                                       | `page.select_item` **\[\*]**                                                                                             |
| `sign_up`                                                                                                                                                                           | `user.sign_up` **\[\*]**                                                                                                 |
| <p><code>video\_ad\_complete</code></p><p><code>video\_ad\_stop</code></p><p><code>video\_complete</code></p><p><code>video\_content\_complete</code></p>                           | `av.stop`                                                                                                                |
| `video_ad_click`                                                                                                                                                                    | `av.ad.click`                                                                                                            |
| <p><code>video\_ad\_playing</code></p><p><code>video\_content\_playing</code></p><p><code>video\_ad\_break\_complete</code></p><p><code>video\_content\_quarter\_reached</code></p> | `av.heartbeat`                                                                                                           |
| <p><code>video\_content\_start</code></p><p><code>video\_ad\_start</code></p><p><code>video\_ad\_break\_start</code></p>                                                            | `av.start`                                                                                                               |
| `video_ad_skip`                                                                                                                                                                     | `av.ad.skip`                                                                                                             |
| `video_buffer_start`                                                                                                                                                                | `av.buffer.start`                                                                                                        |
| `video_buffer_complete`                                                                                                                                                             | `av.buffer.heartbeat`                                                                                                    |
| `video_error`                                                                                                                                                                       | `av.error`                                                                                                               |
| `video_fullscreen_off`                                                                                                                                                              | `av.fullscreen.off`                                                                                                      |
| `video_fullscreen_on`                                                                                                                                                               | `av.fullscreen.on`                                                                                                       |
| `video_pause`                                                                                                                                                                       | `av.pause`                                                                                                               |
| `video_quality`                                                                                                                                                                     | `av.quality`                                                                                                             |
| `video_resume`                                                                                                                                                                      | `av.resume`                                                                                                              |
| `video_seek_start`                                                                                                                                                                  | `av.seek.start`                                                                                                          |
| `video_share`                                                                                                                                                                       | `av.share`                                                                                                               |
| `video_speed`                                                                                                                                                                       | `av.speed`                                                                                                               |
| `video_start`                                                                                                                                                                       | `av.play`                                                                                                                |
| `video_subtitle_off`                                                                                                                                                                | `av.subtitle.off`                                                                                                        |
| `video_subtitle_on`                                                                                                                                                                 | `av.subtitle.on`                                                                                                         |
| `video_volume`                                                                                                                                                                      | `av.volume`                                                                                                              |
| `view_cart`                                                                                                                                                                         | `cart.display`                                                                                                           |
| `view_item`                                                                                                                                                                         | <p><code>product.display</code> <strong>\[3]</strong></p><p><code>product.page\_display</code> <strong>\[3]</strong></p> |
| `view_item_list`                                                                                                                                                                    | `page.view_item_list` **\[\*]**                                                                                          |
| `[Any Other Event]`                                                                                                                                                                 | `[Custom Event]` **\[\*]**                                                                                               |

{% hint style="info" %}

> **\[\*]** Les custom events doivent d’abord être ajoutés au data model de Piano Analytics, sinon ils ne seront pas traités. Vous pouvez ajouter de nouveaux events en suivant ![](https://3282103337-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-5aed90690b9e24f27ec864bad486d53d8dda30e9%2F1.png?alt=media) ➜ `SETTINGS` ➜ `Data Management` ➜ `Data Model` ➜`Events`.\
> \&#xNAN;**\[1]** Si <mark style="color:bleu;">`page_type`</mark> est égal à <mark style="color:bleu;">`product`</mark> alors <mark style="color:bleu;">`product.page_display`</mark> est envoyé, sinon, <mark style="color:bleu;">`page.display`</mark> .\
> \&#xNAN;**\[2]** Un <mark style="color:bleu;">`product.purchased`</mark> sera envoyé pour chaque produit acheté.\
> \&#xNAN;**\[3]** Flagging <mark style="color:bleu;">`Custom Event Mapping: "view_item" associé avec Piano "product.page_display"`</mark> (Voir [Configuration de la destination](#destination-setup)) mappe votre <mark style="color:bleu;">`view_item`</mark> avec Piano <mark style="color:bleu;">`product.page_display`</mark> , sinon votre event sera associé à Piano <mark style="color:bleu;">`product.display`</mark> .
> {% endhint %}

## Mappages des champs

| Propriétés Commanders Act                                                                                                                                                 | Piano Analytics Properties                                                                                          |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `event_timestamp`                                                                                                                                                         | `device_timestamp_utc` **\[1]**                                                                                     |
| `context.page.referrer`                                                                                                                                                   | `previous_url`                                                                                                      |
| `page_name`                                                                                                                                                               | `page`                                                                                                              |
| `value`                                                                                                                                                                   | <p><code>generate\_lead\_value</code></p><p><code>cart\_turnovertaxincluded</code></p>                              |
| `currency`                                                                                                                                                                | <p><code>generate\_lead\_currency</code></p><p><code>cart\_currency</code></p>                                      |
| `id`                                                                                                                                                                      | <p><code>transaction\_id</code></p><p><code>generate\_lead\_id</code></p>                                           |
| `item_list_name`                                                                                                                                                          | `view_item_list_name`                                                                                               |
| `method`                                                                                                                                                                  | <p><code>login\_method</code></p><p><code>sign\_up\_method</code></p>                                               |
| `content_type`                                                                                                                                                            | `content_type`                                                                                                      |
| `item_id`                                                                                                                                                                 | `item_id`                                                                                                           |
| `search_term`                                                                                                                                                             | `ise_keyword`                                                                                                       |
| `items.X.id`                                                                                                                                                              | `product_id` **\[2]**                                                                                               |
| `items.X.product.name`                                                                                                                                                    | `product` **\[2]**                                                                                                  |
| `items.X.variant`                                                                                                                                                         | `product_variant` **\[2]**                                                                                          |
| `items.X.product.brand`                                                                                                                                                   | `product_brand` **\[2]**                                                                                            |
| `(items.X.discount > 0)`                                                                                                                                                  | `product_discount` **\[2]\[3]**                                                                                     |
| `items.X.product.price`                                                                                                                                                   | `product_pricetaxincluded` **\[2]**                                                                                 |
| `items.X.product.currency`                                                                                                                                                | `product_currency` **\[2]**                                                                                         |
| `items.X.product.category_1`                                                                                                                                              | `product_category1` **\[2]**                                                                                        |
| `items.X.product.category_2`                                                                                                                                              | `product_category2` **\[2]**                                                                                        |
| `items.X.product.category_3`                                                                                                                                              | `product_category3` **\[2]**                                                                                        |
| `items.X.product.category_4`                                                                                                                                              | `product_category4` **\[2]**                                                                                        |
| `items.X.quantity`                                                                                                                                                        | <p><code>product\_quantity</code> <strong>\[2]</strong></p><p><code>cart\_quantity</code> <strong>\[4]</strong></p> |
| `items.X.coupon`                                                                                                                                                          | `product_promocode` **\[2]**                                                                                        |
| `coupon`                                                                                                                                                                  | `transaction_promocode`                                                                                             |
| `payment_method`                                                                                                                                                          | `payment_mode`                                                                                                      |
| `shipping_amount`                                                                                                                                                         | `shipping_costtaxincluded`                                                                                          |
| `shipping_tier`                                                                                                                                                           | `shipping_delivery`                                                                                                 |
| `cart_id`                                                                                                                                                                 | `cart_id`                                                                                                           |
| `revenue`                                                                                                                                                                 | `cart_turnovertaxfree`                                                                                              |
| `items.length`                                                                                                                                                            | `cart_nbdistinctproduct`                                                                                            |
| <p><code>user.id</code></p><p><code>user.email</code></p><p><code>user.email\_md5</code></p><p><code>user.email\_sha256</code></p><p><code>\[custom\_property]</code></p> | `user_id` **\[5]**                                                                                                  |
| `context.device.manufacturer`                                                                                                                                             | `device_manufacturer`                                                                                               |
| `context.device.model`                                                                                                                                                    | `device_model`                                                                                                      |
| `context.device.screen.height`                                                                                                                                            | `device_screen_height`                                                                                              |
| `context.device.screen.width`                                                                                                                                             | `device_screen_width`                                                                                               |
| `content_asset_id`                                                                                                                                                        | `av_content_id` **\[6]**                                                                                            |
| `(page.url)` ou `(page.location.href)`                                                                                                                                    | `src_medium` **\[7]**                                                                                               |
| `(page.url)` ou `(page.location.href)`                                                                                                                                    | `src_campaign` **\[8]**                                                                                             |
| `(page.url)` ou `(page.location.href)`                                                                                                                                    | `src_variant` **\[9]**                                                                                              |
| `(page.url)` ou `(page.location.href)`                                                                                                                                    | `src_format` **\[10]**                                                                                              |
| `video_session_id`                                                                                                                                                        | `av_session_id`                                                                                                     |
| `cursor_position * 1000`                                                                                                                                                  | `av_position`                                                                                                       |
| `prev_cursor_position * 1000`                                                                                                                                             | `av_previous_position`                                                                                              |
| `time_prev_event`                                                                                                                                                         | `av_duration`                                                                                                       |
| `prev_event_name`                                                                                                                                                         | `av_previous_event`                                                                                                 |
| `video_title`                                                                                                                                                             | `av_content`                                                                                                        |
| `video_category`                                                                                                                                                          | `av_content_type`                                                                                                   |
| `total_length * 1000`                                                                                                                                                     | `av_content_duration`                                                                                               |
| `content_linked`                                                                                                                                                          | `av_content_linked`                                                                                                 |
| `airdate`                                                                                                                                                                 | `av_publication_date`                                                                                               |
| `keywords`                                                                                                                                                                | `av_content_genre`                                                                                                  |
| `program`                                                                                                                                                                 | `av_show`                                                                                                           |
| `season`                                                                                                                                                                  | `av_show_season`                                                                                                    |
| `episode`                                                                                                                                                                 | `av_episode_id`                                                                                                     |
| `episode_label`                                                                                                                                                           | `av_episode`                                                                                                        |
| `channel`                                                                                                                                                                 | `av_channel`                                                                                                        |
| `publisher`                                                                                                                                                               | `av_author`                                                                                                         |
| `content_version`                                                                                                                                                         | `av_content_version`                                                                                                |
| `content_duration_range`                                                                                                                                                  | `av_content_duration_range`                                                                                         |
| `(livestream)`                                                                                                                                                            | `av_broadcasting_type` **\[11]**                                                                                    |
| `broadcaster_name`                                                                                                                                                        | `av_broadcaster`                                                                                                    |
| `ad_type`                                                                                                                                                                 | `av_ad_type`                                                                                                        |
| `video_player`                                                                                                                                                            | `av_player`                                                                                                         |
| `video_player_version`                                                                                                                                                    | `av_player_version`                                                                                                 |
| `auto_play`                                                                                                                                                               | `av_auto_mode`                                                                                                      |
| `video_language`                                                                                                                                                          | `av_language`                                                                                                       |
| `video_subtitles_language`                                                                                                                                                | `av_subtitles`                                                                                                      |
| `video_launch_reason`                                                                                                                                                     | `av_launch_reason`                                                                                                  |
| `interruption_method`                                                                                                                                                     | `av_player_error`                                                                                                   |
| `seek_position`                                                                                                                                                           | `av_seek_position`                                                                                                  |
| `bitrate`                                                                                                                                                                 | `av_bitrate`                                                                                                        |
| `framerate`                                                                                                                                                               | `av_framerate`                                                                                                      |
| `sound`                                                                                                                                                                   | `av_sound`                                                                                                          |
| `full_screen`                                                                                                                                                             | `av_fullscreen`                                                                                                     |
| `ad_enabled`                                                                                                                                                              | `av_ad_enabled`                                                                                                     |
| `image_quality`                                                                                                                                                           | `av_image_quality`                                                                                                  |
| <p><code>content\_pod\_id</code></p><p><code>ad\_pod\_id</code></p>                                                                                                       | `av_pod_id` **\[6]**                                                                                                |
| `video_description`                                                                                                                                                       | `av_description`                                                                                                    |
| `full_episode`                                                                                                                                                            | `av_full_episode`                                                                                                   |

{% hint style="info" %}

> **\[1]** L’horodatage lié au moment où l’event a eu lieu. Les horodatages à 10 ou 13 chiffres sont pris en charge : avec ce dernier, l’horodatage est converti au format décimal (ex. `1756195156953` est défini comme `1756195156.953` ). Vous pouvez également définir directement le format décimal avec des horodatages à 13 chiffres.\
> \&#xNAN;**\[2]** Champ inclus pour les events suivants : <mark style="color:bleu;">`add_to_cart`</mark> , <mark style="color:bleu;">`page_view (product.page_display)`</mark> , <mark style="color:bleu;">`view_item`</mark> , <mark style="color:bleu;">`purchase (product.purchased)`</mark> , <mark style="color:bleu;">`remove_from_cart`</mark> , <mark style="color:bleu;">`add_to_wishlist`</mark> , et <mark style="color:bleu;">`select_item`</mark> .\
> \&#xNAN;**\[3]** Valeur booléenne : <mark style="color:bleu;">`true`</mark> ou <mark style="color:bleu;">`false`</mark> .\
> \&#xNAN;**\[4]** Additionner tout <mark style="color:bleu;">`items.X.quantity`</mark> .\
> \&#xNAN;**\[5]** Selon la sélection dans la liste déroulante (voir <mark style="color:bleu;">`User Identifier`</mark> dans la[<mark style="color:bleu;">`Configuration`</mark>](#configuration)section), une propriété Commanders Act spécifique est utilisée.\
> \&#xNAN;**\[6]** Champ converti en chaîne de caractères.\
> \&#xNAN;**\[7]** Analysé à partir du <mark style="color:bleu;">`utm_medium`</mark> paramètre dans l’url fournie.\
> \&#xNAN;**\[8]** Analysé à partir du <mark style="color:bleu;">`utm_campaign`</mark> paramètre dans l’url fournie.\
> \&#xNAN;**\[9]** Analysé à partir du <mark style="color:bleu;">`utm_content`</mark> paramètre dans l’url fournie.\
> \&#xNAN;**\[10]** Analysé à partir du <mark style="color:bleu;">`utm_creative_format`</mark> paramètre dans l’url fournie.\
> \&#xNAN;**\[11]** Il s’agit soit de "Live" soit de "Recorded Broadcast".
> {% endhint %}

#### Paramètres des headers

| Propriétés Commanders Act                                          | Piano Analytics Fields |
| ------------------------------------------------------------------ | ---------------------- |
| `device.user_agent`                                                | `User-Agent`           |
| <p><code>page.url</code></p><p><code>page.location.href</code></p> | `Referer`              |
| `device.ip`                                                        | `X-Forwarded-For`      |

## Autopromo events

Lors de l’envoi de [*page\_view*](https://doc.commandersact.com/developers/tracking/events-reference/common-events#page_view) et *click.action* events, vous pouvez ajouter des autopromotions en définissant le champ array `autopromos` . Voir l’exemple suivant :

```json
...
"autopromos": [
        {
          "name": "self_promotion.display",
          "data": {
            "onsitead_type": "Self promotion",
            "onsitead_campaign": "trv_tem",
            "onsitead_category": "opt_tem",
            "onsitead_creation": "https://mysite.com/hp-autopromo.png",
            "onsitead_detailed_placement": "hp_autopromo"
          }
        },
        {
          "name": "self_promotion.display",
          "data": {
            "onsitead_type": "Self promotion",
            "onsitead_campaign": "trv_tem2",
            "onsitead_category": "opt_tem2",
            "onsitead_creation": "https://mysite.com/hp-autopromo-2.png",
            "onsitead_detailed_placement": "hp_autopromo_2"
          }
        }
],
...
```

Chaque position dans l’array doit inclure un event valide Piano Analytics et est transmise telle quelle.\
Dans l’exemple ci-dessus, deux events supplémentaires sont inclus dans une seule requête à Piano Analytics.\
Cette fonctionnalité doit être activée dans le "Advanced Setting" en cochant l’option "Send Autopromo Events" - Voir [Configuration](#configuration) pour plus de détails.
Paramètres	Description
`Side Id`	`Obligatoire` L’identifiant du site auquel les données appartiennent (ex. `628087`). Vous pouvez le trouver dans l’interface Piano Analytics en suivant ➜ `SETTINGS` ➜ `Data Collection Portal` ➜ `Tools` ➜ `Site Management` et en sélectionnant votre site. Ce paramètre prend en charge des valeurs dynamiques [1].
`Secured Collection Domain`	`Obligatoire` Le domaine SSL sur lequel les informations sont collectées (ex. `logs1412.xiti.com`). Vous pouvez le trouver dans l’interface Piano Analytics en suivant ➜ `SETTINGS` `Data Collection Portal` ➜ `Tools` ➜ `Site Management` et en sélectionnant votre site.
`User Identifier`	Vous pouvez définir votre identifiant utilisateur pour les utilisateurs connectés. Plus de détails sont disponibles en suivant ce LIEN.
`Custom Property`	Lors de la sélection de "[Custom Property]" comme valeur pour le `User Identifier`, ce champ apparaîtra afin que vous puissiez spécifier un champ personnalisé contenant la valeur de l’identifiant utilisateur [2].
`Client Identifier`	Vous pouvez définir un identifiant client spécifique comme notre `context.device.sdk_id` ou une propriété personnalisée contenant sa valeur. Lorsque la valeur "Default" est conservée, ou si les premières options mentionnées ne donnent pas de valeur valide, il s’agit de votre identifiant unique de visiteur côté client provenant des cookies, comme détaillé dans le Configuration de la destination. Si aucun cookie n’est disponible, la propriété `user.tcId` est utilisée. Plus de détails sont disponibles en suivant ce LIEN.
`Custom Property`	Lors de la sélection de "[Custom Property]" comme valeur pour le `Client Identifier`, ce champ apparaîtra afin que vous puissiez spécifier un champ personnalisé contenant la valeur de l’identifiant client [2].
`Custom Event Mapping:` `"view_item" associé` `avec Piano` `"product.page_display"`	L’activation de cette option associera votre `view_item` event avec Piano `product.page_display` event. Voir Référence rapide pour plus d’informations sur le mapping des events.
`Envoyer les événements Autopromo`	Cela active les événements autopromo. Voir Autopromo events pour plus de détails.
`Envoyer toutes les propriétés`	Lors de l’activation de cette option, toutes les propriétés incluses à la racine de vos événements sont également envoyées, sans aucune modification, à Piano Analytics dans l’ `data` object. Plus de détails sont disponibles en suivant ce LIEN.
`Do Not Overwrites`	Lorsque `Envoyer toutes les propriétés` est coché, vous pouvez éviter d’écraser des propriétés déjà définies/présentes.
`Propriétés d’événement personnalisées`	Mappez vos propriétés d’événement personnalisées en définissant leurs noms de champ dans `Nom de la propriété Piano Analytics` et en ajoutant le nom du champ contenant la valeur dans `Your event property` . Ex. si vous saisissez `size` dans la `Nom de la propriété Piano Analytics` et `items.0.product.size` dans `Your event property` , vous aurez une propriété d’event personnalisée dans Piano Analytics appelée `size` avec une valeur basée sur le contenu du champ `items.0.product.size` [2]. Dans la colonne `Votre chemin de propriété d’event` vous devez conserver la valeur par défaut `Default (root)` car elle correspond mieux à la plupart des cas. Si vous sélectionnez `In "items" {items.X}` ou `In "product" {items.X.product}` cette destination recherchera la propriété d’event en entrée à partir du niveau items ou product respectivement et ajoutera ses valeurs comme propriété d’item personnalisée. Pour que les propriétés d’event personnalisées soient prises en compte par Piano Analytics, vous devez d’abord les créer en suivant ➜ `SETTINGS` ➜ `Data Management` ➜ `Data Model` ➜ `Properties` .
`Custom User Properties`	Mappez vos propriétés utilisateur personnalisées en définissant leurs noms de champ dans `User property name` et en ajoutant le nom du champ contenant la valeur dans `Commanders Act event property or static value` . Ex. si vous saisissez `customer_zipcode` dans `User property name` et `user.zipcode` [2] dans `Commanders Act event property or static value` , vous aurez une propriété utilisateur personnalisée dans Piano Analytics appelée `customer_zipcode` avec une valeur basée sur le contenu du champ `user.zipcode` . Vous avez également la possibilité de définir une valeur statique chaîne/numérique dans `Commanders Act event property or static value` . Pour que les propriétés utilisateur personnalisées soient prises en compte par Piano Analytics, vous devez d’abord les créer en suivant ➜ `SETTINGS` ➜ `Data Management` ➜ `Data Model` ➜ `Properties` .