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

Summary: Ctors | Methods | Inherited Methods

CustomAudience.Builder

Kotlin |Java

public static final class CustomAudience.Builder
extends Object

java.lang.Object
↳	android.adservices.customaudience.CustomAudience.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/

Builder for CustomAudience objects.

Summary

Public constructors
`Builder()`

Public methods
`CustomAudience`	`build()` Builds an instance of a `CustomAudience`.
`CustomAudience.Builder`	`setActivationTime(Instant activationTime)` Sets the time, truncated to milliseconds, after which the `CustomAudience` will serve ads.
`CustomAudience.Builder`	`setAds(List<AdData> ads)` Sets the initial remarketing ads served by the custom audience.
`CustomAudience.Builder`	`setAuctionServerRequestFlags(int auctionServerRequestFlags)` Sets the bitfield of auction server request flags.
`CustomAudience.Builder`	`setBiddingLogicUri(Uri biddingLogicUri)` Sets the URI to fetch bidding logic from for use in the ad selection process.
`CustomAudience.Builder`	`setBuyer(AdTechIdentifier buyer)` Sets the buyer `AdTechIdentifier`.
`CustomAudience.Builder`	`setComponentAds(List<ComponentAdData> componentAds)` Sets the components ads served by the custom audience.
`CustomAudience.Builder`	`setDailyUpdateUri(Uri dailyUpdateUri)` Sets the daily update URI.
`CustomAudience.Builder`	`setExpirationTime(Instant expirationTime)` Sets the time, truncated to milliseconds, after which the `CustomAudience` should be removed.
`CustomAudience.Builder`	`setName(String name)` Sets the `CustomAudience` object's name.
`CustomAudience.Builder`	`setPriority(double priority)` Sets the priority for this custom audience.
`CustomAudience.Builder`	`setTrustedBiddingData(TrustedBiddingData trustedBiddingData)` Sets the trusted bidding data to be queried and used in the ad selection process.
`CustomAudience.Builder`	`setUserBiddingSignals(AdSelectionSignals userBiddingSignals)` Sets the user bidding signals used in the ad selection process.

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

Builder

Added in API level 34
Also in Ad Services Extensions 4

public Builder ()

Public methods

build

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

public CustomAudience build ()

Builds an instance of a CustomAudience.

Returns
`CustomAudience`	This value cannot be `null`.

Throws
`IllegalArgumentException`	if the expiration time occurs before activation time
`IllegalArgumentException`	if the expiration time is set before the current time
`NullPointerException`	if any non-null parameter is null

setActivationTime

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

public CustomAudience.Builder setActivationTime (Instant activationTime)

Sets the time, truncated to milliseconds, after which the CustomAudience will serve ads.

Set to null in order for this CustomAudience to be immediately active and participate in ad selection.

See CustomAudience.getActivationTime() for more information.

Parameters
`activationTime`	`Instant`: This value may be `null`.

Returns
`CustomAudience.Builder`

setAds

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

public CustomAudience.Builder setAds (List<AdData> ads)

Sets the initial remarketing ads served by the custom audience. Will be assigned with an empty list if not provided.

See CustomAudience.getAds() for more information.

Parameters
`ads`	`List`: This value may be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setAuctionServerRequestFlags

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

public CustomAudience.Builder setAuctionServerRequestFlags (int auctionServerRequestFlags)

Sets the bitfield of auction server request flags.

See CustomAudience.getAuctionServerRequestFlags() for more information.

Parameters
`auctionServerRequestFlags`	`int`: Value is either `0` or a combination of the following: `CustomAudience.FLAG_AUCTION_SERVER_REQUEST_OMIT_ADS`

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setBiddingLogicUri

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

public CustomAudience.Builder setBiddingLogicUri (Uri biddingLogicUri)

Sets the URI to fetch bidding logic from for use in the ad selection process. The URI must use HTTPS.

See CustomAudience.getBiddingLogicUri() for more information.

Parameters
`biddingLogicUri`	`Uri`: This value cannot be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setBuyer

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

public CustomAudience.Builder setBuyer (AdTechIdentifier buyer)

Sets the buyer AdTechIdentifier.

See CustomAudience.getBuyer() for more information.

Parameters
`buyer`	`AdTechIdentifier`: This value cannot be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setComponentAds

Added in API level 36
Also in Ad Services Extensions 16
Deprecated in API level 37

public CustomAudience.Builder setComponentAds (List<ComponentAdData> componentAds)

Sets the components ads served by the custom audience.

See CustomAudience.getComponentAds() for more information.

Parameters
`componentAds`	`List`: This value cannot be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setDailyUpdateUri

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

public CustomAudience.Builder setDailyUpdateUri (Uri dailyUpdateUri)

Sets the daily update URI. The URI must use HTTPS.

See CustomAudience.getDailyUpdateUri() for more information.

Parameters
`dailyUpdateUri`	`Uri`: This value cannot be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setExpirationTime

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

public CustomAudience.Builder setExpirationTime (Instant expirationTime)

Sets the time, truncated to milliseconds, after which the CustomAudience should be removed.

See CustomAudience.getExpirationTime() for more information.

Parameters
`expirationTime`	`Instant`: This value may be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setName

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

public CustomAudience.Builder setName (String name)

Sets the CustomAudience object's name.

See CustomAudience.getName() for more information.

Parameters
`name`	`String`: This value cannot be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setPriority

Added in API level 36
Also in Ad Services Extensions 14
Deprecated in API level 37

public CustomAudience.Builder setPriority (double priority)

Sets the priority for this custom audience.

See CustomAudience.getPriority() for further details.

Parameters
`priority`	`double`

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setTrustedBiddingData

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

public CustomAudience.Builder setTrustedBiddingData (TrustedBiddingData trustedBiddingData)

Sets the trusted bidding data to be queried and used in the ad selection process.

See CustomAudience.getTrustedBiddingData() for more information.

Parameters
`trustedBiddingData`	`TrustedBiddingData`: This value may be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.

setUserBiddingSignals

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

public CustomAudience.Builder setUserBiddingSignals (AdSelectionSignals userBiddingSignals)

Sets the user bidding signals used in the ad selection process.

See CustomAudience.getUserBiddingSignals() for more information.

Parameters
`userBiddingSignals`	`AdSelectionSignals`: This value may be `null`.

Returns
`CustomAudience.Builder`	This value cannot be `null`.