AbstractAdRequestBuilder

public abstract class AbstractAdRequestBuilder<T extends AbstractAdRequestBuilder<T>>


A base builder class to help construct ad requests.

Summary

Public methods

T
@CanIgnoreReturnValue
addCustomEventExtrasBundle(
    Class<CustomEvent> adapterClass,
    Bundle customEventExtras
)

This method is deprecated.

Use addNetworkExtrasBundle instead.

T

Adds a custom targeting parameter.

T

Adds a custom targeting parameter with multiple values.

T

Adds a keyword for targeting purposes.

T
@CanIgnoreReturnValue
addNetworkExtrasBundle(
    Class<MediationExtrasReceiver> adapterClass,
    Bundle networkExtras
)

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

T

Sets an ad string that represents an ad response.

T

Sets the content URL for a web site whose content matches the app's primary content.

T

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

T

Sets URLs representing web content near an ad.

T

Sets the request agent string to identify the ad request's origin.

Protected methods

abstract T

Returns the self instance of a specified subtype.

Public methods

addCustomEventExtrasBundle

@CanIgnoreReturnValue
public T addCustomEventExtrasBundle(
    Class<CustomEvent> adapterClass,
    Bundle customEventExtras
)

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

Parameters
Class<CustomEvent> adapterClass

The Class of the custom event adapter for which you are providing extras.

Bundle customEventExtras

A Bundle of extra information to pass to a custom event adapter.

addCustomTargeting

@CanIgnoreReturnValue
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.

addCustomTargeting

@CanIgnoreReturnValue
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.

addKeyword

@CanIgnoreReturnValue
public T addKeyword(String keyword)

Adds a keyword for targeting purposes.

addNetworkExtrasBundle

@CanIgnoreReturnValue
public T addNetworkExtrasBundle(
    Class<MediationExtrasReceiver> adapterClass,
    Bundle networkExtras
)

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

Parameters
Class<MediationExtrasReceiver> adapterClass

The Class of the adapter that should receive extras.

Bundle networkExtras

A Bundle of extra information to pass to a mediation adapter.

setAdString

@CanIgnoreReturnValue
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.

setContentUrl

@CanIgnoreReturnValue
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
java.lang.NullPointerException

If contentUrl is {code null}.

java.lang.IllegalArgumentException

If contentUrl is empty, or if its length exceeds 512.

setHttpTimeoutMillis

@CanIgnoreReturnValue
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
int 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).

setNeighboringContentUrls

@CanIgnoreReturnValue
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
List<String> neighboringContentUrls

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

setRequestAgent

@CanIgnoreReturnValue
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

self

protected abstract T self()

Returns the self instance of a specified subtype.