Class Index
These are the API classes. See all API packages.
A
| AddAdSelectionFromOutcomesOverrideRequest | Represents the TestAdSelectionManager.overrideAdSelectionFromOutcomesConfigRemoteInfo(AddAdSelectionFromOutcomesOverrideRequest, Executor, OutcomeReceiver) ( AddAdSelectionOverrideRequest, Executor, OutcomeReceiver)} request |
| AddAdSelectionOverrideRequest | Represents the AdSelectionManager.overrideAdSelectionConfigRemoteInfo(android.adservices.adselection.AddAdSelectionOverrideRequest, java.util.concurrent.Executor, android.os.OutcomeReceiver) request |
| AddCustomAudienceOverrideRequest | Represents the CustomAudienceManager.overrideCustomAudienceRemoteInfo(android.adservices.customaudience.AddCustomAudienceOverrideRequest, java.util.concurrent.Executor, android.os.OutcomeReceiver) request |
| AddCustomAudienceOverrideRequest.Builder | Builder for AddCustomAudienceOverrideRequest objects. |
| AdData | Represents data specific to an ad that is necessary for ad selection and rendering. |
| AdData.Builder | Builder for AdData objects. |
| AdId | A unique, user-resettable, device-wide, per-profile ID for advertising. |
| AdIdManager | Provides APIs for app and ad-SDKs to access advertising ID. |
| AdSelectionConfig | Contains the configuration of the ad selection process. Instances of this class are created by SDKs to be provided as arguments to the AdSelectionManager#runAdSelection and AdSelectionManager#reportImpression methods in AdSelectionManager. |
| AdSelectionConfig.Builder | Builder for AdSelectionConfig objects. |
| AdSelectionFromOutcomesConfig | Contains the configuration of the ad selection process that select a winner from a given list of ad selection ids. |
| AdSelectionFromOutcomesConfig.Builder | Builder for AdSelectionFromOutcomesConfig objects. |
| AdSelectionManager | AdSelection Manager provides APIs for app and ad-SDKs to run ad selection processes as well as report impressions. |
| AdSelectionOutcome | This class represents a field in the OutcomeReceiver, which is an input to the AdSelectionManager#runAdSelection in the AdSelectionManager. This field is populated in the case of a successful AdSelectionManager#runAdSelection call. |
| AdSelectionOutcome.Builder | Builder for AdSelectionOutcome objects. |
| AdSelectionSignals | Holds JSON that will be passed into a JavaScript function during ad selection. |
| AdServicesOutcomeReceiver | Callback interface intended for use when an asynchronous operation may result in a failure. |
| AdServicesState | This class encapsulates possible states of the APIs exposed by the AdServicesApi APK. |
| AdServicesException | Exception thrown by AdServices. |
| AdServicesPermissions | Permissions used by the AdServices APIs. |
| AdServicesState | Specifies the state of the APIs exposed by AdServicesApi. |
| AdTechIdentifier | An identifier representing an ad buyer or seller. |
| Appinfo | Information about apps. |
| AppOwnedSdkSandboxInterface | Represents a channel for an SDK in the sandbox process to interact with the app. |
| AppSetId | A unique, per-device, per-developer-account, user-resettable ID. |
| AppSetIdManager | Provides APIs for app and ad SDKs to access appSetId. |
C
| CustomAudience | Represents the information necessary for a custom audience to participate in ad selection. |
| CustomAudience.Builder | Builder for CustomAudience objects. |
| CustomAudienceManager | Provides APIs for app and ad SDKs to join or leave custom audiences. |
D
| DeletionRequest | Get Deletion Request. |
| DeletionRequest.Builder | Builder for DeletionRequest objects. |
| DownloadCompletedInput | The input data for IsolatedWorker.onDownloadCompleted(). |
| DownloadCompletedOutput | The result returned by IsolatedWorker.onDownloadCompleted(). |
| DownloadCompletedOutput.Builder | Builder for DownloadCompletedOutput objects. |
E
| EventInput | The input data for IsolatedWorker.onEvent(). |
| EventLogRecord | Data to be logged in the EVENTS table. |
| EventLogRecord.Builder | Builder for EventLogRecord objects. |
| EventOutput | The result returned by IsolatedWorker.onEvent() |
| EventOutput.Builder | Builder for EventOutput objects. |
| EventUrlProvider | Generates event tracking URLs for a request. |
| ExecuteInput | The input data for IsolatedWorker.onExecute. |
| ExecuteOutput | The result returned by IsolatedWorker.onExecute(). |
| ExecuteOutput.Builder | Builder for ExecuteOutput objects. |
F
| FederatedComputeInput | The input data for FederatedComputeScheduler.schedule() |
| FederatedComputeInput.Builder | Builder for FederatedComputeInput objects. |
| FederatedComputeScheduler | Handles scheduling federated learning and federated analytic jobs. |
| FederatedComputeScheduler.Params | The parameters related to job scheduling. |
| FetchAndJoinCustomAudienceRequest | The request object wrapping the required and optional parameters needed to fetch a custom audience. |
| FetchAndJoinCustomAudienceRequest.Builder | Builder for FetchAndJoinCustomAudienceRequest objects. |
| FrequencyCapFilters | A container for the ad filters that are based on frequency caps. |
| FrequencyCapFilters.Builder | Builder for FrequencyCapFilters objects |
G
| GetAdSelectionDataOutcome | Represents ad selection data collected from device for ad selection. |
| GetAdSelectionDataOutcome.Builder | Represents a request containing the information to get ad selection data. |
| GetAdSelectionDataRequest | Request for GetAdSelectionData |
| GetTopicsRequest | Get Topics Request. |
| GetTopicsRequest.Builder | Builder for GetTopicsRequest objects. |
| GetTopicsResponse | Represent the result from the getTopics API. |
| GetTopicsResponse.Builder |
Builder for GetTopicsResponse objects.
|
I
| IsolatedService | Base class for services that are started by ODP on a call to OnDevicePersonalizationManager.execute(). |
| IsolatedWorker | Interface with methods that need to be implemented to handle requests from the OS to an IsolatedService. |
J
| JoinCustomAudienceRequest | The request object to join a custom audience. |
| JoinCustomAudienceRequest.Builder | Builder for JoinCustomAudienceRequest objects. |
K
| KeyedFrequencyCap | A frequency cap for a specific ad counter key. |
| KeyedFrequencyCap.Builder | Builder for creating KeyedFrequencyCap objects. |
| KeyValueStore | An interface to a read-only key-value store. |
L
| LeaveCustomAudienceRequest | The request object used to leave a custom audience. |
| LeaveCustomAudienceRequest.Builder | Builder for LeaveCustomAudienceRequest objects. |
| LoadSdkException | Exception thrown by SdkSandboxManager#loadSdk |
| LogReader | An interface to a read logs from REQUESTS and EVENTS. |
M
| MeasurementManager | Register an attribution source or trigger. |
| MutableKeyValueStore | An interface to a read-write key-value store. |
O
| OnDevicePersonalizationException | Exception thrown by OnDevicePersonalization APIs. |
| OnDevicePersonalizationManager | Provides APIs for apps to load an IsolatedService in an isolated process and interact with it. |
P
| PersistAdSelectionResultRequest | Represents a request containing the seller, the ad selection id and data. |
| PersistAdSelectionResultRequest.Builder | Builder for PersistAdSelectionResultRequest objects. |
| ProtectedSignalsManager | Provides APIs for apps and ad-SDKs to manage their protected signals. |
R
| RemoveAdSelectionFromOutcomesOverrideRequest | Represents the RemoveAdSelectionFromOutcomesOverrideRequest, Executor, OutcomeReceiver) request. |
| RemoveAdSelectionOverrideRequest | Represents the AdSelectionManager.removeAdSelectionConfigRemoteInfoOverride(android.adservices.adselection.RemoveAdSelectionOverrideRequest, java.util.concurrent.Executor, android.os.OutcomeReceiver) request |
| RemoveCustomAudienceOverrideRequest | Represents the CustomAudienceManager.removeCustomAudienceRemoteInfoOverride(android.adservices.customaudience.RemoveCustomAudienceOverrideRequest, java.util.concurrent.Executor, android.os.OutcomeReceiver) request |
| RemoveCustomAudienceOverrideRequest.Builder | Builder for RemoveCustomAudienceOverrideRequest objects. |
| RenderInput | The input data for IsolatedWorker.onRender() |
| RenderOutput | The result returned by IsolatedWorker.onRender(). |
| RenderOutput.Builder | Builder for RenderOutput objects. |
| RenderingConfig | Information returned by IsolatedWorker.onExecute(). |
| RenderingConfig.Builder | Builder for RenderingConfig objects. |
| ReportEventRequest | Request object wrapping the required arguments needed to report an ad event. |
| ReportEventRequest.Builder | Builder for ReportEventRequest objects. |
| ReportImpressionRequest | Represent input parameters to the reportImpression API. |
| RequestLogRecord | Contains data that will be written to the REQUESTS table. |
| RequestLogRecord.Builder | Builder for RequestLogRecord objects. |
| RequestToken | An opaque token that identifies the current request to an IsolatedService. |
| RequestSurfacePackageException | Builder for ReportImpressionRequest objects. |
S
| SandboxedSdk | Represents an SDK loaded in the sandbox process. |
| SdkSandboxActivityHandler | This is used to notify the SDK when an Activity is created for it. |
| SdkSandboxManager |
Provides APIs to load SDKs into SDK sandbox process, and then interact with them.
|
| SdkSandboxManager.SdkSandboxProcessDeathCallback | Callback for tracking SDK sandbox death events. |
| SourceRegistrationRequest | Class to hold input to measurement source registration calls. |
| SourceRegistrationRequest.Builder | Builder for SourceRegistrationRequest objects. |
| SurfacePackageToken | An opaque reference to content that can be displayed in a SurfaceView. |
T
| TestAdSelectionManager | Provides APIs for app and ad-SDKs to test ad selection processes as well as report impressions. |
| TestCustomAudienceManager | TestCustomAudienceManager provides APIs for app and ad-SDKs to test custom audiences. |
| Topic | Represent the topic result from the getTopics API. |
| TopicsManager | Topics Manager. |
| TrainingExampleInput | The input data for IsolatedWorker.onTrainingExample(). |
| TrainingExampleOutput | The output data of IsolatedWorker.onTrainingExample(). |
| TrainingExampleOutput.Builder | Builder for TrainingExampleOutput objects. |
| TrainingInterval | Training interval settings required for federated computation jobs. |
| TrainingInterval.Builder | Builder for TrainingInterval objects. |
| 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. |
U
| UpdateAdCounterHistogramRequest | Request object wrapping the required arguments needed to update an ad counter histogram. |
| UpdateAdCounterHistogramRequest.Builder | Builder for UpdateAdCounterHistogramRequest objects. |
| UpdateSignalsRequest | The request object for updateSignals(). |
| UpdateSignalsRequest.Builder | Builder for UpdateSignalsRequest objects. |
| UserData | User data provided by the platform to an IsolatedService. |
W
| WebSourceParams | Class holding source registration parameters. |
| WebSourceParams.Builder | Builder for WebSourceParams objects. |
| WebSourceRegistrationRequest | Class to hold input to measurement source registration calls from web context. |
| WebSourceRegistrationRequest.Builder | Builder for WebSourceRegistrationRequest objects. |
| WebTriggerParams | Class holding trigger registration parameters. |
| WebTriggerParams.Builder | Builder for WebTriggerParams objects. |
| WebTriggerRegistrationRequest | Class to hold input to measurement trigger registration calls from web context. |
| WebTriggerRegistrationRequest.Builder | Builder for WebTriggerRegistrationRequest objects. |