Setting up Adobe Analytics integration
Publitas integrates with Adobe Analytics, allowing you to track events in publications and save the event data in Adobe Analytics. Below you can find the most important details on how to set up the integration.
Overview
The Adobe Logger integration uses Adobe Launch (formerly DTM) to handle event tracking. The system triggers events using the standard satellite tracking method:
_satellite.track(eventCategory, eventPayload);
where:
-
eventCategory: Maps to a Direct Call Rule in Adobe Launch
- eventPayload: a JSON object containing data.
Event categories
These categories correspond to Direct Call Rules configure in Adobe Launch
|
Event Category |
Triggered By |
|
pbl_page_view |
Page/product view (state change) |
|
pbl_user_navigation |
Page turns, overview, jumps, banners, search results |
|
pbl_link_click |
Product CTA, hotspots, home button, external links |
|
pbl_image_view |
Image popup, carousel navigation |
|
pbl_file_download |
PDF download |
|
pbl_share |
Share publication or product |
|
pbl_share_favorites |
Share favorites via email/WhatsApp |
|
pbl_search |
Search performed |
|
pbl_add_to_favorites |
Add product to favorites |
|
pbl_remove_from_favorites |
Remove product from favorites |
|
pbl_video_start |
Video played |
|
pbl_add_to_shopping_list |
Add to shopping list |
|
pbl_remove_from_shopping_list |
Remove from shopping list |
|
pbl_checkout_shopping_list |
Checkout shopping list |
|
pbl_subset |
Subset created |
Payload attributes
These attributes are included in the payload for every event.
|
Payload Key |
Source |
Description |
|
groupTitle |
metaData.groupTitle |
Publication group name |
|
collectionTitle |
metaData.collectionTitle |
Collection name |
|
publicationTitle |
config.publicationOriginalTitle |
Publication title |
|
pages |
Reader.instance.currentState().pages |
Current page(s), e.g., "1-2" |
|
eventAction |
varies |
Specific action type (see mapping table) |
|
eventValue |
varies |
Primary value (URL, page number, title, etc.) |
These attributes are included only when a product is involved in the interaction.
|
Payload Key |
Source |
Used In |
|
productTitle |
product.title |
CTA clicks, hotspots, shares, favorites, videos |
|
productSku |
product.webshopIdentifier |
Same as above |
Rich product tracking
The logger can support extended product attributes via rich product tracking object. This allows you to map properties from data.productContext to custom payload keys dynamically. Here is an example of the configuration, which can be added to your custom code injection in your account or groups:
<script>
window.RICH_PRODUCT_TRACKING = {
'price':'price',
'sales_price': 'discountedPrice',
'discount_percent': 'customLabel0',
'product_category': 'productType'
}
</script>
Adobe Launch Rule Configuration
In Adobe Launch, you need to create Direct Call Rules for each event category and map the payload attributes (event.detail) to Adobe Analytics variables.
Here is an example configuration for Page View
-
Rule name: pbl_page_view
- Condition: Direct Call string = "pbl_page_view"
- Actions:
// Set Variables Action
s.pageName = %event.detail.publicationTitle%
s.eVar1 = %event.detail.groupTitle%
s.eVar2 = %event.detail.pages%
s.eVar10 = %event.detail.productSku%
s.events = "event1"
// Send Beacon Action
s.t() // or s.tl() depending on context
Complete event mapping table
This table details how internal user actions map to specific Analytics events and values.
|
Internal Action |
Event Category |
Event Action |
Event Value |
Extra Attributes |
|
State Change |
pbl_page_view |
page view |
publication title |
productTitle, productSku, productContext |
|
Change Spread (Overview) |
pbl_user_navigation |
page overview |
target page |
— |
|
Change Spread (Flip) |
pbl_user_navigation |
direction |
target page |
— |
|
Click Product CTA |
pbl_link_click |
product cta |
URL |
productTitle, productSku |
|
Click Hotspot (Page Ref) |
pbl_user_navigation |
page-jump hotspot |
page number |
— |
|
Click Hotspot (Link) |
pbl_link_click |
link hotspot |
URL |
— |
|
Click Hotspot (Product) |
pbl_link_click |
product hotspot |
webshop URL |
productTitle, productSku |
|
Click Hotspot (Image) |
pbl_image_view |
image popup |
image URL |
— |
|
Click Hotspot (Slideshow) |
pbl_image_view |
carousel navigation |
image URL |
— |
|
Click Menu Item (Home) |
pbl_link_click |
home button |
URL |
— |
|
Click Menu Item (PDF) |
pbl_file_download |
pdf download |
current URL |
— |
|
Share (Product) |
pbl_share |
product share |
product title |
productTitle, productSku, channel |
|
Share (Page) |
pbl_share |
share |
current URL |
channel |
|
Do Search |
pbl_search |
search performed |
search text |
— |
|
Video Played |
pbl_video_start |
video played |
video URL |
productTitle, productSku, method |
|
Add Favorite |
pbl_add_to_favorites |
add |
title |
productTitle, productSku |
|
Remove Favorite |
pbl_remove_from_favorites |
remove |
title |
pbl_product_title, pbl_product_id |
|
Send Favorites |
pbl_share_favorites |
share via email |
SKU array |
— |
|
Add Shopping List |
pbl_add_to_shopping_list |
add |
title |
pbl_product_title, pbl_product_id |
|
Remove Shopping List |
pbl_remove_from_shopping_list |
remove |
title |
pbl_product_title, pbl_product_id |
|
Send Shopping List |
pbl_checkout_shopping_list |
checkout via email |
SKU array |
— |
|
Subset Created |
pbl_subset |
created |
subset token |
— |
Note: Your Adobe Analytics instance might be configured differently depending on your account and setup you are using. For steps on how to add customize your Adobe Analytics account, please refer to Adobe Analytics documentation.