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 AdropAds

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

        // Call after Adrop.initialize()
        Adrop.consentManager?.requestConsentInfoUpdate(from: self) { result in
            if let error = result.error {
                print("Consent error: \(error)")
            }
        }
    }
}

@import AdropAds;

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    // Call after Adrop.initialize()
    if (Adrop.consentManager != nil) {
        [Adrop.consentManager requestConsentInfoUpdateFrom:self completion:^(AdropConsentResult *result) {
            if (result.error != nil) {
                NSLog(@"Consent error: %@", result.error);
            }
        }];
    }
}

@end

The requestConsentInfoUpdate callback returns an AdropConsentResult object with the following properties:

Property	Type	Description
`status`	`AdropConsentStatus`	Current consent status
`canRequestAds`	`Bool`	Whether ads can be requested
`canShowPersonalizedAds`	`Bool`	Whether personalized ads can be shown
`error`	`Error?`	Error if the request failed

Adrop.consentManager?.requestConsentInfoUpdate(from: self) { result in
    print("Status: \(result.status)")
    print("Can request ads: \(result.canRequestAds)")
    print("Can show personalized ads: \(result.canShowPersonalizedAds)")

    if let error = result.error {
        print("Error: \(error)")
    }
}

[Adrop.consentManager requestConsentInfoUpdateFrom:self completion:^(AdropConsentResult *result) {
    NSLog(@"Status: %ld", (long)result.status);
    NSLog(@"Can request ads: %d", result.canRequestAds);
    NSLog(@"Can show personalized ads: %d", result.canShowPersonalizedAds);

    if (result.error != nil) {
        NSLog(@"Error: %@", result.error);
    }
}];

The consent manager returns one of the following statuses:

Status	Description
`unknown`	Consent status not yet determined
`required`	Consent required (popup will be shown)
`notRequired`	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 the iOS SDK (adrop-ads) and backfill (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. These two methods are available in Swift only.

Check whether an entry point is required

import AdropAds

class SettingsViewController: UIViewController {

    // Re-check whenever your settings screen appears
    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)

        let status = Adrop.consentManager?.getPrivacyOptionsRequirementStatus()

        // Show the entry point only when it is required
        privacySettingsButton.isHidden = status != .required
    }
}

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
`notRequired`	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 view controller)
@objc private func privacySettingsTapped() {
    Adrop.consentManager?.showPrivacyOptionsForm(from: self) { [weak self] result in
        if let error = result.error {
            print("Error: \(error)")
            return
        }

        // Consent may have changed — re-check whether the entry point is still required
        self?.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.

Pass nil instead of a view controller to let UMP present the form on the topmost screen — useful when your settings screen is presented modally.

Debug Settings (Test Mode)

Test GDPR/CCPA consent flows during development:

import AdropAds

#if DEBUG
// Set debug geography before requesting consent
Adrop.consentManager?.setDebugSettings(
    testDeviceIdentifiers: ["YOUR_DEVICE_IDENTIFIER"],  // Check Xcode console
    geography: .EEA  // Test GDPR
)

// Reset consent for testing
Adrop.consentManager?.reset()
#endif

@import AdropAds;

#ifdef DEBUG
// Set debug geography before requesting consent
[Adrop.consentManager setDebugSettingsWithTestDeviceIdentifiers:@[@"YOUR_DEVICE_IDENTIFIER"]
                                                      geography:AdropConsentDebugGeographyEEA];

// Reset consent for testing
[Adrop.consentManager reset];
#endif

Debug Geographies

Geography	Description
`disabled`	Use actual device location
`EEA`	Test GDPR (European Economic Area)
`regulatedUSState`	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().

Additional Methods

Method	Return Type	Description
`getConsentStatus()`	`AdropConsentStatus`	Returns the current consent status
`canRequestAds()`	`Bool`	Returns whether ads can be requested based on consent
`getPrivacyOptionsRequirementStatus()`	`AdropPrivacyOptionsRequirementStatus`	Returns whether a privacy options entry point must be shown
`showPrivacyOptionsForm(from:completion:)`	`Void`	Shows the privacy options form so users can change their consent
`reset()`	`Void`	Resets consent information (testing only)

// Check consent status independently
if let status = Adrop.consentManager?.getConsentStatus() {
    switch status {
    case .obtained:
        print("Consent obtained")
    case .required:
        print("Consent required")
    case .notRequired:
        print("Consent not required")
    case .unknown:
        print("Consent status unknown")
    }
}

// Check if ads can be requested
if Adrop.consentManager?.canRequestAds() == true {
    // Load ads
}

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

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, delegates, 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

Additional Methods

Best Practices

Request Early

Handle Errors

Test All Scenarios

Offer Privacy Settings

Targeting

Getting Started

Reference

​Overview

​Basic Usage

​Consent Result

​Consent Status

​Privacy Options

​Check whether an entry point is required

​Show the privacy options form

​Debug Settings (Test Mode)

​Debug Geographies

​Additional Methods

​Best Practices

Request Early

Handle Errors

Test All Scenarios

Offer Privacy Settings

​Related Documentation

Targeting

Getting Started

Reference

Overview

Basic Usage

Consent Result

Consent Status

Privacy Options

Check whether an entry point is required

Show the privacy options form

Debug Settings (Test Mode)

Debug Geographies

Additional Methods

Best Practices

Related Documentation