Branch

Branch.io is an industry leader in cross-platform attribution, mobile app measurement, and deep linking. Many top-ranking apps use Branch to increase their performance and revenue through better performance and engagement.

Find the open source transformer code for this destination in the GitHub repository.

Connection compatibility

Destination Information
Status: Generally Available Supported sources: Android (Java) , Android (Kotlin) , iOS (Obj-C) , iOS (Swift) , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova, Shopify Refer to it as Branch Metrics in the Integrations object.

Connection Modes
Source	Cloud mode	Device mode	Hybrid mode
AMP
Android (Java)
Android (Kotlin)
Cloud
Cordova
Flutter
iOS (Obj-C)
iOS (Swift)
React Native
Shopify
Unity
Warehouse
Web

Supported Message Types
Source	Identify	Page	Track	Screen	Group	Alias	Record	AudienceList
Cloud mode
Supported sources
Device mode
Android (Java)
iOS (Obj-C)

Get started

Once you have confirmed that the source platform supports sending events to Branch, follow these steps:

1. From your RudderStack dashboard, add a source. Then, from the list of destinations, select Branch Metrics.
2. Assign a name to the destination and click Continue.

Connection settings

To successfully set up Branch as a destination, you will need to configure the following settings:

• Branch key: Enter your Branch key from the Settings section in the Branch dashboard. For more information on obtaining this key, see FAQ.
• Map Your Events To Branch Events: Use this setting to map your RudderStack events to specific Branch events from the dropdown.

Note that:

• This setting is currently available in cloud mode only.
• The mappings specified using this setting override the default event mappings configured by RudderStack internally.

• Client-side Events Filtering: This setting lets you specify which events should be blocked or allowed to flow through to Branch. For more information on this setting, see the Client-side Events Filtering guide.
• Consent management settings: Configure the consent management settings for the specified source by choosing the Consent management provider from the dropdown and entering the relevant consent category IDs. See Consent Management in RudderStack for more information on this feature.

Adding device mode integration

Depending on your platform of integration, follow the below steps below to integrate Branch with your app.

pod 'Rudder-Branch', '2.0.0'

RudderConfigBuilder *builder = [[RudderConfigBuilder alloc] init];
[builder withDataPlaneUrl:<data_plane_url>];
[builder withFactory:[RudderBranchFactory instance]];
[builder withLoglevel:RudderLogLevelDebug];
[RudderClient getInstance:<write_key> config:[builder build]];

pod 'RudderBranch', '~> 1.0.0'

import RudderBranch

@import RudderBranch;

let config: RSConfig = RSConfig(writeKey: WRITE_KEY)
            .dataPlaneURL(DATA_PLANE_URL)

RSClient.sharedInstance().configure(with: config)
RSClient.sharedInstance().addDestination(RudderBranchDestination())

RSConfig *config = [[RSConfig alloc] initWithWriteKey:WRITE_KEY];
[config dataPlaneURL:DATA_PLANE_URL];

[[RSClient sharedInstance] configureWith:config];
[[RSClient sharedInstance] addDestination:[[RudderBranchDestination alloc] init]];

repositories {
    mavenCentral()
}

implementation 'com.rudderstack.android.sdk:core:[1.20.1, 2.0.0)'
implementation 'com.rudderstack.android.integration:branch:2.0.0'

// required if your app is in the Google Play Store (tip: avoid using bundled play services libs)
implementation 'com.google.android.gms:play-services-ads-identifier:17.1.0+'
// alternatively, use the following lib for getting the AAID
// implementation 'com.google.android.gms:play-services-ads:17.2.0'
// optional
// Chrome Tab matching (enables 100% guaranteed matching based on cookies)
implementation 'androidx.browser:browser:1.0.0'
// Replace above with the line below if you do not support androidx
// implementation 'com.android.support:customtabs:28.0.0'

// initialize Rudder SDK
val rudderClient: RudderClient =
    RudderClient.getInstance(
        this,
        WRITE_KEY,
        RudderConfig.Builder()
            .withDataPlaneUrl(DATA_PLANE_URL)
            .withLogLevel(RudderLogger.RudderLogLevel.DEBUG)
            .withFactory(BranchIntegrationFactory.FACTORY)
            .build()
    )

Identify

The identify call associates a user to their actions and also captures the traits associated with that user.

A sample identify call captured from the RudderStack iOS (Obj-C) SDK is as shown:

[[RudderClient sharedInstance] identify:@"developer_user_id"];

You can call identify when the user registers to the app for the first time, logs into the app, or updates their information.

Track

The track call lets you record the customer events along with any properties associated with them.

A sample track call is shown below:

[[RudderClient sharedInstance] track:@"test_event"
                          properties:@{@"key":@"value", @"foo": @"bar"}]

All the events tracked by RudderStack are divided into three major Branch event categories:

• Commerce events
• Content events
• Lifecycle events

Ecommerce event mapping

This destination does not strictly adhere to the RudderStack Ecommerce Event Spec.

The following table lists the mapping between the RudderStack ecommerce events and the Branch commerce events:

RudderStack also maps the Spend Credits event to Branch’s SPEND_CREDITS, although it is not directly a part of the ecommerce events.

However, note that the Android device mode integration does not support this mapping.

Content event mapping

The following table lists the mapping between the RudderStack events and the Branch Content events:

The above mentioned events are a part of the RudderStack ecommerce events but are mapped to Branch’s Content events.

Lifecycle event mapping

RudderStack supports mapping the following Branch lifecycle events:

Reset

The reset method resets the previously identified user and related information.

A sample reset call is shown:

[[RSClient getInstance] reset];

Property mappings

The following table lists the mapping of the accepted RudderStack properties common to all events:

FAQ

Where can I find the Branch key?

To retrieve your Branch key, follow these steps:

1. Log into your Branch dashboard.
2. Go to Account Settings > Profile.
3. You can find the Branch Key under Branch Key and Secret section: