public abstract class AbstractAdRequestBuilder extends Object
Known Direct Subclasses

A base builder class to help construct ad requests.

Public Method Summary

T
addCustomEventExtrasBundle(Class<? extends CustomEvent> adapterClass, Bundle customEventExtras)
This method is deprecated. Use addNetworkExtrasBundle(Class, Bundle) instead.
T
addCustomTargeting(String key, List<String> values)
Adds a custom targeting parameter with multiple values.
T
addCustomTargeting(String key, String value)
Adds a custom targeting parameter.
T
addKeyword(String keyword)
Adds a keyword for targeting purposes.
T
addNetworkExtrasBundle(Class<? extends MediationExtrasReceiver> adapterClass, Bundle networkExtras)
Adds extra parameters to pass to a specific ad network adapter.
T
setAdString(String adString)
Sets an ad string that represents an ad response.
T
setContentUrl(String contentUrl)
Sets the content URL for a web site whose content matches the app's primary content.
T
setHttpTimeoutMillis(int httpTimeoutMillis)
Sets a custom timeout for HTTPS calls made by the Google Mobile Ads SDK during an ad request.
T
setNeighboringContentUrls(List<String> neighboringContentUrls)
Sets URLs representing web content near an ad.
T
setRequestAgent(String requestAgent)
Sets the request agent string to identify the ad request's origin.

Protected Method Summary

abstract T
self()
Returns the self instance of a specified subtype.

Inherited Method Summary

Public Methods

public T addCustomEventExtrasBundle (Class<? extends CustomEvent> adapterClass, Bundle customEventExtras)

This method is deprecated.
Use addNetworkExtrasBundle(Class, Bundle) instead.

Adds 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 T addCustomTargeting (String key, List<String> values)

Adds a custom targeting parameter with multiple values. Calling this a second time with the same key will overwrite the old values.

public T addCustomTargeting (String key, String value)

Adds a custom targeting parameter. Calling this a second time with the same key will overwrite the old values.

public T addKeyword (String keyword)

Adds a keyword for targeting purposes.

public T addNetworkExtrasBundle (Class<? extends MediationExtrasReceiver> adapterClass, Bundle networkExtras)

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

Parameters
adapterClass The Class of the adapter that should receive extras.
networkExtras A Bundle of extra information to pass to a mediation adapter.

public T setAdString (String adString)

Sets an ad string that represents an ad response. If set, the SDK will render this ad and ignore all other targeting information set on this request.

public T setContentUrl (String contentUrl)

Sets the content URL for a web site whose content matches the app's primary content. This web site content is used for targeting and brand safety purposes.

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

public T setHttpTimeoutMillis (int httpTimeoutMillis)

Sets a custom timeout for HTTPS calls made by the Google Mobile Ads SDK during an ad request.

If your app uses mediation, this timeout does not apply to network calls made by third-party ad network SDKs.

Parameters
httpTimeoutMillis An integer specifying the HTTPS timeout in milliseconds. Any values lower than 5000 (5 seconds) will be ignored. The default value is 60000 (60 seconds).

public T setNeighboringContentUrls (List<String> neighboringContentUrls)

Sets URLs representing web content near an ad. Promotes brand safety and allows displayed ads to have an app level rating (MA, T, PG, etc) that is more appropriate to neighboring content.

Parameters
neighboringContentUrls The list of neighboring content URLs to be attached to the existing neighboring content URLs.

public T 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".

Protected Methods

protected abstract T self ()

Returns the self instance of a specified subtype.