Branch helps mobile apps grow with deep links that power referral systems, sharing links, invites and marketing links with full attribution and analytics.
mParticle and Branch also offer a web kit that maps common event types such as custom events and commerce events from mParticle’s web sdk to Branch’s web sdk.
Branch provides further documentation on their doc site for the two types of implementation:
Additional documentation around Branch’s custom and commerce events can be found in their Web SDK documentation.
mParticle supports two separate integrations for sending event data to Branch:
We strongly recommend using the embedded kit integration if you fall under any of the following categories:
The S2S integration has been created primarily to support existing Branch customers, who already have implemented the standalone Branch SDK in their apps, and wish to use mParticle to add additional event-forwarding capability. If you fall into this category, it is recommended that you use the S2S event integration, while taking care not to duplicate any data you are already sending to Branch client-side via their standalone SDK. Keep in mind that for your S2S data to be used by Branch, you will need to include at least one device identity. See Supported IDs, for more information.
In order to activate mParticle’s integration with Branch Metrics, you will need to have your Branch Metrics API key handy - one for each app that you would like to set up. Here is a screenshot from Branch Metric’s dashboard where you can find the API Key.
Branch Metrics is integrated with mParticle via the Branch Metrics Kits on iOS and Android. In order to use it, you must add the Branch Metrics kit to your project. See the getting started section for how to add individual kits. In order to test your Branch integration, be sure that the mParticle SDK is running in development mode, and that you’ve configured your Branch test API key in the development-mode settings for your app in the mParticle dashboard. The mParticle SDK will automatically use the right key to initialize the Branch SDK for you.
Once you have added the kit and configured your branch API key in the mParticle dashboard, the mParticle SDKs will take care of initializing the Branch Metrics SDK and forwarding the appropriate application lifecycle events to handle deep links.
The mParticle iOS SDK (version 5.4.1 and later) will automatically call the following methods of the Branch Metrics SDK:
The mParticle Android SDK will initialize the Branch SDK with your Branch API key, and will automatically invoke the
Branch#closeSession APIs when appropriate.
When implementing Branch Metrics with the mParticle Android SDK, also keep in mind:
ReferrerReceiverto your app’s
getAutoInstance()API, rather than the typical
The mParticle Android SDK provides a deep link API that you can use to query Branch Metrics and customize your app experience based on the parameters of deep links. Refer to the deep linking section:
SDKs to learn how to use these APIs. Rather than making direct API calls to the Branch Metric SDK, this API let you write integration-agnostic apps that are easier to maintain.
Though mParticle takes care of initializing the Branch SDK, you still need to choose and define a URI scheme for your app. Follow the iOS and Android links below to register your scheme with Branch Metrics and in your app:
For Android/iOS, by calling
logEvent in mParticle, the Branch Kit will automatically call the Branch
userCompletedAction API. Calling
logScreen in the mParticle SDK will call the same API, prepending
"Viewed " to the name of the event. You can filter event and screen data that you don’t want or need to go to Branch Metrics in the Data Filters section of the mParticle dashboard.
mParticle and Branch’s web kit offers support for custom events and commerce events.
mParticle maps Customer IDs to the Branch Metrics
setIdentity API. See the documentation on user identity to learn how to set Customer IDs in the mParticle SDKs.
mParticle will also map our
logout() method to the Branch SDK
|Setting Name||Data Type||Default Value||Description|
||Your app key found on the Settings page of the Branch Metrics dashboard|
|Setting Name||Data Type||Default Value||Platform||Description|
|Forward screen view messages||
||False||iOS/Android||If enabled, all screen view messages will be forwarded to Branch as separate events.|
|Enable Apple Search Ads||
||False||iOS||Enabling Apple Search Ads will delay the Branch SDK initialization. This may result in a 1 second or longer delay in responding to deep links.|
|Branch Developer ID||
||Customer ID||Web||The mParticle User Identity type to forward as the Branch Developer ID|
Was this page helpful?