GoogleUserMessagingPlatform Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Enumerations
The following enumerations are available globally.
-
Declaration
Swift
enum ConsentStatus : Int, @unchecked Sendable
Objective-C
enum UMPConsentStatus : NSInteger {}
-
State values for whether the user has a consent form available to them. To check whether form
status has changed, an update can be requested through
requestConsentInfoUpdateWithParameters:completionHandler.
Declaration
Swift
enum FormStatus : Int, @unchecked Sendable
Objective-C
enum UMPFormStatus : NSInteger {}
-
State values for whether the user needs to be provided a way to modify their privacy options.
Declaration
Swift
enum PrivacyOptionsRequirementStatus : Int, @unchecked Sendable
Objective-C
enum UMPPrivacyOptionsRequirementStatus : NSInteger {}
-
Debug values for testing geography.
Declaration
Swift
enum DebugGeography : Int, @unchecked Sendable
Objective-C
enum UMPDebugGeography : NSInteger {}
-
Error codes used when making requests to update consent info.
Declaration
Swift
typealias RequestError.Code._ErrorType = RequestError
Objective-C
enum UMPRequestErrorCode : NSInteger {}
-
Error codes used when loading and showing forms.
Declaration
Swift
typealias FormError.Code._ErrorType = FormError
Objective-C
enum UMPFormErrorCode : NSInteger {}
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\u003eThis documentation details globally available enumerations for managing user consent and privacy in Google AdMob for iOS.\u003c/p\u003e\n"],["\u003cp\u003eThe enumerations cover consent status, form status, privacy options, debug geography, request errors, and form errors.\u003c/p\u003e\n"],["\u003cp\u003eEach enumeration provides specific values and their meanings for handling different user privacy scenarios within the app.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize these enumerations to implement and control user consent and privacy settings according to regulatory requirements and user preferences.\u003c/p\u003e\n"]]],["The content defines globally available enumerations for the AdMob iOS privacy API. These include `UMPConsentStatus` for consent status values, `UMPFormStatus` to indicate whether a consent form is available, and `UMPPrivacyOptionsRequirementStatus` for privacy option modification needs. Debug values for testing geography are provided with `UMPDebugGeography`. Error codes for consent info updates (`UMPRequestErrorCode`) and form interactions (`UMPFormErrorCode`) are also defined. Each enum is declared in both Swift and Objective-C.\n"],null,["# GoogleUserMessagingPlatform Framework Reference\n\nEnumerations\n============\n\nThe following enumerations are available globally.\n- `\n ``\n ``\n `\n\n ### [UMPConsentStatus](/admob/ios/privacy/api/reference/Enums/UMPConsentStatus)\n\n `\n ` \n Consent status values. \n\n #### Declaration\n\n Swift \n\n enum ConsentStatus : Int, @unchecked Sendable\n\n Objective-C \n\n enum UMPConsentStatus : NSInteger {}\n\n- `\n ``\n ``\n `\n\n ### [UMPFormStatus](/admob/ios/privacy/api/reference/Enums/UMPFormStatus)\n\n `\n ` \n State values for whether the user has a consent form available to them. To check whether form\n status has changed, an update can be requested through\n requestConsentInfoUpdateWithParameters:completionHandler. \n\n #### Declaration\n\n Swift \n\n enum FormStatus : Int, @unchecked Sendable\n\n Objective-C \n\n enum UMPFormStatus : NSInteger {}\n\n- `\n ``\n ``\n `\n\n ### [UMPPrivacyOptionsRequirementStatus](/admob/ios/privacy/api/reference/Enums/UMPPrivacyOptionsRequirementStatus)\n\n `\n ` \n State values for whether the user needs to be provided a way to modify their privacy options. \n\n #### Declaration\n\n Swift \n\n enum PrivacyOptionsRequirementStatus : Int, @unchecked Sendable\n\n Objective-C \n\n enum UMPPrivacyOptionsRequirementStatus : NSInteger {}\n\n- `\n ``\n ``\n `\n\n ### [UMPDebugGeography](/admob/ios/privacy/api/reference/Enums/UMPDebugGeography)\n\n `\n ` \n Debug values for testing geography. \n\n #### Declaration\n\n Swift \n\n enum DebugGeography : Int, @unchecked Sendable\n\n Objective-C \n\n enum UMPDebugGeography : NSInteger {}\n\n- `\n ``\n ``\n `\n\n ### [UMPRequestErrorCode](/admob/ios/privacy/api/reference/Enums/UMPRequestErrorCode)\n\n `\n ` \n Error codes used when making requests to update consent info. \n\n #### Declaration\n\n Swift \n\n typealias RequestError.Code._ErrorType = RequestError\n\n Objective-C \n\n enum UMPRequestErrorCode : NSInteger {}\n\n- `\n ``\n ``\n `\n\n ### [UMPFormErrorCode](/admob/ios/privacy/api/reference/Enums/UMPFormErrorCode)\n\n `\n ` \n Error codes used when loading and showing forms. \n\n #### Declaration\n\n Swift \n\n typealias FormError.Code._ErrorType = FormError\n\n Objective-C \n\n enum UMPFormErrorCode : NSInteger {}"]]
