AdobeVisitorService Module | Modules

The Adobe Visitor Service module interfaces directly with Adobe’s REST API to retrieve and maintain the Experience Cloud ID (ECID) for visitors.

Learn more about the AdobeVisitorService module.

Requirements

Tealium for Swift (2.0.0+)
Valid Adobe account and Adobe organization ID
TealiumAdobeVisitorAPI GitHub Repo

Sample App

To help to familiarize yourself with the Tealium library and best practice implementation, explore the AdobeVisitorService module sample app for iOS.

Install

The AdobeVisitorService module is configured when initializing the Tealium SDK, and does not have remote configuration capabilities.

The module acts as a DispatchValidator, preventing calls being sent without an Adobe organization ID. It attempts to retrieve an ECID from the Adobe API, but after 5 failed attempts, calls are permitted to continue without an ECID to avoid data loss. Sending data is prioritized over having a valid ECID.

Possible causes for no ECID being retrieved are:

Invalid response, such as a response was received but did not contain a valid ECID.
There was no response.
The Adobe organization ID was invalid.

Carthage

To install the AdobeService module with Carthage, add the following to your cartfile:

github "tealium/tealium-swift-adobe-visitor-api"

Learn more about Carthage installation for iOS.

CocoaPods

To install the AdobeVisitor module with CocoaPods, add the following pod to your podfile:

pod 'TealiumAdobeVisitorAPI'

Learn more about the CocoaPods installation for iOS.

Swift Package Manager (Recommended)

Swift Package Manager is the recommended way to install the Tealium Swift library:

In your Xcode project, select File > Swift Packages > Add Package Dependency.
Enter the repository URL: https://github.com/Tealium/tealium-swift-adobe-visitor-api.
Configure the version rules. The default, "Up to next major", is recommended. If the current Tealium Swift library version does not appear in the list, reset your Swift package cache.
Select the TealiumAdobeVisitorAPI module from the list of modules to install. Add the module to each of your app targets in your Xcode project under Frameworks > Libraries & Embedded Content.

Learn more about the Swift Package Manager installation for iOS.

import TealiumAdobeVisitorAPI

let config = TealiumConfig(account: "ACCOUNT",
    profile: "PROFILE",
    environment: "ENVIRONMENT")
config.collectors = [Collectors.AppData,
    Collectors.Connectivity,
    Collectors.Device,
    Collectors.Lifecycle,
    Collectors.AdobeVisitor]
config.dispatchers = [Dispatchers.Collect]
self.tealium = Tealium(config: config)

Review the Collectors documentation to understand how to correctly specify the collectors you require.

Learn more about the Swift Package Manager installation for iOS.