AdData

Artifact: androidx.privacysandbox.ads:ads-adservices

View Source

Added in 1.0.0

---

Kotlin |Java

public final class AdData

---

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

Summary

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

Public methods
boolean	equals(Object other) Checks whether two AdData objects contain the same information.
final @NonNull Set<@NonNull Integer>	getAdCounterKeys() the set of keys used in counting events
final AdFilters	getAdFilters() all AdFilters associated with the ad, it's optional and can be null as well
final String	getAdRenderId() ad render id for server auctions
final @NonNull String	getMetadata() buyer ad metadata represented as a JSON string
final @NonNull Uri	getRenderUri() a URI pointing to the ad's rendering assets
int	hashCode() Returns the hash of the AdData object's data.
@NonNull String	toString() Overrides the toString method.

Public constructors

AdData

Added in 1.0.0

public AdData(@NonNull Uri renderUri, @NonNull String metadata)

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

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

AdData

Added in 1.1.0-beta11

@ExperimentalFeatures.Ext8OptIn
public AdData(
    @NonNull Uri renderUri,
    @NonNull String metadata,
    @NonNull Set<@NonNull Integer> adCounterKeys,
    AdFilters adFilters
)

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

Parameters
@NonNull Uri renderUri	a URI pointing to the ad's rendering assets
@NonNull String metadata	buyer ad metadata represented as a JSON string
@NonNull Set<@NonNull Integer> adCounterKeys	the set of keys used in counting events
AdFilters adFilters	all AdFilters associated with the ad

AdData

Added in 1.1.0-beta11

@ExperimentalFeatures.Ext10OptIn
public AdData(
    @NonNull Uri renderUri,
    @NonNull String metadata,
    @NonNull Set<@NonNull Integer> adCounterKeys,
    AdFilters adFilters,
    String adRenderId
)

Parameters
@NonNull Uri renderUri	a URI pointing to the ad's rendering assets
@NonNull String metadata	buyer ad metadata represented as a JSON string
@NonNull Set<@NonNull Integer> 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

Public methods

equals

public boolean equals(Object other)

Checks whether two AdData objects contain the same information.

getAdCounterKeys

Added in 1.1.0-beta11

public final @NonNull Set<@NonNull Integer> getAdCounterKeys()

the set of keys used in counting events

getAdFilters

Added in 1.1.0-beta11

public final AdFilters getAdFilters()

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

getAdRenderId

Added in 1.1.0-beta11

public final String getAdRenderId()

ad render id for server auctions

getMetadata

Added in 1.0.0

public final @NonNull String getMetadata()

buyer ad metadata represented as a JSON string

getRenderUri

Added in 1.0.0

public final @NonNull Uri getRenderUri()

a URI pointing to the ad's rendering assets

hashCode

public int hashCode()

Returns the hash of the AdData object's data.

toString

public @NonNull String toString()

Overrides the toString method.