AdRequest.Builder

public static final class AdRequest.Builder extends Object

Builds an AdRequest.

Public Constructor Summary

Public Method Summary

AdRequest.Builder
addCustomEventExtrasBundle(Class<? extends CustomEvent> adapterClass, Bundle customEventExtras)
Add extra parameters to pass to a specific custom event adapter.
AdRequest.Builder
addKeyword(String keyword)
Add a keyword for targeting purposes.
AdRequest.Builder
addNetworkExtras(NetworkExtras networkExtras)
Add extra parameters to pass to a specific ad network adapter.
AdRequest.Builder
addNetworkExtrasBundle(Class<? extends MediationAdapter> adapterClass, Bundle networkExtras)
Add extra parameters to pass to a specific ad network adapter.
AdRequest.Builder
addTestDevice(String deviceId)
Causes a device to receive test ads.
AdRequest
build()
Constructs an AdRequest with the specified attributes.
AdRequest.Builder
setBirthday(Date birthday)
Sets the user's birthday for targeting purposes.
AdRequest.Builder
setContentUrl(String contentUrl)
Sets the content URL for targeting purposes.
AdRequest.Builder
setGender(int gender)
Sets the user's gender for targeting purposes.
AdRequest.Builder
setIsDesignedForFamilies(boolean isDesignedForFamilies)
This method allows apps that have opted into the Designed for Families program to specify whether a given ad request should return Designed for Families-compliant ads.
AdRequest.Builder
setLocation(Location location)
Sets the user's location for targeting purposes.
AdRequest.Builder
setRequestAgent(String requestAgent)
Sets the request agent string to identify the ad request's origin.
AdRequest.Builder
tagForChildDirectedTreatment(boolean tagForChildDirectedTreatment)
This method allows you to specify whether you would like your app to be treated as child-directed for purposes of the Children's Online Privacy Protection Act (COPPA) - //business.ftc.gov/privacy-and-security/childrens-privacy.

Inherited Method Summary

Public Constructors

public AdRequest.Builder ()

Public Methods

public AdRequest.Builder addCustomEventExtrasBundle (Class<? extends CustomEvent> adapterClass, Bundle customEventExtras)

Add extra parameters to pass to a specific custom event adapter.

Parameters
adapterClass The Class of the custom event adapter for which you are providing extras.
customEventExtras A Bundle of extra information to pass to a custom event adapter.

public AdRequest.Builder addKeyword (String keyword)

Add a keyword for targeting purposes.

public AdRequest.Builder addNetworkExtras (NetworkExtras networkExtras)

Add extra parameters to pass to a specific ad network adapter. The networkExtras parameter should be an instance of com.google.ads.mediation.NetworkExtras, which is provided by ad network adapters.

Note that the NetworkExtras class has been deprecated. This method is included to maintain compatibility with older adapters.

public AdRequest.Builder addNetworkExtrasBundle (Class<? extends MediationAdapter> adapterClass, Bundle networkExtras)

Add extra parameters to pass to a specific ad network adapter.

Parameters
adapterClass The Class of the adapter for the network for which you are providing extras.
networkExtras A Bundle of extra information to pass to a mediation adapter.

public AdRequest.Builder addTestDevice (String deviceId)

Causes a device to receive test ads. The deviceId can be obtained by viewing the logcat output after creating a new ad.

public AdRequest build ()

Constructs an AdRequest with the specified attributes.

public AdRequest.Builder setBirthday (Date birthday)

Sets the user's birthday for targeting purposes.

public AdRequest.Builder setContentUrl (String contentUrl)

Sets the content URL for targeting purposes.

Throws
NullPointerException If contentUrl is {code null}.
IllegalArgumentException If contentUrl is empty, or if its length exceeds 512.

public AdRequest.Builder setGender (int gender)

Sets the user's gender for targeting purposes. This should be GENDER_MALE, GENDER_FEMALE, or GENDER_UNKNOWN.

public AdRequest.Builder setIsDesignedForFamilies (boolean isDesignedForFamilies)

This method allows apps that have opted into the Designed for Families program to specify whether a given ad request should return Designed for Families-compliant ads. Please note that the method is ONLY intended for apps that have opted into Designed for Families. Please see the AdMob help center article for more information about this setting.

If you set this value to true, you indicate that your app requires that the ad request should return a Designed for Families-compliant ad.

If you set this value to false, you indicate that your app does not require that the ad request should return a Designed for Families-compliant ad.

Note: This setting is separate from the Children's Online Privacy Protection Act (COPPA) "tag for child directed treatment" setting. For COPPA-related compliance, see tagForChildDirectedTreatment(boolean).

public AdRequest.Builder setLocation (Location location)

Sets the user's location for targeting purposes.

public AdRequest.Builder setRequestAgent (String requestAgent)

Sets the request agent string to identify the ad request's origin. Third party libraries that reference the Mobile Ads SDK should call this method to denote the platform from which the ad request originated. For example, if a third party ad network called "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this method with "CoolAds".

public AdRequest.Builder tagForChildDirectedTreatment (boolean tagForChildDirectedTreatment)

This method allows you to specify whether you would like your app to be treated as child-directed for purposes of the Children's Online Privacy Protection Act (COPPA) - //business.ftc.gov/privacy-and-security/childrens-privacy.

If you set this method to true, you will indicate that your app should be treated as child-directed for purposes of the Children's Online Privacy Protection Act (COPPA).

If you set this method to false, you will indicate that your app should not be treated as child-directed for purposes of the Children's Online Privacy Protection Act (COPPA).

If you do not set this method, ad requests will include no indication of how you would like your app treated with respect to COPPA.

By setting this method, 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.

Note: it may take some time for this designation to be fully implemented in applicable Google services.

This designation will only apply to ad requests for which you have set this method.

Parameters
tagForChildDirectedTreatment Set to true to indicate that your app should be treated as child-directed. Set to false to indicate that your app should not be treated as child-directed.

Send feedback about...

Need help? Visit our support page.