firebase::gma::ump

API for User Messaging Platform.

Summary

The User Messaging Platform (UMP) SDK is Google’s option to handle user privacy and consent in mobile apps.

Enumerations
ConsentDebugGeography{
  kConsentDebugGeographyDisabled = 0,
  kConsentDebugGeographyEEA,
  kConsentDebugGeographyNonEEA
} 		enum
Debug values for testing geography.
ConsentFormError{
  kConsentFormSuccess = 0,
  kConsentFormErrorTimeout,
  kConsentFormErrorInternal,
  kConsentFormErrorUnknown,
  kConsentFormErrorUnavailable,
  kConsentFormErrorAlreadyUsed,
  kConsentFormErrorInvalidOperation,
  kConsentFormErrorOperationInProgress
} 		enum
Errors when loading or showing the consent form.
ConsentFormStatus{
  kConsentFormStatusUnknown = 0,
  kConsentFormStatusUnavailable,
  kConsentFormStatusAvailable
} 		enum
Status of the consent form, whether it is available to show or not.
ConsentRequestError{
  kConsentRequestSuccess = 0,
  kConsentRequestErrorInvalidAppId,
  kConsentRequestErrorNetwork,
  kConsentRequestErrorInternal,
  kConsentRequestErrorMisconfiguration,
  kConsentRequestErrorUnknown,
  kConsentRequestErrorInvalidOperation,
  kConsentRequestErrorOperationInProgress
} 		enum
Errors that can occur during a RequestConsentInfoUpdate operation.
ConsentStatus{
  kConsentStatusUnknown = 0,
  kConsentStatusRequired,
  kConsentStatusNotRequired,
  kConsentStatusObtained
} 		enum
Consent status values.
PrivacyOptionsRequirementStatus{
  kPrivacyOptionsRequirementStatusUnknown = 0,
  kPrivacyOptionsRequirementStatusNotRequired,
  kPrivacyOptionsRequirementStatusRequired
} 		enum
Whether the privacy options need to be displayed.

Typedefs
FormParent typedef
void *
This is a platform specific datatype that is required to show a consent form on screen.

Classes
firebase::gma::ump::ConsentInfo

Consent Information class for the User Messaging Platform SDK.

Structs
firebase::gma::ump::ConsentDebugSettings

Debug settings for ConsentInfo::RequestConsentInfoUpdate().

firebase::gma::ump::ConsentRequestParameters

Parameters for the ConsentInfo::RequestConsentInfoUpdate() operation.

Enumerations

ConsentDebugGeography

 ConsentDebugGeography

Debug values for testing geography.

Properties
kConsentDebugGeographyDisabled

Disable geography debugging.

kConsentDebugGeographyEEA

Geography appears as in EEA (European Economic Area) for debug devices.

kConsentDebugGeographyNonEEA

Geography appears as not in EEA for debug devices.

ConsentFormError

 ConsentFormError

Errors when loading or showing the consent form.

Properties
kConsentFormErrorAlreadyUsed

This form was already used.

kConsentFormErrorInternal

An internal error occurred.

kConsentFormErrorInvalidOperation

An invalid operation occurred. Try again.

kConsentFormErrorOperationInProgress

The operation is already in progress.

Call ConsentInfo::LoadConsentFormLastResult() or ConsentInfo::ShowConsentFormLastResult() to get the status.

kConsentFormErrorTimeout

The load request timed out. Try again.

kConsentFormErrorUnavailable

The form is unavailable.

kConsentFormErrorUnknown

An unknown error occurred.

kConsentFormSuccess

The operation succeeded.

ConsentFormStatus

 ConsentFormStatus

Status of the consent form, whether it is available to show or not.

Properties
kConsentFormStatusAvailable

The consent form is available.

Call ConsentInfo::ShowConsentForm() to display it.

kConsentFormStatusUnavailable

The consent form is unavailable.

Call ConsentInfo::LoadConsentForm() to load it.

kConsentFormStatusUnknown

Status is unknown.

Call ConsentInfo::RequestConsentInfoUpdate() to update this.

ConsentRequestError

 ConsentRequestError

Errors that can occur during a RequestConsentInfoUpdate operation.

Properties
kConsentRequestErrorInternal

An internal error occurred.

kConsentRequestErrorInvalidAppId

Invalid GMA App ID specified in AndroidManifest.xml or Info.plist.

kConsentRequestErrorInvalidOperation

An invalid operation occurred. Try again.

kConsentRequestErrorMisconfiguration

A misconfiguration exists in the UI.

kConsentRequestErrorNetwork

A network error occurred.

kConsentRequestErrorOperationInProgress

The operation is already in progress.

Use ConsentInfo::RequestConsentInfoUpdateLastResult() to get the status.

kConsentRequestErrorUnknown

An unknown error occurred.

kConsentRequestSuccess

The operation succeeded.

ConsentStatus

 ConsentStatus

Consent status values.

Properties
kConsentStatusNotRequired

Consent is not required.

kConsentStatusObtained

Consent was required, and has been obtained.

kConsentStatusRequired

Consent is required, but not obtained.

kConsentStatusUnknown

Unknown status, e.g. prior to calling Request, or if the request fails.

PrivacyOptionsRequirementStatus

 PrivacyOptionsRequirementStatus

Whether the privacy options need to be displayed.

Properties
kPrivacyOptionsRequirementStatusNotRequired

Privacy options are not required to be shown.

kPrivacyOptionsRequirementStatusRequired

Privacy options must be shown.

Call ConsentInfo::ShowPrivacyOptionsForm() to fulfil this requirement.

kPrivacyOptionsRequirementStatusUnknown

Privacy options requirement status is unknown.

Call ConsentInfo::RequestConsentInfoUpdate() to update.

Typedefs

FormParent

void * FormParent

This is a platform specific datatype that is required to show a consent form on screen.

The following defines the datatype on each platform:

  • Android: A jobject which references an Android Activity.
  • iOS: An id which references an iOS UIViewController.
A void pointer for stub classes.