Added in API level 34
Also in Ad Services Extensions 4

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

AdData

Kotlin |Java

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

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34
Also in Ad Services Extensions 4

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

Added in API level 35
Also in Ad Services Extensions 8

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

Added in API level 35
Also in Ad Services Extensions 8

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

Added in API level 35
Also in Ad Services Extensions 10

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

Added in API level 34
Also in Ad Services Extensions 4

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

Added in API level 34
Also in Ad Services Extensions 4

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

AdData

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

equals

getAdCounterKeys

getAdFilters

getAdRenderId

getMetadata

getRenderUri

hashCode

toString

writeToParcel