ComponentAdData


public final class ComponentAdData
extends Object implements Parcelable

java.lang.Object
   ↳ 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

Fields

public static final Creator<ComponentAdData> CREATOR

Public constructors

ComponentAdData(Uri renderUri, String adRenderId)

Constructs a ComponentAdData object.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

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()

Returns a hash code value for the object.

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<ComponentAdData> CREATOR

Public constructors

ComponentAdData

public ComponentAdData (Uri renderUri, 
                String adRenderId)

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.

Throws
IllegalArgumentException if the provided adRenderId is empty.

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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.

getAdRenderId

public String getAdRenderId ()

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.

Returns
String This value cannot be null.

getRenderUri

public Uri getRenderUri ()

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.

Returns
Uri This value cannot be null.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

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