Collect Module | Modules

Usage

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

As an alternative, if you are using the Tag Management module, you may instead use the Collect tag via Tealium iQ. This may give greater control over the data and events dispatched to the Customer Data Hub, as you may then use load rules and extensions to manipulate the data prior to dispatch. If you are using the Collect tag via Tealium iQ, ensure that the Collect module is disabled to avoid duplicate tracking requests.

The following platforms are supported:

iOS
tvOS
watchOS
macOS

Install

Install the Collect module with Swift Package Manager, CocoaPods or Carthage.

Swift Package Manager (Recommended)

Supported in version 1.9.0+, the Swift Package Manager is the recommended and simplest way to install the Tealium Swift library:

In your Xcode project, select File > Add Package Dependencies
Enter the repository URL: https://github.com/tealium/tealium-swift
Configure the version rules. Typically, "Up to next major" is recommended. If the current Tealium Swift library version does not appears in the list, then reset your Swift package cache.
Select the Collect module from the list of modules to install and add it each of your app targets in your Xcode project, under Frameworks and Libraries.

Learn more about the Swift Package Manager installation for iOS.

CocoaPods

To install the Collect module with CocoaPods, add the following pod to your Podfile:

pod 'tealium-swift/Collect'

Learn more about the CocoaPods installation for iOS.

Carthage

To install the Collect module with Carthage, following these steps:

Go to the app target’s General configuration page in Xcode.
Add the following framework to the Embedded Binaries section:
```
TealiumCollect.framework
```

Learn more about Carthage installation for iOS.

Initialize

To initialize the module, verify that it’s specified on the TealiumConfig dispatchers property:

config.dispatchers = [Dispatchers.Collect]

Data Layer

The following variables are transmitted with each tracking call while the module is enabled:

Variable	Description	Example
`dispatch_service`	Static string to indicate which module the tracking call came from	`"collect"`