Set up consent mode for apps

This page is for developers that use the Google Analytics for Firebase SDK in their app and want to integrate consent mode. For an introduction to consent mode, read Consent mode overview.

Google Analytics offers consent mode to adjust how your SDK behaves based on the consent status of your users. You can implement consent mode in a basic or advanced way. If you aren't sure whether to implement basic or advanced consent mode, learn more about basic versus advanced consent mode and check with your company's guidelines.

Important: If either the ad_storage or analytics_storage consent parameter is set to denied, through a default consent state or the setConsent method, the analytics data associated with a particular app instance is permanently reset going forward. For example, if analytics data is reset for all app instances, user counts may be inflated.

If you use the Google Analytics for Firebase iOS SDK, you can prevent this issue by updating the iOS SDK to version 10.23.0. If you use the Android SDK, you can prevent this issue by following these steps:

Don't set default values for ad_storage and analytics_storage in your app's manifest.
Disable Analytics collection before setting the app instance’s ad_storage and analytics_storage consent state.
After you have affirmative consent, re-enable Analytics collection, which won't reset Analytics data.

If you want to reset analytics for an app instance, use the purpose-built API. See here for an Android example.

We will release an update for the Google Analytics for Firebase Android SDK in the coming weeks to adjust this behavior, after which you can update your SDK and consider whether further consent mode changes are appropriate for your app.

Before you begin

Before you can manage user consent, you need to implement:

Google Analytics for Firebase SDK
A consent settings banner to capture user consent

Tip: If you don't want to implement consent settings yourself, consider using a consent management platform (CMP).

Set up consent mode

To set up consent mode, you need to:

Set the default consent state.

By default, no consent mode values are set. To set the default consent state for your app:

Open your app's info.plist file.
Add the consent mode key-value pairs. The key describes the consent type and the value indicates consent state. Values can either be true, meaning consent was granted, or false, meaning consent was denied. Set the following:
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS
Save your changes. Next, implement the mechanism to update consent values.

For example, to set all grant consent for all parameters by default:

<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS</key> <true/>

To update consent values after an app has launched, call the setConsent method.

The value set by the setConsent method overrides the default setting and persists across app executions. The value remains in that state until setConsent is called again, even if a user closes and reopens the app. setConsent only updates the parameters you specify.

If a user withdraws their previously given consent for Analytics or Ad storage, Google Analytics deletes all user properties, including consent for ad_personalization. To preserve the user's consent choice for ad personalization, restore the previous value for ad personalization using setConsent (Swift | Obj-C) .

The following example shows the setConsent method updating the different consent values to granted:

Swift

Analytics.setConsent([
  .analyticsStorage: .granted,
  .adStorage: .granted,
  .adUserData: .granted,
  .adPersonalization: .granted,
])

Objective-C

[FIRAnalytics setConsent:@{
FIRConsentTypeAnalyticsStorage : FIRConsentStatusGranted,
FIRConsentTypeAdStorage : FIRConsentStatusGranted,
FIRConsentTypeAdUserData : FIRConsentStatusGranted,
FIRConsentTypeAdPersonalization : FIRConsentStatusGranted,
}];

If a user decides to revoke their consent, make sure you update the consent states accordingly

As a part of Google's ongoing commitment to a privacy-safe digital advertising ecosystem, we are strengthening the enforcement of our EU user consent policy.

Learn more about Google's Updates to consent mode for traffic in European Economic Area (EEA).

Consent mode users need to send two new parameters in addition to ad storage and analytics storage:

Update your app's info.plist to include:

<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS</key> <true/>

Update your consent calls to include the parameters for ad user data and ad personalization:

Swift

Analytics.setConsent([
.analyticsStorage: .granted,
.adStorage: .granted,
.adUserData: .granted,
.adPersonalization: .granted,
])

Objective-C

[FIRAnalytics setConsent:@{
  FIRConsentTypeAnalyticsStorage : FIRConsentStatusGranted,
  FIRConsentTypeAdStorage : FIRConsentStatusGranted,
  FIRConsentTypeAdUserData : FIRConsentStatusGranted,
  FIRConsentTypeAdPersonalization : FIRConsentStatusGranted,
}];

Verify consent settings

You can verify that your consent settings are working as intended by viewing the Xcode debug console for your app.

Follow these steps:

Enable verbose logging on your device.
In the Xcode debug console, look for:
- ad_storage
- analytics_storage
- ad_user_data
- ad_personalization
For example, if Ad storage are enabled, you'll see the following message:
```
ad_storage is granted.
```

Set up consent mode for apps

Before you begin

Set up consent mode

Set the default consent state

Update consent

Swift

Objective-C

Upgrade to consent mode v2

Swift

Objective-C

Verify consent settings