Skip to main content

ConsentStatus

The state of the consent-gathering process, as reported by the User Messaging Platform (UMP).

Note

This describes whether a consent decision has been collected — not what the user chose. It is never "granted" versus "denied": the user's actual selections live in the IAB TCF consent string, which the ads SDK reads automatically. Use ConsentManager.can_request_ads to decide whether to request ads.

Inherits: enum.Enum

Properties

  • NOT_REQUIRED - Consent is not required (e.g.
  • OBTAINED - A consent decision has been collected.
  • REQUIRED - Consent is required but has not yet been collected.
  • UNKNOWN - Consent status is unknown.

Properties​

NOT_REQUIREDclass-attributeinstance-attribute​

Consent is not required (e.g. the user is outside a regulated region).

OBTAINEDclass-attributeinstance-attribute​

A consent decision has been collected.

Set once the user completes the form — whether they consented, declined ("Do not consent"), or saved custom choices. This does not imply that consent was granted.

REQUIREDclass-attributeinstance-attribute​

Consent is required but has not yet been collected.

UNKNOWNclass-attributeinstance-attribute​

Consent status is unknown.