MeasurementManager
public
class
MeasurementManager
extends Object
java.lang.Object (link em inglês) | |
↳ | android.adservices.measurement.MeasurementManager. |
O MeasurementManager oferece APIs para gerenciar registros de fonte e acionador.
Resumo
Constantes | |
---|---|
int |
MEASUREMENT_API_STATE_DISABLED
Esse estado indica que as APIs de medição não estão disponíveis. |
int |
MEASUREMENT_API_STATE_ENABLED
Esse estado indica que as APIs de medição estão ativadas. |
Métodos públicos | |
---|---|
void
|
deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Excluir registros anteriores. |
static
MeasurementManager
|
get(Context context)
Método Factory para criar uma instância do MeasurementManager. |
void
|
getMeasurementApiStatus(Executor executor, OutcomeReceiver<Integer, Exception> callback)
Receba o status da API Measurement. |
void
|
registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra uma fonte de atribuição (clique ou visualização). |
void
|
registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra fontes de atribuição(clique ou visualização) de um contexto de app. |
void
|
registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra um acionador (conversão). |
void
|
registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra uma fonte de atribuição(clique ou visualização) no contexto da Web. |
void
|
registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registrar um acionador de atribuição(clique ou visualização) no contexto da Web. |
Métodos herdados | |
---|---|
Constantes
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
Esse estado indica que as APIs de medição não estão disponíveis. Invocá-los vai resultar em uma
UnsupportedOperationException
.
Valor da constante: 0 (0x00000000)
MEASUREMENT_API_STATE_ENABLED
public static final int MEASUREMENT_API_STATE_ENABLED
Esse estado indica que as APIs de medição estão ativadas.
Valor da constante: 1 (0x00000001)
Métodos públicos
deleteRegistration
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Excluir registros anteriores. Se a exclusão for bem-sucedida, o OutcomeReceiver.onResult(R)
do callback será invocado com um valor nulo. Em caso de falha, um Exception
é
enviado pelo OutcomeReceiver#onError
do callback. O feedback de sucesso e falha é executado no Executor
fornecido.
Parâmetros | |
---|---|
deletionRequest |
DeletionRequest : a solicitação de exclusão de dados.
Esse valor não pode ser null . |
executor |
Executor : o executor para executar o callback.
Esse valor não pode ser null .
Eventos de callback e listener são enviados por esse
Executor , oferecendo uma maneira fácil de controlar qual linha de execução é
usada. Para enviar eventos com a linha de execução principal do
aplicativo, use
Context.getMainExecutor() .
Caso contrário, forneça um Executor que seja enviado para uma linha de execução adequada. |
callback |
OutcomeReceiver : serve para notificar de maneira assíncrona o resultado da API.
Esse valor não pode ser null . |
get
public static MeasurementManager get (Context context)
Método Factory para criar uma instância do MeasurementManager.
Parâmetros | |
---|---|
context |
Context : o Context a ser usado.
Esse valor não pode ser null . |
Returns | |
---|---|
MeasurementManager |
Uma instância MeasurementManager
Esse valor não pode ser null . |
getMeasurementApiStatus
public void getMeasurementApiStatus (Executor executor, OutcomeReceiver<Integer, Exception> callback)
Receba o status da API Measurement.
O valor Integer
do callback é MeasurementApiState
.
Requer AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parâmetros | |
---|---|
executor |
Executor : usado pelo callback para enviar resultados.
Esse valor não pode ser null .
Eventos de callback e listener são enviados por esse
Executor , oferecendo uma maneira fácil de controlar qual linha de execução é
usada. Para enviar eventos com a linha de execução principal do
aplicativo, use
Context.getMainExecutor() .
Caso contrário, forneça um Executor que seja enviado para uma linha de execução adequada. |
callback |
OutcomeReceiver : serve para notificar de maneira assíncrona o resultado da API.
Esse valor não pode ser null . |
registerSource.
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra uma fonte de atribuição (clique ou visualização).
Requer AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parâmetros | |
---|---|
attributionSource |
Uri : a plataforma emite uma solicitação a esse URI para buscar metadados
associados à fonte de atribuição. Os metadados de origem são armazenados no dispositivo, o que os torna qualificados para correspondência com acionadores futuros.
Esse valor não pode ser null . |
inputEvent |
InputEvent : um objeto InputEvent (para um evento de clique) ou nulo (para um evento
de visualização). |
executor |
Executor : usado pelo callback para enviar resultados.
Esse valor pode ser null .
Eventos de callback e listener são enviados por esse
Executor , oferecendo uma maneira fácil de controlar qual linha de execução é
usada. Para enviar eventos com a linha de execução principal do
aplicativo, use
Context.getMainExecutor() .
Caso contrário, forneça um Executor que seja enviado para uma linha de execução adequada. |
callback |
OutcomeReceiver : serve para notificar de maneira assíncrona o resultado da API.
Esse valor pode ser null . |
Gera | |
---|---|
IllegalArgumentException |
se o esquema para attributionSource não for HTTPS |
registerSource.
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra fontes de atribuição(clique ou visualização) de um contexto de app. Essa API não processa
redirecionamentos. Todos os URLs de registro precisam ser fornecidos com a solicitação.
Requer AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parâmetros | |
---|---|
request |
SourceRegistrationRequest : solicitação de registro da origem do app.
Esse valor não pode ser null . |
executor |
Executor : usado pelo callback para enviar resultados.
Esse valor pode ser null .
Eventos de callback e listener são enviados por esse
Executor , oferecendo uma maneira fácil de controlar qual linha de execução é
usada. Para enviar eventos com a linha de execução principal do
aplicativo, use
Context.getMainExecutor() .
Caso contrário, forneça um Executor que seja enviado para uma linha de execução adequada. |
callback |
OutcomeReceiver : destina-se a notificar assincronamente o resultado da API
Este valor pode ser null . |
registerTrigger
public void registerTrigger (Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra um acionador (conversão).
Requer AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parâmetros | |
---|---|
trigger |
Uri : a API emite uma solicitação a esse URI para buscar metadados associados ao
acionador. Os metadados do acionador são armazenados no dispositivo e podem ser comparados com
as fontes durante o processo de atribuição.
Esse valor não pode ser null . |
executor |
Executor : usado pelo callback para enviar resultados.
Esse valor pode ser null .
Eventos de callback e listener são enviados por esse
Executor , oferecendo uma maneira fácil de controlar qual linha de execução é
usada. Para enviar eventos com a linha de execução principal do
aplicativo, use
Context.getMainExecutor() .
Caso contrário, forneça um Executor que seja enviado para uma linha de execução adequada. |
callback |
OutcomeReceiver : serve para notificar de maneira assíncrona o resultado da API.
Esse valor pode ser null . |
Gera | |
---|---|
IllegalArgumentException |
se o esquema para trigger não for HTTPS |
registerWebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registra uma fonte de atribuição(clique ou visualização) no contexto da Web. Essa API não processa
redirecionamentos. Todos os URLs de registro precisam ser fornecidos com a solicitação. É necessário fornecer pelo menos um dos
parâmetros appDestination ou webDestination. Se o registro
for bem-sucedido, o OutcomeReceiver#onResult
do callback
será invocado com um valor nulo. Em caso de falha, um Exception
é enviado por OutcomeReceiver.onError(E)
do callback
. Tanto o feedback de sucesso quanto o de falha são executados no
Executor
fornecido.
Requer AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parâmetros | |
---|---|
request |
WebSourceRegistrationRequest : solicitação de registro de origem.
Esse valor não pode ser null . |
executor |
Executor : usado pelo callback para enviar resultados.
Esse valor pode ser null . |
callback |
OutcomeReceiver : serve para notificar de maneira assíncrona o resultado da API.
Esse valor pode ser null . |
registerWebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Registrar um acionador de atribuição(clique ou visualização) no contexto da Web. Essa API não processa
redirecionamentos. Todos os URLs de registro precisam ser fornecidos com a solicitação. Se o registro
for bem-sucedido, o OutcomeReceiver#onResult
do callback
será invocado com um valor nulo. Em caso de falha, um Exception
é enviado por OutcomeReceiver.onError(E)
do callback
. Tanto o feedback de sucesso quanto o de falha são executados no
Executor
fornecido.
Requer AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parâmetros | |
---|---|
request |
WebTriggerRegistrationRequest : solicitação de registro de acionador
Esse valor não pode ser null . |
executor |
Executor : usado pelo callback para enviar resultados.
Esse valor pode ser null . |
callback |
OutcomeReceiver : destina-se a notificar assincronamente o resultado da API
Este valor pode ser null . |