Piano Analytics Collection API

Piano Analytics est le successeur de AT Internet Analytics Suite 2 (AS2). C'est un outil centré sur l'utilisateur qui simplifie l'analyse produit et marketing, tout en garantissant la qualité des données. Vos données seront envoyées server-side pour tirer le meilleur parti du Collection API et sous forme de events.

Le Collection API est uniquement disponible pour Piano Analytics. Vous pouvez consulter le compatibility table pour obtenir plus d'informations sur les fonctionnalités prises en charge par produit.

Principales fonctionnalité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 matches Piano Analytics' one, ce qui signifie que vos données sont correctement mappées vers les champs attendus de manière optimisée.

• Mappings préconçus: le mapping des données pour les destinations basées sur des événements se fait automatiquement, ce qui simplifie les saisies utilisateur.

• Custom events: vous pouvez librement envoyer des events personnalisés en fonction de vos besoins spécifiques.

• Prise en charge des données multi-articles: les informations incluses dans le tableau item array is dispatched to Piano Analytics.

• User identifier: vous pouvez choisir librement un champ d'identification utilisateur pour les utilisateurs connectés.

• Support autopromo events: inclure des autopromo events pré-préparés dans vos requêtes. Voir Autopromo events pour plus de détails.

• Send all properties: envoyez toutes les propriétés de vos events à Piano Analytics en un seul clic.

Configuration de la destination

Avant de commencer avec cette destination, assurez-vous d'avoir accès à Piano Analytics.

L'identifiant unique du visiteur côté client est recommandé et est récupéré en obtenant la valeur du _pcid , pa_vid , atuserid , ou xtidc cookie dans cet ordre de priorité.

Configuration

Paramètres	Description
Side Id	Obligatoire L'identifiant du site auquel appartiennent les données (par ex. 628087). Ceci peut être trouvé 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 (par ex. logs1412.xiti.com). Ceci peut être trouvé 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 LINK.
Custom Property	Lorsque vous sélectionnez "[Custom Property]" comme valeur pour le champ ci-dessus 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. En conservant la valeur "Default", 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 LINK.
Custom Property	Lorsque vous sélectionnez "[Custom Property]" comme valeur pour le champ ci-dessus 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" matched with Piano "product.page_display"	Cocher cette option fera correspondre votre view_item event avec Piano product.page_display event. Voir Référence rapide pour plus d'informations sur le mapping des events.
Send Autopromo Events	Cela active les autopromo events. Voir Autopromo events pour plus de détails.
Send All Properties	Lors de l'activation de cette option, toutes les propriétés incluses à la racine de vos events sont également envoyées, without any modificationà Piano Analytics dans le data object. Plus de détails sont disponibles en suivant ce LINK.
Do Not Overwrites	Lorsque Send All Properties 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 champs dans Piano Analytics property name et en ajoutant le nom du champ contenant la valeur dans Your event property . Par ex. si vous saisissez size dans le Piano Analytics property name 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 Your event property path vous devez conserver la valeur par défaut Default (root) car elle convient mieux à la plupart des scénarios. Dans le cas où vous sélectionnez soit Dans "items" {items.X} ou Dans "product" {items.X.product} cette destination recherchera la propriété d'événement d'entrée en partant du niveau items ou product niveau respectivement et ajoutez ses valeurs en tant que propriété d'article personnalisée. Pour garantir que les propriétés d'events 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 champs dans User property name et en ajoutant le nom du champ contenant la valeur dans Commanders Act event property or static value . Par 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 garantir 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 .

[1] Cette fonctionnalité vous permet de définir une propriété d'event 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}} ). [2] En utilisant des "dots" (".") vous pouvez naviguer plus profondément vers le champ spécifique dont vous voulez récupérer la valeur. Voir Référence des événements pour plus de détails sur les noms de champs standard par événement. Vous pouvez également définir librement des champs personnalisés : il n'y a pas de limites.

Référence rapide

Piano Analytics video/audio events are supported by our event model.

Commanders Act Events	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 [*]
video_ad_complete video_ad_stop video_complete video_content_complete	av.stop
video_ad_click	av.ad.click
video_ad_playing video_content_playing video_ad_break_complete video_content_quarter_reached	av.heartbeat
video_content_start video_ad_start video_ad_break_start	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	product.display [3] product.page_display [3]
view_item_list	page.view_item_list [*]
[Any Other Event]	[Custom Event] [*]

[*] Les events personnalisés 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 ➜ SETTINGS ➜ Data Management ➜ Data Model ➜Events. [1] Si page_type est égal à product alors product.page_display est envoyé, sinon, page.display . [2] A product.purchased sera envoyé pour chaque produit acheté. [3] Flagging Custom Event Mapping: "view_item" matched with Piano "product.page_display" (Voir Configuration de la destination) mappe votre view_item with Piano product.page_display , sinon votre event sera associé à Piano product.display .

Mappings de champs

Propriétés Commanders Act	Piano Analytics Properties
event_timestamp	device_timestamp_utc [1]
context.page.referrer	previous_url
page_name	page
value	generate_lead_value cart_turnovertaxincluded
currency	generate_lead_currency cart_currency
id	transaction_id generate_lead_id
item_list_name	view_item_list_name
method	login_method sign_up_method
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	product_quantity [2] cart_quantity [4]
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
user.id user.email user.email_md5 user.email_sha256 [custom_property]	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
content_pod_id ad_pod_id	av_pod_id [6]
video_description	av_description
full_episode	av_full_episode

[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 (par ex. 1756195156953 is set as 1756195156.953 ). Vous pouvez également définir directement le format décimal avec des horodatages à 13 chiffres. [2] Champ inclus pour les events suivants : add_to_cart , page_view (product.page_display) , view_item , purchase (product.purchased) , remove_from_cart , add_to_wishlist , et select_item . [3] Valeur booléenne : true ou false . [4] Somme de tous items.X.quantity . [5] Selon la sélection du menu déroulant (Voir User Identifier dans leConfigurationsection), une propriété Commanders Act spécifique est utilisée. [6] Champ converti en chaîne. [7] Analysé à partir du utm_medium paramètre dans l'url fournie. [8] Analysé à partir du utm_campaign paramètre dans l'url fournie. [9] Analysé à partir du utm_content paramètre dans l'url fournie. [10] Analysé à partir du utm_creative_format paramètre dans l'url fournie. [11] Il s'agit soit de "Live" soit de "Recorded Broadcast".

Headers parameters

Propriétés Commanders Act	Piano Analytics Fields
device.user_agent	User-Agent
page.url page.location.href	Referer
device.ip	X-Forwarded-For

Autopromo events

Lors de l'envoi de page_view et click.action events, vous pouvez ajouter des autopromotions, en définissant le champ array autopromos . Voir l'exemple suivant :

...
"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 du array doit inclure un event Piano Analytics valide et est transmis tel quel. 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 les "Advanced Setting" en cochant l'option "Send Autopromo Events" - Voir Configuration pour plus de détails.