UMP Integration

Overview

The User Messaging Platform (UMP) SDK helps you manage user consent for personalized advertising in compliance with GDPR (General Data Protection Regulation) and CCPA (California Consumer Privacy Act).

UMP integration requires the adrop-ads-backfill module. Make sure you have completed the Getting Started installation guide first.

Basic Usage

Use the Consent Manager to request user consent after initializing Adrop.

import io.adrop.ads.Adrop
import io.adrop.ads.consent.AdropConsentListener
import io.adrop.ads.consent.AdropConsentResult

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // Call after Adrop.initialize()
        Adrop.consentManager?.requestConsentInfoUpdate(this, object : AdropConsentListener {
            override fun onConsentInfoUpdated(result: AdropConsentResult) {
                if (result.error != null) {
                    Log.e("Consent", "Error: ${result.error}")
                }
            }
        })
    }
}

import io.adrop.ads.Adrop;
import io.adrop.ads.consent.AdropConsentListener;
import io.adrop.ads.consent.AdropConsentResult;

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Call after Adrop.initialize()
        if (Adrop.getConsentManager() != null) {
            Adrop.getConsentManager().requestConsentInfoUpdate(this, new AdropConsentListener() {
                @Override
                public void onConsentInfoUpdated(AdropConsentResult result) {
                    if (result.getError() != null) {
                        Log.e("Consent", "Error: " + result.getError());
                    }
                }
            });
        }
    }
}

The consent manager returns one of the following statuses:

Status	Description
`UNKNOWN`	Consent status not yet determined
`REQUIRED`	Consent required (popup will be shown)
`NOT_REQUIRED`	Consent not required (non-GDPR region)
`OBTAINED`	Consent already obtained

Privacy Options

Users must be able to change their consent after the first prompt. When UMP reports that a privacy options entry point is required, add one to your app — typically a Privacy settings item in your settings screen — and open the privacy options form from it.

Requires adrop-ads and adrop-ads-backfill 1.15.0 or later. Keep both on the same version — with an older backfill the status always returns UNKNOWN and the form is not shown.

Check whether an entry point is required

import io.adrop.ads.consent.AdropPrivacyOptionsRequirementStatus

class SettingsActivity : AppCompatActivity() {

    // Re-check whenever your settings screen appears
    override fun onResume() {
        super.onResume()

        val status = Adrop.consentManager?.getPrivacyOptionsRequirementStatus(this)

        // Show the entry point only when it is required
        privacySettingsButton.visibility =
            if (status == AdropPrivacyOptionsRequirementStatus.REQUIRED) View.VISIBLE else View.GONE
    }
}

import io.adrop.ads.consent.AdropPrivacyOptionsRequirementStatus;

public class SettingsActivity extends AppCompatActivity {

    // Re-check whenever your settings screen appears
    @Override
    protected void onResume() {
        super.onResume();

        if (Adrop.getConsentManager() == null) return;

        AdropPrivacyOptionsRequirementStatus status =
                Adrop.getConsentManager().getPrivacyOptionsRequirementStatus(this);

        // Show the entry point only when it is required
        privacySettingsButton.setVisibility(
                status == AdropPrivacyOptionsRequirementStatus.REQUIRED ? View.VISIBLE : View.GONE);
    }
}

Status	Description
`UNKNOWN`	Not determined yet — `requestConsentInfoUpdate()` has not completed in this app session, or the installed backfill does not support privacy options
`REQUIRED`	An entry point must be shown
`NOT_REQUIRED`	No entry point is needed

Call requestConsentInfoUpdate() on every app launch, including for users who already gave consent. The requirement status reflects the current app session only after that call completes — otherwise returning users never see the entry point. The consent form itself is still shown only when it is needed.

Show the privacy options form

// Open the form from your "Privacy settings" entry point (inside your activity)
private fun showPrivacyOptionsForm() {
    Adrop.consentManager?.showPrivacyOptionsForm(this, object : AdropConsentListener {
        override fun onConsentInfoUpdated(result: AdropConsentResult) {
            if (result.error != null) {
                Log.e("Consent", "Error: ${result.error}")
                return
            }

            // Consent may have changed — re-check whether the entry point is still required
            updatePrivacySettingsVisibility()
        }
    })
}

// Open the form from your "Privacy settings" entry point (inside your activity)
private void showPrivacyOptionsForm() {
    if (Adrop.getConsentManager() == null) return;

    Adrop.getConsentManager().showPrivacyOptionsForm(this, new AdropConsentListener() {
        @Override
        public void onConsentInfoUpdated(AdropConsentResult result) {
            if (result.getError() != null) {
                Log.e("Consent", "Error: " + result.getError());
                return;
            }

            // Consent may have changed — re-check whether the entry point is still required
            updatePrivacySettingsVisibility();
        }
    });
}

When the form closes, the SDK applies the updated consent and then returns an AdropConsentResult. The form opens only while an entry point is required; otherwise the stored consent is left unchanged and the result carries the current state with an error.

The listener is also called when the activity has already finished — for example when the user leaves the screen while the form is open. Check isFinishing / isDestroyed before touching activity UI from the callback.

Debug Settings (Test Mode)

Test GDPR/CCPA consent flows during development:

import io.adrop.ads.consent.AdropConsentDebugGeography

if (BuildConfig.DEBUG) {
    // Set debug geography before requesting consent
    Adrop.consentManager?.setDebugSettings(
        testDeviceHashedIds = listOf("YOUR_HASHED_DEVICE_ID"),  // Check Logcat
        geography = AdropConsentDebugGeography.EEA  // Test GDPR
    )

    // Reset consent for testing
    Adrop.consentManager?.reset(this)
}

import io.adrop.ads.consent.AdropConsentDebugGeography;

if (BuildConfig.DEBUG) {
    // Set debug geography before requesting consent
    Adrop.getConsentManager().setDebugSettings(
        Arrays.asList("YOUR_HASHED_DEVICE_ID"),  // Check Logcat
        AdropConsentDebugGeography.EEA  // Test GDPR
    );

    // Reset consent for testing
    Adrop.getConsentManager().reset(this);
}

Debug Geographies

Geography	Description
`DISABLED`	Use actual device location
`EEA`	Test GDPR (European Economic Area)
`REGULATED_US_STATE`	Test CCPA (California, etc.)
`OTHER`	Test non-regulated regions

Debug settings should only be used during development. Remove or disable them before releasing to production.reset() is for testing only — never call it in production code. To let users change their consent, use showPrivacyOptionsForm().

Best Practices

Request Early

Request consent as early as possible in your app lifecycle, ideally right after SDK initialization, and call it on every app launch.

Handle Errors

Always handle consent errors gracefully and provide fallback behavior.

Test All Scenarios

Use debug settings to test all consent scenarios (required, not required, obtained) before release.

Offer Privacy Settings

When the privacy options status is required, show an entry point in your settings screen so users can change their consent at any time.

Targeting

Set up user and context targeting

Getting Started

SDK installation and setup guide

Reference

Classes, listeners, and error codes

SDK Guide

AI

Android

iOS

React Native

Flutter

Web

REST API

Overview

Basic Usage

Privacy Options

Check whether an entry point is required

Show the privacy options form

Debug Settings (Test Mode)

Debug Geographies

Best Practices

Request Early

Handle Errors

Test All Scenarios

Offer Privacy Settings

Targeting

Getting Started

Reference

​Overview

​Basic Usage

​Consent Status

​Privacy Options

​Check whether an entry point is required

​Show the privacy options form

​Debug Settings (Test Mode)

​Debug Geographies

​Best Practices

Request Early

Handle Errors

Test All Scenarios

Offer Privacy Settings

​Related Documentation

Targeting

Getting Started

Reference

Overview

Basic Usage

Consent Status

Privacy Options

Check whether an entry point is required

Show the privacy options form

Debug Settings (Test Mode)

Debug Geographies

Best Practices

Related Documentation