Share your feedback and help shape the Google Mobile Ads SDK roadmap. Take the Google Mobile Ads SDK Annual Survey for 2023 before it closes on May 5th, 2023.

GoogleMobileAds Framework Reference

Stay organized with collections Save and categorize content based on your preferences.

UMPConsentInformation

@interface UMPConsentInformation : NSObject

Consent information. All methods must be called on the main thread.

  • The shared consent information instance.

    Declaration

    Swift

    class var sharedInstance: UMPConsentInformation { get }

    Objective-C

    @property (class, nonatomic, readonly, nonnull) UMPConsentInformation *sharedInstance;

  • The user’s consent status. This value is cached between app sessions and can be read before requesting updated parameters.

    Declaration

    Swift

    var consentStatus: UMPConsentStatus { get }

    Objective-C

    @property (nonatomic, readonly) UMPConsentStatus consentStatus;

  • Consent form status. This value defaults to UMPFormStatusUnknown and requires a call to requestConsentInfoUpdateWithParameters:completionHandler to update.

    Declaration

    Swift

    var formStatus: UMPFormStatus { get }

    Objective-C

    @property (nonatomic, readonly) UMPFormStatus formStatus;

  • Requests consent information update. Must be called before loading a consent form.

    Declaration

    Swift

    func requestConsentInfoUpdate(with parameters: UMPRequestParameters?) async throws

    Objective-C

    - (void)
    requestConsentInfoUpdateWithParameters:
        (nullable UMPRequestParameters *)parameters
                         completionHandler:
                             (nonnull
                                  UMPConsentInformationUpdateCompletionHandler)
                                 handler;

  • Clears all consent state from persistent storage.

    Declaration

    Swift

    func reset()

    Objective-C

    - (void)reset;