MeasurementManager
public
class
MeasurementManager
extends Object
java.lang.Object. | |
↳ | android.adservices.measurement.MeasurementManager |
MeasurementManager proporciona APIs para administrar registros de fuentes y activadores.
Resumen
Constantes | |
---|---|
int |
MEASUREMENT_API_STATE_DISABLED
Este estado indica que las API de Measurement no están disponibles. |
int |
MEASUREMENT_API_STATE_ENABLED
Este estado indica que las API de Measurement están habilitadas. |
Métodos públicos | |
---|---|
void
|
deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Borrar registros anteriores |
static
MeasurementManager
|
get(Context context)
Método de fábrica para crear una instancia de MeasurementManager. |
void
|
getMeasurementApiStatus(Executor executor, OutcomeReceiver<Integer, Exception> callback)
Obtenga el estado de la API de Measurement. |
void
|
registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra una fuente de atribución (clic o vista). |
void
|
registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra las fuentes de atribución(clic o vista) del contexto de una app. |
void
|
registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra un activador (conversión). |
void
|
registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra una fuente de atribución(clic o vista) del contexto web. |
void
|
registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra un activador de atribución(clic o vista) del contexto de la Web. |
Métodos heredados | |
---|---|
Constantes
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
Este estado indica que las API de Measurement no están disponibles. Si los invocas, se generará un UnsupportedOperationException
.
Valor constante: 0 (0x00000000)
MEASUREMENT_API_STATE_ENABLED
public static final int MEASUREMENT_API_STATE_ENABLED
Este estado indica que las API de Measurement están habilitadas.
Valor constante: 1 (0x00000001)
Métodos públicos
deleteRegistrations
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Borrar registros anteriores Si la eliminación se realiza correctamente, el OutcomeReceiver.onResult(R)
de la devolución de llamada se invoca con un valor nulo. En caso de que se produzca una falla, se envía un Exception
a través del OutcomeReceiver#onError
de la devolución de llamada. Los comentarios sobre el éxito y el fracaso se ejecutan en el Executor
proporcionado.
Parámetros | |
---|---|
deletionRequest |
DeletionRequest : Es la solicitud de eliminación de datos.
Este valor no puede ser null . |
executor |
Executor : Es el ejecutor que ejecutará la devolución de llamada.
Este valor no puede ser null .
Los eventos de devolución de llamada y de objetos de escucha se envían a través de este Executor , lo que proporciona una manera fácil de controlar qué subproceso se usa. Para enviar eventos a través del subproceso principal de tu aplicación, puedes usar Context.getMainExecutor() .
De lo contrario, proporciona un Executor que se envíe al subproceso correspondiente. |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API.
Este valor no puede ser null . |
get
public static MeasurementManager get (Context context)
Método de fábrica para crear una instancia de MeasurementManager.
Parámetros | |
---|---|
context |
Context : El Context que se usará. Este valor no puede ser null . |
Devuelve | |
---|---|
MeasurementManager |
Una instancia de MeasurementManager . Este valor no puede ser null . |
getMeasurementApiStatus (estado)
public void getMeasurementApiStatus (Executor executor, OutcomeReceiver<Integer, Exception> callback)
Obtenga el estado de la API de Measurement.
El valor Integer
de la devolución de llamada es uno de MeasurementApiState
.
Requiere AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parámetros | |
---|---|
executor |
Executor : Lo usa la devolución de llamada para enviar los resultados.
Este valor no puede ser null .
Los eventos de devolución de llamada y de objetos de escucha se envían a través de este Executor , lo que proporciona una manera fácil de controlar qué subproceso se usa. Para enviar eventos a través del subproceso principal de tu aplicación, puedes usar Context.getMainExecutor() .
De lo contrario, proporciona un Executor que se envíe al subproceso correspondiente. |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API.
Este valor no puede ser null . |
registroSource
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra una fuente de atribución (clic o vista).
Requiere AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parámetros | |
---|---|
attributionSource |
Uri : La plataforma emite una solicitud a este URI para recuperar los metadatos asociados con la fuente de atribución. Los metadatos de origen se almacenan en el dispositivo, por lo que
son aptos para coincidir con activadores futuros.
Este valor no puede ser null . |
inputEvent |
InputEvent : Es un objeto InputEvent (para un evento de clic) o un valor nulo (para un evento de vista). |
executor |
Executor : Lo usa la devolución de llamada para enviar los resultados.
Este valor puede ser null .
Los eventos de devolución de llamada y de objetos de escucha se envían a través de este Executor , lo que proporciona una manera fácil de controlar qué subproceso se usa. Para enviar eventos a través del subproceso principal de tu aplicación, puedes usar Context.getMainExecutor() .
De lo contrario, proporciona un Executor que se envíe al subproceso correspondiente. |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API.
Este valor puede ser null . |
Arroja | |
---|---|
IllegalArgumentException |
si el esquema para attributionSource no es HTTPS |
registroSource
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra las fuentes de atribución(clic o vista) del contexto de una app. Esta API no procesará ningún redireccionamiento. Todas las URLs de registro se deben proporcionar junto con la solicitud.
Requiere AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parámetros | |
---|---|
request |
SourceRegistrationRequest : Solicitud de registro de fuente de la app. Este valor no puede ser null . |
executor |
Executor : Lo usa la devolución de llamada para enviar resultados. Este valor puede ser null .
Los eventos de devolución de llamada y de objetos de escucha se envían a través de este Executor , lo que proporciona una manera fácil de controlar qué subproceso se usa. Para enviar eventos a través del subproceso principal de tu aplicación, puedes usar Context.getMainExecutor() .
De lo contrario, proporciona un Executor que se envíe al subproceso correspondiente. |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API. Este valor puede ser null . |
RegisterTrigger
public void registerTrigger (Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra un activador (conversión).
Requiere AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parámetros | |
---|---|
trigger |
Uri : La API emite una solicitud a este URI para recuperar metadatos asociados con el activador. Los metadatos del activador se almacenan en el dispositivo y son aptos para coincidir con las fuentes durante el proceso de atribución.
Este valor no puede ser null . |
executor |
Executor : Lo usa la devolución de llamada para enviar los resultados.
Este valor puede ser null .
Los eventos de devolución de llamada y de objetos de escucha se envían a través de este Executor , lo que proporciona una manera fácil de controlar qué subproceso se usa. Para enviar eventos a través del subproceso principal de tu aplicación, puedes usar Context.getMainExecutor() .
De lo contrario, proporciona un Executor que se envíe al subproceso correspondiente. |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API.
Este valor puede ser null . |
Arroja | |
---|---|
IllegalArgumentException |
si el esquema para trigger no es HTTPS |
registroWebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra una fuente de atribución(clic o vista) del contexto web. Esta API no procesará ningún redireccionamiento. Todas las URLs de registro se deben proporcionar junto con la solicitud. Se debe proporcionar al menos uno de los parámetros appDestination o webDestination. Si el registro se realiza correctamente, el OutcomeReceiver#onResult
de callback
se invoca con un valor nulo. En caso de falla, se envía un Exception
a través de OutcomeReceiver.onError(E)
de callback
. Los comentarios sobre el éxito y el fracaso se ejecutan en el Executor
proporcionado.
Requiere AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parámetros | |
---|---|
request |
WebSourceRegistrationRequest : Solicitud de registro de fuente. Este valor no puede ser null . |
executor |
Executor : Lo usa la devolución de llamada para enviar los resultados.
Este valor puede ser null . |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API.
Este valor puede ser null . |
registroWebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra un activador de atribución(clic o vista) del contexto de la Web. Esta API no procesará ningún redireccionamiento. Todas las URLs de registro se deben proporcionar junto con la solicitud. Si el registro se realiza correctamente, el OutcomeReceiver#onResult
de callback
se invoca con un valor nulo. En caso de falla, se envía un Exception
a través de OutcomeReceiver.onError(E)
de callback
. Los comentarios sobre el éxito y el fracaso se ejecutan en el Executor
proporcionado.
Requiere AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parámetros | |
---|---|
request |
WebTriggerRegistrationRequest : Solicitud de registro del activador. Este valor no puede ser null . |
executor |
Executor : Lo usa la devolución de llamada para enviar resultados. Este valor puede ser null . |
callback |
OutcomeReceiver : Está destinado a notificar de forma asíncrona el resultado de la API. Este valor puede ser null . |