Piano Analytics Collection API

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

Le Collection API est uniquement disponible pour Piano Analytics. Vous pouvez consulter le tableau de compatibilité suivant tableau de compatibilité pour obtenir davantage d'informations sur les fonctionnalités prises en charge par produit.

Fonctionnalités clés

La destination Piano Analytics Collection API offre les fonctionnalités clés suivantes :

• Structure des événements: notre Référence des événements correspond à celui de Piano Analytics, ce qui signifie que vos données sont correctement reliées aux champs attendus de manière optimisée.

• Mappages prédéfinis: le mapping des données pour les destinations basées sur les événements se fait automatiquement, ce qui simplifie la saisie 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-item: les informations incluses dans le item array est transmis à Piano Analytics.

• Identifiant utilisateur: vous pouvez librement sélectionner 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 événements autopromo 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.

L'identifiant unique de visiteur client-side est recommandé et est récupéré en obtenant la valeur du _pcid , pa_vid , atuserid , ou xtidc cookie dans cet ordre de priorité. Valeur par défaut : user.consistent_anonymous_id. Voir Identifiant client dans Configuration pour personnaliser davantage cette valeur.

Configuration

Paramètres	Description
ID du site	Obligatoire L'identifiant du site auquel appartiennent les données (p. ex. 628087). Vous pouvez le trouver dans l'interface Piano Analytics en suivant ➜ PARAMÈTRES ➜ Portail de collecte de données ➜ Outils ➜ Gestion du site et en sélectionnant votre site. Ce paramètre prend en charge les valeurs dynamiques [1].
Domaine de collecte sécurisé	Obligatoire Le domaine SSL sur lequel les informations sont collectées (p. ex. logs1412.xiti.com). Vous pouvez le trouver dans l'interface Piano Analytics en suivant ➜ PARAMÈTRES Portail de collecte de données ➜ Outils ➜ Gestion du site et en sélectionnant votre site.
Identifiant utilisateur	Vous pouvez définir votre identifiant utilisateur pour les utilisateurs connectés. Plus de détails sont disponibles en suivant ce LIEN.
Propriété personnalisée	Lorsque vous sélectionnez « [Custom Property] » comme valeur pour le champ ci-dessus, Identifiant utilisateurce champ apparaîtra afin que vous puissiez spécifier un champ personnalisé contenant la valeur de l'identifiant utilisateur.
Identifiant client	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 vous conservez la valeur « Default », ou si les premières options mentionnées ne renvoient pas une valeur valide, il s'agit de votre identifiant unique de visiteur client-side 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.
Propriété personnalisée	Lorsque vous sélectionnez « [Custom Property] » comme valeur pour le champ ci-dessus, Identifiant client, ce champ apparaîtra afin que vous puissiez spécifier un champ personnalisé contenant la valeur de l'identifiant client.
Mappage d'événement personnalisé : "view_item" associé à Piano "product.page_display"	En cochant cette option, votre view_item événement sera associé à Piano product.page_display événement. Voir Référence rapide pour plus d'informations sur le mappage des événements.
Envoyer les événements Autopromo	Cela active les événements autopromo. Voir événements autopromo pour plus de détails.
Envoyer toutes les propriétés	Lorsque cette option est activée, toutes les propriétés incluses à la racine de vos événements sont également envoyées, sans aucune modification, à Piano Analytics dans l'objet data . Plus de détails sont disponibles en suivant ce LIEN.
Ne pas écraser	Lorsque Envoyer toutes les propriétés est cochée, vous pouvez éviter d'écraser les 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 propriété Piano Analytics et en ajoutant le nom du champ contenant la valeur dans Votre propriété d'événement . p. ex. si vous saisissez size dans le nom de propriété Piano Analytics et items.0.product.size dans Votre propriété d'événement , vous aurez dans Piano Analytics une propriété d'événement personnalisée appelée size avec une valeur basée sur le contenu du champ items.0.product.size. Dans la colonne Chemin de votre propriété d'événement vous devez conserver la valeur par défaut Default (racine) car cela convient mieux à la plupart des scénarios. Si vous sélectionnez Dans "items" {items.X} ou Dans "product" {items.X.product} cette destination recherchera la propriété d'événement d'entrée à partir du items ou product niveau respectivement et ajoutera ses valeurs comme propriété d'item personnalisée. Pour garantir que les propriétés d'événement personnalisées soient prises en compte par Piano Analytics, vous devez d'abord les créer en suivant ➜ PARAMÈTRES ➜ Gestion des données ➜ Modèle de données ➜ Propriétés .
Propriétés utilisateur personnalisées	Mappez vos propriétés utilisateur personnalisées en définissant leurs noms de champ dans Nom de propriété utilisateur et en ajoutant le nom du champ contenant la valeur dans propriété d'événement Commanders Act ou valeur statique . p. ex. si vous saisissez customer_zipcode dans Nom de propriété utilisateur et user.zipcode dans propriété d'événement Commanders Act ou valeur statique , 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 de chaîne/numérique dans propriété d'événement Commanders Act ou valeur statique . 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 ➜ PARAMÈTRES ➜ Gestion des données ➜ Modèle de données ➜ Propriétés .

Référence rapide

Piano Analytics vidéo/audio les événements sont pris en charge par notre modèle d'événements.

Événements Commanders Act	Événements Piano Analytics
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	transaction.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 événements personnalisés doivent d'abord être ajoutés au modèle de données de Piano Analytics, sinon ils ne seront pas traités. Vous pouvez ajouter de nouveaux événements en suivant ➜ PARAMÈTRES ➜ Gestion des données ➜ Modèle de données ➜Événements. 1. Si page_type est égal à product alors product.page_display est envoyé, sinon, page.display . 2. Un product.purchased sera envoyé pour chaque produit acheté. 3. En cochant Mappage d'événement personnalisé : "view_item" associé à Piano "product.page_display" (Voir Configuration de la destination) associe votre view_item à Piano product.page_display , sinon votre événement sera associé à Piano product.display .

Mappages des champs

Propriétés Commanders Act	Propriétés Piano Analytics
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 page.location.href	src_medium [7]
page.url page.location.href	src_campaign [8]
page.url page.location.href	src_variant [9]
page.url page.location.href	src_format [10]
page.url page.location.href	src_[property] [11]
video_session_id	av_session_id
cursor_position	av_position
prev_cursor_position	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 [12]
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’événement a eu lieu. Les horodatages à 10 ou 13 chiffres sont tous deux pris en charge : dans ce dernier cas, l’horodatage est converti au format décimal (par ex. 1756195156953 est défini comme 1756195156.953 ). Vous pouvez également définir directement le format décimal avec des horodatages à 13 chiffres. 2. Champ inclus pour les événements 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. Additionner tous les items.X.quantity . 5. Selon la sélection dans la liste déroulante (voir la Identifiant utilisateur dans leConfigurationsection), une propriété Commanders Act spécifique est utilisée. 6. Champ converti en chaîne de caractères. 7. Analysé à partir du utm_medium ou at_medium paramètre dans l’url fournie. Le premier paramètre est prioritaire sur le second. 8. Analysé à partir du utm_campaign ou at_campaign paramètre dans l’url fournie. Le premier paramètre est prioritaire sur le second. 9. Analysé à partir du utm_content ou at_variant paramètre dans l’url fournie. Le premier paramètre est prioritaire sur le second. 10. Analysé à partir du utm_creative_format ou at_creative_format paramètre dans l’url fournie. Le premier paramètre est prioritaire sur le second. 11. Analysé à partir du at_[property] paramètre dans l’url fournie. 12. Il s’agit soit de « Live », soit de « Recorded Broadcast ».

Paramètres des en-têtes

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

événements autopromo

Lors de l’envoi d’événements page_view et click.action vous pouvez ajouter des autopromotions en définissant le champ de tableau 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 tableau doit inclure un événement Piano Analytics valide et est transmis tel quel. Dans l’exemple ci-dessus, deux événements 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 pour plus de détails.