SignedContextualAds
public
final
class
SignedContextualAds
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.adservices.adselection.SignedContextualAds |
Contains a list of buyer supplied AdWithBid
bundle and its signature.
Instances of this class are created by SDKs to be injected as part of AdSelectionConfig
and passed to AdSelectionManager#selectAds
SignedContextualAds are signed using ECDSA algorithm with SHA256 hashing algorithm (aka SHA256withECDSA). Keys used should belong to P-256 curve (aka \u201csecp256r1\u201d or \u201cprime256v1\u201d).
Signature should include the buyer, decisionLogicUri and adsWithBid fields.
While creating the signature a specific serialization rules must be followed as it's outlined here:
Objects
concatenate the serialized values of their fields with the|
(pipe) in between each fieldAll fields
are sorted by alphabetical order within the objectNullable fields
are skipped if they are null/unsetDoubles
are converted to String preserving precisionIntegers
are converted to string valuesSets
are sorted alphabeticallyLists
keep the same orderStrings
get encoded into byte[] using UTF-8 encoding
Summary
Nested classes | |
---|---|
class |
SignedContextualAds.Builder
Builder for |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<SignedContextualAds> |
CREATOR
|
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. |
List<AdWithBid>
|
getAdsWithBid()
|
AdTechIdentifier
|
getBuyer()
|
Uri
|
getDecisionLogicUri()
|
byte[]
|
getSignature()
Returns a copy of the signature for the contextual ads object. |
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<SignedContextualAds> CREATOR
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. |
getAdsWithBid
public List<AdWithBid> getAdsWithBid ()
Returns | |
---|---|
List<AdWithBid> |
the Ad data with bid value associated with this ad
This value cannot be null . |
getBuyer
public AdTechIdentifier getBuyer ()
Returns | |
---|---|
AdTechIdentifier |
the Ad tech identifier from which this contextual Ad would have been downloaded
This value cannot be null . |
getDecisionLogicUri
public Uri getDecisionLogicUri ()
Returns | |
---|---|
Uri |
the URI used to retrieve the updateBid() and reportWin() function used during the ad
selection and reporting process
This value cannot be null . |
getSignature
public byte[] getSignature ()
Returns a copy of the signature for the contextual ads object.
See SignedContextualAds
for more details.
Returns | |
---|---|
byte[] |
the signature
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 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. |
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.