Remote Command: Braze

Requirements

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

How It Works

The Braze integration uses three items:

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

Adding the Braze remote command module to your app automatically installs and builds the required Braze libraries, without having to add vendor-specific code to your app. If you are using a dependency manager installation, there is no need to install the Braze 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 Braze remote commands requires the Tealium for Swift library to be installed. To install the Braze remote commands for your iOS project:

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

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

3. Set the remoteAPIEnabled configuration flag to true

Initialize

For all Tealium libraries, you need to register the Braze remote command when you initialize.

Android (Kotlin)

Initialize remote commands with a JSON configuration file or the Remote Command tag for Tealium’s Kotlin library.

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
// New code to add the Braze Remote Command
val brazeRemoteCommand = BrazeRemoteCommand(application,
                            true,
                            sessionHandlingBlacklist,
                            true,
                            inAppMessageBlacklist)

var tealium = Tealium.create(TEALIUM_MAIN, config) {
    // Optional: Set config options that may not be supported yet by the Tag in Tealium IQ
    //              or simply to override settings locally.
    brazeRemoteCommand.registerConfigOverride { builder ->
            // builder.setIsLocationCollectionEnabled(true);
            // builder.setGeofencesEnabled(true);
            // builder.setPushDeepLinkBackStackActivityEnabled(true);
            // builder.setPushDeepLinkBackStackActivityClass(UserActivity.class);
    }

    // register the command
    remoteCommands?.add(brazeRemoteCommand, filename = "braze.json");
}

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands, Dispatchers.TagManagement));
// New code to add the Braze Remote Command
val brazeRemoteCommand = BrazeRemoteCommand(application,
                            true,
                            sessionHandlingBlacklist,
                            true,
                            inAppMessageBlacklist)

var tealium = Tealium.create(TEALIUM_MAIN, config) {
    // Optional: Set config options that may not be supported yet by the Tag in Tealium IQ
    //              or simply to override settings locally.
    brazeRemoteCommand.registerConfigOverride { builder ->
            // builder.setIsLocationCollectionEnabled(true);
            // builder.setGeofencesEnabled(true);
            // builder.setPushDeepLinkBackStackActivityEnabled(true);
            // builder.setPushDeepLinkBackStackActivityClass(UserActivity.class);
    }

    // register the command
    remoteCommands?.add(brazeRemoteCommand);
}

Android (Java)

import com.tealium.remotecommands.BrazeRemoteCommand;

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

BrazeRemoteCommand braze;
// Initialize with default configuration options.
braze = new BrazeRemoteCommand(config);

// Or alternatively initialize with some additional config options:
Set<Class> sessionHandlingBlacklist = new HashSet<>();
Set<Class> inAppMessageBlacklist = new HashSet<>();
// sessionHandlingBlacklist.add(MainActivity.class);
// inAppMessageBlacklist.add(UserActivity.class);
braze = new BrazeRemoteCommand(config,
        true,                     // sessiongHandlingEnabled
        sessionHandlingBlacklist, // sessionHandlingBlacklist
        true,                     // registerInAppMessageManager
        inAppMessageBlacklist);   // inAppMessageBlackList

// Optional: Set config options that may not be supported yet by the Tag in Tealium IQ
//              or simply to override settings locally.
braze.registerConfigOverride(new BrazeRemoteCommand.ConfigOverrider() {
    @Override
    public void onOverride(AppboyConfig.Builder b) {
        b.setPushDeepLinkBackStackActivityEnabled(true);
        b.setPushDeepLinkBackStackActivityClass(UserActivity.class);
    }
});

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

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.remoteAPIEnabled = true // Required to use Remote Commands

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

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

config.remoteAPIEnabled = true // Required to use Remote Commands

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

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": {
        "api_key": "YOUR_API_KEY",
        "session_timeout": 30,
        "disable_location": false,
        "trigger_interval_seconds": 100
    },
    "mappings": {
        "customer_id": "user_id",
        "customer_first_name": "first_name",
        "customer_last_name": "last_name",
        "customer_gender": "gender",
        "customer_language": "language",
        "customer_email": "email",
        "customer_home_city": "home_city",
        "customer_dob": "date_of_birth",
        "customer_alias": "user_alias",
        "customer_alias_label": "alias_label",
        "pet": "set_custom_attribute.pet",
        "pet_count": "set_custom_attribute.pet_count",
        "pet_count_unset": "unset_custom_attribute.pet_count_unset",
        "pet_count_increment": "increment_custom_attribute.pet_count_increment",
        "pet_names": "set_custom_array_attribute.pet_names",
        "pet_names_append": "append_custom_array_attribute.pet_names_append",
        "pet_names_remove": "remove_custom_array_attribute.pet_names_remove",
        "facebook_user": "facebook_user",
        "number_of_friends": "friends_count",
        "list_of_likes": "likes",
        "facebook_user_properties": "facebook_user",
        "social_media_user_description": "description",
        "twitter_id": "twitter_id",
        "twitter_name": "twitter_name",
        "twitter_user_description": "description",
        "profile_image_url": "profile_image_url",
        "screen_name": "screen_name",
        "number_of_followers": "followers_count",
        "number_of_statuses": "statuses_count",
        "email_notification": "email_notification",
        "push_notification": "push_notification",
        "event_name": "event_name",
        "current_level": "event.current_level",
        "start_date": "event.start_date",
        "high_score": "event.high_score",
        "product_id": "product_id",
        "product_quantity": "quantity",
        "product_unit_price": "product_unit_price",
        "currency_code": "order_currency",
        "rewards_member": "purchase.rewards_member",
        "rewards_points_earned": "purchase.rewards_points_earned",
        "date_joined_program": "purchase.date_joined_program",
        "latitude": "location_latitude",
        "longitude": "location_longitude",
        "horizontal_accuracy": "location_horizontal_accuracy"
    },
    "commands": {
        "launch": "initialize",
        "twitter": "twitteruser",
        "facebook": "facebookuser",
        "setengagement": "emailnotification,pushnotification",
        "log_custom_event": "logcustomevent",
        "set_location": "setlastknownlocation",
        "custom_attribute": "setcustomattribute",
        "unset_custom_attribute": "unsetcustomattribute",
        "custom_array_attribute": "appendcustomarrayattribute",
        "append_custom_array_attribute": "appendcustomarrayattribute",
        "remove_custom_array_attribute": "removecustomarrayattribute",
        "increment_custom_attribute": "incrementcustomattribute",
        "log_purchase": "logpurchase",
        "user_attribute": "userattribute,useridentifier,useralias",
        "user_login": "useridentifier,useralias",
        "user_alias": "useralias",
    }
}

Supported Methods

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

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.

The following mappings are used to set launch options.

Android

• Braze Developer Guide: Initial SDK Setup

iOS

• Braze Developer Guide: Initial SDK Setup
  
• Braze Developer Guide: Fine Network Traffic Control
  
• Braze Developer Guide: Locations and Geofences
  
• Braze Developer Guide: Push Story Setup
  
• Braze Developer Guide: Tracking Sessions

User Tracking

Assigning a User ID

• Braze Developer Guide: Analytics User IDs
  
  • iOS
  • Android

Aliasing Users

• Braze Developer Guide: Analytics Alias Users
  
  • iOS
  • Android

User Attributes

Standard Attributes

• Braze Developer Guide: Analytics User Attributes
  • iOS
  • Android
• Braze Developer Guide: User Data API

Set Custom Attribute

• Braze Developer Guide: Analytics Custom Attributes
  
  • iOS
  • Android

Unset Custom Attribute

• Braze Developer Guide: Analytics Custom Attributes
  
  • iOS
  • Android

Increment Custom Attribute

• Braze Developer Guide: Analytics Incrementing Attributes
  • iOS
  • Android

Set Custom Array Attribute

• Braze Developer Guide: Analytics Array Attributes
  
  • iOS
  • Android

Append Custom Array Attribute

• Braze Developer Guide: Analytics Array Attributes
  
  • iOS
  • Android

Remove Custom Array Attribute

• Braze Developer Guide: Analytics Array Attributes
  
  • iOS
  • Android

Social Data Tracking

Facebook

• Braze Developer Guide: Social Data
  
  • iOS
  • Android

Twitter

• Braze Developer Guide: Social Data
  
  • iOS
  • Android

Custom Event Tracking

Custom Event

• Braze Developer Guide: Analytics Custom Events
  • iOS
  • Android

Notifications

Email Notifications

• Braze Developer Guide: Analytics Email Subscriptions
  
  • iOS
  • Android

Push Notifications

• Braze Developer Guide: Analytics Push Notifications
  
  • iOS
  • Android

Purchase Tracking

Log Purchase

• Braze Developer Guide: Analytics Purchase Events
  
  • iOS
  • Android

Location Tracking

Set User’s Last Known Location

• Braze Developer Guide: Analytics Location Tracking

Data Privacy

Enable SDK

• Braze Developer Guide: Analytics Disabling
  
  • iOS
  • Android

Wipe Data

• Braze Developer Guide: Analytics Disabling
  
  • iOS
  • Android