BannerAdRequest

class BannerAdRequest : AdRequest


A banner ad request. See Builder for how to construct a BannerAdRequest.

Summary

Nested types

A builder for creating BannerAdRequests, which require an AdSize and adUnitId.

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.

Set<String>

The slot-level ad category exclusion labels.

String?

The content URL targeting information.

Map<StringString>

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.common.AdRequest
open String

The ad unit ID.

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 adSizeAdSize

The AdSize to be requested. If multiple ad sizes are requested through Builder(String, List), this property returns the first ad size in that list.

adSizes

open val adSizesList<AdSize>

A list of valid ad sizes for the request.

categoryExclusions

val categoryExclusionsSet<String>

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

contentUrl

val contentUrlString?

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

customTargeting

val customTargetingMap<StringString>

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

googleExtrasBundle

val googleExtrasBundleBundle

The extra parameters to pass to Google ad network

keywords

val keywordsSet<String>

The targeting information keywords.

manualImpressionRequested

open val manualImpressionRequestedBoolean

Whether enabling manual impression recording is requested.

neighboringContentUrls

val neighboringContentUrlsSet<String>

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

placementId

val placementIdLong

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

publisherProvidedId

val publisherProvidedIdString?

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 requestAgentString?

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

videoOptions

open val videoOptionsVideoOptions?

The VideoOptions for the request.