• Platforms
  • Partners
  • Forums
  • 日本語
  • TLC Tealium Learning Center Tealium Learning
    Community
  • Discussions & Ideas Dicussions & Ideas
  • Product Guides Product Guides
  • Knowledge Base Knowledge Base
  • Developer Docs Developer Docs
  • Education Education
  • TLC Blog TLC Blog
  • Support Desk Support Desk
  • CDH Customer Data Hub Customer Data Hub
  • Mobile
  • Getting Started
    • Overview
    • Quick Start Guide
    • Mobile Concepts
    • Client-Side
    • Server-Side
    • Tracking Webviews
    • Data Layer
    • Consent Management
    • Event Batching
    • User Location and Geofencing
    • Media Tracking
    • Deep Links
    • Timed Events
    • Trace
    • Hosted Data Layer
    • Adobe Visitor Service Module
    • Feature Comparison
    • Troubleshooting
  • Remote Commands
    • Overview
    • How It Works
    • Integrations
      • Adjust
      • AppsFlyer
      • Branch
      • Braze
      • Contentsquare
      • Facebook
      • Firebase
      • Kochava
      • Usabilla
  • Android (Java)
    • Overview
    • Install
    • Track
    • Data Layer
    • Data Management
    • Consent Management
    • Module List
      • Ad Identifier Module
      • Crash Reporter Module
      • Install Referrer Module
      • Lifecycle Tracking Module
      • Location Module
      • Optimizely X Tracking Module
    • Android TV
    • Android Wear
    • API Reference
      • ConsentManager
      • DataSources
      • Lifecycle
      • Tealium
      • Tealium.Config
      • TealiumLocation
    • Release Notes
  • Android (Kotlin)
    • Overview
    • Install
    • Track
    • Data Layer
    • Consent Management
    • Identity Resolution
    • Module List
      • Ad Identifier Module
      • AutoTracking Module
      • AdobeVisitorService Module
      • Collect Module
      • Collectors Module
      • Crash Reporter Module
      • In-App Purchase Module
      • Install Referrer Module
      • Lifecycle Tracking Module
      • Location Manager Module
      • Media Module
      • RemoteCommands Module
      • Tag Management Dispatcher Module
      • Visitor Service Module
    • Android TV
    • API Reference
      • ConsentCategory
      • ConsentManager
      • CurrentVisit
      • DataLayer
      • Lifecycle
      • LocationManager
      • Media
      • Tealium
      • TealiumConfig
      • VisitorProfile
      • VisitorService
    • Release Notes
  • Cordova 1.x
    • Overview
    • Install
    • Track
    • Data Management
    • Module List
      • Ad Identifier Module
      • Crash Reporter Module
      • Install Referrer Module
    • API Reference
    • Release Notes
  • Cordova 2.x
    • Overview
    • Install
    • Track
    • API Reference
    • Release Notes
  • Flutter 1.x
    • Overview
    • Install
    • Track
    • Consent Management
    • Data Management
    • API Reference
    • Release Notes
  • Flutter 2.x
    • Overview
    • Install
    • Track
    • Consent Management
    • Data Management
    • API Reference
      • Tealium
      • TealiumConfig
      • VisitorProfile
    • Release Notes
  • iOS (Objective-C)
    • Overview
    • Install
    • Track
    • Data Layer
    • Data Management
    • Consent Management
    • Tag Management
    • Module List
      • Lifecycle Tracking Module
    • tvOS
    • watchOS
    • API Reference
    • Release Notes
  • iOS (Swift) 1.x
    • Overview
    • Install
    • Track
    • Data Layer
    • Data Management
    • App Extensions
    • Identity Resolution
    • Consent Management
    • Modules
    • Module List
      • AppData Module
      • Attribution Module
      • AutoTracking Module
      • Collect Module
      • Connectivity Module
      • CrashReporter Module
      • DataSource Module
      • DefaultStorage Module
      • Delegate Module
      • DeviceData Module
      • DispatchQueue Module
      • FileStorage Module
      • Lifecycle Module
      • Location Module
      • Logger Module
      • PersistentData Module
      • RemoteCommands Module
      • TagManagement Module
      • VisitorService Module
      • VolatileData Module
    • Feature Comparison
    • Working with Objective-C
    • API Reference
      • TealiumConfig
      • TealiumConsentCategories
      • TealiumConsentManagerDelegate
      • TealiumConsentManager
      • TealiumInstanceManager
      • TealiumPersistentData
      • TealiumVolatileData
      • Tealium
    • Release Notes
  • iOS (Swift) 2.x
    • Overview
    • Install
    • Track
    • Data Layer
    • Consent Management
    • App Extensions
    • Identity Resolution
    • Modules
    • Module List
      • AppData Module
      • AdobeVisitorService Module
      • Attribution Module
      • AutoTracking Module
      • Collect Module
      • Connectivity Module
      • CrashReporter Module
      • DeviceData Module
      • In-App Purchase Module
      • Lifecycle Module
      • Location Module
      • Media Module
      • RemoteCommands Module
      • TagManagement Module
      • VisitorService Module
    • Working with Objective-C
    • API Reference
      • LocationModule
      • MediaSession
      • Tealium
      • TealiumConfig
      • TealiumConsentCategories
      • TealiumConsentManager
      • TealiumDataLayer
      • TealiumInstanceManager
    • Release Notes
  • NativeScript
    • Overview
    • Install
    • Track
    • API Reference
      • Tealium
      • TealiumConfig
    • Release Notes
  • React Native 1.x
    • Overview
    • Install
    • Track
    • API Reference
    • Release Notes
  • React Native 2.x
    • Overview
    • Install
    • Track
    • Location Module
    • API Reference
    • Release Notes
  • Unity 1.x
    • Overview
    • Install
    • Track
    • API Reference
  • Unity 2.x
    • Overview
    • Install
    • Track
    • API Reference
  • Xamarin 1.x
    • Overview
    • Install
    • Track
    • Data Management
    • Consent Management
    • API Reference
    • Release Notes
  • Xamarin 2.x
    • Overview
    • Install
    • Track
    • Data Layer
    • Consent Management
    • API Reference
    • Release Notes
  • Web
  • Getting Started
    • Overview
    • Quick Start Guide
    • Web Concepts
    • Data Layer
      • An Introduction to the Data Layer
      • How the Data Layer Works for Websites
      • Data Layer Best Practices
      • Definitions
        • Retail
        • Publisher
        • Hotel
        • Travel
        • Basic Video Tracking
  • Adobe Launch
    • Overview
    • Install
    • Data Layer
  • AMP
    • Overview
    • Install
    • Track
    • Data Layer
  • Angular
    • Overview
    • Install
    • Track
    • API Reference
  • Google Tag Manager
    • Overview
    • Install
    • Data Layer
  • JavaScript (Web)
    • Overview
    • Install
    • Track
    • Data Layer
    • Universal Data Object (utag_data)
    • Universal Tag (utag.js)
    • Data Layer Object (b)
    • Single-Page Applications
    • Settings
    • Debugging
    • API Reference
      • Cookie Functions
      • GDPR Functions
      • Tracking Functions
      • Utility Functions
    • Release Notes
  • Server
  • C#
    • Overview
    • Install
    • Track
    • Data Layer
    • API Reference
    • Release Notes
  • HTTP API
    • Overview
    • Endpoint
    • Data Layer
  • Java
    • Overview
    • Install
    • Track
    • API Reference
    • Release Notes
  • Node
    • Overview
    • Install
    • Track
    • API Reference
  • Python
    • Overview
    • Install
    • Track
    • API Reference
  • Roku
    • Overview
    • Install
    • Track
    • API Reference
  • Ruby
    • Overview
    • Install
    • Track
    • API Reference
FLUTTER

TealiumConfig

A class to set configuration options for the main Tealium class. Individual modules provide their own extensions for the TealiumConfig class if they are enabled.

TealiumConfig

The following summarizes the properties of the TealiumConfig class.

Parameters Type Description Example
account String (Required) Tealium account name companyXYZ
collectors List<Collectors> (Required) Sets the list of Collectors to initialize the Tealium library with [Collectors.AppData]
consentExpiry ConsentExpiry Sets the expiration of the user’s consent preferences (default is dependent upon policy) ConsentExpiry(90, TimeUnit.DAYS)
consentLoggingEnabled Boolean Enables the Consent Logging feature, which sends all consent status changes to Tealium Customer Data Hub for auditing purposes. (default: enabled) true
consentPolicy ConsentPolicy Sets the consent policy, such as CCPA or GDPR. Consent Manager is only enabled if this property is set. ConsentPolicy.GDPR
customVisitorId String Set a custom Visitor ID “ALK2398LSDKJ3289SLKJ3298SLKJ3”
dataSource String CDH data source key "abc123"
deepLinkTrackingEnabled Boolean Enables or disables automatic tracking of standard deep links, such as links to the app from Facebook or other sources, as well as QR trace. (default: enabled) false
dispatchers Dispatchers[] (Required) Sets the list of Dispatchers to initialize the Tealium library with [Dispatchers.Collect]
environment TealiumEnvironment (Required) Tealium environment name TealiumEnvironment.dev
lifecycleAutotrackingEnabled Boolean Enables or disables lifecycle auto tracking. (default: enabled) false
logLevel LogLevel` Sets the log level property, which controls how much information is logged (default: silent) LogLevel.DEV
memoryReportingEnabled Boolean Enables or disables memory reporting in the DeviceData module (default: disabled) true
overrideCollectBatchURL String Overrides the Tealium Collect batch URL to send data to a different endpoint “https://custom-domain.com/batch-event”
overrideCollectURL String Overrides the Tealium Collect URL to send data to a different endpoint. If using the event batching feature, also override the overrideCollectBatchURL property. “https://custom-domain.com/event”
overrideLibrarySettingsURL String Overrides the publish settings URL.` “https://custom-domain.com/mobile.html”
overrideTagManagementURL String Overrides the default URL used by the Tag Management module. This is needed if you are self-hosting your Tealium flutterScript files “https://custom-domain.com/path/env/utag.js”
profile String (Required) Tealium profile name main
qrTraceEnabled Boolean Enables or disables QR trace. (default: enabled) false
useRemoteLibrarySettings Boolean Enables or disables the Mobile Publish Settings (default: enabled) Configure the Mobile Publish Settings in iQ Tag Management, or disable the feature. false
visitorServiceEnabled Boolean Enables or disables the automatic retrieval of the Visitor Profile using the Data Layer Enrichment API (default: disabled) true

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:

Collector Name TealiumConfig Reference
AppData (default) Collectors.AppData
Connectivity (default) Collectors.Connectivity
Device Collectors.Device
Lifecycle Collectors.Lifecycle

These modules are enabled or disabled using the TealiumConfig collectors property.

ConsentExpiry

Defines user consent preferences expiration.

Parameters Type Description Example
time Number The amount of time before expiration 90
unit TimeUnit The unit of time before expiration TimeUnit.DAYS

Example:

new ConsentExpiry(90, TimeUnit.Days)

The following time units are available:

Time Unit Description
ConsentExpiry.DAYS Days
ConsentExpiry.HOURS Hours
ConsentExpiry.MINUTES Minutes
ConsentExpiry.MONTHS Months

ConsentPolicy

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

Example:

ConsentPolicy.GDPR
Consent Policy Description
ConsentPolicy.GDPR GDPR
ConsentPolicy.CCPA CCPA

Dispatchers

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

Dispatcher Name TealiumConfig Reference
Collect Dispatchers.Collect
RemoteCommands Dispatchers.RemoteCommands
TagManagement Dispatchers.TagManagement

At least one dispatcher is required. If no dispatchers are specified, no tracking occurs.

Expiry

Defines the expiration time for setting a property that expires.

Example:

Expiry.session

The following expiry options are available:

Value Description
session (default) The lifetime of the current active session
forever Never expires while the app is installed
untilRestart Until the app restarts

LogLevel

Sets the logLevel property, which controls how much information is logged.

The following logging levels are available:

Value Description
LogLevel.DEV Informational events that highlight the progress of the application
LogLevel.QA Debug-level events used for debugging an application
LogLevel.PROD Error events such as critical errors and failures
LogLevel.SILENT No Logging (default)

Example:

LogLevel.DEV

TealiumEnvironment

The environment is one of three default environments (Dev, QA, Prod) or any custom environments that Tealium publishes to. Select one of these environments.

Example:

TealiumEnvironment.dev

Value Description
.dev Development
.qa QA/UAT
.prod Production
"Tealium "
Previous
Tealium
Next
VisitorProfile
"VisitorProfile"

 

Was this article helpful?

This page was last updated: May 13, 2022      

Thank you for your feedback!

Table of Contents

  • TealiumConfig
    • Collectors
    • ConsentExpiry
    • ConsentPolicy
    • Dispatchers
    • Expiry
    • LogLevel
    • TealiumEnvironment
  • Platforms
  • Partners
  • Forums
  • Mobile
  • Getting Started
  • Remote Commands
  • Android (Java)
  • Android (Kotlin)
  • Cordova 1.x
  • Cordova 2.x
  • Flutter 1.x
  • Flutter 2.x
  • iOS (Objective-C)
  • iOS (Swift) 1.x
  • iOS (Swift) 2.x
  • NativeScript
  • React Native 1.x
  • React Native 2.x
  • Unity 1.x
  • Unity 2.x
  • Xamarin 1.x
  • Xamarin 2.x
  • Web
  • Getting Started
  • Adobe Launch
  • AMP
  • Angular
  • Google Tag Manager
  • JavaScript (Web)
  • Server
  • C#
  • HTTP API
  • Java
  • Node
  • Python
  • Roku
  • Ruby