• Platforms
  • Partners
  • Forums
  • 日本語
  • TLC Tealium Learning Center Tealium Learning
    Community
  • Discussions & Ideas Dicussions & Ideas
  • Product Guides Product Guides
  • Knowledge Base Knowledge Base
  • Developer Docs Developer Docs
  • Education Education
  • TLC Blog TLC Blog
  • Support Desk Support Desk
  • CDH Customer Data Hub Customer Data Hub
  • Mobile
  • Getting Started
    • Overview
    • Quick Start Guide
    • Mobile Concepts
    • Client-Side
    • Server-Side
    • Tracking Webviews
    • Data Layer
    • Consent Management
    • Event Batching
    • User Location and Geofencing
    • Media Tracking
    • Deep Links
    • Timed Events
    • Trace
    • Hosted Data Layer
    • Adobe Visitor Service Module
    • Feature Comparison
    • Troubleshooting
  • Remote Commands
    • Overview
    • How It Works
    • Integrations
      • Adjust
      • AppsFlyer
      • Branch
      • Braze
      • Contentsquare
      • Facebook
      • Firebase
      • Kochava
      • Usabilla
  • Android (Java)
    • Overview
    • Install
    • Track
    • Data Layer
    • Data Management
    • Consent Management
    • Module List
      • Ad Identifier Module
      • Crash Reporter Module
      • Install Referrer Module
      • Lifecycle Tracking Module
      • Location Module
      • Optimizely X Tracking Module
    • Android TV
    • Android Wear
    • API Reference
      • ConsentManager
      • DataSources
      • Lifecycle
      • Tealium
      • Tealium.Config
      • TealiumLocation
    • Release Notes
  • Android (Kotlin)
    • Overview
    • Install
    • Track
    • Data Layer
    • Consent Management
    • Identity Resolution
    • Module List
      • Ad Identifier Module
      • AutoTracking Module
      • AdobeVisitorService Module
      • Collect Module
      • Collectors Module
      • Crash Reporter Module
      • In-App Purchase Module
      • Install Referrer Module
      • Lifecycle Tracking Module
      • Location Manager Module
      • Media Module
      • RemoteCommands Module
      • Tag Management Dispatcher Module
      • Visitor Service Module
    • Android TV
    • API Reference
      • ConsentCategory
      • ConsentManager
      • CurrentVisit
      • DataLayer
      • Lifecycle
      • LocationManager
      • Media
      • Tealium
      • TealiumConfig
      • VisitorProfile
      • VisitorService
    • Release Notes
  • Cordova 1.x
    • Overview
    • Install
    • Track
    • Data Management
    • Module List
      • Ad Identifier Module
      • Crash Reporter Module
      • Install Referrer Module
    • API Reference
    • Release Notes
  • Cordova 2.x
    • Overview
    • Install
    • Track
    • API Reference
    • Release Notes
  • Flutter 1.x
    • Overview
    • Install
    • Track
    • Consent Management
    • Data Management
    • API Reference
    • Release Notes
  • Flutter 2.x
    • Overview
    • Install
    • Track
    • Consent Management
    • Data Management
    • API Reference
      • Tealium
      • TealiumConfig
      • VisitorProfile
    • Release Notes
  • iOS (Objective-C)
    • Overview
    • Install
    • Track
    • Data Layer
    • Data Management
    • Consent Management
    • Tag Management
    • Module List
      • Lifecycle Tracking Module
    • tvOS
    • watchOS
    • API Reference
    • Release Notes
  • iOS (Swift) 1.x
    • Overview
    • Install
    • Track
    • Data Layer
    • Data Management
    • App Extensions
    • Identity Resolution
    • Consent Management
    • Modules
    • Module List
      • AppData Module
      • Attribution Module
      • AutoTracking Module
      • Collect Module
      • Connectivity Module
      • CrashReporter Module
      • DataSource Module
      • DefaultStorage Module
      • Delegate Module
      • DeviceData Module
      • DispatchQueue Module
      • FileStorage Module
      • Lifecycle Module
      • Location Module
      • Logger Module
      • PersistentData Module
      • RemoteCommands Module
      • TagManagement Module
      • VisitorService Module
      • VolatileData Module
    • Feature Comparison
    • Working with Objective-C
    • API Reference
      • TealiumConfig
      • TealiumConsentCategories
      • TealiumConsentManagerDelegate
      • TealiumConsentManager
      • TealiumInstanceManager
      • TealiumPersistentData
      • TealiumVolatileData
      • Tealium
    • Release Notes
  • iOS (Swift) 2.x
    • Overview
    • Install
    • Track
    • Data Layer
    • Consent Management
    • App Extensions
    • Identity Resolution
    • Modules
    • Module List
      • AppData Module
      • AdobeVisitorService Module
      • Attribution Module
      • AutoTracking Module
      • Collect Module
      • Connectivity Module
      • CrashReporter Module
      • DeviceData Module
      • In-App Purchase Module
      • Lifecycle Module
      • Location Module
      • Media Module
      • RemoteCommands Module
      • TagManagement Module
      • VisitorService Module
    • Working with Objective-C
    • API Reference
      • LocationModule
      • MediaSession
      • Tealium
      • TealiumConfig
      • TealiumConsentCategories
      • TealiumConsentManager
      • TealiumDataLayer
      • TealiumInstanceManager
    • Release Notes
  • NativeScript
    • Overview
    • Install
    • Track
    • API Reference
      • Tealium
      • TealiumConfig
    • Release Notes
  • React Native 1.x
    • Overview
    • Install
    • Track
    • API Reference
    • Release Notes
  • React Native 2.x
    • Overview
    • Install
    • Track
    • Location Module
    • API Reference
    • Release Notes
  • Unity 1.x
    • Overview
    • Install
    • Track
    • API Reference
  • Unity 2.x
    • Overview
    • Install
    • Track
    • API Reference
  • Xamarin 1.x
    • Overview
    • Install
    • Track
    • Data Management
    • Consent Management
    • API Reference
    • Release Notes
  • Xamarin 2.x
    • Overview
    • Install
    • Track
    • Data Layer
    • Consent Management
    • API Reference
    • Release Notes
  • Web
  • Getting Started
    • Overview
    • Quick Start Guide
    • Web Concepts
    • Data Layer
      • An Introduction to the Data Layer
      • How the Data Layer Works for Websites
      • Data Layer Best Practices
      • Definitions
        • Retail
        • Publisher
        • Hotel
        • Travel
        • Basic Video Tracking
  • Adobe Launch
    • Overview
    • Install
    • Data Layer
  • AMP
    • Overview
    • Install
    • Track
    • Data Layer
  • Angular
    • Overview
    • Install
    • Track
    • API Reference
  • Google Tag Manager
    • Overview
    • Install
    • Data Layer
  • JavaScript (Web)
    • Overview
    • Install
    • Track
    • Data Layer
    • Universal Data Object (utag_data)
    • Universal Tag (utag.js)
    • Data Layer Object (b)
    • Single-Page Applications
    • Settings
    • Debugging
    • API Reference
      • Cookie Functions
      • GDPR Functions
      • Tracking Functions
      • Utility Functions
    • Release Notes
  • Server
  • C#
    • Overview
    • Install
    • Track
    • Data Layer
    • API Reference
    • Release Notes
  • HTTP API
    • Overview
    • Endpoint
    • Data Layer
  • Java
    • Overview
    • Install
    • Track
    • API Reference
    • Release Notes
  • Node
    • Overview
    • Install
    • Track
    • API Reference
  • Python
    • Overview
    • Install
    • Track
    • API Reference
  • Roku
    • Overview
    • Install
    • Track
    • API Reference
  • Ruby
    • Overview
    • Install
    • Track
    • API Reference
REMOTE COMMANDS/INTEGRATIONS

Remote Command: Braze

Tealium remote command integration for Braze on Android and Swift/iOS.

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.

    To install Braze remote commands for iOS using CocoaPods:

    1. Remove tealium-swift and pod "Appboy-iOS-SDK" if they exist in your Podfile. The dependency for tealium-swift is already included in the TealiumBraze framework.

    2. Add the following dependency to your Podfile:

      pod "TealiumBraze"
      

      The TealiumBraze pod includes the following TealiumSwift dependencies:

      'tealium-swift/Core'
      'tealium-swift/RemoteCommands'
      'tealium-swift/TagManagement'
      
    3. Import the modules TealiumSwift and TealiumBraze in your TealiumHelper file, and any other files that access the Tealium class, or the Braze remote command.

    To install Braze remote commands for iOS using Carthage:

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

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

      github "Appboy/Appboy-iOS-SDK"
      
    3. Add the following dependency to your Cartfile:

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

    Tealium for Swift SDK (version 1.x) and TealiumBraze version 1.x requires the TealiumDelegate module to be included with your installation.

    To install Braze remote commands for Android using Maven:

    1. Install Tealium for Android (Kotlin) or Tealium for Android (Java) and add the Tealium Maven URL to your project’s top-level build.gradle file, if you haven’t done so already.

      allprojects {
        repositories {
          jcenter()
          maven {
            url "https://maven.tealiumiq.com/android/releases/"
          }
        }
      }
      
    2. Import both the Braze SDK and Tealium-Braze remote commands by adding the following dependencies in your app project’s build.gradle file:

      dependencies {
        implementation 'com.tealium.remotecommands:braze:1.0.0'
        implementation 'com.appboy:android-sdk-ui:10.1.0'
      }
      

    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.

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

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

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

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

        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.

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

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

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

          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 (iOS) Braze Method (Android)
          initialize startWithApiKey() configure()

          The following mappings are used to set launch options.

          Parameter Type Description
          custom_endpoint String Sets a custom API endpoint. This gets sent in the format sdk.api.braze.eu
          device_options Int Key to specify a whitelist for device fields that are collected by the Braze SDK (default all fields are collected)
          disable_location Int Disable automatic location data collection (1 or 0)
          enable_geofences Int Enable automatic collection of geofences (1 or 0)
          flush_interval Double Sets the data flush interval (in seconds). Values are converted into NSTimeIntervals and must be greater than 1.0
          push_story_identifier String This key is set to a string value representing the app group name for the Push Story Notification Content extension.
          request_processing_policy Int Possible values for the SDKs request processing (default ABKAutomaticRequestProcessing)
          session_timeout Int (seconds) The session timeout in seconds (default: 30 seconds)
          trigger_interval_seconds Int (seconds) Override the minimum interval between in-app message triggers (default: 30 seconds)

          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

          Remote Command Braze Method
          useridentifier changeUser
          Parameter Type
          user_id (required) String
          • Braze Developer Guide: Analytics User IDs
            • iOS
            • Android

          Aliasing Users

          Remote Command Braze Method
          useralias addAlias
          Parameter Type
          user_alias (required) String
          alias_label (required) String
          • Braze Developer Guide: Analytics Alias Users
            • iOS
            • Android

          User Attributes

          Standard Attributes

          Event Braze Method
          userattribute Set fields on the ABKUser/AppboyUser 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
          • Braze Developer Guide: Analytics User Attributes
            • iOS
            • Android
          • Braze Developer Guide: User Data API

          Set Custom Attribute

          Remote Command Braze Method (iOS) Braze Method (Android)
          setcustomattribute setCustomAttributeWithKey setCustomUserAttribute
          Parameter Type
          set_custom_attribute.PROPERTY [String: Any] / JSONObject
          • Braze Developer Guide: Analytics Custom Attributes
            • iOS
            • Android

          Unset Custom Attribute

          Remote Command Braze Method (iOS) Braze Method (Android)
          setcustomattribute unsetCustomAttributeWithKey unsetCustomUserAttribute
          Parameter Type
          set_custom_attribute.PROPERTY String
          • Braze Developer Guide: Analytics Custom Attributes
            • iOS
            • Android

          Increment Custom Attribute

          Remote Command Braze Method
          incrementcustomattribute incrementCustomUserAttribute
          Parameter Type
          increment_custom_attribute.PROPERTY String
          • Braze Developer Guide: Analytics Incrementing Attributes
            • iOS
            • Android

          Set Custom Array Attribute

          Remote Command Braze Method (iOS) Braze Method (Android)
          setcustomarrayattribute setCustomAttributeArrayWithKey setCustomAttributeArray
          Parameter Type
          set_custom_array_attribute.PROPERTY [String: [Any]] / JSONObject
          • Braze Developer Guide: Analytics Array Attributes
            • iOS
            • Android

          Append Custom Array Attribute

          Remote Command Braze Method (iOS) Braze Method (Android)
          appendcustomarrayattribute addToCustomAttributeArrayWithKey addToCustomAttributeArray
          Parameter Type
          append_custom_array_attribute.PROPERTY [String: String] / JSONObject
          • Braze Developer Guide: Analytics Array Attributes
            • iOS
            • Android

          Remove Custom Array Attribute

          Remote Command Braze Method (iOS) Braze Method (Android)
          removecustomarrayattribute removeFromCustomAttributeArrayWithKey removeFromCustomAttributeArray
          Parameter Type
          remove_custom_array_attribute.PROPERTY [String: String] / JSONObject
          • Braze Developer Guide: Analytics Array Attributes
            • iOS
            • Android

          Social Data Tracking

          Facebook

          Remote Command Braze Method
          facebookuser Initialize an ABKFacebookUser/FacebookUser object
          Parameter Type
          facebook_id [String: Any] / String
          friends_count Int
          likes [Any] / String[]
          • Braze Developer Guide: Social Data
            • iOS
            • Android

          Twitter

          Remote Command Braze Method
          twitteruser Initialize a ABKTwitterUser/TwitterUser 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
            • iOS
            • Android

          Custom Event Tracking

          Custom Event

          Remote Command Braze Method
          logcustomevent logCustomEvent
          Parameter Type
          event_name (required) String
          event_properties [String: Any] / JSONObject
          • Braze Developer Guide: Analytics Custom Events
            • iOS
            • Android

          Notifications

          Email Notifications

          Remote Command Braze Method
          emailnotification setEmailNotificationSubscriptionType
          Parameter Type Example
          email_notification String ["optedin", "subscribed", "unsubscribed"]
          • Braze Developer Guide: Analytics Email Subscriptions
            • iOS
            • Android

          Push Notifications

          Remote Command Braze Method
          pushnotification setPushNotificationSubscriptionType
          Parameter Type Example
          push_notification String ["optedin", "subscribed", "unsubscribed"]
          • Braze Developer Guide: Analytics Push Notifications
            • iOS
            • Android

          Purchase Tracking

          Log Purchase

          Remote Command Braze Method
          logpurchase logPurchase
          Parameter Type
          product_id (required) [String] / String[]
          currency (required) String / String
          price (required) [Double] / Double[]
          quantity [Int] / Int[]
          purchase_properties [AnyHashable: Any] / JSONObject
          • Braze Developer Guide: Analytics Purchase Events
            • iOS
            • Android

          Location Tracking

          Set User’s Last Known Location

          Remote Command Braze Method
          setlastknownlocation setLastKnownLocationWithLatitude
          Parameter Type
          latitude (required) Double
          longitude (required) Double
          horizontalAccuracy (required) Double
          altitude Double
          verticalAccuracy Double
          • Braze Developer Guide: Analytics Location Tracking

          Data Privacy

          Enable SDK

          Remote Command Braze Method (iOS) Braze Method (Android)
          enable_sdk enableSDK enableSdk/disableSdk
          Parameter Type Example
          enable_sdk Boolean true / false
          • Braze Developer Guide: Analytics Disabling
            • iOS
            • Android

          Wipe Data

          Remote Command Braze Method
          wipe_data wipeData
          • Braze Developer Guide: Analytics Disabling
            • iOS
            • Android
          "Remote Command: Branch "
          Previous
          Remote Command: Branch
          Next
          Remote Command: Contentsquare
          "Remote Command: Contentsquare"

           

          Was this article helpful?

          This page was last updated: March 2, 2022      

          Thank you for your feedback!

          Table of Contents

          • Requirements
          • How It Works
          • Install
            • Dependency Manager
            • Manual (iOS)
          • Initialize
            • Android (Kotlin)
            • Android (Java)
            • iOS (Swift)
          • JSON Template
          • Supported Methods
            • SDK Setup
            • User Tracking
            • User Attributes
            • Social Data Tracking
            • Custom Event Tracking
            • Notifications
            • Purchase Tracking
            • Location Tracking
            • Data Privacy
          • Platforms
          • Partners
          • Forums
          • Mobile
          • Getting Started
          • Remote Commands
          • Android (Java)
          • Android (Kotlin)
          • Cordova 1.x
          • Cordova 2.x
          • Flutter 1.x
          • Flutter 2.x
          • iOS (Objective-C)
          • iOS (Swift) 1.x
          • iOS (Swift) 2.x
          • NativeScript
          • React Native 1.x
          • React Native 2.x
          • Unity 1.x
          • Unity 2.x
          • Xamarin 1.x
          • Xamarin 2.x
          • Web
          • Getting Started
          • Adobe Launch
          • AMP
          • Angular
          • Google Tag Manager
          • JavaScript (Web)
          • Server
          • C#
          • HTTP API
          • Java
          • Node
          • Python
          • Roku
          • Ruby