CustomAudience

FLAG_AUCTION_SERVER_REQUEST_OMIT_ADS

public static final int FLAG_AUCTION_SERVER_REQUEST_OMIT_ADS

This auction server request flag indicates to the service that ads for this CustomAudience can be omitted in the server auction payload.

Constant Value: 1 (0x00000001)

CREATOR

public static final Creator<CustomAudience> CREATOR

equals

public boolean equals (Object o)

Checks whether two CustomAudience objects contain the same information.

getActivationTime

public Instant getActivationTime ()

On creation of the CustomAudience object, an optional activation time may be set in the future, in order to serve a delayed activation. If the field is not set, the CustomAudience will be activated at the time of joining.

For example, a custom audience for lapsed users may not activate until a threshold of inactivity is reached, at which point the custom audience's ads will participate in the ad selection process, potentially redirecting lapsed users to the original owner application.

The maximum delay in activation is 60 days from initial creation.

If specified, the activation time must be an earlier instant than the expiration time.

getAds

public List<AdData> getAds ()

This list of AdData objects is a full and complete list of the ads that will be served by this CustomAudience during the ad selection process.

If not specified, or if an empty list is provided, the CustomAudience will not participate in ad selection until a valid list of ads are provided via the daily update for the custom audience.

The combined ads size of the CA is limited and the sizes of each ad's string fields are considered using String.getBytes() in UTF-8 encoding.

getAuctionServerRequestFlags

public int getAuctionServerRequestFlags ()

Returns the bitfield of auction server request flags. These are flags that influence the creation of the payload generated by the AdSelectionManager.getAdSelectionData(GetAdSelectionDataRequest, Executor, OutcomeReceiver) API.

To create this bitfield, place an | bitwise operator between each ERROR(AuctionServerRequestFlag/android.adservices.customaudience.CustomAudience.AuctionServerRequestFlag AuctionServerRequestFlag) to be enabled.

getBiddingLogicUri

public Uri getBiddingLogicUri ()

Returns the target URI used to fetch bidding logic when a custom audience participates in the ad selection process. The URI must use HTTPS.

getBuyer

public AdTechIdentifier getBuyer ()

A buyer is identified by a domain in the form "buyerexample.com".

getDailyUpdateUri

public Uri getDailyUpdateUri ()

This URI points to a buyer-operated server that hosts updated bidding data and ads metadata to be used in the on-device ad selection process. The URI must use HTTPS.

getExpirationTime

public Instant getExpirationTime ()

Once the expiration time has passed, a custom audience is no longer eligible for daily ad/bidding data updates or participation in the ad selection process. The custom audience will then be deleted from memory by the next daily update.

If no expiration time is provided on creation of the CustomAudience, expiry will default to 60 days from activation.

The maximum expiry is 60 days from initial activation.

getName

public String getName ()

The custom audience's name is an arbitrary string provided by the owner and buyer on creation of the CustomAudience object.

The overall size of the CA is limited and the size of this field is considered using String.getBytes() in UTF-8 encoding.

getPriority

public double getPriority ()

Returns the priority of this CustomAudience with respect to other CustomAudiences for this buyer.

This means if there is insufficient space during buyer input generation in the AdSelectionManager.getAdSelectionData(GetAdSelectionDataRequest, Executor, OutcomeReceiver) call, the service will attempt to include the highest priority custom audiences first.

The default value if this field is not set is 0.0.

getTrustedBiddingData

public TrustedBiddingData getTrustedBiddingData ()

Trusted bidding data consists of a URI pointing to a trusted server for buyers' bidding data and a list of keys to query the server with. Note that the keys are arbitrary identifiers that will only be used to query the trusted server for a buyer's bidding logic during ad selection.

If not specified, the CustomAudience will not participate in ad selection until trusted bidding data are provided via the daily update for the custom audience.

getUserBiddingSignals

public AdSelectionSignals getUserBiddingSignals ()

User bidding signals are optionally provided by buyers to be consumed by buyer-provided JavaScript during ad selection in an isolated execution environment.

If the user bidding signals are not a valid JSON object that can be consumed by the buyer's JS, the custom audience will not be eligible for ad selection.

If not specified, the CustomAudience will not participate in ad selection until user bidding signals are provided via the daily update for the custom audience.

hashCode

public int hashCode ()

Returns the hash of the CustomAudience object's data.

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.