AdRequest

Kotlin |Java

open class AdRequest

Known direct subclasses

BannerAdRequest, IconAdRequest, NativeAdRequest

BannerAdRequest	A banner ad request.
IconAdRequest	An AdRequest for IconAds.
NativeAdRequest	A native ad request.

---

An AdRequest contains targeting information used to fetch an ad. Ad requests are created using AdRequest.Builder.

Summary

Nested types
class AdRequest.Builder Builder class for AdRequest.
@IntDef(value = [0, 1, 2, 3, 4, 5, 6]) @Retention(value = AnnotationRetention.SOURCE) annotation AdRequest.ErrorCode

Protected constructors
AdRequest(     adUnitId: String,     categoryExclusions: Set<String>,     contentUrl: String?,     customTargeting: Map<String, String>,     googleExtrasBundle: Bundle,     keywords: Set<String>,     neighboringContentUrls: Set<String>,     adSourceExtrasBundles: Map<String, Bundle>,     publisherProvidedId: String?,     requestAgent: String?,     placementId: Long )

Public functions
Bundle?	getAdSourceExtrasBundle(adapterClass: Class<MediationExtrasReceiver>) Gets the extras bundle associated with an ad source's adapter, if present.

Public properties
open String	adUnitId The ad unit ID.
Set<String>	categoryExclusions The slot-level ad category exclusion labels.
String?	contentUrl The content URL targeting information.
Map<String, String>	customTargeting The custom targeting parameters.
Bundle	googleExtrasBundle The extra parameters to pass to Google ad network
Set<String>	keywords The targeting information keywords.
Set<String>	neighboringContentUrls The list of neighboring content URLs or an empty List if no URLs were set.
Long	placementId An identifier for a placement in reporting.
String?	publisherProvidedId 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?	requestAgent The request agent string to identify the ad request's origin.

Protected constructors

AdRequest

protected AdRequest(
    adUnitId: String,
    categoryExclusions: Set<String>,
    contentUrl: String?,
    customTargeting: Map<String, String>,
    googleExtrasBundle: Bundle,
    keywords: Set<String>,
    neighboringContentUrls: Set<String>,
    adSourceExtrasBundles: Map<String, Bundle>,
    publisherProvidedId: String?,
    requestAgent: String?,
    placementId: Long
)

Public functions

getAdSourceExtrasBundle

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

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

Public properties

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.

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.