Targeting

This guide explains how to provide targeting information to an ad request. For a working example, download the Android API Demo app.

Download API Demo

Prerequisite

• Complete the Get Started guide.

RequestConfiguration

RequestConfiguration is an object that collects targeting information to be applied globally via a MobileAds static method.

To update the request configuration, obtain a builder from the existing configuration, perform any desired updates, and set it as follows:

Java

RequestConfiguration requestConfiguration = MobileAds.getRequestConfiguration().toBuilder().build();
MobileAds.setRequestConfiguration(requestConfiguration);

Kotlin

var requestConfiguration = MobileAds.getRequestConfiguration().toBuilder().build()
MobileAds.setRequestConfiguration(requestConfiguration)

Child-directed setting

For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called "tag for child-directed treatment". By setting this tag, you certify that this notification is accurate and you are authorized to act on behalf of the owner of the app. You understand that abuse of this setting may result in termination of your Google account.

As an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. If you indicate that you want Google to treat your content as child-directed, we take steps to disable IBA and remarketing ads on that ad request.

The setting can be used with all versions of the Google Play services SDK via RequestConfiguration.Builder.setTagForChildDirectedTreatment(int):

• Call setTagForChildDirectedTreatment with TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE to indicate that you want your content treated as child-directed for purposes of COPPA.

• Call setTagForChildDirectedTreatment with TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE to indicate that you don't want your content treated as child-directed for purposes of COPPA.

• Call setTagForChildDirectedTreatment with TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED if you don't want to indicate how you would like your content treated with respect to COPPA in ad requests.

The following example indicates that you want your content treated as child-directed for purposes of COPPA:

Java

RequestConfiguration requestConfiguration = MobileAds.getRequestConfiguration().toBuilder()
        .setTagForChildDirectedTreatment(TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE)
        .build();

Kotlin

var requestConfiguration = MobileAds.getRequestConfiguration().toBuilder()
        .setTagForChildDirectedTreatment(TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE)
        .build()

Note: Apps in the Designed For Families Program as Primarily child-directed apps and users signed into Google accounts managed with Family Link automatically have all content treated as child-directed for all ad requests.

Users under the age of consent

You can mark your ad requests to receive treatment for users in the European Economic Area (EEA) under the age of consent. This feature is designed to help facilitate compliance with the General Data Protection Regulation (GDPR). Note that you may have other legal obligations under GDPR. Please review the European Union’s guidance and consult with your own legal counsel. Please remember that Google's tools are designed to facilitate compliance and do not relieve any particular publisher of its obligations under the law. Learn more about how the GDPR affects publishers.

When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in the ad request. This parameter disables personalized advertising, including remarketing, for all ad requests. It also disables requests to third-party ad vendors, such as ad measurement pixels and third-party ad servers.

Like child-directed settings, there is a method in RequestConfiguration.Builder for setting the TFUA parameter: setTagForUnderAgeOfConsent, with the following options.

• Call setTagForUnderAgeOfConsent with TAG_FOR_UNDER_AGE_OF_CONSENT_TRUE to indicate that you want the ad request to receive treatment for users in the European Economic Area (EEA) under the age of consent.

• Call setTagForUnderAgeOfConsent with TAG_FOR_UNDER_AGE_OF_CONSENT_FALSE to indicate that you want the ad request to not receive treatment for users in the European Economic Area (EEA) under the age of consent.

• Call setTagForUnderAgeOfConsent with TAG_FOR_UNDER_AGE_OF_CONSENT_UNSPECIFIED to indicate that you have not specified whether the ad request should receive treatment for users in the European Economic Area (EEA) under the age of consent.

The following example indicates that you want TFUA included in your ad requests:

Java

RequestConfiguration requestConfiguration = MobileAds.getRequestConfiguration().toBuilder()
        .setTagForUnderAgeOfConsent(TAG_FOR_UNDER_AGE_OF_CONSENT_TRUE)
        .build();

Kotlin

var requestConfiguration = MobileAds.getRequestConfiguration().toBuilder()
        .setTagForUnderAgeOfConsent(TAG_FOR_UNDER_AGE_OF_CONSENT_TRUE)
        .build()

The tags to enable the Child-directed setting and setTagForUnderAgeOfConsent should not both simultaneously be set to true. If they are, the child-directed setting takes precedence.

Ad content filtering

Apps can set a maximum ad content rating for their ad requests using the setMaxAdContentRating method. AdMob ads returned when this is configured have a content rating at or below that level. The possible values for this network extra are based on digital content label classifications, and must be one of the following strings:

• MAX_AD_CONTENT_RATING_G
• MAX_AD_CONTENT_RATING_PG
• MAX_AD_CONTENT_RATING_T
• MAX_AD_CONTENT_RATING_MA

The following code configures an RequestConfiguration object to specify that ad content returned should correspond to a digital content label designation no higher than G:

Java

RequestConfiguration requestConfiguration = MobileAds.getRequestConfiguration().toBuilder()
        .setMaxAdContentRating(MAX_AD_CONTENT_RATING_G)
        .build();

Kotlin

var requestConfiguration = MobileAds.getRequestConfiguration().toBuilder()
        .setMaxAdContentRating(MAX_AD_CONTENT_RATING_G)
        .build()

Note: Content rating filter settings specified via the SDK will override any settings configured using the AdMob UI.

Ad request

The AdRequest object collects targeting information to be sent with an ad request.

Location

If a user has granted your app location permissions, AdMob automatically passes this location data to the SDK. The SDK uses this data to improve ad targeting without requiring any code changes in your app. You can, of course, enable or disable location data for ads.

Autopopulated location information is not forwarded to mediation networks and it may also be disabled entirely. Therefore, the SDK provides the ability to set location manually. You can specify location-targeting information in the ad request as follows:

Java

AdRequest request = new AdRequest.Builder()
        .setLocation(location)
        .build();

Kotlin

val request = AdRequest.Builder()
        .setLocation(location)
        .build()

The user's location should be obtained by a suitable method.

Out of respect for user privacy, Google asks that you specify location only if that information is already being used by your app.

Load an ad with targeting

Once your request targeting information is set, call loadAd() on the ad view with your AdRequest instance.

Java

AdRequest request = new AdRequest.Builder()
        .setLocation(location)
        .build();
adView.loadAd(request);

Kotlin

val request = AdRequest.Builder()
        .setLocation(location)
        .build()
adView.loadAd(request)

Refer to the Ad Targeting example for an implementation of ad targeting in the Android API Demo app.