Visitor Service Module

Usage

The Visitor Service module brings data layer Enrichment functionality to the native mobile app.

Usage of this module requires a license for Tealium AudienceStream. Use the retrieved Visitor Profile to enhance your customer experience or data layer throughout your application.

Install

Install the Visitor Service 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 Visitor Service Module

   dependencies {
     implementation 'com.tealium:kotlin-core:1.0.0'
     implementation 'com.tealium:kotlin-visitor-service:1.0.0'
   }

Manual

To install the Visitor Service Module manually:

1. Download the Tealium Visitor Service module.

2. Copy the file tealium-kotlin.visitor-service-1.0.0.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.visitor-service-1.0.0', 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.

Visitor Profile Data

To make use of the current visitor data you need to register a delegate object to receive the latest Visitor Profile each time it gets updated:

instance = Tealium.create("main", config) {
    events.subscribe(object : VisitorUpdatedListener {
        override fun onVisitorUpdated(visitorProfile: VisitorProfile) {
            Logger.dev("--", "VisitorProfile updated: $visitorProfile")
        }
    })
}

The VisitorProfile object have access to many fields relating to your Visitor - the following outlines the available properties:

Below is a basic example of how to interact with the Visitor Profile once it has been retrieved. Key names differ per account/profile.

val returningVisitor = visitorProfile.badges?.get("returning_visitor")
returningVisitor?.let {
    if (returningVisitor == true) {
        val ltv = visitorProfile.numbers?.get("lifetime_value")
        // take action
    }
}

Configuration Options

Configure the URL that it used to retrieve the Visitor Profile using the following setting when creating your TealiumConfig object:

Override Visitor Service Url

val config = TealiumConfig(...)
config.overrideVisitorServiceUrl = "https://your.preferred.visitor-service.com"

The default value for the Visitor Service URL is https://visitor-service.tealiumiq.com/{ACCOUNT_NAME}/{PROFILE_NAME}/{VISITOR_ID}

Visitor Profile Refresh Interval

Sets the minimum time interval, in seconds, that should pass before the SDK will automatically attempt to retrieve the latest Visitor Profile. Note that manually requesting a new Visitor Profile - i.e. by calling requestVisitorProfile() - will always request a new profile regardless of whether the refresh interval has elapsed, unless the SDK is already in the process of fetching the latest profile.

val config = TealiumConfig(...)
config.visitorServiceRefreshInterval = 300L                           // 5 minutes (deafult)
config.visitorServiceRefreshInterval = TimeUnit.MINUTES.toSeconds(30) // 30 minutes
config.visitorServiceRefreshInterval = TimeUnit.HOURS.toSeconds(24)   // 24 Hours

The default value for the Visitor Service refresh interval is 300 seconds (5 Minutes)

API Reference

For the reference of methods used by the Visitor Service module, see the VisitorService class in the Tealium SDK for Android API.