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.

String getMetadata()

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

Uri getRenderUrl()

Gets the URL 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

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.

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.

getRenderUrl

public Uri getRenderUrl ()

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

Returns
Uri This value cannot be null.

hashCode

public int hashCode ()

Returns the hash of the AdData object's data.

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

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