AdSelectionConfig
public
final
class
AdSelectionConfig
extends Object
implements
Parcelable
Contains the configuration of the ad selection process.
Instances of this class are created by SDKs to be provided as arguments to the AdSelectionManager.selectAds(AdSelectionConfig, Executor, OutcomeReceiver) and AdSelectionManager.reportImpression methods in AdSelectionManager.
Summary
Nested classes |
|---|
class |
AdSelectionConfig.Builder
Builder for AdSelectionConfig object.
|
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
|
|
Fields
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 return
true.
- It is symmetric: for any non-null reference values
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
- It is transitive: for any non-null reference values
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
- It is consistent: for any non-null reference values
x and y, multiple invocations of
x.equals(y) consistently return true
or consistently return false, provided no
information used in equals comparisons on the
objects is modified.
- For any non-null reference value
x,
x.equals(null) should return false.
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. |
getAdSelectionSignals
public AdSelectionSignals getAdSelectionSignals ()
| Returns |
|---|
AdSelectionSignals |
JSON in an AdSelectionSignals object, fetched from the AdSelectionConfig and consumed
by the JS logic fetched from the DSP, represents signals given to the participating
buyers in the ad selection and reporting processes.
This value cannot be null. |
getCustomAudienceBuyers
public List<AdTechIdentifier> getCustomAudienceBuyers ()
| Returns |
|---|
List<AdTechIdentifier> |
a list of custom audience buyers allowed by the SSP to participate in the ad
selection process
This value cannot be null. |
getDecisionLogicUri
public Uri getDecisionLogicUri ()
| Returns |
|---|
Uri |
the URI used to retrieve the JS code containing the seller/SSP scoreAd function used
during the ad selection and reporting processes
This value cannot be null. |
getPerBuyerSignals
public Map<AdTechIdentifier, AdSelectionSignals> getPerBuyerSignals ()
| Returns |
|---|
Map<AdTechIdentifier, AdSelectionSignals> |
a Map of buyers and AdSelectionSignals, fetched from the AdSelectionConfig and
consumed by the JS logic fetched from the DSP, representing any information that each
buyer would provide during ad selection to participants (such as bid floor, ad selection
type, etc.)
This value cannot be null. |
getSeller
public AdTechIdentifier getSeller ()
| Returns |
|---|
AdTechIdentifier |
a AdTechIdentifier of the seller, for example "www.example-ssp.com"
This value cannot be null. |
getSellerSignals
public AdSelectionSignals getSellerSignals ()
| Returns |
|---|
AdSelectionSignals |
JSON in an AdSelectionSignals object, provided by the SSP and consumed by the JS
logic fetched from the SSP, represents any information that the SSP used in the ad
scoring process to tweak the results of the ad selection process (e.g. brand safety
checks, excluded contextual ads).
This value cannot be null. |
getTrustedScoringSignalsUri
public Uri getTrustedScoringSignalsUri ()
| Returns |
|---|
Uri |
URI endpoint of sell-side trusted signal from which creative specific realtime
information can be fetched from.
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 in equals 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 the hashCode 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 the hashCode 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.
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 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[]]
