Interface BannerAdRequest

Extends AdRequest
A banner ad request.

You must provide exactly one of adSize or adSizes.
Properties
adSize?
The ad size to be requested.
adSizes?
A list of valid ad sizes for the request.
adUnitId
The ad unit ID.
categoryExclusions?
Slot-level ad category exclusion labels.
contentUrl?
The content URL for a website whose content matches the app's primary content.
customTargeting?
Custom targeting parameters.
extras?
Extra parameters to pass to AdMob or Ad Manager.
keywords?
Keywords for targeting purposes.
manualImpressionRequested?
Whether enabling manual impression recording is requested.
mediationExtras?
Extra parameters to pass to a specific ad source adapter in a mediation setup.
neighboringContentUrls?
URLs representing web content near an ad.
placementId?
A long integer provided by the AdMob UI for the configured placement.
publisherProvidedId?
An identifier for use in frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.
skipUninitializedAdapters?
Instructs the SDK to not collect bidding signals or execute waterfall elements for adapters that haven't yet successfully initialized.
videoOptions?
The VideoOptions for the request.

Properties

Optional Readonly adSize

adSize?: AdSize | Promise<AdSize>
The ad size to be requested.

Optional Readonly adSizes

adSizes?: readonly (AdSize | Promise<AdSize>)[]
A list of valid ad sizes for the request.

This feature is available to Ad Manager publishers only. AdMob publishers should use adSize instead.

Readonly adUnitId

adUnitId: string
The ad unit ID.

Optional Readonly categoryExclusions

categoryExclusions?: readonly string[]
Slot-level ad category exclusion labels.

This feature is applicable only to Ad Manager ad requests. Category exclusions are ignored on AdMob requests.

Optional Readonly contentUrl

contentUrl?: string
The content URL for a website whose content matches the app's primary content. This website content is used for targeting and brand safety purposes.

Optional Readonly customTargeting

customTargeting?: Readonly<Record<string, string | readonly string[]>>
Custom targeting parameters.

This feature is applicable only to Ad Manager ad requests. Custom targeting is ignored on AdMob requests.

Optional Readonly extras

extras?: Readonly<Record<string, unknown>>
Extra parameters to pass to AdMob or Ad Manager.

Values must be JSON-serializable types (strings, numbers, booleans, null, or arrays or objects of these types). Functions, class instances, or complex JavaScript types such as Set and Map aren't supported.

Optional Readonly keywords

keywords?: readonly string[]
Keywords for targeting purposes.

Optional Readonly manualImpressionRequested

manualImpressionRequested?: boolean
Whether enabling manual impression recording is requested.

Optional Readonly mediationExtras

mediationExtras?: readonly MediationExtras[]
Extra parameters to pass to a specific ad source adapter in a mediation setup.

Optional Readonly neighboringContentUrls

neighboringContentUrls?: readonly string[]
URLs representing web content near an ad. Promotes brand safety and allows displayed ads to have an app-level rating, such as MA, T, or PG, that's more appropriate to neighboring content.

Optional Readonly placementId

placementId?: bigint
A long integer provided by the AdMob UI for the configured placement.

Optional Readonly publisherProvidedId

publisherProvidedId?: string
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 applicable only to Ad Manager ad requests. Any ID is ignored on AdMob requests.

Optional Readonly skipUninitializedAdapters

skipUninitializedAdapters?: boolean
Instructs the SDK to not collect bidding signals or execute waterfall elements for adapters that haven't yet successfully initialized.

Optional Readonly videoOptions

videoOptions?: VideoOptions
The VideoOptions for the request.