AdRequest.Builder

Kotlin |Java

public final class AdRequest.Builder

---

Builder class for AdRequest.

Summary

Public constructors
Builder(@NonNull String adUnitId)

Public methods
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue addCategoryExclusion(@NonNull String categoryExclusion) Sets a slot-level ad category exclusion label.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue addKeyword(@NonNull String keyword) Adds a keyword for targeting purposes.
final @NonNull AdRequest	build() Constructs an AdRequest with the specified attributes.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue putAdSourceExtrasBundle(     @NonNull Class<@NonNull MediationExtrasReceiver> adapterClass,     @NonNull Bundle adSourceExtras ) Adds extra parameters to pass to a specific ad source adapter.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue putCustomTargeting(@NonNull String key, @NonNull String value) Adds a custom targeting parameter.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue putCustomTargeting(     @NonNull String key,     @NonNull List<@NonNull String> values ) Adds a custom targeting parameter with multiple values.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue setContentUrl(@NonNull String contentUrl) Sets the content URL for a web site whose content matches the app's primary content.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue setGoogleExtrasBundle(@NonNull Bundle extraBundle) Set extra parameters to pass to AdMob or Ad Manager.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue setNeighboringContentUrls(     @NonNull Set<@NonNull String> neighboringContentUrls ) Sets URLs representing web content near an ad.
@NonNull AdRequest.Builder	@CanIgnoreReturnValue setPlacementId(long placementId) Sets a default placement ID for the loaded ad.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue setPublisherProvidedId(@NonNull String publisherProvidedId) Sets an identifier for use in frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.
final @NonNull AdRequest.Builder	@CanIgnoreReturnValue setRequestAgent(@NonNull String requestAgent) Sets the request agent string to identify the ad request's origin.

Protected methods
final @NonNull Map<@NonNull String, @NonNull Bundle>	getAdSourceExtrasBundles()
final String	getAdUnitId() The ad unit ID.
final @NonNull Set<@NonNull String>	getCategoryExclusions()
final String	getContentUrl()
final @NonNull Map<@NonNull String, @NonNull String>	getCustomTargeting()
final @NonNull Bundle	getGoogleExtrasBundle()
final @NonNull HashSet<@NonNull String>	getKeywords()
final @NonNull HashSet<@NonNull String>	getNeighboringContentUrls()
final long	getPlacementId()
final String	getPublisherProvidedId()
final String	getRequestAgent()
@NonNull AdRequest.Builder	self()
final void	setAdUnitId(String adUnitId) The ad unit ID.

Public constructors

Builder

public Builder(@NonNull String adUnitId)

Public methods

addCategoryExclusion

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder addCategoryExclusion(@NonNull String categoryExclusion)

Sets a slot-level ad category exclusion label.

This feature is only applicable for Ad Manager ad requests. Any category exclusions will be ignored on AdMob requests.

addKeyword

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder addKeyword(@NonNull String keyword)

Adds a keyword for targeting purposes.

build

public final @NonNull AdRequest build()

Constructs an AdRequest with the specified attributes.

putAdSourceExtrasBundle

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder putAdSourceExtrasBundle(
    @NonNull Class<@NonNull MediationExtrasReceiver> adapterClass,
    @NonNull Bundle adSourceExtras
)

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

Parameters
@NonNull Class<@NonNull MediationExtrasReceiver> adapterClass	The Class of the adapter that should receive extras.
@NonNull Bundle adSourceExtras	A Bundle of extra information to pass to a mediation adapter.

putCustomTargeting

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder putCustomTargeting(@NonNull String key, @NonNull String value)

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

This feature is only applicable for Ad Manager ad requests. Any custom targeting will be ignored on AdMob requests.

putCustomTargeting

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder putCustomTargeting(
    @NonNull String key,
    @NonNull List<@NonNull String> values
)

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

This feature is only applicable for Ad Manager ad requests. AdMob requests currently ignore custom targeting.

setContentUrl

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder setContentUrl(@NonNull 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
kotlin.IllegalArgumentException	If contentUrl is empty.

setGoogleExtrasBundle

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder setGoogleExtrasBundle(@NonNull Bundle extraBundle)

Set extra parameters to pass to AdMob or Ad Manager. Calling this a second time will overwrite the old values.

Parameters
@NonNull Bundle extraBundle	A Bundle of extra information to pass to AdMob or Ad Manager.

setNeighboringContentUrls

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder setNeighboringContentUrls(
    @NonNull Set<@NonNull 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
@NonNull Set<@NonNull String> neighboringContentUrls	The set of neighboring content URLs to be attached to the existing neighboring content URLs.

setPlacementId

@CanIgnoreReturnValue
public @NonNull AdRequest.Builder setPlacementId(long placementId)

Sets a default placement ID for the loaded ad.

Parameters
long placementId	A long integer provided by the AdMob UI for the configured placement.

setPublisherProvidedId

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder setPublisherProvidedId(@NonNull String publisherProvidedId)

Sets an identifier for use in frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

This feature is only applicable for Ad Manager ad requests. Any ID will be ignored on AdMob requests.

setRequestAgent

@CanIgnoreReturnValue
public final @NonNull AdRequest.Builder setRequestAgent(@NonNull String requestAgent)

Sets the request agent string to identify the ad request's origin. Third party libraries that implement the Mobile Ads SDK on behalf of publishers should call this method to denote the platform from which the ad request originated.

Protected methods

getAdSourceExtrasBundles

protected final @NonNull Map<@NonNull String, @NonNull Bundle> getAdSourceExtrasBundles()

getAdUnitId

protected final String getAdUnitId()

The ad unit ID.

getCategoryExclusions

protected final @NonNull Set<@NonNull String> getCategoryExclusions()

getContentUrl

protected final String getContentUrl()

getCustomTargeting

protected final @NonNull Map<@NonNull String, @NonNull String> getCustomTargeting()

getGoogleExtrasBundle

protected final @NonNull Bundle getGoogleExtrasBundle()

getKeywords

protected final @NonNull HashSet<@NonNull String> getKeywords()

getNeighboringContentUrls

protected final @NonNull HashSet<@NonNull String> getNeighboringContentUrls()

getPlacementId

protected final long getPlacementId()

getPublisherProvidedId

protected final String getPublisherProvidedId()

getRequestAgent

protected final String getRequestAgent()

self

protected @NonNull AdRequest.Builder self()

setAdUnitId

protected final void setAdUnitId(String adUnitId)

The ad unit ID.