Tealium

Class: Tealium

The following summarizes the commonly used methods and properties of the Tealium class for the NativeScript plugin.

addRemoteCommand()

Adds a remote command to the remote command manager.

Tealium.addRemoteCommand(id, callback);

Example:

Tealium.addRemoteCommand('mycommand', (result: any): void => {
	console.log(result["payload"]["command_id"]);            // logs "mycommand"
	console.log(result["payload"]["my_remote_command_key"]); // logs value for key "my_remote_command_key"
});

addData()

Adds data to the persistent data storage for the given expiration time.

Tealium.addData(data, expiry);

Example:

let data: Map<string, any> = new Map([['test_session_data', 'test']]);
data.set('my_test_value', 1);
data['my_test_value'] = 1;
Tealium.addData(data, Expiry.session);

Expiry

Defines the expiration time for setting a property that expires.

The following expiry options are available:

consentCategories

Gets or sets the user’s consent categories.

To set the user’s consent categories:

Tealium.consentCategories = categories

To get the user’s consent categories:

let categories = Tealium.consentCategories

Example:

Tealium.consentCategories = [ConsentCategories.analytics, ConsentCategories.email];

The following consent categories are available:

consentStatus

Gets or sets the user’s consent status. Default is .unknown until changed.

To set the user’s consent status:

Tealium.consentStatus = status;

To get the user’s consent status:

let status = Tealium.consentStatus

Example:

Tealium.consentStatus = ConsentStatus.consented;

The following consent status are available:

getData()

Retrieves data from the data layer as any type.

let data = Tealium.getData(key);

let data: Tealium.getData("KEY")

initialize()

Initialize Tealium before calling any other method.

Tealium.initialize(config);

Example:

let config: TealiumConfig =
{
	account: 'ACCOUNT',
	profile: 'PROFILE',
	environment: TealiumEnvironment.dev,
	dispatchers: [Dispatchers.Collect,
	 			  Dispatchers.TagManagement,
	  			Dispatchers.RemoteCommands],
	collectors: [Collectors.AppData,
				 Collectors.DeviceData,
				 Collectors.Lifecycle,
				 Collectors.Connectivity],
	consentLoggingEnabled: true,
	consentPolicy: ConsentPolicy.gdpr,
	visitorServiceEnabled: true
};

Tealium.initialize(config);

joinTrace()

Joins a trace with the specified ID. Learn more about the Trace feature in the Tealium Customer Data Hub.

Tealium.joinTrace(id);

Example:

Tealium.joinTrace("abc123xy");

leaveTrace()

A trace remains active for the duration of the app session until the leaveTrace() method is called, which leaves a previously joined trace and ends the visitor session.

Tealium.leaveTrace();

removeData()

Remove persistent data that has been previously set using Tealium.addData().

Tealium.removeData(keys);

Example:

Tealium.removeData(["foo", "bar"]);

gatherTrackData()

Gathers all data from all collectors and data layer.

Example:

Tealium.gatherTrackData((response: Map<string, any>): void => {				
	console.log(response);
});

removeRemoteCommand()

Removes a remote command from the remote command manager.

Tealium.removeRemoteCommand(id);

Example:

Tealium.removeRemoteCommand("test_command");

setVisitorServiceListener()

Defines a callback to execute when the visitor profile has been updated. The updated VisitorProfile is provided in the callback response.

The VisitorService module implements the Data Layer Enrichment feature of the Tealium Customer Data Hub.

Usage of this module is recommended if you are licensed for Tealium AudienceStream and you want to use the visitor profile to enhance the user experience in your mobile application. If you are not licensed for AudienceStream, usage of this module is not recommended as no visitor profile is returned.

Tealium.setVisitorServiceListener(callback);

The following example logs the visitor’s audiences and badges to the console:

Tealium.setVisitorServiceListener(profile => {
    console.log(profile["audiences"]);
    console.log(profile["badges"]);
});

terminateInstance()

Disables the Tealium library and removes all module references. Re-enable by creating a new Tealium instance if required.

Tealium.terminateInstance();

track()

Tracks a screen view or event with optional associated data.

tealium?.track(tealEvent)

To track events, pass an instance of TealiumEvent to the track() method:

let tealEvent = new TealiumEvent(
	"cart_add", 
	new Map([
		[
			"customer_id": "abc123", 
			"product_id": ["PROD123", "PROD456"], 
			"product_price": [4.00, 6.00]
		]
	])
);
Tealium.track(tealEvent);

visitorId

Gets the current visitor ID.

let visitorId = Tealium.visitorId;

Interface: TealiumDispatch

An interface that defines the type of dispatch to be tracked. The following classes implement TealiumDispatch:

Class: TealiumEvent

To track a user’s interaction with a screen or a screen view, pass an instance of TealiumEvent(tealiumEvent, dataLayer) to the Track() method. TealiumEvent consists of an event name, which appears in the tracking call as tealium_event, and an optional data dictionary.

let tealEvent = new TealiumEvent(tealiumEvent, eventData);
Tealium.track(tealEvent);

Example:

let tealEvent = new TealiumEvent(
	"cart_add", 
	new Map([
		[
			"customer_id": "abc123", 
			"product_id": ["PROD123", "PROD456"], 
			"product_price": [4.00, 6.00]
		]
	)
);
Tealium.track(tealEvent);

Class: TealiumView

To track screen views, pass an instance of TealiumView(tealiumEvent, dataLayer) to the Track() method. TealiumView consists of a view name, which appears in the tracking call as tealium_event, and an optional data dictionary.

let screenView = new TealiumEvent(tealiumEvent, eventData);
Tealium.track(screenView);

Example:

let screenView = new TealiumView(
	'purchase', 
	new Map([
		[
			'customer_id', 'abc123', 
			'order_total', 10.00, 
			'product_id', ["PROD123", "PROD456"], 
			'order_id': "0123456789"
		]
	])
);
Tealium.track(screenView);