Vitec Visiolink has redefined our tracking. This is to ensure that our standard tracking solution is both efficient and aligned with our vision of tracking on the Modular App platform. While there are fewer standard events now, it does not mean that the amount of events fired and data captured is reduced. For most of our standard events, we will support the same, if not more, tracking possibilities.
Our tracking has been simplified to be more reusable. The parameters will therefore have less explicit naming, which makes them reusable across multiple events.
The purpose of this guide is to explain each event, how it's triggered, and how the event parameters are used. This guide will go through each Event and its Event Parameters. Additionally, User Parameters will be covered. You can find a guide on how to set up your Google Analytics 4 Property here: https://support.visiolink.com/hc/en-us/articles/21345503430034-Guide-Set-up-Custom-Definitions-parameters-in-GA4-Modular-App
Standard Events in Google Analytics 4 for the Modular App:
1. vl_event_download
2. vl_event_publication
3. vl_event_page
4. vl_event_article
5. vl_event_media
6. vl_event_search
7. vl_event_interstital
8. vl_event_hotspot
9. vl_event_module_interaction
This guide is split into 2 sections:
Section 1 - User Parameters
Section 2 - Events
Section 1 - User Parameters
User Parameters are applied to all events are generally parameters that don't change often. There are two tables below for User Parameters. The first table contains the most important User Parameters that we highly recommend to implement. The second table contains the User Parameters needed to fully capture the push token. These should be implemented, if you need the token for sending push messages.
|
Dimension Name |
Description |
Parameter (Code) |
Example value(s) |
|
App_id |
Name of the app/bundle id/application id |
vl_value_app_id |
com.visiolink.vlqa |
|
Client |
Platform: iOS, Android, Desktop, Desktop Web App, Fallback |
vl_value_client |
iOS, Android, Desktop, Desktop Web App, Fallback |
|
Client_id |
Unique hashed id |
vl_value_client_id |
8AA0F2E5-1234-5678-ABCD-E7EEDEE7AA49 |
|
User_id |
Unique id that can be connected through the SSO or just be a hashed id |
user_id |
8AA0F2E5-1234-5678-ABCD-E7EEDEE7AA49 |
|
User_id_source |
Takes the values: Custom, Server or Client - Depends on how the user id is created. |
vl_value_user_id_source |
Custom, Server, Client |
|
Version |
Generic platform version |
vl_value_version |
1.0.0 |
|
Orientation |
Device Orientation: Landscape or Portrait |
vl_value_orientation |
Landscape, Portrait |
User Parameters - Push token
The Push Token is a long string that is split into 8 parts due to the length limitations imposed by Google for User Parameters. The Push Token can be put back together by joining the parameters in the numerical order seen below. The user has to accept tracking to get a Push Token.
|
Dimension Name |
Description |
Scope |
Parameter (Code) |
|
Push_token1 |
Part of the push token |
User |
vl_value_push_token1 |
|
Push_token2 |
Part of the push token |
User |
vl_value_push_token2 |
|
Push_token3 |
Part of the push token |
User |
vl_value_push_token3 |
|
Push_token4 |
Part of the push token |
User |
vl_value_push_token4 |
|
Push_token5 |
Part of the push token |
User |
vl_value_push_token5 |
|
Push_token6 |
Part of the push token |
User |
vl_value_push_token6 |
|
Push_token7 |
Part of the push token |
User |
vl_value_push_token7 |
|
Push_token8 |
Part of the push token |
User |
vl_value_push_token8 |
Section 2 - Events
Download event
Trigger: When a user downloads a publication
Event name: vl_event_download
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB. |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB. |
vl_value_publication_date |
2024-02-01 |
|
Authentication_method |
Contains the method used to download the publication. |
vl_value_authentication_method |
Subscriber, Free, Voucher |
Publication event
Trigger: When a user opens a publication
Event name: vl_event_publication
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB. |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB. |
vl_value_publication_date |
2024-02-01 |
|
Source |
Contains the source of the publication opening. "Where was the publication opened from" |
vl_value_source |
Newest Publication, Archive, Deeplink, Downloads |
|
Section_number |
Number from the section value |
vl_value_section_number |
1, 2, 3 … |
|
Section_name |
Name from the section value |
vl_value_section_name |
Section 1, Section 2, Section 3 … |
Page event
Trigger: When a user is shown a page
Event name: vl_event_page
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB. |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB. |
vl_value_publication_date |
2024-02-01 |
|
Page_number |
Contains the page number |
vl_value_page_number |
1, 2, 3 … |
|
Section_number |
Number from the section value |
vl_value_section_number |
1, 2, 3 … |
|
Section_name |
Name from the section value |
vl_value_section_name |
Section 1, Section 2, Section 3 … |
For the page event we also send an event metric*:
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Duration |
Time spent in seconds |
vl_value_duration |
3, 4, 5 … |
*If the user has spent more than 2 seconds on the page
Article event
Trigger: When a user reads an article by clicking on the article or by zooming or panning on the article. The article event stops if the user zooms out, closes the article, closes the app, or is inactive for more than 2 minutes
Event name: vl_event_article
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB. |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB. |
vl_value_publication_date |
2024-02-01 |
|
Page_number |
Contains the page number |
vl_value_page_number |
1, 2, 3 … |
|
Section_number |
Number from the section value |
vl_value_section_number |
1, 2, 3 … |
|
Section_name |
Name from the section value |
vl_value_section_name |
Section 1, Section 2, Section 3 … |
|
Title |
Article Title from XML |
vl_value_title |
Lorem Ipsum |
|
Category |
Article Category from XML |
vl_value_category |
Local News, Regional News, Sport, Politics |
|
ID |
Article ID from XML |
vl_value_id |
4129799 |
|
Source |
Contains the source of the article event. "Where was the article event triggered from" |
vl_value_source |
Article View, PDF, Search, Article Module, Bookmark, Deeplink |
|
Method |
Contains the method used to trigger the article event. "How was the article event triggered" |
vl_value_method |
Zoom, Click, Swipe |
|
Length |
Article character count |
vl_value_length |
500, 1000, 1500 … |
|
Author |
Article author from XML |
vl_value_author |
Lars Larsen |
|
Save |
Indicates if the article is bookmarked |
vl_value_saved |
True / False |
|
Share |
Indicates if the article was shared |
vl_value_share |
True / False |
|
Search |
Contains the search-word used, if search was used to find the article |
vl_value_search |
Search word |
For the article event we also send an event metric*:
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Duration |
Time spent in seconds |
vl_value_duration |
3, 4, 5 … |
*Starts after 2 seconds to avoid unwanted triggering.
Media event
Trigger: When a user triggers an audio article or a podcast
Event name: vl_event_media
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB. Blank for Podcast. |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB. Blank for Podcast. |
vl_value_publication_date |
2024-02-01 |
|
Page_number |
Contains the page number. Blank for Podcast. |
vl_value_page_number |
1, 2, 3 … |
|
Section_number |
Number from the section value. Blank for Podcast. |
vl_value_section_number |
1, 2, 3 … |
|
Section_name |
Name from the section value. Blank for Podcast. |
vl_value_section_name |
Section 1, Section 2, Section 3 … |
|
Title |
Article Title from XML for Audio Articles. Podcast title for Podcasts. |
vl_value_title |
Lorem Ipsum |
|
Category |
Article Category from XML for Audio Articles. Podcast Feed for Podcasts. |
vl_value_category |
Local News, Regional News, Sport, Politics |
|
ID |
Article ID from XML for Audio Articles. Podcast ID or Podcasts. |
vl_value_id |
4129799 |
|
Source |
Contains the source of the media event. "Where was the media event triggered from" |
vl_value_source |
Article View, PDF, Search, Frontpage, Bookmark, Live News, Podcast |
|
Method |
Contains the media method. "What kind of audio is played" |
vl_value_method |
Narrated, Podcast |
|
Length |
Audio Length |
vl_value_length |
500, 1000, 1500 … |
|
Author |
Article author from XML. Podcast author or Podcasts |
vl_value_author |
Lars Larsen |
For the media event we also send an event metric*:
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Duration |
Time spent in seconds |
vl_value_duration |
3, 4, 5 … |
*Duration stops if the user pauses, closes the player, closes the audio article / podcast, closes the app, or if the audio article / podcast ends
Search event
Trigger: When a user submits a search
Event name: vl_event_search
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Search |
Contains the search word |
vl_value_search |
Lorem Ipsum |
|
Source |
Contains the source for the search. "Where was the search made from" |
vl_value_source |
Archive, Current |
Interstitial event
Trigger: When a user sees or clicks an interstitial
Event name: vl_event_interstitial
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB |
vl_value_publication_date |
2024-02-01 |
|
Section_number |
Number from the section value |
vl_value_section_number |
1, 2, 3 … |
|
Section_name |
Name from the section value |
vl_value_section_name |
Section 1, Section 2, Section 3 … |
|
ID |
Contains the Interstitial name |
vl_value_id |
Interstitial_1 |
|
Click |
True / False whether the interstitial was clicked |
vl_value_click |
True, False |
Hotspot (Clickable ad) event
Trigger: When a user sees or clicks a hotspot (clickable ad)
Event name: vl_event_hotspot
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains prefix, folder id, and publication id. Return as a string separated by a slash "/" (prefix/folder id/publication id). |
vl_value_info |
visiolink/100/1000 |
|
Publication_title |
Contains the publication title as see in the HUB |
vl_value_publication_title |
Visiolink Title - 01/02/2024 |
|
Publication_date |
Contains the publication date as see in the HUB |
vl_value_publication_date |
2024-02-01 |
|
Section_number |
Number from the section value |
vl_value_section_number |
1, 2, 3 … |
|
Section_name |
Name from the section value |
vl_value_section_name |
Section 1, Section 2, Section 3 … |
|
ID |
Contains the hotspot (clickable ad) name |
vl_value_id |
Interstitial_1 |
|
Click |
True / False whether the hotspot (clickable ad) was clicked |
vl_value_click |
True, False |
|
Page_number |
Contains the page number |
vl_value_page_number |
1, 2, 3 … |
Module event
Trigger: When a user clicks a module
Event name: vl_event_module_interaction
|
Parameter Name |
Description |
Parameter (Code) |
Example value(s) |
|
Info |
Contains the module name |
vl_value_info |
Newest Publication, Previous Publications, Current Articles |
Comments