AdWithBid
public
final
class
AdWithBid
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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 |
---|
Fields | |
---|---|
public
static
final
Creator<AdWithBid> |
CREATOR
|
Public constructors | |
---|---|
AdWithBid(AdData adData, double bid)
|
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. |
AdData
|
getAdData()
|
double
|
getBid()
The bid is the amount of money an advertiser has bid during the ad selection process to show an ad. |
int
|
hashCode()
Returns a hash code value for the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
AdWithBid
public AdWithBid (AdData adData, double bid)
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 |
Throws | |
---|---|
NullPointerException |
if adData is null |
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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. |
getAdData
public AdData getAdData ()
Returns | |
---|---|
AdData |
the ad that was bid on
This value cannot be null . |
getBid
public double getBid ()
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.
Returns | |
---|---|
double |
the bid value to be passed to the scoring function when scoring the ad returned by
getAdData() |
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 inequals
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 thehashCode
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 thehashCode
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. |
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 |