Terms and Privacy Policy Flow

This page explains how you can use the MAX Terms & Privacy Policy Flow to prompt acceptance of your Terms of Use and Privacy Policy.

Note

It is optional to use the CMP flow included with the MAX SDK. If you integrate your own CMP flow, make sure that flow completes before you initialize the MAX SDK.

SDK 12.0.0 Release

Note

Due to a bug in iOS 17.4, the App Tracking Transparency (ATT) prompt may prematurely indicate that a user rejected ATT. This causes the AppLovin SDK to initialize your Ad Units with LAT-configured ad networks, even for a user who might consent to ATT. If you use AppLovin’s Unifed Consent Flow, update to the latest iOS SDK (12.3.0+) to mitigate this issue.

AppLovin MAX SDK v12.0.0, when used with Google UMP, complies with TCF v2: The MAX SDK can ingest the consent string and AC string and forward the TCF v2 Consent strings / states to the mediated networks as described in TCF v2 Consent.

If you do not use Google UMP as your CMP, either through AppLovin’s automated flow or otherwise, you must ensure that the CMP you choose supports all of the mediated networks you integrate.

If you do not use a CMP, you must continue to set AppLovin’s SDK’s binary consent flags as described in Consent and Other Applicable Flags in GDPR and Other Regions.

Note

If you access Google demand through MAX, it’s critical that you review the Google CMP requirements before you start the integration process.

Google UMP Automation

Versions 12.0.0 and above of the AppLovin MAX SDK automate the integration of Google UMP. Therefore you do not need to manually integrate the Google UMP in addition to the MAX SDK. This is completely opt-in and AppLovin will provide you instructions on how you can enable this additional Google UMP integration. Below is a visual representation of the flow:

1. MAX SDK initializes.
2. Regional Compliance Check: AppLovin determines whether the user is located in a GDPR region. If the user is in a GDPR region, the MAX SDK presents Google UMP.
3. (iOS only) If Google UMP is not configured to display the ATT prompt, or if the user did not see the Google UMP flow, MAX SDK shows the MAX ATT prompt.
4. MAX SDK calls your initialization completion callback to signal that you can start loading ads.

Note

The TCF consent state may be false in either of the following circumstances:

1. The user indicated that they do not consent to the terms of data collection that you specified in your message.
2. Some of the ad networks you integrated into your application are not configured into UMP. Therefore UMP will always reject consent. See “Verifying Missing Networks” to learn how to fix this.

Enabling Google UMP

Enabling Google CMP on AdMob Dashboard

So that the MAX consent flow can display the Google GDPR form, you must first create and publish the Google GDPR message on the AdMob dashboard. To do so:

1. Sign in to your AdMob account at apps.admob.com.
   • Add your apps to the AdMob dashboard, if you have not done so already.
2. Click Privacy & messaging.
3. Click GDPR.
4. Click Create message. The GDPR message page opens.
5. Select the apps that you want to display your message:
   1. Click Select apps.
   2. Select the desired apps.
   3. Click Save.
6. Select the languages in which you want to display your message.
7. In the User consent options section, select Consent or Manage options.

   Note

   Do not check the Close (do not consent) option.

8. In the Targeting section, select Countries subject to GDPR (EEA and UK).
9. Click Continue. The Edit message page opens.
10. In the Message name field, enter a descriptive message name to help you identify the message later. This name appears only on the Privacy & messaging page and is not visible to users.
11. Select the Styling tab.
    1. Under the Global section, set the Secondary color to white (#ffffff).
    2. Under the Buttons section, set the Secondary color to gray (#6e6e6e).
12. Click Publish.

Customize Ad Partners List

Note

In its default GDPR message, Google might not show all of your ad network partners. If you fail to include these networks, this could adversely affect your ad revenue. Follow the steps in this section to ensure all of your ad partners appear in the GDPR message.

To customize which ad partners show in the GDPR message:

1. Open the GDPR settings page.
2. Click the edit icon () under the Review your ad partners section.
3. Select the Custom ad partners toggle. Then select all of the networks that you integrated into your app.

   Note

   For Mintegral, select Mobvista/Mintegral from the list of ad partners, rather than Mintegral.

4. Click Confirm.
5. Click Save at the bottom of the GDPR settings page.

Enabling MAX Terms and Privacy Policy Flow

First, add the dependency for the Google User Messaging Platform SDK to your app’s target. Do this in your project’s Podfile:

target '«your-project-name»' do
  pod 'Google-Mobile-Ads-SDK'
end

In your app’s Info.plist, create a new key named NSUserTrackingUsageDescription of type String. This string is how you inform your user why the app is requesting permission to use data that tracks the user or the device. AppLovin recommends that you set its value to “This uses device info for more personalized ads and content.”

You can enable the MAX Terms and Privacy Policy Flow programmatically or by adding a settings file to application resources. The sections below explain both of these methods.

When you submit your app to App Store Connect for review, you must notify the reviewer that you have enabled the App Tracking Transparency framework permission request for iOS 14.5+ only. Do this in the Review Notes section. If you do not do this, Apple may reject your build.

Programmatically

To enable the MAX Terms and Privacy Policy Flow programmatically, set several properties of the SDK’s settings object before you initialize the SDK. The code sample below demonstrates this:

Objective-C

#import <AppLovinSDK/AppLovinSDK.h>
⋮

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  ⋮
  ALSdkSettings *settings = [[ALSdkSettings alloc] init];
  settings.termsAndPrivacyPolicyFlowSettings.enabled = YES;
  settings.termsAndPrivacyPolicyFlowSettings.privacyPolicyURL = [NSURL URLWithString: @"«https://your-company-name.com/privacy-policy»"];

  // Terms of Service URL is optional
  settings.termsAndPrivacyPolicyFlowSettings.termsOfServiceURL = [NSURL URLWithString: @"«https://your-company-name.com/terms-of-service»"];

  ALSdk *sdk = [ALSdk sharedWithKey: sdkKey settings: settings];

  // Set the mediation provider value to @"max" to ensure proper functionality
  sdk.mediationProvider = @"max";
  [sdk initializeSdkWithCompletionHandler:^(ALSdkConfiguration *configuration) {
    ⋮
  }];
}

Swift

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate
{
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool
  {
    ⋮
    let settings = ALSdkSettings()
    settings.termsAndPrivacyPolicyFlowSettings.isEnabled = true
    settings.termsAndPrivacyPolicyFlowSettings.privacyPolicyURL = URL(string: "«https://your-company-name.com/privacy-policy»")

    // Terms of Service URL is optional
    settings.termsAndPrivacyPolicyFlowSettings.termsOfServiceURL = URL(string: "«https://your-company-name.com/terms-of-service»")

    let sdk = ALSdk.shared(with: settings)

    // Please make sure to set the mediation provider value to "max" to ensure proper functionality
    sdk.mediationProvider = "max"
    sdk.initializeSdk { (configuration: ALSdkConfiguration) in
      ⋮
    }
  }
}

AppLovin-Settings.plist

To enable the MAX Terms and Privacy Policy Flow by using your app’s AppLovin-Settings.plist, do the following:

1. Add a new property list file named AppLovin-Settings.plist to your project’s main target.
2. In AppLovin-Settings.plist, create a new key named ConsentFlowInfo of type Dictionary. Inside ConsentFlowInfo add the following key/value pairs:
   1. A Boolean with the key ConsentFlowEnabled and the value YES.
   2. A String with the key ConsentFlowPrivacyPolicy and the value of your Privacy Policy URL.
   3. Optionally, a String with the key ConsentFlowTermsOfService and the value of your Terms of Service URL.

The final result should look similar to this:

Integration

The SDK presents the consent flow when you initialize the SDK. When the user completes the flow, the SDK calls your initialization-completion callback.

Caution

You must wait until the user finishes the consent flow before you initialize third-party SDKs (such as MMPs or analytics SDKs). For this reason, initialize such SDKs from within your initialization-completion callback. If you initialize third-party SDKs before the user completes the consent flow, these third-party SDKs cannot access relevant identifiers. Therefore you would suffer a material impact on measurement, reporting, and ad revenue.

Do not initialize MAX mediated network SDKs in your initialization callback. MAX performs this initialization automatically.

If you set the user ID in your MMP integration, set it where you set the AppLovin user ID. The code snippets below use Adjust as an example. Refer to Adjust’s documentation to learn how to initialize Adjust and set the user ID.

Objective-C

#import <AppLovinSDK/AppLovinSDK.h>
#import <Adjust/Adjust.h>

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    ⋮
    // Set the mediation provider value to @"max" to ensure proper functionality
    [ALSdk shared].mediationProvider = @"max";

    [ALSdk shared].userIdentifier = @"«user-ID»";
    [Adjust addSessionCallbackParameter: @"«your-user-ID-key»" value: @"«user-ID»"];

    [[ALSdk shared] initializeSdkWithCompletionHandler:^(ALSdkConfiguration *configuration) {

        // You can check app transparency tracking authorization via configuration.appTrackingTransparencyStatus
        // Initialize other 3rd-party SDKs - do not initialize mediated advertising SDKs; MAX will automatically do that for you. Not following this step will result in noticeable integration issues

        // Initialize the Adjust SDK inside the AppLovin SDK's initialization callback
        ADJConfig *adjustConfig = [ADJConfig configWithAppToken: @"«your-Adjust-app-token»"
                                                    environment: ADJEnvironmentSandbox or ADJEnvironmentProduction];
        [Adjust appDidLaunch: adjustConfig];

        // Start loading ads
    }];
}

Swift

import AppLovinSDK
import Adjust

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate
{
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool
  {
    ⋮
    // Set the mediation provider value to "max" to ensure proper functionality
    ALSdk.shared().mediationProvider = "max"

    ALSdk.shared().userIdentifier = "«user-ID»"
    Adjust.addSessionCallbackParameter("«your-user-ID-key»", value: "«user-ID»")

    ALSdk.shared().initializeSdk { (configuration: ALSdkConfiguration) in
      // App transparency tracking authorization can be checked via `configuration.appTrackingTransparencyStatus`
      // Initialize other 3rd-party SDKs - do not initialize mediated advertising SDKs, MAX will do that for you automatically. Not following this step will result in noticeable integration issues

      // Initialize the Adjust SDK inside the AppLovin SDK's initialization callback
      let adjustConfig = ADJConfig(appToken: "«your-Adjust-app-token»",
                                   environment: ADJEnvironmentSandbox or ADJEnvironmentProduction)
      Adjust.appDidLaunch(adjustConfig)

      // Start loading ads
    }
  }
}

Localizing NSUserTrackingUsageDescription

The table below gives you an English (base) description and a variety of localizations that you can use at your discretion. Read the Documentation > Xcode > Localization instructions to learn how to localize your app.

Locale	String
English (base)	This uses device info for more personalized ads and content
Chinese Simplified (ZhHans)	我们使用设备信息来提供个性化的广告和内容。
Chinese Traditional (ZhHant)	我們使用設備信息來提供個性化的廣告和內容。
French (fr)	Cela permet d’utiliser les informations du téléphone pour afficher des contenus publicitaires plus pertinents.
German (de)	Dies benutzt Gerätinformationen für relevantere Werbeinhalte
Japan (Ja)	これはユーザーデータをもとに、より関連性の高い広告コンテンツをお客様に提供します
Korean (Ko)	보다 개인화된 광고 및 콘텐츠를 위해 기기 정보를 사용합니다.
Spanish (es)	Esto utiliza la información del dispositivo para anuncios y contenido más personalizados

Show GDPR Flow to Existing Users

AppLovin recommends that you allow existing users in GDPR regions to reenter the GDPR flow. Typically, users do this in your app’s Settings section via an option to Manage Existing Privacy Settings. You can determine if a user is within a GDPR region with the SDK API ALSdkConfiguration.consentFlowUserGeography. The user is in GDPR region when consentFlowUserGeography is ALConsentFlowUserGeographyGDPR. If so, you can conditionally show that settings option to the user.

When the user clicks Manage Existing Privacy Settings (or its equivalent), call -[ALCMPService showCMPForExistingUserWithCompletion]. This resets the user’s existing consent information.

Objective-C

#import "MyViewController.h"
#import <AppLovinSDK/AppLovinSDK.h>

@interface MyViewController ()

@end

@implementation MyViewController

- (void)loadAndShowCMPFlow
{
  ALCMPService *cmpService = [ALSdk shared].cmpService;

  [cmpService showCMPForExistingUserWithCompletion:^(ALCMPError * _Nullable error) {

    if ( !error )
    {
      // The CMP alert was shown successfully.
    }
  }];
}

@end

Swift

import AppLovinSDK

class MyViewController: UIViewController
{
  func loadAndShowCmpFlow()
  {
    let cmpService = ALSdk.shared().cmpService
    cmpService.showCMPForExistingUser { error in

      if (nil == error)
      {
        // The CMP alert was shown successfully.
      }
    }
  }
}

Testing

If you want to test the Google CMP outside the GDPR region, set the debug user geography by using one of the techniques shown below:

Note

The flow is shown only to new users. If you want to test the flow after you have completed the CMP prompt, you must delete and re-install the app.

Programmatically

To set the debug user geography to GDPR use code like the following:

Objective-C

AppLovinSdkSettings.termsAndPrivacyPolicyFlowSettings.debugUserGeography = ALConsentFlowUserGeographyGDPR;

Swift

AppLovinSdkSettings.termsAndPrivacyPolicyFlowSettings.debugUserGeography = .GDPR

AppLovin-Settings.plist

To set the debug user geography, add the ConsentFlowDebugUserGeography key with string value gdpr under the ConsentFlowInfo object:

Testing Google UMP Integration with the Mediation Debugger

Verifying Installation

Under the Privacy section of the MAX Mediation Debugger, the CMP (Consent Management Platform) row displays the name of the Google-certified CMP SDK that you integrated. If you successfully integrated the Google UMP SDK, it displays “Google consent management solutions” as the name.

Verifying IAB TCF Parameters

If you select the CMP (Consent Management Platform) row, you can inspect the IAB TCF parameters IABTCF_gdprApplies, IABTCF_TCString, and IABTCF_AddtlConsent. For the latter two, you can click on the row to copy or share its value.

Verifying Missing Networks

In the CMP CONFIGURATION section, you can verify which networks are integrated with or are missing from your Google UMP configuration. This is an exhaustive list of all networks that are available to MAX. You can ignore any networks that you did not integrate in your application.

On your CMP flow you must list all of the networks that you integrate in your application. To check if any of those networks are missing, and to fix this problem:

1. Complete the CMP flow, granting consent to all networks.
2. Open the Mediation Debugger. The Mediation Debugger parses the TC and AC strings and displays two lists:
   1. Integrated networks you listed on your CMP flow
   2. Networks that are missing which you might need to add (under Configured CMP Networks in the CMP CONFIGURATION section)
3. You will see missing networks in the MISSING ATP NETWORKS or MISSING TCF VENDORS lists. If any of these are networks that you integrated into your application:
   1. Return to your CMP’s dashboard. Add the missing networks to those covered by the GDPR message. (See Customize Ad Partners List for how to do this in Google’s Unified Consent Flow.)
   2. Restart your app.

Repeat these steps until you verify that all of your networks are correctly included in the CMP flow.

Verifying Mediated Network Consent Statuses

To view the consent statuses of all networks, expand Network Consent Statuses in the Mediation Debugger. The Mediation Debugger parses the TC string and displays the consent statuses of all networks. It also displays the AppLovin consent status that it parses from the AC string that Google UMP generates.