API Reference

Class: Tealium

The following summarizes the commonly used methods of the Tealium class for the Unity library.

AddRemoteCommand()

Adds a remote command to the remote command manager.

TealiumUnityPlugin.AddRemoteCommand(id, callback);

Example:

TealiumUnityPlugin.AddRemoteCommand("firebase", (payload) => {

  string? eventName = (string)payload["firebase_event_name"];
  Dictionary<string, object>? eventProperties =
      (Dictionary<string, object>)payload["firebase_event_properties"];

  if (eventName != null) {
    analytics().logEvent(eventName, eventProperties);
  }
});

AddToDataLayer()

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

TealiumUnityPlugin.AddToDataLayer(data, expiry);

Collectors

Collectors are modules that gather supplemental information from the device and append it to the data layer before it’s transmitted to the Tealium Customer Data Hub. Some collectors are included in the core library, while others are optional and installed as separate modules.

The following table lists the available collectors. Default collectors are denoted by a * next to the collector name.

ConsentExpiry

Defines the consent preferences expiration.

ConsentExpiry(time, unit)

Example:

new ConsentExpiry(90, TimeUnit.Days)

TimeUnit

The following are the time unit values:

ConsentPolicy

Defines the consent policy to adhere to. If no consent policy is defined on the TealiumConfig object, the consent manager is be disabled.

Example:

ConsentPolicy.GDPR

Dispatchers

Dispatchers are modules that send the data from your data layer and send it to a Tealium endpoint. The following dispatchers are currently available:

At least one dispatcher is required. If no dispatchers are specified, your data is not sent to the data layer.

Expiry

Defines the custom data expiration.

Example:

Expiry.session

GatherTrackData()

Gathers all track data from collectors and data layer.

Tealium.GatherTrackData(callback);

Example:

Tealium.GatherTrackData(callback => {
  string? serializedPayload = JsonConvert.SerializeObject(callback);
  if (serializedPayload != null) {
      TealiumLogger.Log($"Track Data: {serializedPayload}");
  }
});

GetFromDataLayer()

Gets the value for a specified key in the persistent data layer, then returns in the form of a callback function.

TealiumUnityPlugin.GetFromDataLayer(key);

Example:

string? stringValue =
    (string)TealiumUnityPlugin.GetFromDataLayer("test_string");

GetConsentCategories()

Gets the user’s consented categories.

TealiumUnityPlugin.GetConsentCategories();

Example:

List<string> caetgories = TealiumUnityPlugin.GetConsentCategories();
TealiumLogger.Log("Consent Categories: ");
caetgories.ForEach(category => TealiumLogger.Log(category.Value + " "));

GetConsentStatus()

Gets the user’s consent status.

TealiumUnityPlugin.GetConsentStatus();

TealiumLogger.Log("Consent Status: "
    + TealiumUnityPlugin.GetConsentStatus().Value);

GetVisitorId()

Gets the user’s visitor ID.

TealiumUnityPlugin.GetVisitorId()

Example:

TealiumLogger.Log("Visitor Id: " + TealiumUnityPlugin.GetVisitorId())

Initialize()

Initialize Tealium before calling any other method. Optionally, pass in an Action<bool> callback that executes after the Tealium’s initialization is complete

TealiumUnityPlugin.Initialize(config, callback);

Example:

private TealiumConfig config =
      new TealiumConfig("tealiummobile",
      "demo",
      TealiumEnvironment.DEV,
      new List<Dispatchers> {
        Dispatchers.TagManagement,
        Dispatchers.Collect,
        Dispatchers.RemoteCommands },
      new List<Collectors> {
        Collectors.AppData,
        Collectors.DeviceData,
        Collectors.Lifecycle,
        Collectors.Connectivity },
      consentPolicy: ConsentPolicy.GDPR,
      consentExpiry: new ConsentExpiry(10, TimeUnit.Minutes));

TealiumUnityPlugin.Initialize(config, success => {
    if (success) {
        TealiumLogger.Log("TealiumUnityPlugin Initialized");
        TealiumUnityPlugin.SetConsentStatus(ConsentStatus.Consented);
        TealiumUnityPlugin.SetConsentExpiryListener(() =>
            TealiumLogger.Log("Consent Expired!!"));
    } else {
        TealiumLogger.Log("TealiumUnityPlugin Failed to Initialize");
    }
});

JoinTrace()()

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

TealiumUnityPlugin.JoinTrace(id);

LeaveTrace()

Leaves an active trace and ends the visitor session. A trace remains active for the duration of the app session until this method is called.

TealiumUnityPlugin.LeaveTrace();

LogLevel

Sets the log level property, which controls how much information is logged, to one of the following values:

Example:

LogLevel.Dev

SetConsentCategories()

Sets the consent categories of a user. Pass in an array of strings to set the categories. Default is an empty array until ConsentStatus is set to .Consented. If the consent status is .Consented and no categories are specified with the SetConsentCategories() method, then all categories are set.

TealiumUnityPlugin.setConsentCategories(categories);

Example:

TealiumUnityPlugin.SetConsentCategories(new List<ConsentCategories>(){ConsentCategories.Analytics, ConsentCategories.Email});

ConsentCategories

SetConsentExpiryListener()

Defines a callback to execute after the user’s consent preferences have expired according the ConsentExpiry. It is recommended to define this listener in the Initialization callback to ensure Tealium is fully initialized.

TealiumUnityPlugin.SetConsentExpiryListener(callback);

Example:

TealiumUnityPlugin.SetConsentExpiryListener(()
    => TealiumLogger.Log("Consent Expired!!"));

SetConsentStatus()

Sets the consent status of a user. Default is .Unknown.

TealiumUnityPlugin.SetConsentStatus(status);

Example:

TealiumUnityPlugin.SetConsentStatus(ConsentStatus.Consented);

ConsentStatus

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.

TealiumUnityPlugin.setVisitorServiceListener(callback);

Example:

TealiumUnityPlugin.setVisitorServiceListener((profile) => {
  string? serializedProfile = JsonConvert.SerializeObject(profile);
  if (serializedProfile != null) {
      TealiumLogger.Log(serializedProfile);
  }
});

RemoveFromDataLayer()

Remove persistent data that has been previously set using TealiumUnityPlugin.AddToDataLayer().

TealiumUnityPlugin.RemoveFromDataLayer(keys);

RemoveRemoteCommand()

Removes a remote command from the remote command manager.

TealiumUnityPlugin.RemoveRemoteCommand(id);

Example:

TealiumUnityPlugin.RemoveRemoteCommand("firebase");

Track()

Track a user’s interaction with a game or a game view.

TealiumUnityPlugin.Track(dispatch);

To track game events, create a TealiumEvent object, and pass it to the track() method:

TealiumEvent event = TealiumEvent('GAME_EVENT_NAME', new Dictionary<string, object> {{"KEY", "VALUE"}});
TealiumUnityPlugin.Track(event);

To track game screen views, create a TealiumView object, and pass it to the track() method:

TealiumView view = new TealiumView("VIEW_NAME", new Dictionary<string, object> {{"KEY", "VALUE"}})
TealiumUnityPlugin.Track(view);

Terminate()

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

TealiumUnityPlugin.Terminate();

VisitorProfile

The visitor profile is an object that contains friendly names for each attribute. There is a currentVisit property that lets you distinguish visitor or visit attribute types. Access each attribute value by ID using a subscript. If the attribute does not exist, null is returned.

Attribute Types

Class: TealiumConfig

The following summarizes the properties of the TealiumConfig class.

Class: TealiumEnvironment

TealiumEnvironment is one of three default environments (Dev, QA, Prod), or may be a custom environment that Tealium publishes to.

Example:

TealiumEnvironment.Dev

The following environments are available:

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 game or game view, pass an instance of TealiumEvent(eventName, dataLayer) to the Track() method. TealiumEvent is comprised of an event name, which appears in the tracking call as tealium_event, and an optional data dictionary.

TealiumEvent(viewName, dataLayer)

Example:

TealiumEvent event = TealiumEvent('EVENT_NAME',
    new Dictionary<string, object> {{"KEY", "VALUE"}});
TealiumUnityPlugin.Track(event);

Class: TealiumView

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

TealiumView(viewName, dataLayer)

Example:

TealiumView view = new TealiumView("VIEW_NAME",
    new Dictionary<string, object> {{"KEY", "VALUE"}})
TealiumUnityPlugin.Track(view);