Branch Web SDK

The Branch Web SDK provides a suite of methods for managing user sessions, tracking events, handling deep linking, and managing user privacy. The API is organized into the following functional areas:

1. Branch Session

Manage the user's lifecycle and identity within the SDK.

• .init(branch_key, options, callback): Initialize the SDK.
• .data(callback): Retrieve session data.
• .first(callback): Check if it is the user's first session.
• .setIdentity(identity, callback): Set user identity.
• .logout(callback): Log the user out.
• .crossPlatformIds(callback): Retrieve cross-platform identifiers.
• .lastAttributedTouchData(attribution_window, callback): Get attribution data.

2. Event Tracking

Record user actions and custom events.

• .track(event, metadata, callback): Track standard events.
• .logEvent(event, event_data_and_custom_data, content_items, callback): Log specific events with detailed data.

3. Deep Linking

Handle incoming links and deep view experiences.

• .link(data, callback): Create or process links.
• .deepview(data, options, callback): Trigger a deep view experience.
• .deepviewCta(): Handle deep view Call to Action.

4. Event Listener

Subscribe to SDK events.

• .addListener(event_listener): Add a listener.
• .removeListener(listener): Remove a listener.

5. Journeys Web To App

Manage the transition from web to mobile applications.

• .setBranchViewData(data): Set data for the web-to-app journey.
• .closeJourney(): Close the current journey.

6. Revenue Analytics

Track commerce-related data.

• .trackCommerceEvent(event, commerce_data, metadata, callback): Track revenue and commerce events.

7. User Privacy

Control data collection.

• .disableTracking(disableTracking): Enable or disable tracking.

To use the SDK, you must call branch.init() with your Branch Key. This is an asynchronous method that accepts a callback function to handle any errors (err) or returned data (data).

The SDK Command Queue

While branch.init() is asynchronous, the SDK includes a built-in command queue. This means you do not need to wrap all your SDK calls inside the init callback. As long as branch.init() is called before any other methods, the SDK guarantees that:

1. All methods are executed in the order they were called.
2. Each method waits for the previous one to finish before executing.

Note: If branch.init() fails, all subsequent calls to the Branch SDK will fail.

Example of calling methods immediately after initialization:

branch.init('BRANCH_KEY', function(err, data) { /* ... */ });
branch.banner(...); // This will wait for init to complete

branch.init('BRANCH KEY', function(err, data) {
    // callback to handle err or data
});

The Branch Web SDK is a native JavaScript library that requires no third-party dependencies. It is compatible with all modern browsers that support sessionStorage.

Browser Support

• Chrome: Supported
• Firefox: Supported
• Safari: Supported
• IE: 9, 10, 11

Installation Methods

1. Script Tag (Recommended)

Add the following script within your <head> tags. Replace BRANCH KEY with your actual Branch Key from your Branch dashboard.

<script type="text/javascript">
	branch.init('BRANCH KEY', function(err, data) {
    	// callback to handle err or data
	});
</script>

2. NPM or Bower

Install the branch-sdk package via npm or bower.

3. CommonJS or RequireJS

For environments like Webpack, Browserify, or RequireJS, you can import the SDK directly:

CommonJS:

const branch = require('branch');

RequireJS/AMD:

define(['branch'], function(branch) { ... });