Android.AdServices.CustomAudiences Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides custom audience data, request builders, and managers for Android ad selection.

Classes

Name	Description
AddCustomAudienceOverrideRequest	This POJO represents the `TestCustomAudienceManager#overrideCustomAudienceRemoteInfo(AddCustomAudienceOverrideRequest, Executor, OutcomeReceiver)` request.
AddCustomAudienceOverrideRequest.Builder	Builder for `AddCustomAudienceOverrideRequest` objects.
CustomAudience	Represents the information necessary for a custom audience to participate in ad selection.
CustomAudience.Builder	Builder for `CustomAudience` objects.
CustomAudience.InterfaceConsts	Contains the parcelable interface constants exposed for CustomAudience.
CustomAudienceManager	CustomAudienceManager provides APIs for app and ad-SDKs to join / leave custom audiences.
FetchAndJoinCustomAudienceRequest	The request object wrapping the required and optional parameters needed to fetch a `CustomAudience`.
FetchAndJoinCustomAudienceRequest.Builder	Builder for `FetchAndJoinCustomAudienceRequest` objects.
JoinCustomAudienceRequest	The request object to join a custom audience.
JoinCustomAudienceRequest.Builder	Builder for `JoinCustomAudienceRequest` objects.
LeaveCustomAudienceRequest	The request object is used to leave a custom audience.
LeaveCustomAudienceRequest.Builder	Builder for `LeaveCustomAudienceRequest` objects.
PartialCustomAudience	Represents a partial custom audience that is passed along to the buyer ad tech, when scheduling a delayed update for Custom Audience.
PartialCustomAudience.Builder	Builder for `PartialCustomAudience` objects.
PartialCustomAudience.InterfaceConsts	Contains the parcelable interface constants exposed for PartialCustomAudience.
RemoveCustomAudienceOverrideRequest	This POJO represents the `TestCustomAudienceManager#removeCustomAudienceRemoteInfoOverride( RemoveCustomAudienceOverrideRequest, Executor, OutcomeReceiver)` request.
RemoveCustomAudienceOverrideRequest.Builder	Builder for `RemoveCustomAudienceOverrideRequest` objects.
ScheduleCustomAudienceUpdateRequest	The request object wrapping the required and optional parameters to schedule a deferred update for a buyer ad tech's custom audiences.
ScheduleCustomAudienceUpdateRequest.Builder	Builder for `ScheduleCustomAudienceUpdateRequest` objects.
TestCustomAudienceManager	TestCustomAudienceManager provides APIs for app and ad-SDKs to test custom audiences.
TrustedBiddingData	Represents data used during the ad selection process to fetch buyer bidding signals from a trusted key/value server.
TrustedBiddingData.Builder	Builder for `TrustedBiddingData` objects.
TrustedBiddingData.InterfaceConsts	Contains the parcelable interface constants exposed for TrustedBiddingData.

Enums

Name	Description
AuctionServerRequest	Specifies custom audience data that can be omitted from a server auction request.

Remarks

Use CustomAudienceManager to join or leave an audience, fetch an audience from a buyer's server, or schedule a deferred update. Request objects carry the audience identifiers, bidding data, and optional caller-supplied fields needed by these operations.

TestCustomAudienceManager can replace remote bidding data with local values for testing. These test operations require a debuggable application and enabled developer options.

The operations and test requirements are documented in the CustomAudienceManager reference and the TestCustomAudienceManager reference.