Data Layer

Custom Data

It’s common to need general data layer values on every event. To avoid having to add these values to every tracking call, use the tealium.dataLayer methods to persist data layer values that apply to all tracking calls. Once values are stored, they are automatically included in every tracked event.

Methods provided by tealium.dataLayer are able to read and write custom values, but do not have access to module data.

Set and Get Values

There are several utility methods for setting, getting, and deleting values in the data layer. The methods to set and get custom data layer values are typed, however an untyped method is available if you don’t know the type of the variable stored in the data layer.

For example, to set a string value call putString():

tealium.dataLayer.putString("my_string", "my_string_value")

To get a value without the type specified, call get():

tealium.dataLayer.get("my_string")

Data Types

The data layer supports the following data types:

• Boolean
• String
• Integer
• Long
• Double
• JSONObject
• Array<Boolean>
• Array<String>
• Array<Integer>
• Array<Long>
• Array<Double>

For example, to set a long number value call putLong():

val launchTime = System.currentTimeMillis()
tealium.dataLayer.putLong("launch_time", launchTime)

For example, to set an array of strings call putStringArray():

val lastThreeProductsViewed = arrayOf("SKU-1", "SKU-2", "SKU-3")
tealium.dataLayer.putStringArray("last_three_products", lastThreeProductsViewed)

Data Expiration

Data layer values have an expiration and are removed from the data layer when they expire. When you set a custom data layer value you can optionally set the expiration time for the value. The default expiration length is the current session.

The following expiration types are available:

For example, to set a value to never expire:

val userId = "my_id"
instance.dataLayer.putString("user_id", userId, Expiry.FOREVER)

To explicitly set a value to expire at the end of the current session (the default behavior):

val sessionProductViews = 10
instance.dataLayer.putInt("product_views", sessionProductViews, Expiry.SESSION)

To set a value to expire after one day:

val frequentVisitor = tealium.dataLayer.getBoolean("frequent_visitor") ?: false

tealium.dataLayer.putBoolean("frequent_visitor",
        frequentVisitor,
        Expiry.afterTimeUnit(1, TimeUnit.DAYS))

Examples

For a full list of available methods see Class: DataLayer.

To check if the data layer contains a variable call contains():

tealium.dataLayer.contains("my_string")

To delete a value call remove():

tealium.dataLayer.remove("my_string")

To list all key names in the data layer call keys():

tealium.dataLayer.keys()

To get the number of variables in the data layer, call count():

tealium.dataLayer.count()

To get the expiry time of a variable call getExpiry():

tealium.dataLayer.getExpiry("my_string")

To retrieve all data layer variables call all(), which returns a mapOf():

tealium.dataLayer.all()

To delete all data layer variables call clear():

tealium.dataLayer.clear()

Module Data

App Collector

The following variables are added to the data layer by the App Collector.

Connectivity Collector

The following variables are added to the data layer by the Connectivity Collector.

Device Collector

The following variables are added to the data layer by the Device Collector.

Core

The following variables are added to the data layer by the Core Library.

Lifecycle Module

The following variables are added to the data layer by the Lifecycle Module.

Location Collector

The following variables are added to the data layer by the Location Collector.

Tealium Collector

The following variables are added to the data layer by the Tealium Collector.

Time Collector

The following variables are added to the data layer by the Time Collector.