Overview

Branch's Consumer Protection Preferences (CPP) model is an advancement in the user consent and attribution space. Instead of turning tracking either entirely on or entirely off for a user, you can take a more nuanced approach based on the level of consent you've received from them.

Once you've integrated a Branch SDK into your app, you can use it to tell Branch the level of data you want to collect and transmit about these users.

Branch offers four consumer data preference levels, ranging from full attribution to no attribution.

Using the setConsumerProtectionAttributionLevel method, you can relay to Branch the level of attribution and analytics data the user has consented to sharing with you and third parties.

Consumer Preference Levels

The table below lists the different consumer preference levels and provides a brief description of each. See the next section for a more detailed look at each level.

Consumer Preference Level	Description
Full Attribution	This is the default level. This level includes advertising IDs and device IDs, as well as other data.
Privacy Attribution	This level does not include advertising IDs, but does include data from privacy frameworks like SKAN and Privacy Sandbox.
Analytics Only	This level includes device IDs, but does not include data from privacy frameworks.
No Attribution	This level only includes deterministic deep linking. Appropriate for customers with specific privacy compliance needs.

Consumer Preference Level Details

	Full Attribution	Privacy Attribution	Analytics Only	No Attribution
Advertising IDs (aaid/idfa)	Yes	No	No	No
Device IDs (idfv/android_id/BFPID)	Yes	Yes	Yes	No
Persisted Non-Aggregate IDs (gclid)	Yes	No	No	No
Persisted Aggregate IDs (gbraid)	Yes	No	No	No
Privacy Frameworks	Yes	Yes	No	No
Ads Postbacks/Webhooks	Yes	No	No	No
Data Integrations/ Dashboard Webhooks	Yes	Yes	Yes	No
SAN Callouts	Yes	No	No	No
Deep Linking	Always	Always	Always	Deterministic Only

Usage

The table below describes how each consumer preference level is referred to in various languages.

Consumer Preference Level	Swift	Objective-C	Kotlin	Android
Full Attribution	`full`	`BranchAttributionLevelFull`	`FULL`	`FULL`
Privacy Attribution	`reduced`	`BranchAttributionLevelReduced`	`REDUCED`	`REDUCED`
Analytics Only	`minimal`	`BranchAttributionLevelMinimal`	`MINIMAL`	`MINIMAL`
No Attribution	`none`	`BranchAttributionLevelNone`	`NONE`	`NONE`

Examples

Use the values in the table above alongside the consumer preference method used in these examples to set the appropriate attribution levels for your customers.

iOS

// Set consumer preference level to "Privacy Attribution"
Branch.getInstance().setConsumerProtectionAttributionLevel(.reduced)

// Set consumer preference level to "Full Attribution"
[Branch setConsumerProtectionAttributionLevel:BranchAttributionLevelFull];

Android

// Set consumer preference level to "Analytics Only"
Branch.getInstance().setConsumerProtectionAttributionLevel(Defines.BranchAttributionLevel.MINIMAL)

// Set consumer preference level to "No Attribution"
Branch.getInstance().setConsumerProtectionAttributionLevel(Defines.BranchAttributionLevel.NONE);