Piano Analytics Tag Setup Guide | Client-Side Tags

Tag Tips

Use mapping to override the standard config values dynamically.

Tag Configuration

Navigate to the Tag Marketplace to add a new tag. Read the Tag Overview article for general instructions on how to add a tag.

When adding the tag, configure the following settings:

Site ID: AT Internet Site ID.
Collection Domain: AT Internet data collection domain.
Collection Path: AT Internet pixel request URL path.
Add Event URL: Automatically adds a page_url property to all events, containing the URL of the current page. (default is set to withoutQS)
Require Consent: To activate the Consents feature, set the requireConsent variable to true.
Send Event When Optout: Do you want to send events when opted out? (default is true)
Campaign Prefix: Choose with an order of priority the type of campaign to be collected.
Enable UTM Tracking: UTM parameters collected as properties. (default is true)
Queue Name: Use this field to overwrite the default queueName from _pac.
Privacy Default Mode: Select the default mode for privacy: ‘opt-in’, ’essential’, or ‘opt-out’.

Load Rules

Load the tag on all pages or set conditions for when your tag will load. For more information about load rules, see the Load Rules documentation.

Data Mappings

Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings.

The available categories are:

Tag Configuration Parameters

Variable	Type	Description
`site`	String	Site ID
`collectionDomain`	String	Collection domain
`collectionPath`	String	Collection path
`addEventURL`	Boolean	Add event URL
`sendEventWhenOptout`	Boolean	Send event when optout
`campaignPrefix`	String	Campaign prefix
`enableUTMTracking`	Boolean	Enable UTM tracking
`queueName`	String	Queue Name

Conversion Parameters

Variable	Type	Description
`goal_type`	String	Goal type

Page Parameters

Variable	Type	Description
`page`	String	Page
`page_chapter1`	String	Page chapter 1
`page_chapter2`	String	Page chapter 2
`page_chapter3`	String	Page chapter 3

Clicks Parameters

Variable	Type	Description
`click`	String	Click
`click_chapter1`	String	Click chapter 1
`click_chapter2`	String	Click chapter 2
`click_chapter3`	String	Click chapter 3

On Site Ads Parameters

Variable	Type	Description
`onsitead_type` (Required)	String	On Site ad type
`onsitead_advertiser`	String	On Site ad advertiser
`onsitead_campaign`	String	On Site ad campaign
`onsitead_category`	String	On Site ad category
`onsitead_creation`	String	On Site ad creation
`onsitead_detailed_placement`	String	On Site ad detailed placement
`onsitead_format`	String	On Site ad format
`onsitead_general_placement`	String	On Site ad general placement
`onsitead_url`	String	On Site ad URL
`onsitead_variant`	String	On Site ad variant

ISE (Internal Search Engine) Parameters

Variable	Type	Description
`ise_keyword`	String	ISE keyword
`ise_page`	Number	ISE page
`ise_click_rank`	Number	ISE click rank

MV (Multivariate) Testing Parameters

Variable	Type	Description
`mv_creation`	String	MV creation
`mv_test`	String	MV test
`mv_wave`	Number	MV wave

Product Parameters

Variable	Type	Description
`product_id` (Overrides `_cprod`)	Array of strings	Product ID
`product` (Overrides `_cprodname`)	Array of strings	Product label
`product_variant`	String	Product variant
`product_brand` (Overrides `_cbrand`)	Array of strings	Product brand
`product_discount` (Overrides `_cpdisc`)	Array of Booleans	Whether the product is discontinued
`product_pricetaxincluded` (Overrides `_cprice`)	Array of numbers	Price tax included
`product_pricetaxfree`	Number	Price tax free
`product_currency`	String	Currency (ISO 4217)
`product_stock`	Boolean	Whether the product is in stock
`product_quantity` (Overrides `_cquan`)	Array of numbers	Product quantity
`product_category1` (Overrides `_ccat`)	Array of strings	Level 1 category
`product_category2` (Overrides `_ccat2`)	Array of strings	Level 2 category
`product_category3`	String	Level 3 category
`product_category4`	String	Level 4 category
`product_cartcreation`	Boolean	Whether the cart was created by this product addition

Cart Parameters

Variable	Type	Description
`cart_id` (Overrides `_corder`)	String	Cart ID
`cart_currency` (Overrides `_ccurrency`)	String	Cart currency
`cart_turnovertaxincluded`	Number	Turnover tax included
`cart_turnovertaxfree`	Number	Turnover tax free
`cart_creation_utc`	Number	Cart creation date in UTC seconds
`cart_quantity` (Overrides `_ctotal`)	Number	Number of products
`cart_nbdistinctproduct`	Number	Number of distinct products
`cart_version`	Number	New unique version identifier associated with the cart

Transaction Parameters

Variable	Type	Description
`transaction_id`	String	Transaction ID
`transaction_promocode`	Array of strings	Promo code list
`transaction_firstpurchase`	Boolean	Whether this is the first purchase by the customer

Shipping and Payment Parameters

Variable	Type	Description
`shipping_delivery`	String	Shipping type
`shipping_costtaxincluded`	Number	Shipping cost tax included
`shipping_costtaxfree`	Number	Shipping cost tax free
`payment_mode`	String	Payment mode

Users Parameters

Variable	Type	Description
`visitorId`	String	Custom visitor ID (GUID or 16 characters long)
`userId`	String	User ID
`userCategory`	String	User category
`enableStorage`	Boolean	Enable storage

Global Parameters

Variable	Type	Description
`cookieDomain`	String	Domain of cookie deposit
`cookieSameSite`	String	SameSite flag in cookies in client-side
`cookieSecure`	Boolean	Secure flag in cookies in client-side cookies
`encodeStorageBase64`	Boolean	Storage value encode

Privacy and Storage Parameters

Variable	Type	Description
`privacyDefaultMode`	String	Privacy Mode by default
`mode`	String	Consent Mode
`properties`	Object	Properties priority configuration
`consent_events`	Object	Events priority configuration
`storageLifetimePrivacy`	Number	Lifetime storage privacy value
`storageLifetimeUser`	Number	Lifetime storage user value
`storageLifetimeVisitor`	Number	Lifetime storage visitor value
`visitorStorageMode`	String	Relative or fixed cookie lifetime value for visitor

Visitor Policy Parameters

Variable	Type	Description
`isVisitorClientSide`	Boolean	`true`: Cookie deposit is client-side. `false`: Cookie deposit is server-side.

Audio Video Parameters

Variable	Type	Description
`heartbeatDuration`	[Number or Object]	Delay between two heartbeats during playback, minimum delay is 5 sec.
`bufferingHeartbeatDuration`	[Number or Object]	Delay between two heartbeats during buffering, minimum delay is 1 sec.
`av_session_id`	String	Session ID, generated by the SDK
`av_content_id`	String	Content ID
`av_content`	String	Content Label
`av_content_type`	String	Content Type
`av_content_duration`	Number	Content Duration, in milliseconds
`av_content_linked`	String	Linked Content Label
`av_publication_date`	Number	Publication Date, timestamp
`av_content_genre`	Array of strings	Content genres
`av_show`	String	Show Label
`av_show_season`	String	Show Season Label
`av_episode_id`	String	Episode ID
`av_episode`	String	Episode Label
`av_channel`	String	Channel Label
`av_author`	String	Author Name
`av_content_version`	String	Content Version
`av_content_duration_range`	String	Duration range
`av_broadcasting_type`	String	Broadcasting Type
`av_broadcaster`	String	Broadcaster Name
`av_ad_type`	String	Ad type
`av_player`	String	Player label
`av_player_version`	String	Player version
`av_player_position`	String	Player position
`av_auto_mode`	Boolean	Auto play mode
`av_language`	String	Media language
`av_subtitles`	String	Subtitles
`av_launch_reason`	String	Launch reason

Events

To map events, refer to Create an Event Mapping.

Variable	Description
`page.display`	Page display
`click.action`	Click action
`click.navigation`	Click navigation
`click.download`	Click download
`click.exit`	Click exit
`publisher.impression`	Publisher impression
`publisher.click`	Publisher click
`self_promotion.impression`	Self-promotion impression
`self_promotion.click`	Self-promotion click
`internal_search_result.display`	Internal search result display
`internal_search_result.click`	Internal search result display
`mv_test.display`	MV test display
`product.display`	Product display
`product.page_display`	Product page display
`product.add_to_cart`	Product added to cart
`product.remove_from_cart`	Product removed from cart
`product.awaiting_payment`	Product awaiting payment
`product.purchased`	Product purchased
`cart.creation`	Cart created
`cart.display`	Cart display
`cart.update`	Cart updated
`cart.delivery`	Cart delivery
`cart.payment`	Cart payment
`cart.awaiting_payment`	Cart awaiting payment
`transaction.confirmation`	Transaction confirmation
`setUser`	Set user
`getUser`	Get user
`deleteUser`	Delete user
`getSessionID`	Get session ID
`av.play`	AV play
`av.buffer.start`	AV buffer start
`av.buffer.heartbeat`	AV buffer heartbeat
`av.start`	AV start
`av.heartbeat`	AV heartbeat
`av.pause`	AV pause
`av.rebuffer.start`	AV rebuffer start
`av.rebuffer.heartbeat`	AV rebuffer heartbeat
`av.resume`	AV resume
`av.stop`	AV stop
`av.seek.start`	AV seek start
`av.forward`	AV forward
`av.backward`	AV backward
`av.ad.click`	AV ad click
`av.ad.skip`	AV ad skip
`av.error`	AV error
`av.display`	AV display
`av.close`	AV close
`av.volume`	AV volume
`av.subtitle.on`	AV subtitle on
`av.subtitle.off`	AV subtitle off
`av.fullscreen.on`	AV full screen on
`av.fullscreen.off`	AV full screen off
`av.quality`	AV quality
`av.speed`	AV speed
`av.share`	AV share
Custom	custom

Event-specific Parameters

To map events, refer to Create an Event Mapping.

Variable	Description
`page.display`	Page display
`click.action`	Click action
`click.navigation`	Click navigation
`click.download`	Click download
`click.exit`	Click exit
`publisher.impression`	Publisher impression
`publisher.click`	Publisher click
`self_promotion.impression`	Self-promotion impression
`self_promotion.click`	Self-promotion click
`internal_search_result.display`	Internal search result display
`internal_search_result.click`	Internal search result display
`mv_test.display`	MV test display
`product.display`	Product display
`product.page_display`	Product page display
`product.add_to_cart`	Product added to cart
`product.remove_from_cart`	Product removed from cart
`product.awaiting_payment`	Product awaiting payment
`product.purchased`	Product purchased
`cart.creation`	Cart created
`cart.display`	Cart display
`cart.update`	Cart updated
`cart.delivery`	Cart delivery
`cart.payment`	Cart payment
`cart.awaiting_payment`	Cart awaiting payment
`transaction.confirmation`	Transaction confirmation
`setUser`	Set user
`getUser`	Get user
`deleteUser`	Delete user
`getSessionID`	Get session ID
`av.play`	AV play
`av.buffer.start`	AV buffer start
`av.buffer.heartbeat`	AV buffer heartbeat
`av.start`	AV start
`av.heartbeat`	AV heartbeat
`av.pause`	AV pause
`av.rebuffer.start`	AV rebuffer start
`av.rebuffer.heartbeat`	AV rebuffer heartbeat
`av.resume`	AV resume
`av.stop`	AV stop
`av.seek.start`	AV seek start
`av.forward`	AV forward
`av.backward`	AV backward
`av.ad.click`	AV ad click
`av.ad.skip`	AV ad skip
`av.error`	AV error
`av.display`	AV display
`av.close`	AV close
`av.volume`	AV volume
`av.subtitle.on`	AV subtitle on
`av.subtitle.off`	AV subtitle off
`av.fullscreen.on`	AV full screen on
`av.fullscreen.off`	AV full screen off
`av.quality`	AV quality
`av.speed`	AV speed
`av.share`	AV share
Custom	custom