Remote Command: Braze (Beta) | Integrations |Tealium Developer Docs

Requirements

Braze API key
Tealium library for Android or Swift/iOS in your app
Braze Remote Command Tag in iQ Tag Management

How It Works

The Braze integration uses the native Braze SDK, a remote command module that wraps the Braze methods, and the Braze Remote Commands tag that translates event tracking into native Braze calls. This solution leverages the convenience of tag management to configure a native Braze implementation without having to add vendor-specific code to your app.

There is no need to install the Braze SDK separately. Adding the Braze remote command module to your app build automatically installs and builds the required Braze libraries. If you previously added Braze to your app, remove it.

Install

Dependency Manager

Install options are available for the following dependency managers. This is the recommended install method.

Add the following dependency to your Podfile:

pod "TealiumBraze"

In addition, you must remove the line pod "Appboy-iOS-SDK", if it exists in your Podfile.

TealiumBraze already has a dependency on tealium-swift, so if tealium-swift was previously in your Podfile, you need to remove it.

Add the following dependency to your Cartfile:

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

In addition, you must remove the line github "Appboy/Appboy-iOS-SDK", if it exists in your Cartfile.

TealiumBraze already has a dependency on tealium-swift, so if tealium-swift was previously in your Cartfile, you need to remove it.

If you are using version 1.6.5 or later of the Tealium for Swift SDK, the TealiumDelegate module needs to be included as well with your installation.

Add a reference in your build.gradle file to the following:

dependencies {
    implementation 'com.tealium.remotecommands:braze:1.0.0'
}

Manual for iOS

To manually install the Braze remote command for your Objective-C or Swift project, use the following repo:

Tealium iOS Braze Remote Command

To include the remote command files in your own project, clone this repo and drag the files within the Sources folder into your project.

This assumes you have Tealium Swift and Braze installed already.

When initializing the Tealium SDK, in the completion handler:

tealium = Tealium(config: config) { responses in
  guard let remoteCommands = self.tealium?.remoteCommands() else {
      return
  }
  let brazeCommandRunner = BrazeCommandRunner()
  let brazeCommand = BrazeCommand(brazeCommandRunner: brazeCommandRunner)
  let brazeRemoteCommand = brazeCommand.remoteCommand()
  remoteCommands.add(brazeRemoteCommand)
}

Manual install options are available for the following platforms:

First, clone the repo and drag the files from the Objective-C folder into your project.

Then, in TealiumHelper.m, add this line to import the Swift code:

#import "TealiumRemoteCommandObjcApp-Swift.h"

Learn more about importing Swift into Objective-C.

Then initialize the remote command:

BrazeCommandRunner *brazeCommandRunner = [[BrazeCommandRunner alloc] init];
BrazeCommand *brazeCommand = [[BrazeCommand alloc] initWithBrazeCommandRunner:brazeCommandRunner];
TEALRemoteCommandResponseBlock brazeRemoteCommand = [brazeCommand remoteCommand];
[[Tealium instanceForKey:@"MY_INSTANCE"] addRemoteCommandID:@"braze"
                                    description:@"Braze Remote Command"
                                    targetQueue:dispatch_get_main_queue()
                                    responseBlock:brazeRemoteCommand];

In your TealiumHelper.swift, add the remote command as follows:

let brazeCommandRunner = BrazeCommandRunner()
let brazeCommand = BrazeCommand(brazeCommandRunner: brazeCommandRunner)
let brazeRemoteCommand = brazeCommand.remoteCommand()
tealium.addRemoteCommandID("braze",
                           description: nil,
                           targetQueue: DispatchQueue.main,
                           responseBlock: brazeRemoteCommand)

Initialize

For all Tealium libraries, you need to register the Braze Remote Command when you initialize.

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

RemoteCommand braze = new BrazeRemoteCommand(application);
teal.addRemoteCommand(braze);

This class is designed for the Objective-C library, but the code itself is written in Swift. You need to have a Bridging Header in your Xcode project for this to work correctly.

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

let brazeCommandRunner = BrazeCommandRunner()
let brazeCommand = BrazeCommand(brazeCommandRunner: brazeCommandRunner)
let brazeRemoteCommand = brazeCommand.remoteCommand()
teal.addRemoteCommandID("braze", description: nil, targetQueue: DispatchQueue.main, responseBlock: brazeRemoteCommand)

This class is designed for use with Tealium’s Swift library for iOS (does not work with other platforms).

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 brazeCommandRunner = BrazeCommandRunner()
  let brazeCommand = BrazeCommand(brazeCommandRunner: brazeCommandRunner)
  let brazeRemoteCommand = brazeCommand.remoteCommand()
      remoteCommands.add(brazeRemoteCommand)
}

Supported Methods

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

Remote Command	Braze Method
`initialize`	`startWithApiKey()`
`useridentifier`	`changeUser()`
`useralias`	`addAlias()`
`userattribute`	`ABKUser()`
`facebookuser`	`facebookUser()`
`twitteruser`	`twitterUser()`
`setcustomattribute`	`setCustomAttributeWithKey()`
`unsetcustomattribute`	`unsetCustomAttributeWithKey()`
`setcustomarrayattribute`	`setCustomAttributeArrayWithKey()`
`appendcustomarrayattribute`	`addToCustomAttributeArrayWithKey()`
`removecustomarrayattribute`	`removeFromCustomAttributeArrayWithKey()`
`incrementcustomattribute`	`incrementCustomUserAttribute()`
`emailnotification`	`setEmailNotificationSubscriptionType()`
`pushnotification`	`setPushNotificationSubscriptionType()`
`logcustomevent`	`logCustomEvent()`
`logpurchase`	`logPurchase()`

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

SDK Setup

Initialize

The Braze SDK is initialized automatically upon launch. The Braze API key is set in the tag configuration.

Remote Command	Braze Method
`initialize`	`startWithApiKey()`

The following mappings are used to set launch options.

Parameter	Type	Description
`session_timeout`	`Int` (seconds)	The session timeout in seconds (default: 30 seconds)
`disable_location`	`Int` (1 or 0)	Disable automatic location data collection
`trigger_interval_seconds`	`Int` (seconds)	Override the minimum interval between in-app message triggers (default: 30 seconds)

Braze Developer Guide: Initial SDK Setup

User Tracking

Assigning a User ID

Remote Command	Braze Method
`useridentifier`	`changeUser`

Parameter	Type
`user_id` (required)	`String`

Braze Developer Guide: Analytics User IDs

Aliasing Users

Remote Command	Braze Method
`useralias`	`addAlias`

Parameter	Type
`user_alias` (required)	`String`
`alias_label` (required)	`String`

Braze Developer Guide: Analytics Alias Users

User Attributes

Standard Attributes

Event	Braze Method
userattribute	Set fields on the `ABKUser` object

Parameter	Type
`first_name`	`String`
`last_name`	`String`
`email`	`String`
`date_of_birth`	`String`
`country`	`String`
`language`	`String`
`home_city`	`String`
`phone`	`String`
`avatar_image_url`	`String`
`gender`	`String`

Set Custom Attribute

Remote Command	Braze Method
`setcustomattribute`	`setCustomAttributeWithKey`

Parameter	Type
`set_custom_attribute.PROPERTY`	`[String: Any]`

Braze Developer Guide: Analytics Custom Attributes

Unset Custom Attribute

Remote Command	Braze
`setcustomattribute`	`unsetCustomAttributeWithKey`

Parameter	Type
`set_custom_attribute.PROPERTY`	`String`

Braze Developer Guide: Analytics Custom Attributes

Increment Custom Attribute

Remote Command	Braze Method
`incrementcustomattribute`	`incrementCustomUserAttribute`

Parameter	Type
`increment_custom_attribute.PROPERTY`	`String`

Braze Developer Guide: Analytics Incrementing Attributes

Set Custom Array Attribute

Remote Command	Braze Method
setcustomarrayattribute	`setCustomAttributeArrayWithKey`

Parameter	Type
`set_custom_array_attribute.PROPERTY`	`[String: [Any]]`

Braze Developer Guide: Analytics Array Attributes

Append Custom Array Attribute

Remote Command	Braze Method
`appendcustomarrayattribute`	`addToCustomAttributeArrayWithKey`

Parameter	Type
`append_custom_array_attribute.PROPERTY`	`[String: String]`

Braze Developer Guide: Analytics Array Attributes

Remove Custom Array Attribute

Remote Command	Braze Method
removecustomarrayattribute	`removeFromCustomAttributeArrayWithKey`

Parameter	Type
`remove_custom_array_attribute.PROPERTY`	`[String: String]`

Braze Developer Guide: Analytics Array Attributes

Facebook

Remote Command	Braze Method
`facebookuser`	Initialize a `ABKFacebookUser` object

Parameter	Type
`facebook_id`	`[String: Any]`
`friends_count`	`Int`
`likes`	`[Any]`

Braze Developer Guide: Social Data

Twitter

Remote Command	Braze Method
`twitteruser`	Initialize a `ABKTwitterUser` object

Parameter	Type
`description`	`String`
`twitter_name`	`String`
`profile_image_url`	`String`
`screen_name`	`String`
`followers_count`	`Int`
`friends_count`	`Int`
`statuses_count`	`Int`
`twitter_id`	`Int`

Braze Developer Guide: Social Data

Custom Event Tracking

Custom Event

Remote Command	Braze Method
`logcustomevent`	`logCustomEvent`

Parameter	Type
`event_name` (required)	`String`
`event_properties`	`[String: Any]`

Braze Developer Guide: Analytics Custom Events

Notifications

Email Notifications

Remote Command	Braze Method
`emailnotification`	`setEmailNotificationSubscriptionType`

Parameter	Type	Example
email_notification	`String`	[`"optedin"`, `"subscribed"`, `"unsubscribed"`]

Braze Developer Guide: Analytics Email Subscriptions

Push Notifications

Remote Command	Braze Method
pushnotification	`setPushNotificationSubscriptionType`

Parameter	Type	Example
`push_notification`	`String`	[`"optedin"`, `"subscribed"`, `"unsubscribed"`]

Braze Developer Guide: Analytics Push Notifications

Purchase Tracking

Log Purchase

Remote Command	Braze Method
logpurchase	`logPurchase`

Parameter	Type
`product_id` (required)	`[String]`
`currency` (required)	`String`
`price` (required)	`[Double]`
`quantity`	`[Int]`
`purchase_properties`	`[AnyHashable: Any]`

Braze Developer Guide: Analytics Purchase Events

Data Privacy

Enable SDK

Remote Command	Braze Method
`enable_sdk`	`enableSDK`

Braze Developer Guide: Analytics Disabling

Wipe Data

Remote Command	Braze Method
`wipe_data`	`wipeData`

Braze Developer Guide: Analytics Disabling

Requirements

How It Works

Install

Dependency Manager

Manual for iOS

Initialize

Supported Methods

SDK Setup

Initialize

User Tracking

Assigning a User ID

Aliasing Users

User Attributes

Standard Attributes

Set Custom Attribute

Unset Custom Attribute

Increment Custom Attribute

Set Custom Array Attribute

Append Custom Array Attribute

Remove Custom Array Attribute

Social Data Tracking

Facebook

Twitter

Custom Event Tracking

Custom Event

Notifications

Email Notifications

Push Notifications

Purchase Tracking

Log Purchase

Data Privacy

Enable SDK

Wipe Data