Tealium

This is the previous version (2.x) of Tealium for Flutter. For the latest version, see Tealium for Flutter.

Class: Tealium

The following summarizes the commonly used methods of the Flutter Tealium class.

addCustomRemoteCommand()

Adds a custom remote command to the remote command manager, backed up by a Tag on Tag Management.

Tealium.addCustomRemoteCommand(id, callback);

Example:

Tealium.addCustomRemoteCommand('CUSTOM_COMMAND_ID', (payload) {
  print(JsonEncoder().convert(payload));
});

addRemoteCommand()

Adds a remote command to the remote command manager.

Tealium.addRemoteCommand(remoteCommand);

Example:

Tealium.addRemoteCommand(RemoteCommand(TealiumFirebase.commandName, path: "firebase.json")); // local
Tealium.addRemoteCommand(RemoteCommand(TealiumFirebase.commandName, url: "www.tealium.com/path_to_remote_command/firebase.json")); // remote
Tealium.addRemoteCommand(RemoteCommand(TealiumFirebase.commandName)); // webview

addToDataLayer()

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

Tealium.addToDataLayer(data, expiry);

clearStoredVisitorIds()

Clears all previously stored visitor IDs and hashed customer identifiers.

Tealium.clearStoredVisitorIds();

getFromDataLayer()

Gets the value for a specified key in the persistent data layer as a callback function.

Tealium.getFromDataLayer(key);

Example:

Tealium.getFromDataLayer('key')
    .then((value) => print('Value From data layer: $value'));

getConsentCategories()

Gets the user’s consented categories.

Tealium.getConsentCategories();

Example:

Tealium.getConsentCategories()
  .then((categories) =>
      print('Consent Categories: ' + categories.join(",")));

getConsentStatus()

Gets the user’s consent status as a callback function.

Tealium.getConsentStatus();

Example:

Tealium.getConsentStatus()
  .then((status) => print('Consent Status: $status'));

getVisitorId()

Gets the user’s visitor ID as a callback function.

Tealium.getVisitorId();

initialize()

Initialize Tealium before calling any other method.

Tealium.initialize(config);

Example:

final config = TealiumConfig(
    'ACCOUNT',
    'PROFILE',
    TealiumEnvironment.dev,
    [
        Collectors.AppData,
        Collectors.DeviceData,
        Collectors.Lifecycle,
        Collectors.Connectivity,
    ],
    [
        Dispatchers.Collect,
        Dispatchers.TagManagement,
        Dispatchers.RemoteCommands,
    ],
    loglevel: LogLevel.DEV,
    consentLoggingEnabled: true,
    consentPolicy: ConsentPolicy.GDPR,
    visitorServiceEnabled: true);

Tealium.initialize(config).then((_) {
    print('Tealium Initialized');
    Tealium.setConsentStatus(ConsentStatus.consented);
    Tealium.setConsentExpiryListener(() => print('Consent Expired'));
});

joinTrace()

Joins a trace with the specified ID. Learn more about Trace.

Tealium.joinTrace(id);

leaveTrace()

Leaves a previously joined traced and ends the visitor session. The trace remains active for the duration of the app session until this method is called.

Tealium.leaveTrace();

removeFromDataLayer()

Remove persistent data that was previously set using addToDataLayer().

Tealium.removeFromDataLayer(keys);

removeRemoteCommand()

Removes a remote command from the remote command manager.

Tealium.removeRemoteCommand(id);

Example:

Tealium.removeRemoteCommand('test_command');

resetVisitorId()

Generates a new visitor ID for the user.

Tealium.resetVisitorId();

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 ConsentStatus.consented. If the consent status is ConsentStatus.consented and no categories are specified with the setConsentCategories() method, then all categories are set.

Tealium.setConsentCategories(categories);

Example:

Tealium.setConsentCategories([ConsentCategories.analytics, ConsentCategories.email]);

Consent categories

The following consent categories are available:

setConsentExpiryListener()

Sets a callback to execute after the user’s consent preferences have expired according the ConsentExpiry.

Tealium.setConsentExpiryListener(callback);

Tealium.setConsentExpiryListener(() {
    print('Consent Expired');
});

setConsentStatus()

Sets the consent status of a user. Default is ConsentStatus.unknown until the status is updated.

Tealium.setConsentStatus(status);

Example:

Tealium.setConsentStatus(ConsentStatus.consented);

Consent status

The following consent statuses are available:

setVisitorIdListener()

Sets a callback to execute when the visitor ID changes.

Tealium.setVisitorIdListener(callback);

Example:

Tealium.setVisitorIdListener((newVisitorId) {
    print(newVisitorId);
});

setVisitorServiceListener()

Sets a callback to execute when the visitor profile is 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 Customer Data Platform (CDP) and you want to use the visitor profile to enhance the user experience in your mobile application. If you are not licensed for Customer Data Platform (CDP), usage of this module is not recommended as no visitor profile is returned.

Tealium.setVisitorServiceListener(callback);

Example:

Tealium.setVisitorServiceListener((profile) {
    print(JsonEncoder().convert(profile));
});

terminateInstance()

Terminates the Tealium instance by disabling the Tealium library and removing all module references. Re-enable by creating a new Tealium instance, if required.

Tealium.terminateInstance();

track()

Tracks a screen view or event with optional event data.

Tealium.track(tealEvent);

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

final tealEvent = TealiumEvent(
  'cart_add',
  {
    'customer_id': 'abc123',
    'product_id': ["PROD123", "PROD456"],
    'product_price': [4.00, 6.00]
  }
);
Tealium.track(tealEvent);

gatherTrackData()

Gathers all data from all collectors and data layer.

Example:

Tealium.gatherTrackData()
  .then((data) => print('Gather track data: $data'));

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(eventName, 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.

final tealEvent = TealiumEvent(eventName, dataLayer);
Tealium.track(tealEvent);

Example:

final tealEvent = TealiumEvent(
  'cart_add',
  {
    '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(viewName, dataLayer) to the track() method. TealiumView consists of a view name, which appears in the tracking call as tealium_event, and an optional data object.

final screenView = TealiumView(viewName, dataLayer);
Tealium.track(screenView);

Example:

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