android.adservices.ondevicepersonalization


Interfaces

IsolatedWorker

Interface with methods that need to be implemented to handle requests from the OnDevicePersonalization service to an IsolatedService.

KeyValueStore

An interface to a read-only key-value store.

MutableKeyValueStore

An interface to a read-write key-value store.

Classes

AppInfo

Information about apps.

DownloadCompletedInput

The input data for android.adservices.ondevicepersonalization.IsolatedWorker#onDownloadCompleted(android.adservices.ondevicepersonalization.DownloadCompletedInput,android.os.OutcomeReceiver).

DownloadCompletedOutput

The result returned by android.adservices.ondevicepersonalization.IsolatedWorker#onDownloadCompleted(android.adservices.ondevicepersonalization.DownloadCompletedInput,android.os.OutcomeReceiver).

EventInput

The input data for android.adservices.ondevicepersonalization.IsolatedWorker#onEvent(android.adservices.ondevicepersonalization.EventInput,android.os.OutcomeReceiver).

EventLogRecord

Data to be logged in the EVENTS table.

EventOutput

The result returned by IsolatedWorker#onEvent(EventInput, android.os.OutcomeReceiver).

EventUrlProvider

Generates event tracking URLs for a request.

ExecuteInput

The input data for IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver).

ExecuteOutput

The result returned by IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver) in response to a call to OnDevicePersonalizationManager#execute(ComponentName, PersistableBundle, java.util.concurrent.Executor, OutcomeReceiver) from a client app.

FederatedComputeInput

The input data for FederatedComputeScheduler#schedule.

FederatedComputeScheduler

Handles scheduling federated compute jobs.

InferenceInput

Contains all the information needed for a run of model inference.

InferenceOutput

The result returned by ModelManager#run.

IsolatedService

Base class for services that are started by ODP on a call to OnDevicePersonalizationManager#execute(ComponentName, PersistableBundle, java.util.concurrent.Executor, OutcomeReceiver) and run in an isolated process.

LogReader

An interface to a read logs from REQUESTS and EVENTS Used as a Data Access Object for the REQUESTS and EVENTS table.

ModelManager

Handles model inference and only support TFLite model inference now.

OnDevicePersonalizationManager

OnDevicePersonalizationManager provides APIs for apps to load an IsolatedService in an isolated process and interact with it.

RenderingConfig

Information returned by IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver) that is used in a subesequent call to IsolatedWorker#onRender(RenderInput, android.os.OutcomeReceiver) to identify the content to be displayed in a single android.view.View.

RenderInput

The input data for IsolatedWorker#onRender(RenderInput, android.os.OutcomeReceiver).

RenderOutput

The result returned by IsolatedWorker#onRender(RenderInput, android.os.OutcomeReceiver).

RequestLogRecord

Contains data that will be written to the REQUESTS table at the end of a call to IsolatedWorker#onExecute(ExecuteInput, android.os.OutcomeReceiver).

RequestToken

An opaque token that identifies the current request to an IsolatedService.

SurfacePackageToken

An opaque reference to content that can be displayed in a android.view.SurfaceView.

TrainingExampleRecord

One record of TrainingExamplesOutput.

TrainingExamplesInput

The input data for IsolatedWorker#onTrainingExamples.

TrainingExamplesOutput

The output data of IsolatedWorker#onTrainingExamples

TrainingInterval

Training interval settings required for federated computation jobs.

UserData

User data provided by the platform to an IsolatedService.

WebTriggerInput

The input data for IsolatedWorker#onWebTrigger(WebTriggerInput, android.os.OutcomeReceiver).

WebTriggerOutput

The result that should be returned by IsolatedWorker#onWebTrigger(WebTriggerInput, android.os.OutcomeReceiver).

Exceptions

IsolatedServiceException

A class that an IsolatedService can use to signal a failure in handling a request and return an error to be logged and aggregated.

OnDevicePersonalizationException

Exception thrown by OnDevicePersonalization APIs.