CustomAudience.Builder

Builder(
    buyer: AdTechIdentifier,
    name: String,
    dailyUpdateUri: Uri,
    biddingLogicUri: Uri,
    ads: List<AdData>
)

fun build(): CustomAudience

Builds an instance of a CustomAudience.

fun setActivationTime(activationTime: Instant): CustomAudience.Builder

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.

fun setAds(ads: List<AdData>): CustomAudience.Builder

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.

fun setBiddingLogicUri(biddingLogicUri: Uri): CustomAudience.Builder

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

fun setBuyer(buyer: AdTechIdentifier): CustomAudience.Builder

Sets the buyer AdTechIdentifier.

fun setDailyUpdateUri(dailyUpdateUri: Uri): CustomAudience.Builder

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.

fun setExpirationTime(expirationTime: Instant): CustomAudience.Builder

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.

fun setName(name: String): CustomAudience.Builder

Sets the CustomAudience object's name.

fun setTrustedBiddingData(trustedBiddingSignals: TrustedBiddingData): CustomAudience.Builder

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.

fun setUserBiddingSignals(userBiddingSignals: AdSelectionSignals): CustomAudience.Builder

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.