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 or write custom values, but do not have access to module data.

Set and Get Values

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:

Session Data

Session data values are persisted for the session. A session is determined by user activity within a given time frame. The session expires after 30 minutes of user inactivity.

To persist a data layer value that expires after the session:

tealium?.dataLayer.add(key: "mysessionvar", value: "hello", expiry: .session)

To retrieve all session data:

let sessionData = tealium?.dataLayer.allSessionData

Restart Data

Restart data values are persisted for each event. The data is removed when the app is closed or restarted.

To persist a data layer value until the next app restart:

tealium?.dataLayer.add(key: "myrestartvar", value: "foo", expiry: .untilRestart)

Forever Data

Forever data values are persisted for the lifetime of the current app version. The data is removed from the data layer when the the app is uninstalled or updated.

To persist forever data:

tealium?.dataLayer.add(key: "myforevervar", value: "world", expiry: .forever)

Custom Date Data

Custom date data values are persisted by a specified date.

To persist data layer values with a custom date expiration:

tealium?.dataLayer.add(key: "customdate", value: "bar", expiry: .after(yourDate))

Custom Duration Data

Custom duration data values are persisted by a specified duration of time.

To persist a data layer value for a custom duration:

tealium?.dataLayer.add(key: "lengthoftime", value: "months", expiry: .afterCustom((.months, 1)))

tealium?.dataLayer.add(key: "lengthoftime", value: "days", expiry: .afterCustom((.days, 1)))

Retrieve All Data

To retrieve all of the currently stored data in the data layer:

let data: [String: Any] = tealium?.dataLayer.allEventData

Clear Data

To clear data for specific keys use the following methods:

• Multiple: dataLayer.delete(forKeys:)
• Single: dataLayer.delete(forKey:)

To clear all data, use the dataLayer.deleteAll() method.

Examples

The following example demonstrates the above methods:

class TealiumHelper {
	var tealium: Tealium?

	let config = TealiumConfig(...)

	tealium = Tealium(config: config) { [weak self] _ in
		guard let self = self, let teal = self.tealium else { return }

		// Add data to be sent on each hit until manually cleared
		teal.dataLayer.add(key: "myvarforever", value: 123456) // stored as session data (default)

		// Add data to be sent on each hit for length of session
		teal.dataLayer.add(key: "mysessionvar", value: "hello", expiry: .forever)

		// Add data to persist for 3 months
		teal.dataLayer.add(key: "campaign", value: "summer", expiry: .afterCustom((.months, 3)))

		print("All event data: \(teal.dataLayer.allEventData)")
		print("All event data: \(teal.dataLayer.allSessionData)")
		print("Single event data key `campaign`: \(teal.dataLayer.allEventData["campaign"])")

		// Delete keys
		teal.dataLayer.delete(forKeys: ["myvarforever"])

		// Delete all data
		teal.dataLayer.deleteAll()
	}
}

Module Data

App Data Collector

The following variables are added to the data layer by the AppData module.

Attribution Collector

The following variables are added to the data layer by the Attribution module.

Autotracking Collector

The following variables are added to the data layer by the Autotracking module.

Collect Dispatcher

The following variables are added to the data layer by the Collect dispatcher.

Consent Manager Module

The following variables are added to the data layer by the ConsentManager module if enabled.

Core

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

Crash Collector

The following variables are added to the data layer by the CrashReporter module.

Device Data Collector

The following variables are added to the data layer by the DeviceData module.

Lifecycle Collector

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 module.

Tag Management

The following variables are added to the data layer by the Tag Management module.