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
Unity plugin.
For US states regulations messaging support, we recommend you to use version
8.7.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.
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
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.
The following example sets TFUA to true on a UMP consent request:
ConsentRequestParametersparams=newConsentRequestParameters{// Indicate the user is under age of consent.TagForUnderAgeOfConsent=true;};ConsentInformation.Update(params,(FormErrorupdateError)=>
{// ...});
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
UMPDebugGeographyRegulatedUSStatedebugGeography 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["Select platform: [Android](/ad-manager/mobile-ads-sdk/android/privacy/us-iab-support \"View this page for the Android platform docs.\") [iOS](/ad-manager/mobile-ads-sdk/ios/privacy/us-iab-support \"View this page for the iOS platform docs.\") [Unity](/ad-manager/mobile-ads-sdk/unity/privacy/us-iab-support \"View this page for the Unity platform docs.\")\n\n\u003cbr /\u003e\n\nThis guide outlines the steps required to support the US states regulations\nmessage as part of the UMP SDK. Pair these instructions with\n[Get started](/ad-manager/mobile-ads-sdk/unity/privacy), which details how to get your app running\nwith the UMP SDK and set up your message. The following guidance is specific to\nthe US states regulations message.\n\nPrerequisites\n\nBefore continuing, ensure you do the following:\n\n- Update to the latest version of the Unity plugin. For US states regulations messaging support, we recommend you to use version 8.7.0 or higher.\n- Complete [Get started](/ad-manager/mobile-ads-sdk/unity/privacy). 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.\n- [Create a US state regulations message](//support.google.com/admanager/answer/10115735) for apps.\n- If you're using the US states regulations message alongside other messages, consult [Available user message types](//support.google.com/admanager/answer/10075998) to understand when different messages are displayed to your users.\n\nSet the tag for under age of consent\n\nTo indicate whether a user is under the age of consent, set\n`\n`[tagForUnderAgeOfConsent](/ad-manager/mobile-ads-sdk/unity/reference/class/google-mobile-ads/ump/api/consent-request-parameters#tagforunderageofconsent) (TFUA). When you set TFUA to `true`, the UMP SDK\ndoesn't request consent from the user. If your app has a mixed audience, set\nthis parameter for child users to ensure consent is not requested.\nIt is your\nresponsibility for setting this parameter where necessary to comply with COPPA\nand other relevant regulations.\n| **Important:** The UMP SDK does not forward the TFUA tag set on consent requests to the Google Mobile Ads SDK. You must explicitly set the `tagForUnderAgeOfConsent` or `tagForChildDirectectedTreatment` on ad requests. If you don't set the `tagForUnderAgeOfConsent` or `tagForChildDirectectedTreatment` 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 for child-directed treatment](//support.google.com/admanager/answer/3671211).\n\nThe following example sets TFUA to true on a UMP consent request: \n\n ConsentRequestParameters params = new ConsentRequestParameters\n {\n // Indicate the user is under age of consent.\n TagForUnderAgeOfConsent = true;\n };\n\n ConsentInformation.Update(params, (FormError updateError) =\u003e\n {\n // ...\n });\n\nRead consent choices\n\nAfter the user has made a US states regulations decision, you can read\ntheir choice from local storage following the Global Privacy Platform (GPP)\nspec. For more details see,\n[In-App Details](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Core/CMP%20API%20Specification.md#in-app-details).\nNote that the UMP SDK only populates the `IABGPP_GppSID` and\n`IABGPP_HDR_GppString` keys.\n\nTest your US states regulations messaging\n\nTo test your US states regulations messaging, use the\n`UMPDebugGeographyRegulatedUSState` `debugGeography` to force the UMP\nSDK to treat your test device as if the device were located in a regulated US\nstate. You can also use `UMPDebugGeographyOther` to force suppression of US\nstates regulations messages. For more details on `debugGeography`, see\n[Force a geography](/ad-manager/mobile-ads-sdk/unity/privacy#force_a_geography).\n| **Note:** `UMPDebugGeographyRegulatedUSState` is only available in Unity plugin 9.4.0 or higher."]]