Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37

Summary: Nested Classes | Ctors | Methods | Inherited Methods

AddCustomAudienceOverrideRequest

---

Kotlin |Java

public class AddCustomAudienceOverrideRequest
extends Object

java.lang.Object
↳	android.adservices.customaudience.AddCustomAudienceOverrideRequest

---

This class was deprecated in API level 37.
The Rubidium (Rb) Relevance APIs, including those in android.adservices.customaudience, are being deprecated. Relevance APIs have no direct replacement. Developers should stop using them, as calls will be rejected in future Android releases. Please refer to official Privacy Sandbox documentation for deprecation and roadmap details: https://privacysandbox.com/news/update-on-plans-for-privacy-sandbox-technologies/

This POJO represents the TestCustomAudienceManager.overrideCustomAudienceRemoteInfo(AddCustomAudienceOverrideRequest,Executor,OutcomeReceiver) request.

It contains fields buyer and name which will serve as the identifier for the override fields, biddingLogicJs and trustedBiddingSignals, which are used during ad selection instead of querying external servers.

Summary

Nested classes

class

AddCustomAudienceOverrideRequest.Builder This class was deprecated in API level 37. The Rubidium (Rb) Relevance APIs, including those in android.adservices.customaudience, are being deprecated. Relevance APIs have no direct replacement. Developers should stop using them, as calls will be rejected in future Android releases. Please refer to official Privacy Sandbox documentation for deprecation and roadmap details: https://privacysandbox.com/news/update-on-plans-for-privacy-sandbox-technologies/

Public constructors
AddCustomAudienceOverrideRequest(AdTechIdentifier buyer, String name, String biddingLogicJs, AdSelectionSignals trustedBiddingSignals)

Public methods
String	getBiddingLogicJs()
long	getBiddingLogicJsVersion() Returns the value to return as version for JavaScript bidding logic.
AdTechIdentifier	getBuyer()
String	getName()
AdSelectionSignals	getTrustedBiddingSignals()

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.

Public constructors

AddCustomAudienceOverrideRequest

Added in API level 34
Also in Ad Services Extensions 4

public AddCustomAudienceOverrideRequest (AdTechIdentifier buyer, 
                String name, 
                String biddingLogicJs, 
                AdSelectionSignals trustedBiddingSignals)

Parameters
buyer	AdTechIdentifier: This value cannot be null.
name	String: This value cannot be null.
biddingLogicJs	String: This value cannot be null.
trustedBiddingSignals	AdSelectionSignals: This value cannot be null.

Public methods

getBiddingLogicJs

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37

public String getBiddingLogicJs ()

Returns
String	the override JavaScript result that should be served during ad selection. This value cannot be null.

getBiddingLogicJsVersion

Added in API level 35
Also in Ad Services Extensions 12
Deprecated in API level 37

public long getBiddingLogicJsVersion ()

Returns the value to return as version for JavaScript bidding logic.

Default to be 0L, which will fall back to use default version(V1 or V2).

Returns
long

getBuyer

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37

public AdTechIdentifier getBuyer ()

Returns
AdTechIdentifier	an AdTechIdentifier representing the buyer. This value cannot be null.

getName

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37

public String getName ()

Returns
String	name of the custom audience being overridden. This value cannot be null.

getTrustedBiddingSignals

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37

public AdSelectionSignals getTrustedBiddingSignals ()

Returns
AdSelectionSignals	the override trusted bidding signals that should be served during ad selection. This value cannot be null.