Google UMP SDK Gudelines

1. Background

Starting January 16, 2024, publishers and developers using Google AdSense, Ad Manager, or AdMob to serve ads to users in the European Economic Area or the United Kingdom must use a Consent Management Platform (CMP) that is certified by Google and integrated with IAB's Transparency and Consent Framework (TCF).

Starting from 6.2.87, the TopOn SDK provides a method compatible with the UMP SDK to configure the GDPR level. The TopOn SDK internally uses this level to set the GDPR reporting level for third-party ad networks.

2. UMP Usage Process

Enable UMP in the AdMob Console

1. Visit the AdMob Console and log in to your AdMob account.
   • Add your app in AdMob (if you have not added the app yet).
2. Click "Privacy & messaging".
3. Click "European regulations - Manage".
4. Click "Create message" and wait for the GDPR message page to open.
5. On the GDPR message page, click "Select apps" in the top right corner and select the app for which you want to display the GDPR message.
6. Select the language in which you want to display the message.
7. In the "Targeting" section, select the "Countries subject to GDPR (EEA and UK)" option.

The following configuration can improve the probability of users consenting to GDPR:

1. Under "User options - Close (do not consent)", select Close.
2. Style adjustment: Select the "Style" section
   • Under the button section, adjust the "Secondary color" to white (#ffffff).
   • Under the button section, adjust the "Secondary font color" to gray (#6e6e6e).

The overall effect after adjustment is shown below:

Finally, click "Publish" in the top right corner.

Self-Specified Ad Partners

Note: By default, Google may not display all ad networks integrated in your project in your GDPR message. Failure to include these ad networks may adversely affect your ad revenue. Please follow the steps in this section to ensure that all ad networks integrated in your project appear in the GDPR message.

Customize which ad partners are displayed in the GDPR message:

1. In the AdMob console, under "Privacy & messaging", click "GDPR Settings" to open the GDPR settings.
   

2. Click the edit icon () under the "Review your ad partners" section.

3. Refer to the table below and check all ad networks integrated in your project.

   Google Name	TopOn SDK Network
   Facebook	Meta
   AppLovin Corp	Applovin
   ironSource Mobile	IronSource
   InMobi Choice	InMobi
   BIGOAds	Bigo
   Chartboost	Chartboost
   UnityAds	Unity Ads
   Ogury Ltd	Ogury
   AdColony	AdColony
   Google	Admob
   StartApp	Start.io【StartApp】
   Verve Group	PubNative【Verve】
   Tapjoy	Tapjoy
   Liftoff	Vungle
   F@N communications	Nend
   Fyber	Fyber
   Kidoz	Kidoz
   Mobvista/Mintegral	Mintegral

   Remarks: For other ad networks not listed in this table, such as Pangle, Huawei, Maio, Appnext, MyTarget, Yandex, Helium, etc., since they are not in the AdMob GDPR ad partner list, TopOn will internally use the popup consent result to set the GDPR reporting level for these ad networks.

4. Click "Confirm".

5. Click the "Save" button at the bottom of the GDPR settings page.
   Note: If a popup asking "Re-consent all eligible users?" appears, select "Re-prompt".

Enable UMP in the Project

Android:

Add the Google User Messaging Platform SDK dependency to the mainTemplate.gradle file:

dependencies {
    implementation("com.google.android.ump:user-messaging-platform:2.1.0")
}

In the Unity Editor, open Player Setting > Publishing Settings, then find Custom Proguard File. After checking it, locate this file and add the following obfuscation rules:

-keep public class com.google.android.ump.*

iOS:

Add the Google User Messaging Platform SDK dependency to the Unity project's Podfile:

pod 'GoogleUserMessagingPlatform'

Display the UMP Dialog

Use the ATSDKAPI.showGDPRConsentDialog API and perform SDK initialization within the onDismiss callback. Internally, ATSDKAPI.showGDPRConsentDialog will determine whether the UMP SDK is integrated. If integrated, it will use the UMP SDK API to display the GDPR information dialog. If not integrated, it will display the TopOn GDPR information dialog in the EU region for the user to select the GDPR level.
Note: You need to initiate ad requests after SDK initialization.

public void showGDPRConsentDialog(){
    Debug.Log ("Developer showGDPRConsentDialog");
    // Added in plugin version 2.1.8
    ATSDKAPI.showGDPRConsentDialog(new ConsentDismissListener(),string appId);
}


private class ConsentDismissListener : ATConsentDismissListener
{
    public void onConsentDismiss()
    {
        Debug.Log("Developer callback onConsentDismiss(): call initSDK() to init sdk in this callback");
    }
}

Add a Link in the App to Allow Users to Withdraw Consent

// Added in plugin version 2.1.8. The showGDPRConsentSecondDialog method allows the consent process to be modified, enabling a second GDPR selection.
public void showGDPRConsentSecondDialog(){
    Debug.Log ("Developer showGDPRConsentDialog");

    ATSDKAPI.showGDPRConsentDialog(new ConsentDismissListener(),string appId);
}


private class ConsentDismissListener : ATConsentDismissListener
{
    public void onConsentDismiss()
    {
        Debug.Log("Developer callback onConsentDismiss(): call initSDK() to init sdk in this callback");
    }
}

Note: Withdrawing consent is the process by which users in the European Economic Area (EEA), the United Kingdom, and Switzerland can withdraw their consent after having consented to personalized ads. A corresponding link must be provided in the app's menu to allow users who wish to withdraw their consent to do so, and then the user consent message will be shown to them again.

For details, please refer to here.

Please refer to the Google AdMob Ads SDK Developer Documentation to implement the privacy settings option.