This guide outlines the steps required to support the US states regulations message as part of the UMP SDK. Pair these instructions with Get started, 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, ensure you do the following:
- Update to the latest version of the UMP SDK. For US states regulations messaging support, we recommend you to use version 2.1.0 or higher.
- Complete Get started. Be sure to implement a privacy options entrypoint and render it if required. By completing this guide, you have an entrypoint to serve your US states regulations message to your users.
- Create a US states regulations message for apps.
- If you're using the US states regulations message alongside other messages, consult Available user message types to understand when different messages are displayed to your users.
Set the tag for under age of consent
To indicate whether a user is under the age of consent, set
setTagForUnderAgeOfConsent
(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.
The following example sets TFUA to true on a UMP consent request:
Java
ConsentRequestParameters params = new ConsentRequestParameters
.Builder()
// Indicate the user is under age of consent.
.setTagForUnderAgeOfConsent(true)
.build();
consentInformation = UserMessagingPlatform.getConsentInformation(this);
consentInformation.requestConsentInfoUpdate(
this,
params,
(OnConsentInfoUpdateSuccessListener) () -> {
// ...
},
(OnConsentInfoUpdateFailureListener) requestConsentError -> {
// ...
});
Kotlin
val params = ConsentRequestParameters
.Builder()
// Indicate the user is under age of consent.
.setTagForUnderAgeOfConsent(true)
.build()
consentInformation = UserMessagingPlatform.getConsentInformation(this)
consentInformation.requestConsentInfoUpdate(
this,
params,
ConsentInformation.OnConsentInfoUpdateSuccessListener {
// ...
},
ConsentInformation.OnConsentInfoUpdateFailureListener {
requestConsentError ->
// ...
})
Read consent choices
After the user has made a US states regulations decision, you can read
their choice from local storage following the Global Privacy Platform (GPP)
spec. For more details see,
In-App Details.
Note that the UMP SDK only populates the IABGPP_GppSID
and
IABGPP_HDR_GppString
keys.
Test your US states regulations messaging
To test your US states regulations messaging, use the
UMPDebugGeographyRegulatedUSState
debugGeography
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 UMPDebugGeographyOther
to force suppression of US
states regulations messages. For more details on debugGeography
, see
Force a geography.