Collect Module

Usage

The Collect module dispatches tracking calls to the Tealium Customer Data Hub. Usage of this module is strongly recommended if you are using server-side products.

Alternatively, if you have Tealium iQ, use the Tealium Collect tag in partnership with the Tag Management Dispatcher.

Install

Install the Collect Dispatcher module using Maven (recommended) or manually.

Maven

To install the module using Maven:

1. In your project’s top-level build.gradle file, add the following Maven repository:

   maven {
         url "https://maven.tealiumiq.com/android/releases/"
   }
   

2. In your project module’s build.gradle file, add the Maven dependencies for the Tealium library and Collect Dispatcher

   dependencies {
         implementation 'com.tealium:kotlin-core:1.6.0'
         implementation 'com.tealium:kotlin-collect-dispatcher:1.1.1'
   }
   

Manual

To install the Collect Dispatcher manually:

1. Download the Tealium Collect Dispatcher module.

2. Copy the file tealium-kotlin.collect-1.1.1.aar into your project’s <PROJECT_ROOT>/<MODULE>/libs directory.

3. Add the Tealium library dependency to your project module’s build.gradle file:

   dependencies {
       implementation(name:'tealium-kotlin.collect-1.1.1', ext:'aar')
   }
   

The Collect Dispatcher has a dependency on the main Tealium Kotlin SDK, so ensure that you also make this available by following the installation instructions.

Configuration Options

Configure the URL that the Collect Dispatcher sends your data to using the following setting when creating your TealiumConfig object:

val config = TealiumConfig(...)
config.overrideCollectUrl = "https://your.endpoint.com/event"
config.overrideCollectBatchUrl = "https://your.endpoint.com/bulk-event"

Configure the endpoints that individual events or batched events are sent to.

For deployments that make use of the CNAME or data-center specific requirements, override the domain and keep the Tealium defined endpoints. In the following example, individual events go to https://cname.tealiumiq.com/event and batched events go to https://cname.tealiumiq.com/bulk-event:

val config = TealiumConfig(...)
config.overrideCollectDomain = "cname.tealiumiq.com"

If you need to send events to a Tealium Profile that is different to the one used in the TealiumConfig object, then you can override this as follows - this has the effect of changing the value of the tealium_profile key in the event payload:

val config = TealiumConfig(..., profile="android", ...)
config.overrideCollectProfile = "main"