AdData


public final class AdData
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.common.AdData


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

Summary

Nested classes

class AdData.Builder

Builder for AdData objects. 

Inherited constants

Fields

public static final Creator<AdData> CREATOR

Public methods

boolean equals(Object o)

Checks whether two AdData objects contain the same information.

Set<Integer> getAdCounterKeys()

Gets the set of keys used in counting events.

AdFilters getAdFilters()

Gets all AdFilters associated with the ad.

String getAdRenderId()

Gets the ad render id for server auctions.

String getMetadata()

Gets the buyer ad metadata used during the ad selection process.

Uri getRenderUri()

Gets the URI that points to the ad's rendering assets.

int hashCode()

Returns the hash of the AdData object's data.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

public static final Creator<AdData> CREATOR

Public methods

equals

Added in API level 34
public boolean equals (Object o)

Checks whether two AdData objects contain the same information.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAdCounterKeys

public Set<Integer> getAdCounterKeys ()

Gets the set of keys used in counting events.

No more than 10 ad counter keys may be associated with an ad.

The keys and counts per key are used in frequency cap filtering during ad selection to disqualify associated ads from being submitted to bidding.

Note that these keys can be overwritten along with the ads and other bidding data for a custom audience during the custom audience's daily update.

Returns
Set<Integer> This value cannot be null.

getAdFilters

public AdFilters getAdFilters ()

Gets all AdFilters associated with the ad.

The filters, if met or exceeded, exclude the associated ad from participating in ad selection. They are optional and if null specify that no filters apply to this ad.

Returns
AdFilters

getAdRenderId

public String getAdRenderId ()

Gets the ad render id for server auctions.

Ad render id is collected for each AdData when server auction request is received.

Any AdData without ad render id will be ineligible for server-side auction.

The overall size of the CA is limited. The size of this field is considered using String#getBytes() in UTF-8 encoding.

Returns
String This value may be null.

getMetadata

public String getMetadata ()

Gets the buyer ad metadata used during the ad selection process.

The metadata should be a valid JSON object serialized as a string. Metadata represents ad-specific bidding information that will be used during ad selection as part of bid generation and used in buyer JavaScript logic, which is executed in an isolated execution environment.

If the metadata is not a valid JSON object that can be consumed by the buyer's JS, the ad will not be eligible for ad selection.

Returns
String This value cannot be null.

getRenderUri

public Uri getRenderUri ()

Gets the URI that points to the ad's rendering assets. The URI must use HTTPS.

Returns
Uri This value cannot be null.

hashCode

Added in API level 34
public int hashCode ()

Returns the hash of the AdData object's data.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES