AdData

Artifact: androidx.privacysandbox.ads:ads-adservices

Added in 1.0.0

Kotlin |Java

class AdData

Represents data specific to an ad that is necessary for ad selection and rendering.

Summary

Public constructors
`AdData(renderUri: Uri, metadata: String)` Represents data specific to an ad that is necessary for ad selection and rendering.
`@ExperimentalFeatures.Ext8OptIn AdData( renderUri: Uri, metadata: String, adCounterKeys: Set<Int>, adFilters: AdFilters? )` Represents data specific to an ad that is necessary for ad selection and rendering.
`@ExperimentalFeatures.Ext10OptIn AdData( renderUri: Uri, metadata: String, adCounterKeys: Set<Int>, adFilters: AdFilters?, adRenderId: String? )`

Public functions
`open operator Boolean`	`equals(other: Any?)` Checks whether two `AdData` objects contain the same information.
`open Int`	`hashCode()` Returns the hash of the `AdData` object's data.
`open String`	`toString()` Overrides the toString method.

Public properties
`Set<Int>`	`adCounterKeys` the set of keys used in counting events
`AdFilters?`	`adFilters` all `AdFilters` associated with the ad, it's optional and can be null as well
`String?`	`adRenderId` ad render id for server auctions
`String`	`metadata` buyer ad metadata represented as a JSON string
`Uri`	`renderUri` a URI pointing to the ad's rendering assets

Public constructors

AdData

Added in 1.0.0

AdData(renderUri: Uri, metadata: String)

Represents data specific to an ad that is necessary for ad selection and rendering.

Parameters
`renderUri: Uri`	a URI pointing to the ad's rendering assets
`metadata: String`	buyer ad metadata represented as a JSON string

AdData

Added in 1.1.0-beta12

@ExperimentalFeatures.Ext8OptIn
AdData(
    renderUri: Uri,
    metadata: String,
    adCounterKeys: Set<Int> = setOf(),
    adFilters: AdFilters? = null
)

Represents data specific to an ad that is necessary for ad selection and rendering.

Parameters
`renderUri: Uri`	a URI pointing to the ad's rendering assets
`metadata: String`	buyer ad metadata represented as a JSON string
`adCounterKeys: Set<Int> = setOf()`	the set of keys used in counting events
`adFilters: AdFilters? = null`	all `AdFilters` associated with the ad

AdData

Added in 1.1.0-beta12

@ExperimentalFeatures.Ext10OptIn
AdData(
    renderUri: Uri,
    metadata: String,
    adCounterKeys: Set<Int> = setOf(),
    adFilters: AdFilters? = null,
    adRenderId: String? = null
)

Parameters
`renderUri: Uri`	a URI pointing to the ad's rendering assets
`metadata: String`	buyer ad metadata represented as a JSON string
`adCounterKeys: Set<Int> = setOf()`	the set of keys used in counting events
`adFilters: AdFilters? = null`	all `AdFilters` associated with the ad, it's optional and can be null as well
`adRenderId: String? = null`	ad render id for server auctions

Public functions

equals

open operator fun equals(other: Any?): Boolean

Checks whether two AdData objects contain the same information.

hashCode

open fun hashCode(): Int

Returns the hash of the AdData object's data.

toString

open fun toString(): String

Overrides the toString method.

Public properties

adCounterKeys

Added in 1.1.0-beta12

val adCounterKeys: Set<Int>

the set of keys used in counting events

adFilters

Added in 1.1.0-beta12

val adFilters: AdFilters?

all AdFilters associated with the ad, it's optional and can be null as well

adRenderId

Added in 1.1.0-beta12

val adRenderId: String?

ad render id for server auctions

metadata

Added in 1.0.0

val metadata: String

buyer ad metadata represented as a JSON string

renderUri

Added in 1.0.0

val renderUri: Uri

a URI pointing to the ad's rendering assets