Remote Command: Contentsquare | Integrations |Tealium Developer Docs

Requirements

Tealium for Android or Tealium for iOS in your app
Contentsquare Remote Command tag in Tealium iQ Tag Management

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. This solution leverages the convenience of Tealium iQ Tag Management to configure a native Contentsquare implementation without having to add vendor-specific code to your app.

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.

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:

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.

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'

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.
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:

Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumContentsquare framework.
Remove the following line if it exists in your Cartfile:
```
github "ContentSquare/CS_iOS_SDK"
```

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:

Install Tealium’s Android SDK, if you haven’t done so already.
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:1.0.0'
}
```

Manual for iOS

The manual installation for Contentsquare remote commands requires one of the following iOS libraries to be installed:

To install the Contentsquare remote commands for your iOS project:

Install the Contentsquare SDK, if you haven’t already done so.
Clone the Tealium iOS Contentsquare remote command repo and drag the files within the Sources folder into your project.

When initializing the Tealium Swift SDK, in the completion handler:

tealium = Tealium(config: config) { responses in
guard let remoteCommands = self.tealium?.remoteCommands() else {
  return
}
let contentsquareTracker = ContentsquareTracker()
let contentsquareCommand = ContentsquareCommand(ContentsquareTracker: contentsquareTracker)
let contentsquareRemoteCommand = ContentsquareCommand.remoteCommand()
remoteCommands.add(contentsquareRemoteCommand)
}

If you are using the TealiumIOS, add the following code:

Add the remote command in the TealiumHelper.swift file as follows:

let contentsquareTracker = ContentsquareTracker()
let contentsquareCommand = ContentsquareCommand(contentsquareTracker: contentsquareTracker)
let contentsquareRemoteCommand = contentsquareCommand.remoteCommand()
tealium.addRemoteCommandID("contentsquare",
                           description: nil,
                           targetQueue: DispatchQueue.main,
                           responseBlock: contentsquareRemoteCommand)

Import the remote command in the TealiumHelper.m file as follows:

#import "TealiumRemoteCommandObjcApp-Swift.h"

The Swift bridging header for your target is named ending with -Swift.h. Find this by filtering for “Module Name” in your target’s build settings.

Learn more about importing Swift into Objective-C.

Initialize the remote command as follows:

ContentsquareTracker *contentsquareTracker = [[ContentsquareTracker alloc] init];
ContentsquareCommand *contentsquareCommand = [[ContentsquareCommand alloc] initWithContentsquareTracker:contentsquareTracker];
TEALRemoteCommandResponseBlock contentsquareRemoteCommand = [contentsquareCommand remoteCommand];
[[Tealium instanceForKey:@"MY_INSTANCE"] addRemoteCommandID:@"contentsquare"
                                                description:@"An example remote command block"
                                                targetQueue:dispatch_get_main_queue()  
                                              responseBlock:contentsquareRemoteCommand];

Initialize

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

The following code is designed for use with Tealium’s Android library:

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 following code is designed for use with Tealium’s Android library.

import com.tealium.remotecommands.contentsquare.ContentsquareRemoteCommand

val config = Tealium.Config.create(this, "ACCOUNT", "PROFILE", "ENVIRONMENT")
tealium = Tealium.createInstance(TealiumHelper.instanceName, 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
tealium.addRemoteCommand(contentsquare)

The following code is designed for use with Tealium’s Swift library for iOS:

var teal: Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           datasource: "DATASOURCE",
                           optionalData: nil)

teal = Tealium(config: config) { responses in
  guard let remoteCommands = self.tealium?.remoteCommands() else {
        return
  }
  let contentsquareTracker = ContentsquareTracker()
  let contentsquareCommand = ContentsquareCommand(ContentsquareTracker: contentsquareTracker)
  let contentsquareRemoteCommand = ContentsquareCommand.remoteCommand()
      remoteCommands.add(contentsquareRemoteCommand)
}

The following code is designed for use with Tealium’s Objective-C library for iOS, although it is written in Swift. A Bridging Header is required in your Xcode project for this code to work correctly.

let config = TEALConfiguration(account: "ACCOUNT",
                               profile: "PROFILE",
                               environment: "ENVIRONMENT",
                               datasource: "DATASOURCE")
let teal = Tealium.newInstance(forKey: "teal", configuration: config)

let contentsquareTracker = ContentsquareTracker()
let contentsquareCommand = ContentsquareCommand(ContentsquareTracker: contentsquareTracker)
let contentsquareRemoteCommand = contentsquareCommand.remoteCommand()
teal.addRemoteCommandID("contentsquare", description: nil, targetQueue: DispatchQueue.main, responseBlock: contentsquareRemoteCommand)

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

Android
iOS

Track Screens

Remote Command	Contentsquare Method
`sendscreenview`	`send`

Parameter	Type
`screen_name` (required)	`String`

Contentsquare Developer Guide: Analytics User IDs

Android
iOS

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

Android
iOS

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

Android
iOS

Stop / Resume Tracking

Remote Command	Contentsquare Method
`stoptracking`	`stopTracking`
`resumetracking`	`resumeTracking`

Contentsquare Developer Guide: Stop / Resume Tracking

Android
iOS

Opt In

Remote Command	Contentsquare Method
`optin`	`optIn`

Contentsquare Developer Guide: Opt In

Android
iOS

Opt Out

Remote Command	Contentsquare Method
`optout`	`optOut`

Contentsquare Developer Guide: Opt Out

Android
iOS

Forget Me

Remote Command	Contentsquare Method
`forgetme`	`forgetMe`

Contentsquare Developer Guide: Forget Me

Android
iOS