Overview

Send your referred Branch data to your Google Analytics dashboard, helping you understand the power of Branch as an acquisition and re-engagement pathway. If you're interested in the segment of users coming into your apps through Branch and want to measure their events against your other cohorts, this guide can help.

How does it work?

Once the Branch SDK is integrated into an app, Branch can detect which Branch Links are leading to opens, installs, re-installs, and down funnel events. Enabling this integration and providing your Google Analytics Tracking ID will result in Branch automatically forwarding events to Google Analytics, in the exact format Google Analytics expects. This includes automatically setting various UTM tags that can be used to determine the source of new users.

Branch events sent to Google Analytics

Branch will send referred installs and opens, commerce, content, user lifecycle, as well as any custom events you track with Branch. Clicks, web session starts, and web pageviews will not be sent. Branch also sends over analytics data that is attached to the link, whether it's UTM tags or fields set in Branch (e.g. Campaign, Channel, Feature). This will allow you to analyze which campaigns, channels, etc. are helping you acquire and engage users. You can see the list of fields that we send to Google Analytics in Properties sent to Google Analytics.

What does it look like?

Branch events will appear alongside your other tracked events in Google Analytics. Here is an example of the Sources screen with test information set.

To view installs and opens, as well as any custom events you track with Branch as they occur, navigate to Real-Time > Events. The event category for all Branch events is BranchEvent.

Before you begin

To set up the Google Analytics integration, you first need to:

1. Admin access to your Branch account.

2. Have data export functionality enabled on your Branch account. Availability varies by Branch plan. See Branch pricing or contact your Branch representative.

3. Implemented the Branch SDK into your mobile app (iOS | Android).

   • Track events

4. Implement the Google Analytics SDK.

5. Admin access to your Google Analytics account.

Enable Google Analytics

Complete the following steps to enable Google Analytics:

1. Retrieve IDs from Google Analytics

Log into your Google Analytics Dashboard. Make sure that you have admin access.

To retrieve your Tracking ID:

• Go to Admin.
• In the Property column, select Property Settings. Your UA-XXXX Tracking ID appears at the top of the Property Settings page.

2. Connect Google Analytics in Branch

In Branch, go to Configuration > Integrations and select the Data tab. Search for Google Analytics and select it to open its data partner page.

In the Export section, enter the following, then toggle Export to Enabled and select Save:

• Android Tracking ID.
• iOS Tracking ID.

Note: If you only have one Tracking ID, then enter the same ID for both iOS and Android.

3. Pass metadata to the Branch SDK

Developer Required

Developers on your mobile app are required for this step.

For a given app session, the unique Google Analytics identifier needs to be passed to the Branch SDK (before the Branch SDK initializes) in order for Branch to properly send events to Google Analytics.

Compatible IDs

Version	Identifier	Google Shortcode	Branch Metadata Key
Universal Analytics	Client ID (for device identification)	cid	$google_analytics_client_id

Specify the Branch metadata key for your Google Analytics tracking identifier.

Pass Client ID to Branch

Note: You just need to pass a random UUID on install and store it in local storage for later use for the Branch SDK.

Swift

// Add before initializing Branch session.
let uuid = UUID().uuidString;
let branch = Branch.getInstance();
branch.setRequestMetadataKey("$google_analytics_client_id", uuid)

Java

// Need import java.util.UUID
// Call after instantiating Branch in your application's onCreate before you call Branch initSession
UUID uuid = UUID.randomUUID();
String client_id = uuid.toString();

Branch.getInstance().setRequestMetadata("$google_analytics_client_id",client_id);

4. Verify data sent

Once the above steps are complete, you are now ready to start launching campaigns. Branch-attributed conversions will be sent to Google Analytics. To verify data is being sent from Branch to Google Analytics, you can look at Branch's Liveview Webhook Records and apply the following filter:

Filter	Operator	Value
webhook partner key	equals	di_google_analytics

Wait Period

Data may take some time to flow through Branch's attribution systems and onto Google Analytics. If data has not appeared in Google Analytics after 30 minutes of completing a test conversion, review the above steps to see if you may have missed something.

Properties sent to Google Analytics

Property Name	Value	Sourced From	Example	Required
v	API version	[fixed]	1	Yes
tid	Tracking ID	Branch	UA-XXXXXX-Y	Yes
ds	Source (mobile SDK)	[fixed]	app	Yes
an	Application Name	[fixed]	BRANCH-APP	Yes
t	Type	[fixed]	event	Yes
ec	Event Category	[fixed]	BranchEvent	Yes
cid	Client ID	(discussed above, includes $google_analytics_client_id)	AEBE52E7-03EE-455A-B3C4-E57283966239	Yes
uid	User ID	$google_analytics_user_id	User A	No
cn	Campaign Name	utm_campaign or Branch campaign	"Beaches and breezes"	No
cs	Campaign Source	utm_source or Branch channel	"Twitter"	No
cm	Campaign Medium	utm_medium or Branch feature	"480banner"	No
ck	Campaign Keywords	utm_term or Branch $keywords	["Keyword1", "keyword3"]	No
cc	Campaign Content	utm_content or Branch tags	"Some content"	No
ea	Event Action (Name)	event name	install	Yes
uip	Device IP Address	collected by Branch SDK	111.111.111.111	No
z	Cache buster	[unix time + random number]	1461878903666	No

Anonymous Client ID

If for some reason Branch does not receive an advertising identifier or hardware identifier, and you do not explicitly specify $google_analytics_user_id or $google_analytics_client_id, then Branch will send anonymous as the Client ID (cid). This is a required field by Google Analytics.

Troubleshooting

The following sections cover common issues and how to resolve them.

Very short or nonexistent session lengths

Google Analytics will automatically start a session when Branch sends over installs and opens. Because of this, you should remove any code that creates a new session when your application starts up. For example, on iOS, you may be firing an event with the following:

[builder set:@"start" forKey:kGAISessionControl];

You should remove this so that your app does not start a new session. Otherwise, you may see zero second sessions and your average session length drop.

Data not appearing in Google Analytics

1. Check your Tracking ID in Branch matches the Tracking ID in Google Analytics.
2. Ensure you are looking at the right part of the Google Analytics dashboard. The data should appear in Acquisition > Sources > All.
3. Check that your Google Analytics Views don't have any filters on them. For example, if your View filters out users in the United Kingdom, and your Branch opens are from users in the United Kingdom, you won't see this Branch data in your View.