CustomAudience
public final class CustomAudience
Represents the information necessary for a custom audience to participate in ad selection.
A custom audience is an abstract grouping of users with similar demonstrated interests. This class is a collection of some data stored on a device that is necessary to serve advertisements targeting a single custom audience.
Summary
Nested types |
|---|
public final class CustomAudience.BuilderBuilder for |
Public constructors |
|---|
CustomAudience( |
Public methods |
|
|---|---|
boolean |
Checks whether two |
final Instant |
optional activation time may be set in the future, in order to serve a delayed activation. |
final @NonNull List<@NonNull AdData> |
getAds()the list of |
final @NonNull Uri |
the target URI used to fetch bidding logic when a custom audience participates in the ad selection process. |
final @NonNull AdTechIdentifier |
getBuyer()A buyer is identified by a domain in the form "buyerexample.com". |
final @NonNull Uri |
a URI that points to a buyer-operated server that hosts updated bidding data and ads metadata to be used in the on-device ad selection process. |
final Instant |
optional expiration time. |
final @NonNull String |
getName()The custom audience's name is an arbitrary string provided by the owner and buyer on creation of the |
final TrustedBiddingData |
optional 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. |
final AdSelectionSignals |
optional User bidding signals, provided by buyers to be consumed by buyer-provided JavaScript during ad selection in an isolated execution environment. |
int |
hashCode()Returns the hash of the |
@NonNull String |
toString() |
Public constructors
CustomAudience
public CustomAudience(
@NonNull AdTechIdentifier buyer,
@NonNull String name,
@NonNull Uri dailyUpdateUri,
@NonNull Uri biddingLogicUri,
@NonNull List<@NonNull AdData> ads,
Instant activationTime,
Instant expirationTime,
AdSelectionSignals userBiddingSignals,
TrustedBiddingData trustedBiddingSignals
)
| Parameters | |
|---|---|
@NonNull AdTechIdentifier buyer |
A buyer is identified by a domain in the form "buyerexample.com". |
@NonNull String name |
The custom audience's name is an arbitrary string provided by the owner and buyer on creation of the |
@NonNull Uri dailyUpdateUri |
a URI that 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. |
@NonNull Uri biddingLogicUri |
the target URI used to fetch bidding logic when a custom audience participates in the ad selection process. The URI must use HTTPS. |
@NonNull List<@NonNull AdData> ads |
the list of |
Instant activationTime |
optional activation time may be set in the future, in order to serve a delayed activation. If the field is not set, the object will be activated at the time of joining. |
Instant expirationTime |
optional expiration time. Once it 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. |
AdSelectionSignals userBiddingSignals |
optional User bidding signals, provided by buyers to be consumed by buyer-provided JavaScript during ad selection in an isolated execution environment. |
TrustedBiddingData trustedBiddingSignals |
optional 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. |
Public methods
equals
public boolean equals(Object other)
Checks whether two CustomAudience objects contain the same information.
getActivationTime
public final Instant getActivationTime()
optional activation time may be set in the future, in order to serve a delayed activation. If the field is not set, the object will be activated at the time of joining.
getAds
public final @NonNull List<@NonNull AdData> getAds()
the 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.
getBiddingLogicUri
public final @NonNull Uri getBiddingLogicUri()
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 final @NonNull AdTechIdentifier getBuyer()
A buyer is identified by a domain in the form "buyerexample.com".
getDailyUpdateUri
public final @NonNull Uri getDailyUpdateUri()
a URI that 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 final Instant getExpirationTime()
optional expiration time. Once it 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.
getName
public final @NonNull String getName()
The custom audience's name is an arbitrary string provided by the owner and buyer on creation of the CustomAudience object.
getTrustedBiddingSignals
public final TrustedBiddingData getTrustedBiddingSignals()
optional 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.
getUserBiddingSignals
public final AdSelectionSignals getUserBiddingSignals()
optional User bidding signals, provided by buyers to be consumed by buyer-provided JavaScript during ad selection in an isolated execution environment.