AddCustomAudienceOverrideRequest

public class AddCustomAudienceOverrideRequest
extends Object

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

This data object represents the TestCustomAudienceManager.overrideCustomAudienceRemoteInfo(android.adservices.customaudience.AddCustomAudienceOverrideRequest, java.util.concurrent.Executor, android.os.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

Builder for AddCustomAudienceOverrideRequest objects. 

Public constructors

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

Public methods

String getBiddingLogicJs()
long getBiddingLogicJsVersion()

Returns the override bidding logic JavaScript version.

AdTechIdentifier getBuyer()
String getName()
AdSelectionSignals getTrustedBiddingSignals()

Inherited methods

Public constructors

AddCustomAudienceOverrideRequest

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

public String getBiddingLogicJs ()

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

getBiddingLogicJsVersion

public long getBiddingLogicJsVersion ()

Returns the override bidding logic JavaScript version.

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

Returns
long

getBuyer

public AdTechIdentifier getBuyer ()

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

getName

public String getName ()

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

getTrustedBiddingSignals

public AdSelectionSignals getTrustedBiddingSignals ()

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