TealiumConfig

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