AdWithBid
class AdWithBid : Parcelable
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 |
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 methods |
| Int |
|
| Boolean |
|
| AdData |
|
| Double |
The bid is the amount of money an advertiser has bid during the ad selection process to show an ad.
|
| Int |
|
| Unit |
Flatten this object in to a Parcel.
|
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
fun describeContents(): Int
equals
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
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
Properties
