REMOTE COMMANDS/INTEGRATIONS

Remote Command: Contentsquare

Requirements

How It Works

The Contentsquare integration uses the native Contentsquare SDK, a remote command module that wraps the Contentsquare methods, and the Contentsquare Remote Command tag that translates event tracking into native Contentsquare calls. The integration uses three items:

  1. The Contentsquare native SDK
  2. The remote commands module
  3. Either the JSON configuration file or Remote Command tag

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.

    To install Contentsquare remote commands for iOS using CocoaPods:

    1. Remove tealium-swift and pod "CS_iOS_SDK" if they already exist your Podfile. The dependency for tealium-swift is already included in the TealiumContentsquare framework.

    2. Add the following dependency to your Podfile:

      pod "TealiumContentsquare"

      The TealiumContentsquare pod includes the following TealiumSwift dependencies:

      'tealium-swift/Core'
'tealium-swift/TealiumDelegate'
'tealium-swift/TealiumRemoteCommands'
'tealium-swift/TealiumTagManagement'

    3. Add any other required modules manually to your Podfile, such as the following:

      'tealium-swift/TealiumLogger'
'tealium-swift/TealiumLifecycle'
'tealium-swift/TealiumAppData'

      Learn more about the recommended modules for iOS.

    4. Import the modules TealiumSwift and TealiumContentsquare in your TealiumHelper file, and any other files that access the Tealium class, or the Contentsquare Remote Command.

    To install Contentsquare remote commands for iOS using Carthage:

    1. Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumContentsquare framework.

    2. Remove the following line if it exists in your Cartfile:

      github "ContentSquare/CS_iOS_SDK"

    3. Add the following dependency to your Cartfile:

      github "tealium/tealium-ios-contentsquare-remote-command"

    Tealium for Swift SDK (version 1.6.5+) requires the TealiumDelegate module to be included with your installation.

    To install Contentsquare remote commands for Android using Maven:

    1. Install Tealium for Android (Kotlin) or Tealium for Android (Java), if you haven’t done so already.

    2. Import both the Contentquare SDK and Tealium-Contentsquare remote commands by adding the following dependencies in your app project’s build.gradle file:

      dependencies {
  implementation 'com.tealium.remotecommands:contentsquare:2.0.0'
}

    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

    5. When initializing the Tealium SDK, update the completion handler as follows:

      The following code is designed for use with the JSON Remote Commands feature, using the local file option.

      let config = TealiumConfig(account: "ACCOUNT", profile: "PROFILE", environment: "ENVIRONMENT")
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)
}

      The following code is designed for use with the Remote Command tag feature.

      let config = TealiumConfig(account: "ACCOUNT", profile: "PROFILE", environment: "ENVIRONMENT")
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)
}

      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.

        The following code is designed for use with the JSON Remote Commands feature, using the local file option:

        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");
}

        The following code is designed for use with the Remote Command tag feature:

        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)

          The following code is designed for use with the Remote Command tag feature:

          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);

          The JSON Remote Command file feature for Android is only available in the Kotlin SDK

          iOS (Swift)

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

            The following code is designed for use with the JSON Remote Commands feature, using the local file option:

            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)
}

            The following code is designed for use with the Remote Command tag feature:

            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:

            Remote Command Contentsquare Method
            sendscreenview send()
            sendtransaction send()
            senddynamicvar send()
            stoptracking stopTracking()
            resumeTracking resumeTracking()
            forgetme forgetMe()
            optin optIn()
            optout optOut()

            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

            Track Screens

            Remote Command Contentsquare Method
            sendscreenview send
            Parameter Type
            screen_name (required) String

            Contentsquare Developer Guide: Analytics User IDs

            Track Transactions

            Remote Command Contentsquare Method
            sendtransaction send
            Parameter Type
            price (required) Double or Float
            currency (required) Int
            transaction_id (optional) String

            Contentsquare Developer Guide: Track Transactions

            Track Dynamic Variables

            Remote Command Contentsquare Method
            sendtransaction send
            Parameter Type
            price (required) Double or Float
            currency (required) Int
            transaction_id (optional) String

            Contentsquare Developer Guide: Track Dynamic Variables

            Stop / Resume Tracking

            Remote Command Contentsquare Method
            stoptracking stopTracking
            resumetracking resumeTracking

            Contentsquare Developer Guide: Stop / Resume Tracking

            Opt In

            Remote Command Contentsquare Method
            optin optIn

            Contentsquare Developer Guide: Opt In

            Opt Out

            Remote Command Contentsquare Method
            optout optOut

            Contentsquare Developer Guide: Opt Out

            Forget Me

            Remote Command Contentsquare Method
            forgetme forgetMe

            Contentsquare Developer Guide: Forget Me

            Remote Command: Braze
            Remote Command: Facebook