Overview
Google Analytics tracking is configurable on a license-level: the same Google Analytics Tracking ID will be applied to all your Display instances in the same license, once configured.
Events
All events are tracked to the iPaper Display category in the following format:
gtag('event', [EVENT NAME], {
event_category: 'iPaper Display',
event_action: [ACTION],
event_label: [LABEL],
non_interaction: [IS NON INTERACTIVE]
});
Overview
UA event name | GA4 event name | Interactive 1 | Data 2 | Comments |
---|---|---|---|---|
Instance | ||||
Load | ipd_load | No |
|
– |
Time Spent | ipd_time_spent | No |
|
– |
Button entity | ||||
Button Click | ipd_button_click | Yes |
|
– |
Image entity | ||||
Image Click | ipd_image_click | Yes |
|
– |
Product entity | ||||
Product Click | ipd_product_click | Yes |
|
– |
Instance | ||||
Video Click | ipd_video_click | Yes |
|
Only available for autoplaying video. ActionUrl is only present if the entity has an action assigned to it. |
Video Start | ipd_video_start | Yes |
|
Only available for non-autoplaying video. Fires once per video entity, when a user manually plays video. ActionUrl is only present if the entity has an action assigned to it. |
Video Played 25 Percent | ipd_video_played_25_percent | Yes |
|
Only available for non-autoplaying video. Fires once per video entity, once the timestamp of a video exceeds the stated percentage of its total duration. ActionUrl is only present if the entity has an action assigned to it. |
Video Played 50 Percent | ipd_video_played_50_percent | Yes |
|
|
Video Played 75 Percent | ipd_video_played_75_percent | Yes |
|
|
Video Played 100 Percent | ipd_video_played_100_percent | Yes |
|
Example
For example, when somebody clicks on a button in your Display, we will track it as such via the “Button Click” event:
Universal Analytics (UA):
gtag('event', 'Button Click', {
event_category: 'iPaper Display',
event_action: 'Button Click',
event_label: 'Url: https://wwww.ipaper.io/',
non_interaction: true
});
Google Analytics 4 (GA4):
gtag('event', 'ipd_button_click', {
event_category: 'iPaper Display',
event_action: 'Button Click',
event_label: 'Url: https://wwww.ipaper.io/',
non_interaction: true,
ip_url: 'https://wwww.ipaper.io/'
});
Interactive flag
There are some events that we want to mark as non-interactive (or “non-interaction events” by Google Analytics’ definition). This will mean that even if these events are fired, the session will be considered as bounced if the user does not further interact with the page.
Event labels
The data format below is represented in JSON. It is converted to a string for the eventLabel
object using the following convention:
- Key names are PascalCased
- Key-value pairs are separated by the pipe character
|
Example:
{
Id: [PRODUCT_ENTITY_PRODUCT_ID],
Url: [PRODUCT_ENTITY_PRODUCT_URL]
}
…is converted into:
Id: [PRODUCT_ENTITY_PRODUCT_ID] | Url: [PRODUCT_ENTITY_PRODUCT_URL]