# 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.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** The [firebase::gma::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump) namespace has been deprecated and renamed to [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump).

| ### Enumerations ||
|---|---|
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a4d5617f24718c0f4f2e4d3268874d74f{ https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a4d5617f24718c0f4f2e4d3268874d74fae989846ffeb964b6dd0aa00f2c62c76a = 0, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a4d5617f24718c0f4f2e4d3268874d74fae22e21b1a97c684406d413cd3a1218af, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a4d5617f24718c0f4f2e4d3268874d74fad38d46763fbd2c76418d2c43c034d40c }` | enum**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace. Debug values for testing geography. |
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983{ https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a56ae829f6b68adcc5c5db48947d1f1c7 = 0, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a2a5f9a57761a115bba8e5b6a96e0d6bb, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a02fcae9b629866f1b621908ca1be2623, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a1d06a7a383f55a7a6b14ad56ae6b3a79, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a5d425ea25c34781c3ea9282d7e0e1488, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a52ee1332960f4c69d09054f7082bf1af, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a146f75b03f50c79f1808fad5e7dd4c28, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a1dc9def6277f9e2bfd76bbe5c4780983a3c1a3cb36d20b43a4266043b7470c6f2 }` | enum**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace. Errors when loading or showing the consent form. |
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a257886851ea6ac048f36cb87e623233d{ https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a257886851ea6ac048f36cb87e623233da237d1f16704094de356cdb274df47630 = 0, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a257886851ea6ac048f36cb87e623233dac5579ed8ffe224280d0192ee37cb43b7, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a257886851ea6ac048f36cb87e623233da375d6a4623ae1818aa5b3ebf27b8a53e }` | enum**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace. Status of the consent form, whether it is available to show or not. |
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45f{ https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fa3a7bb7fb2f30cac7a02ebfa6c88ab45a = 0, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fac874294b362466bac99ebbb84f843478, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fa59a2421dde5278658142adeb0a59f49a, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fa94a1c781cee8a486ccd80aa6388873cd, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fad12615ce5e00bfccd504252afeb90adf, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fa8d65aaf89e7b8ba6c7b084c7ec79a3bb, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45faa84ae03bdbdfce003b79236108f857fb, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a8cd2fc9dded81fbba4f1d4c2ac3ee45fa0bdd1e8a2e5b4fba7104a33059413eff }` | enum**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace. Errors that can occur during a RequestConsentInfoUpdate operation. |
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a9185ca551351378e3c99e2cd357979cf{ https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a9185ca551351378e3c99e2cd357979cfa4925be3d87bfc1d5bac8edc96161f1f4 = 0, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a9185ca551351378e3c99e2cd357979cfa0642ccb2affc60fa3da5aaf83a284061, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a9185ca551351378e3c99e2cd357979cfaf058796c48341e133eb1396c929e8b9a, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a9185ca551351378e3c99e2cd357979cfa9e5c8d0f7935690e6eacc95838159507 }` | enum**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace. Consent status values. |
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1ad94746f2f3492e68b92738b9cf4cfb64{ https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1ad94746f2f3492e68b92738b9cf4cfb64ad3f9cfadbaf9e8de43e150b65f5c8537 = 0, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1ad94746f2f3492e68b92738b9cf4cfb64a0ff46cde0b025df30439eeacdf3046f3, https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1ad94746f2f3492e68b92738b9cf4cfb64a52d7bb8a5ffffefdebd2d4d61d5cad23 }` | enum**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace. Whether the privacy options need to be displayed. |

| ### Typedefs ||
|---|---|
| `https://developers.google.com/admob/cpp/reference/namespace/firebase/gma/ump#namespacefirebase_1_1gma_1_1ump_1a2aef33d9a1aa6bf80c70b40ef9c0268e` | typedef `void *` This is a platform specific datatype that is required to show a consent form on screen. |

| ### Classes ||
|---|---|
| [firebase::gma::ump::ConsentInfo](https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info) | Consent Information class for the User Messaging Platform SDK. |

| ### Structs ||
|---|---|
| [firebase::gma::ump::ConsentDebugSettings](https://developers.google.com/admob/cpp/reference/struct/firebase/gma/ump/consent-debug-settings) | Debug settings for `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1aff1b2c4891eca23c058052b01c37290e`. |
| [firebase::gma::ump::ConsentRequestParameters](https://developers.google.com/admob/cpp/reference/struct/firebase/gma/ump/consent-request-parameters) | Parameters for the `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1aff1b2c4891eca23c058052b01c37290e` operation. |

## Enumerations

### ConsentDebugGeography

```c++
 ConsentDebugGeography
```
Debug values for testing geography.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace.

| 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

```c++
 ConsentFormError
```
Errors when loading or showing the consent form.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace.

| 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 `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1a21d515227440053359d7dbad86c10c82` or `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1a4a1953380acee90f309714ff5d5b7a9e` 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

```c++
 ConsentFormStatus
```
Status of the consent form, whether it is available to show or not.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace.

| Properties ||
|---|---|
| `kConsentFormStatusAvailable` | The consent form is available. Call `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1a27453314485ba3a0665110affbd6b6d3` to display it. |
| `kConsentFormStatusUnavailable` | The consent form is unavailable. Call `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1a2bbbe1d4d1c174901f4cd55a48b7d57b` to load it. |
| `kConsentFormStatusUnknown` | Status is unknown. Call `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1aff1b2c4891eca23c058052b01c37290e` to update this. |

### ConsentRequestError

```c++
 ConsentRequestError
```
Errors that can occur during a RequestConsentInfoUpdate operation.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace.

| Properties ||
|---|---|
| `kConsentRequestErrorInternal` | An internal error occurred. |
| `kConsentRequestErrorInvalidAppId` | Invalid GMA [App](https://developers.google.com/admob/cpp/reference/class/firebase/app#classfirebase_1_1_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 `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1ad222e41a98233c241ce6952cb56ff41b` to get the status. |
| `kConsentRequestErrorUnknown` | An unknown error occurred. |
| `kConsentRequestSuccess` | The operation succeeded. |

### ConsentStatus

```c++
 ConsentStatus
```
Consent status values.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace.

| 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

```c++
 PrivacyOptionsRequirementStatus
```
Whether the privacy options need to be displayed.

**[Deprecated.](https://developers.google.com/admob/cpp/reference/deprecated/deprecated)** This enum has been moved to the [firebase::ump](https://developers.google.com/admob/cpp/reference/namespace/firebase/ump#namespacefirebase_1_1ump) namespace.

| Properties ||
|---|---|
| `kPrivacyOptionsRequirementStatusNotRequired` | Privacy options are not required to be shown. |
| `kPrivacyOptionsRequirementStatusRequired` | Privacy options must be shown. Call `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1afc5235054c8ecfadaa69a2d557a176db` to fulfil this requirement. |
| `kPrivacyOptionsRequirementStatusUnknown` | Privacy options requirement status is unknown. Call `https://developers.google.com/admob/cpp/reference/class/firebase/gma/ump/consent-info#classfirebase_1_1gma_1_1ump_1_1_consent_info_1aff1b2c4891eca23c058052b01c37290e` to update. |

## Typedefs

### FormParent

```c++
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.

<br />