BannerSignalRequest

public final class BannerSignalRequest extends SignalRequest


A banner signal request. See Builder for how to construct a BannerSignalRequest.

Summary

Nested types

public final class BannerSignalRequest.Builder

A builder class for creating BannerSignalRequest.

Public methods

AdSize

The AdSize to be requested.

@NonNull List<@NonNull AdSize>

A list of valid ad sizes for the request.

final Bundle

Gets the extras bundle associated with an ad source's adapter, if present.

String

The ad unit ID.

final @NonNull Set<@NonNull String>

The slot-level ad category exclusion labels.

final String

The content URL targeting information.

final @NonNull Map<@NonNull String, @NonNull String>

The custom targeting parameters.

final @NonNull Bundle

The extra parameters to pass to Google ad network

final @NonNull Set<@NonNull String>

The targeting information keywords.

boolean

Whether enabling manual impression recording is requested.

final @NonNull Set<@NonNull String>

The list of neighboring content URLs or an empty List if no URLs were set.

final long

An identifier for a placement in reporting.

final String

A publisher-provided identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

final String

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

VideoOptions

The VideoOptions for the request.

Inherited methods

From com.google.android.libraries.ads.mobile.sdk.signal.SignalRequest
final @NonNull String

The signal type associated with the request.

Public methods

getAdSize

public AdSize getAdSize()

The AdSize to be requested.

getAdSizes

public @NonNull List<@NonNull AdSizegetAdSizes()

A list of valid ad sizes for the request.

getAdSourceExtrasBundle

public final Bundle getAdSourceExtrasBundle(
    @NonNull Class<@NonNull MediationExtrasReceiver> adapterClass
)

Gets the extras bundle associated with an ad source's adapter, if present.

getAdUnitId

public String getAdUnitId()

The ad unit ID.

getCategoryExclusions

public final @NonNull Set<@NonNull StringgetCategoryExclusions()

The slot-level ad category exclusion labels. Default to an empty Set if not set.

getContentUrl

public final String getContentUrl()

The content URL targeting information. Default to null if not set.

getCustomTargeting

public final @NonNull Map<@NonNull String, @NonNull StringgetCustomTargeting()

The custom targeting parameters. Default to an empty Map if not set.

getGoogleExtrasBundle

public final @NonNull Bundle getGoogleExtrasBundle()

The extra parameters to pass to Google ad network

getKeywords

public final @NonNull Set<@NonNull StringgetKeywords()

The targeting information keywords.

getManualImpressionRequested

public boolean getManualImpressionRequested()

Whether enabling manual impression recording is requested.

getNeighboringContentUrls

public final @NonNull Set<@NonNull StringgetNeighboringContentUrls()

The list of neighboring content URLs or an empty List if no URLs were set.

getPlacementId

public final long getPlacementId()

An identifier for a placement in reporting. A value set here will be set onto any ad returned by this request.

getPublisherProvidedId

public final String getPublisherProvidedId()

A publisher-provided identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

getRequestAgent

public final String getRequestAgent()

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

getVideoOptions

public VideoOptions getVideoOptions()

The VideoOptions for the request.