Stay organized with collections
Save and categorize content based on your preferences.
GoogleMobileAds.Ump.Api
Summary
Enumerations
ConsentStatus
ConsentStatus
Consent status values.
| Properties |
NotRequired
|
Consent not required.
|
Obtained
|
User consent obtained, personalized vs non-personalized undefined.
|
Required
|
User consent required but not yet obtained.
|
Unknown
|
Unknown consent status.
|
DebugGeography
DebugGeography
Debug values for testing geography.
| Properties |
Disabled
|
Debug geography disabled.
|
EEA
|
Geography appears as in EEA for debug devices.
|
NotEEA
|
Geography appears as not in EEA for debug devices.
Deprecated.
Use DebugGeography.Other instead.
|
Other
|
Geography appears as in a region with no regulation in force.
|
RegulatedUSState
|
Geography appears as in a regulated US State for debug devices.
|
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus
Privacy options requirement status.
| Properties |
NotRequired
|
Privacy options entry point is not required.
|
Required
|
Privacy options entry point is required.
|
Unknown
|
Privacy options requirement status is unknown.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eGoogleMobileAds.Ump.Api provides tools for managing user consent, including a consent form and methods to obtain and update consent information.\u003c/p\u003e\n"],["\u003cp\u003eThe API includes enums for consent status, debug geography, and privacy options requirement status for handling different user consent scenarios.\u003c/p\u003e\n"],["\u003cp\u003eConsentDebugSettings allows for testing User Messaging Platform functionality.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize ConsentInformation and ConsentRequestParameters to handle and update user consent data.\u003c/p\u003e\n"],["\u003cp\u003eFormError provides details on any failures during form operations related to user consent.\u003c/p\u003e\n"]]],["This document outlines the `GoogleMobileAds.Ump.Api` framework, detailing its core components for managing user consent. It defines three enumerations: `ConsentStatus` (Unknown, NotRequired, Required, Obtained), `DebugGeography` (Disabled, EEA, NotEEA, Other, RegulatedUSState), and `PrivacyOptionsRequirementStatus` (Unknown, NotRequired, Required). Additionally, it lists five classes: `ConsentDebugSettings`, `ConsentForm`, `ConsentInformation`, `ConsentRequestParameters`, and `FormError`, which are used for debug settings, consent forms, consent information management, consent update parameters, and form operation errors respectively.\n"],null,["# GoogleMobileAds.Ump.Api Namespace\n\nGoogleMobileAds.Ump.Api\n=======================\n\nSummary\n-------\n\n| ### Enumerations ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|\n| [ConsentStatus](#namespace_google_mobile_ads_1_1_ump_1_1_api_1aa83ad2ecf6f2a08c584b60cef06f5133)`{` ` `[Unknown](#namespace_google_mobile_ads_1_1_ump_1_1_api_1aa83ad2ecf6f2a08c584b60cef06f5133a88183b946cc5f0e8c96b2e66e1c74a7e)` = 0,` ` `[NotRequired](#namespace_google_mobile_ads_1_1_ump_1_1_api_1aa83ad2ecf6f2a08c584b60cef06f5133a3c841b03acb069eccf34fa1e6898c992)` = 1,` ` `[Required](#namespace_google_mobile_ads_1_1_ump_1_1_api_1aa83ad2ecf6f2a08c584b60cef06f5133ab651efdb98a5d6bd2b3935d0c3f4a5e2)` = 2,` ` `[Obtained](#namespace_google_mobile_ads_1_1_ump_1_1_api_1aa83ad2ecf6f2a08c584b60cef06f5133ad70ed07499bc45f2aa5d267bbd6c5d6f)` = 3` `}` | enum Consent status values. |\n| [DebugGeography](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a27be0886258b34265df84626c4b24a3e)`{` ` `[Disabled](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a27be0886258b34265df84626c4b24a3eab9f5c797ebbf55adccdd8539a65a0241)` = 0,` ` `[EEA](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a27be0886258b34265df84626c4b24a3ea90aa9b8fa4bb4d8ad89a11841186926d)` = 1,` ` `[NotEEA](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a27be0886258b34265df84626c4b24a3ea9309739e97c17f9c6c9e3e2ef8cf0a20)` = 2,` ` `[RegulatedUSState](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a27be0886258b34265df84626c4b24a3ea7e206b38c484e39a4f1595c30b559995)` = 3,` ` `[Other](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a27be0886258b34265df84626c4b24a3ea6311ae17c1ee52b36e68aaf4ad066387)` = 4` `}` | enum Debug values for testing geography. |\n| [PrivacyOptionsRequirementStatus](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a60f41ef4f7e14d5ae1fb5f23b7e0244b)`{` ` `[Unknown](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a60f41ef4f7e14d5ae1fb5f23b7e0244ba88183b946cc5f0e8c96b2e66e1c74a7e)` = 0,` ` `[NotRequired](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a60f41ef4f7e14d5ae1fb5f23b7e0244ba3c841b03acb069eccf34fa1e6898c992)` = 1,` ` `[Required](#namespace_google_mobile_ads_1_1_ump_1_1_api_1a60f41ef4f7e14d5ae1fb5f23b7e0244bab651efdb98a5d6bd2b3935d0c3f4a5e2)` = 2` `}` | enum Privacy options requirement status. |\n\n| ### Classes ||\n|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|\n| [GoogleMobileAds.Ump.Api.ConsentDebugSettings](/admob/unity/reference/class/google-mobile-ads/ump/api/consent-debug-settings) | Debug settings for testing User Messaging Platform. |\n| [GoogleMobileAds.Ump.Api.ConsentForm](/admob/unity/reference/class/google-mobile-ads/ump/api/consent-form) | A rendered form for collecting consent from a user. |\n| [GoogleMobileAds.Ump.Api.ConsentInformation](/admob/unity/reference/class/google-mobile-ads/ump/api/consent-information) | Utility methods for managing consent information from users. |\n| [GoogleMobileAds.Ump.Api.ConsentRequestParameters](/admob/unity/reference/class/google-mobile-ads/ump/api/consent-request-parameters) | Parameters sent on updating user consent info. |\n| [GoogleMobileAds.Ump.Api.FormError](/admob/unity/reference/class/google-mobile-ads/ump/api/form-error) | Error information about why a form operation failed. |\n\nEnumerations\n------------\n\n### ConsentStatus\n\n```c#\n ConsentStatus\n``` \nConsent status values.\n\n| Properties ||\n|---------------|--------------------------------------------------------------------|\n| `NotRequired` | Consent not required. |\n| `Obtained` | User consent obtained, personalized vs non-personalized undefined. |\n| `Required` | User consent required but not yet obtained. |\n| `Unknown` | Unknown consent status. |\n\n### DebugGeography\n\n```c#\n DebugGeography\n``` \nDebug values for testing geography.\n\n| Properties ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `Disabled` | Debug geography disabled. |\n| `EEA` | Geography appears as in EEA for debug devices. |\n| `NotEEA` | Geography appears as not in EEA for debug devices. **[Deprecated.](/admob/unity/reference/deprecated/deprecated)**Use DebugGeography.Other instead. |\n| `Other` | Geography appears as in a region with no regulation in force. |\n| `RegulatedUSState` | Geography appears as in a regulated US State for debug devices. |\n\n### PrivacyOptionsRequirementStatus\n\n```c#\n PrivacyOptionsRequirementStatus\n``` \nPrivacy options requirement status.\n\n| Properties ||\n|---------------|------------------------------------------------|\n| `NotRequired` | Privacy options entry point is not required. |\n| `Required` | Privacy options entry point is required. |\n| `Unknown` | Privacy options requirement status is unknown. |"]]