Added in API level 36
Also in Ad Services Extensions 16

ComponentAdData

---

Kotlin |Java

class ComponentAdData : Parcelable

kotlin.Any
↳	android.adservices.common.ComponentAdData

Represents data specific to a component ad that is necessary for ad selection and rendering. This is to support use case for ads composed of multiple pieces, such as an ad displaying multiple products at once.

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
ComponentAdData(renderUri: Uri, adRenderId: String) Constructs a ComponentAdData object.

Public methods
Int	describeContents()
Boolean	equals(other: Any?)
String	getAdRenderId() Gets the component ad render id for server auctions.
Uri	getRenderUri() Gets the URI that points to the component's rendering resources.
Int	hashCode()
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ComponentAdData!>	CREATOR

Public constructors

ComponentAdData

Added in API level 36
Also in Ad Services Extensions 16

ComponentAdData(
    renderUri: Uri, 
    adRenderId: String)

Constructs a ComponentAdData object.

This object represents a single component within a multi-part ad. The provided render URI points to the resources needed to render this component. Both the URI and the resources to render the component are provided by the buyer ad tech.

Parameters
renderUri	Uri: the URI that points to the component's rendering resources. This value cannot be null.
adRenderId	String: the component ad render ID used in the auction flow to identify the ad and bid on it. This ID is typically generated by the buyer ad tech and is also used to track the individual component within the larger ad. This value cannot be null.

Exceptions
java.lang.IllegalArgumentException	if the provided adRenderId is empty.

Public methods

describeContents

Added in API level 36

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 36

fun equals(other: Any?): Boolean

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getAdRenderId

Added in API level 36
Also in Ad Services Extensions 16

fun getAdRenderId(): String

Gets the component ad render id for server auctions.

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

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

Return
String	This value cannot be null.

getRenderUri

Added in API level 36
Also in Ad Services Extensions 16

fun getRenderUri(): Uri

Gets the URI that points to the component's rendering resources.

Both the URI and the resources it points to are provided by the buyer ad tech.

Return
Uri	This value cannot be null.

hashCode

Added in API level 36

fun hashCode(): Int

Return
Int	a hash code value for this object.

toString

Added in API level 36

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 36

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 36
Also in Ad Services Extensions 16

static val CREATOR: Parcelable.Creator<ComponentAdData!>