This article provides an overview of the Tealium Events Extension, a new way to standardize event conditions in your iQ account. The extension introduces a new built-in variable called
tealium_event to uniquely identify standard events.
In this article:
This extension introduces standardized event names into your solution, along with a new variable in your data layer called
tealium_event. It covers the standard e-commerce customer journey and includes familiar events such as "Add to Cart", "Product Detail Page View", and "Purchase Complete". Since these events are typically represented in the data layer using
event_name, this extension acts as a translation between your current page/event tracking conditions and the new standardized Tealium event names.
Each event can be assigned to a custom condition that matches your data layer implementation. When an event condition evaluates to true,
tealium_event is set to the pre-defined event value. For example, when the condition for "Add to Cart" evalutes to "true",
tealium_event will be set to “cart_add”. See below for the list of standard events.
The goal of the extension is to standardize the event name value into the
tealium_event variable used in your configuration. Here are some uses for this variable:
Tag configurations that support page and event mappings can be simplified by using a single variable,
tealium_event, to configure these events.
Load Rules can use
tealium_event to simplify their conditions.
If you have the Tealium Collect tag all the variables in your data layer will be passed along to the UDH, including
tealium_event. This variable is made available as an imported Event Attribute in UDH and can be used in enrichments, rules, and feeds.
Below is a table of standard events and default conditions in the Extension. Events are listed in alphabetical order and are evaluated sequentially. The default conditions match our standard data layer recommendations, but they can be customized to match your exact implementation.
|Add to Cart||cart_add||event_name EQUALS "cart_add"|
|Category Page View||category_view||page_type EQUALS "category"|
|Checkout||checkout||page_type EQUALS "checkout"|
|Email Signup||email_signup||event_name EQUALS "email_signup"|
|Empty cart||cart_empty||event_name EQUALS "cart_empty"|
|Page View||page_view||page_type EQUALS "generic"|
|Product Detail Page View||product_view||page_type EQUALS "product"|
|Purchase Complete||purchase||page_type EQUALS "purchase"|
|Remove from Cart||cart_remove||event_name EQUALS "cart_remove"|
|Search Page View||search||page_type EQUALS "search"|
|Shopping Cart View||cart_view||page_type EQUALS "cart"|
|Social Share||social_share||event_name EQUALS "social_share"|
|User Log in||user_login||event_name EQUALS "user_login"|
|User Log out||user_logout||event_name EQUALS "user_logout"|
|User Register||user_register||event_name EQUALS "user_register"|
tealium_event value is always set for the condition that last evaluated to "true". If more than one event condition evaluates to "true", the event lower in the list will be set.
This extension is located in the "Events" tab of the Extension modal. Once the extension is added, set the following fields:
The Execution dropdown requires the latest utag version, or v 4.38 at minimum.
You may customize event conditions according to your implementation needs. The list of events cannot be changed--only the event conditions. To customize an event condition:
To prevent an event from being set, remove the condition and click Apply. This will change the event from being "Set" to "Not Set" and it will no longer be evaluated in your configuration.
In this example the condition for the "Email Signup" event has been removed, resulting in the event to be "Not Set".
The Tealium Events extension provides a list of predefined events. A custom event uses a value defined by you and assigned to the variable
tealium_event. Custom events can be defined directly in your data layer or by using the Set Data Values extension.
Custom events defined in an extension should be positioned after the Tealium Events extension.
To define a custom event using an extension:
Example of custom event using the Set Data Values extension: