Remote Command: Contentsquare

Requirements

• One of these mobile libraries:
  • Tealium for Android-Kotlin (1.0.0+)
  • Tealium for Android-Java (5.9.0+ for Contentsquare 1.0.0+ or <5.9.0 for previous versions)
  • Tealium for iOS-Swift
• One of these remote command integrations:
  • Contentsquare Remote Command JSON File (Requires Android-Kotlin 1.0.0+ or iOS-Swift 2.1.0+)
  • Contentsquare Remote Command tag in Tealium iQ Tag Management

How It Works

The Contentsquare integration uses three items:

1. The Contentsquare native SDK
2. The remote commands module that wraps the Contentsquare methods
3. Either the JSON configuration file or Remote Command tag that translates event tracking into native Contentsquare calls

Adding the Contentsquare remote command module to your app automatically installs and builds the required Contentsquare libraries. If you are using a dependency manager installation, there is no need to install the Contentsquare SDK separately.

There are two remote command options: A JSON configuration file, or using iQ Tag Management to configure the mappings. A JSON configuration file is the recommended option for your vendor integration, hosted either remotely or locally within your app. If using iQ Tag Management, add the Remote Command tag for the vendor integration. Learn more about vendor integrations.

Install

Dependency Manager

We recommend using one of the following dependency managers for installation:

If you are using the Tealium iOS (Objective-C) library, use the manual installation method. The CocoaPods and Carthage options are only available if you are using the Tealium iOS (Swift) library.

Manual (iOS)

The manual installation for Contentsquare remote commands requires the Tealium for Swift library to be installed. To install the Contentsquare remote commands for your iOS project:

1. Install the Contentsquare SDK, if you haven’t already done so.

2. Clone the Tealium iOS Contentsquare remote command repo and drag the files within the Sources folder into your project.

3. Add Dispatchers.RemoteCommands as a dispatcher

4. Set the remoteAPIEnabled configuration flag to true

Initialize

For all Tealium libraries, register the Contentsquare remote commands when you initialize.

Android (Kotlin)

Initialize remote commands with a JSON configuration file or the Remote Command tag for Tealium’s Android (Java) library.

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
    // Initialize with `Application` in order to take advantage of consent management and other
    // advanced features
    val contentsquare = ContentsquareRemoteCommand(this);

    // Or for simple tracking, you can initialize without `Application`
    val contentsquare = ContentsquareRemoteCommand();
    // register the command
    remoteCommands?.add(contentsquare, filename = "contentsquare.json");
}

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
    // Initialize with `Application` in order to take advantage of consent management and other
    // advanced features
    val contentsquare = ContentsquareRemoteCommand(this);

    // Or for simple tracking, you can initialize without `Application`
    val contentsquare = ContentsquareRemoteCommand();
    // register the command
    remoteCommands?.add(contentsquare);
}

Android (Java)

import com.tealium.remotecommands.contentsquare.ContentsquareRemoteCommand;

Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);

// Initialize with `Application` in order to take advantage of consent management and other
// advanced features
ContentsquareRemoteCommand contentsquare = new ContentsquareRemoteCommand(this);

// Or for simple tracking, you can initialize without `Application`
ContentsquareRemoteCommand contentsquare = new ContentsquareRemoteCommand();

// register the command
teal.addRemoteCommand(contentsquare);

iOS (Swift)

Initialize remote commands with a JSON configuration file or the Remote Command tag for Tealium’s iOS (Swift) library.

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE",
                           optionalData: nil)
config.dispatchers = [Dispatchers.TagManagement, Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // Required to use Remote Commands

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }
    let contentsquare = ContentsquareRemoteCommand(type: .local(file: "contentsquare"))
    remoteCommands.add(contentsquare)
}

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",˜˜
                           dataSource: "DATASOURCE",
                           optionalData: nil)
config.dispatchers = [Dispatchers.TagManagement, Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // Required to use Remote Commands

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }
    let contentsquare = ContentsquareRemoteCommand()
    remoteCommands.add(contentsquare)
}

JSON Template

If you are configuring remote commands using a JSON configuration file, refer to the following template to get started. The template includes common mappings used in a standard e-commerce installation. Edit the mappings as needed.

{
  "config": {},
  "mappings": {
    "screen": "screen_name",
    "dynamic_var": "dynamic_var",
    "price": "purchase.price",
    "currency": "purchase.currency",
    "transaction_id": "purchase.transaction_id"
  },
  "commands": {
    "screen_title": "sendscreenview",
    "dynamic_var": "senddynamicvar",
    "transaction": "sendtransaction",
    "stop_tracking": "stoptracking",
    "resume_tracking": "resumetracking",
    "forget_me": "forgetme",
    "opt_in": "optin",
    "opt_out": "optout"
  }
}

Supported Methods

The following Contentsquare methods are triggered using a data mapping in the Contentsquare Remote Command tag using the following Tealium commands:

Since the Contentsquare SDK is installed alongside the Tealium SDK, trigger any native Contentsquare functionality given the corresponding tag configuration.

SDK Setup

Initialize

The Contentsquare SDK is initialized automatically upon launch.

Contentsquare Developer Guide: Initial SDK Setup

• Android
• iOS

Track Screens

Contentsquare Developer Guide: Analytics User IDs

• Android
• iOS

Track Transactions

Contentsquare Developer Guide: Track Transactions

• Android
• iOS

Track Dynamic Variables

Contentsquare Developer Guide: Track Dynamic Variables

• Android
• iOS

Stop / Resume Tracking

Contentsquare Developer Guide: Stop / Resume Tracking

• Android
• iOS

Opt In

Contentsquare Developer Guide: Opt In

• Android
• iOS

Opt Out

Contentsquare Developer Guide: Opt Out

• Android
• iOS

Forget Me

Contentsquare Developer Guide: Forget Me

• Android
• iOS