AdWithBid


class AdWithBid : Parcelable
kotlin.Any
   ↳ android.adservices.adselection.AdWithBid

Represents an ad and its corresponding bid value after the bid generation step in the ad selection process.

The ads and their bids are fed into an ad scoring process which will inform the final ad selection. The currency unit for the bid is expected to be the same requested by the seller when initiating the selection process and not specified in this class. The seller can provide the currency via AdSelectionSignals. The currency is opaque to FLEDGE.

Summary

Inherited constants
Public constructors
AdWithBid(adData: AdData, bid: Double)

Public methods
Int

Boolean
equals(other: Any?)

AdData

Double

The bid is the amount of money an advertiser has bid during the ad selection process to show an ad.

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AdWithBid!>

Public constructors

AdWithBid

AdWithBid(
    adData: AdData,
    bid: Double)
Parameters
adData AdData: An AdData object defining an ad's render URI and buyer metadata This value cannot be null.
bid Double: The amount of money a buyer has bid to show an ad; note that while the bid is expected to be non-negative, this is only enforced during the ad selection process
Exceptions
java.lang.NullPointerException if adData is null

Public methods

describeContents

Added in API level 35
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 35
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.

getAdData

fun getAdData(): AdData
Return
AdData the ad that was bid on This value cannot be null.

getBid

fun getBid(): Double

The bid is the amount of money an advertiser has bid during the ad selection process to show an ad. The bid could be any non-negative double, such as 0.00, 0.17, 1.10, or 1000.00.

The currency for a bid would be controlled by Seller and will remain consistent across a run of Ad selection. This could be achieved by leveraging bidding signals during "generateBid()" phase and using the same currency during the creation of contextual ads. Having currency unit as a dedicated field could be supported in future releases.

Return
Double the bid value to be passed to the scoring function when scoring the ad returned by getAdData()

hashCode

Added in API level 35
fun hashCode(): Int
Return
Int a hash code value for this object.

writeToParcel

Added in API level 35
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

static val CREATOR: Parcelable.Creator<AdWithBid!>