FetchAndJoinCustomAudienceRequest.Builder


public static final class FetchAndJoinCustomAudienceRequest.Builder
extends Object

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

Summary

Public constructors

Builder(Uri fetchUri)

Instantiates a FetchAndJoinCustomAudienceRequest.Builder with the Uri from which the custom audience is to be fetched.

Public methods

FetchAndJoinCustomAudienceRequest build()

Builds an instance of a FetchAndJoinCustomAudienceRequest.

FetchAndJoinCustomAudienceRequest.Builder setActivationTime(Instant activationTime)

Sets the Instant by which joining the custom audience will be delayed.

FetchAndJoinCustomAudienceRequest.Builder setExpirationTime(Instant expirationTime)

Sets the Instant by when the membership to the custom audience will expire.

FetchAndJoinCustomAudienceRequest.Builder setFetchUri(Uri fetchUri)

Sets the Uri from which the custom audience is to be fetched.

FetchAndJoinCustomAudienceRequest.Builder setName(String name)

Sets the String name of the custom audience to join.

FetchAndJoinCustomAudienceRequest.Builder setUserBiddingSignals(AdSelectionSignals userBiddingSignals)

Sets the buyer signals to be consumed by the buyer-provided JavaScript when the custom audience participates in an ad selection.

Inherited methods

Public constructors

Builder

public Builder (Uri fetchUri)

Instantiates a FetchAndJoinCustomAudienceRequest.Builder with the Uri from which the custom audience is to be fetched.

Parameters
fetchUri Uri: This value cannot be null.

Public methods

build

Added in API level 35
Also in Ad Services Extensions 10
Deprecated in API level 37
public FetchAndJoinCustomAudienceRequest build ()

Builds an instance of a FetchAndJoinCustomAudienceRequest.

Returns
FetchAndJoinCustomAudienceRequest This value cannot be null.

Throws
NullPointerException if any non-null parameter is null.

setActivationTime

Added in API level 35
Also in Ad Services Extensions 10
Deprecated in API level 37
public FetchAndJoinCustomAudienceRequest.Builder setActivationTime (Instant activationTime)

Sets the Instant by which joining the custom audience will be delayed.

See FetchAndJoinCustomAudienceRequest.getActivationTime() for details.

Parameters
activationTime Instant: This value may be null.

Returns
FetchAndJoinCustomAudienceRequest.Builder This value cannot be null.

setExpirationTime

Added in API level 35
Also in Ad Services Extensions 10
Deprecated in API level 37
public FetchAndJoinCustomAudienceRequest.Builder setExpirationTime (Instant expirationTime)

Sets the Instant by when the membership to the custom audience will expire.

See FetchAndJoinCustomAudienceRequest.getExpirationTime() for details.

Parameters
expirationTime Instant: This value may be null.

Returns
FetchAndJoinCustomAudienceRequest.Builder This value cannot be null.

setFetchUri

Added in API level 35
Also in Ad Services Extensions 10
Deprecated in API level 37
public FetchAndJoinCustomAudienceRequest.Builder setFetchUri (Uri fetchUri)

Sets the Uri from which the custom audience is to be fetched.

See FetchAndJoinCustomAudienceRequest.getFetchUri() ()} for details.

Parameters
fetchUri Uri: This value cannot be null.

Returns
FetchAndJoinCustomAudienceRequest.Builder This value cannot be null.

setName

Added in API level 35
Also in Ad Services Extensions 10
Deprecated in API level 37
public FetchAndJoinCustomAudienceRequest.Builder setName (String name)

Sets the String name of the custom audience to join.

See FetchAndJoinCustomAudienceRequest.getName() for details.

Parameters
name String: This value may be null.

Returns
FetchAndJoinCustomAudienceRequest.Builder This value cannot be null.

setUserBiddingSignals

Added in API level 35
Also in Ad Services Extensions 10
Deprecated in API level 37
public FetchAndJoinCustomAudienceRequest.Builder setUserBiddingSignals (AdSelectionSignals userBiddingSignals)

Sets the buyer signals to be consumed by the buyer-provided JavaScript when the custom audience participates in an ad selection.

See FetchAndJoinCustomAudienceRequest.getUserBiddingSignals() for details.

Parameters
userBiddingSignals AdSelectionSignals: This value may be null.

Returns
FetchAndJoinCustomAudienceRequest.Builder This value cannot be null.