Disclose to US users

Select platform: Android iOS Unity React Native Android (Legacy)

This guide outlines the steps required to support the US states regulations message as part of the UMP SDK. Pair these instructions with Set up UMP SDK, which details how to get your app running with the UMP SDK and set up your message. The following guidance is specific to the US states regulations message.

Prerequisites

Before continuing, do the following:

• Set up UMP SDK.
• Create a US states regulations message for apps.

Set the tag for under age of consent

To indicate whether a user is under the age of consent, set tagForUnderAgeOfConsent (TFUA). When you set TFUA to true, the UMP SDK doesn't request consent from the user. If your app has a mixed audience, set this parameter for child users to ensure consent is not requested. It is your responsibility for setting this parameter where necessary to comply with COPPA and other relevant regulations.

Important: The UMP SDK does not forward the TFUA tag set on consent requests to Google Mobile Ads SDK for React Native. You must explicitly set ageRestrictedTreatment on ad requests. If you don't set ageRestrictedTreatment on ad requests, the UMP SDK does not collect any information that allows Google to determine whether or not users under the age of consent use your app. For more information about data processing restrictions for these users, see Tag an ad request from an app for child-directed treatment.

The following example sets TFUA to true on a UMP consent request:

/**
 * Sets tag for under age of consent on consent request parameters.
 */
export function requestConsentWithTagForUnderAgeOfConsent() {
  requestConsentInfoUpdate(
    {
      tagForUnderAgeOfConsent: true,
    },
    (error) => {
      if (error) {
        console.warn('Consent info update error:', error.message);
      }
    },
  );
}

Test your US states regulations messaging

To test your US states regulations messaging, use the DebugGeography.REGULATED_US_STATE value to force the UMP SDK to treat your test device as if the device were located in a regulated US state. You can also use the DebugGeography.OTHER value to suppress US states regulations messages. For details on the debugGeography property, see Force a geography.