AdSelectionOutcome

open class AdSelectionOutcome
kotlin.Any
   ↳ android.adservices.adselection.AdSelectionOutcome

This class represents a field in the OutcomeReceiver, which is an input to the android.adservices.adselection.AdSelectionManager#selectAds in the AdSelectionManager. This field is populated in the case of a successful android.adservices.adselection.AdSelectionManager#selectAds call.

Empty outcome may be returned from AdSelectionManager.selectAds(AdSelectionFromOutcomesConfig, Executor, OutcomeReceiver). Use AdSelectionOutcome.hasOutcome() to check if an instance has a valid outcome. When AdSelectionOutcome.hasOutcome() returns false, results from getAdSelectionId() and AdSelectionOutcome.getRenderUri() are invalid and shouldn't be used.

Summary

Nested classes

Builder for AdSelectionOutcome objects.
Public methods
open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
open Long

Returns the adSelectionId that identifies the AdSelection.
open MutableList<Uri!>

Returns the ad component renderUris that are returned by this auction.
open Uri

Returns the renderUri that the AdSelection returns.
open AdTechIdentifier

Returns the willing seller that won the auction.
open Boolean

Returns whether the outcome contains results or empty.
open Int

Returns a hash code value for the object.
Properties
static AdSelectionOutcome

Represents an AdSelectionOutcome with empty results.

Public methods

equals

Added in API level 34
open fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAdSelectionId

Added in API level 34
Also in Ad Services Extensions 4
open fun getAdSelectionId(): Long

Returns the adSelectionId that identifies the AdSelection.

Return
Long This value cannot be null.

getComponentAdUris

Added in API level 36
Also in Ad Services Extensions 16
open fun getComponentAdUris(): MutableList<Uri!>

Returns the ad component renderUris that are returned by this auction.

These URIs represent individual components of a multi-part ad creative. Seller ad tech SDKs are expected to fetch and render these components in their ad display logic.

This approach allows for flexible and dynamic ad creatives where different parts of the ad can be loaded and rendered independently.

Return
MutableList<Uri!> This value cannot be null.

getRenderUri

Added in API level 34
Also in Ad Services Extensions 4
open fun getRenderUri(): Uri

Returns the renderUri that the AdSelection returns.

Return
Uri This value cannot be null.

getWinningSeller

Added in API level 36
Also in Ad Services Extensions 18
open fun getWinningSeller(): AdTechIdentifier

Returns the willing seller that won the auction.

Return
AdTechIdentifier This value cannot be null.

hasOutcome

Added in API level 35
Also in Ad Services Extensions 10
open fun hasOutcome(): Boolean

Returns whether the outcome contains results or empty. Empty outcomes' render uris shouldn't be used.

hashCode

Added in API level 34
open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

Properties

NO_OUTCOME

Added in API level 35
Also in Ad Services Extensions 10
static val NO_OUTCOME: AdSelectionOutcome

Represents an AdSelectionOutcome with empty results.