BannerSignalRequest

class BannerSignalRequest : SignalRequest


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

Summary

Nested types

A builder class for creating BannerSignalRequest.

Public functions

Bundle?

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

Public properties

open AdSize?

The AdSize to be requested.

open List<AdSize>

A list of valid ad sizes for the request.

open String?

The ad unit ID.

Set<String>

The slot-level ad category exclusion labels.

String?

The content URL targeting information.

Map<String, String>

The custom targeting parameters.

Bundle

The extra parameters to pass to Google ad network

Set<String>

The targeting information keywords.

open Boolean

Whether enabling manual impression recording is requested.

Set<String>

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

Long

An identifier for a placement in reporting.

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.

String?

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

open VideoOptions?

The VideoOptions for the request.

Inherited properties

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

The signal type associated with the request.

Public functions

getAdSourceExtrasBundle

fun getAdSourceExtrasBundle(adapterClass: Class<MediationExtrasReceiver>): Bundle?

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

Public properties

adSize

open val adSize: AdSize?

The AdSize to be requested.

adSizes

open val adSizes: List<AdSize>

A list of valid ad sizes for the request.

adUnitId

open val adUnitId: String?

The ad unit ID.

categoryExclusions

val categoryExclusions: Set<String>

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

contentUrl

val contentUrl: String?

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

customTargeting

val customTargeting: Map<String, String>

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

googleExtrasBundle

val googleExtrasBundle: Bundle

The extra parameters to pass to Google ad network

keywords

val keywords: Set<String>

The targeting information keywords.

manualImpressionRequested

open val manualImpressionRequested: Boolean

Whether enabling manual impression recording is requested.

neighboringContentUrls

val neighboringContentUrls: Set<String>

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

placementId

val placementId: Long

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

publisherProvidedId

val publisherProvidedId: 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.

requestAgent

val requestAgent: String?

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

videoOptions

open val videoOptions: VideoOptions?

The VideoOptions for the request.