GoogleUserMessagingPlatform Framework Reference

  • UMPConsentStatus is an enum defining the User Messaging Platform (UMP) consent status of a user.

  • It includes four possible values: unknown, required, notRequired, and obtained.

  • Each status indicates whether user consent is unknown, required but not yet obtained, not necessary, or has been successfully obtained.

  • UMPConsentStatus is essential for publishers to determine a user's consent status and manage ad personalization accordingly.

UMPConsentStatus

enum UMPConsentStatus : NSInteger {}

Consent status values.

  • < Unknown consent status.

    Declaration

    Swift

    case unknown = 0

    Objective-C

    UMPConsentStatusUnknown = 0
  • < User consent required but not yet obtained.

    Declaration

    Swift

    case required = 1

    Objective-C

    UMPConsentStatusRequired = 1
  • < Consent not required.

    Declaration

    Swift

    case notRequired = 2

    Objective-C

    UMPConsentStatusNotRequired = 2
  • Undocumented

    Declaration

    Swift

    case obtained = 3

    Objective-C

    UMPConsentStatusObtained =
          3