CustomAudienceManager

public class CustomAudienceManager
extends Object

java.lang.Object (link em inglês)
   ↳ android.adservices.customaudience.CustomAudienceManager


O CustomAudienceManager fornece APIs para SDKs de anúncios e apps para fazer parte ou sair de públicos-alvo personalizados.

Resumo

Métodos públicos

void fetchAndJoinCustomAudience(FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

Adiciona o usuário ao CustomAudience buscado por um fetchUri.

static CustomAudienceManager get(Context context)

Método Factory para criar uma instância de CustomAudienceManager.

TestCustomAudienceManager getTestCustomAudienceManager()

Criar um serviço com APIs de ativação de teste

void joinCustomAudience(JoinCustomAudienceRequest joinCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

Adiciona o usuário ao CustomAudience especificado.

void leaveCustomAudience(LeaveCustomAudienceRequest leaveCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

Tenta remover um usuário de um público-alvo personalizado excluindo os dados de CustomAudience, identificados por ownerPackageName, buyer e name.

Métodos herdados

Métodos públicos

FetchAndJoinCustomAudience

public void fetchAndJoinCustomAudience (FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

Adiciona o usuário ao CustomAudience buscado por um fetchUri.

Uma tentativa de registrar o usuário em um público-alvo personalizado com a mesma combinação de ownerPackageName, buyer e name vai fazer com que as informações do público-alvo personalizado sejam substituídas, incluindo a lista de dados de anúncios.

A lista de anúncios pode ser completamente substituída pelo trabalho de busca diária em segundo plano.

A chamada vai falhar com um SecurityException se

  1. o ownerPackageName não estiver chamando o nome do pacote do app e/ou
  2. o comprador não está autorizado a usar a API.

A chamada vai falhar com um IllegalArgumentException se

  1. o limite de armazenamento foi excedido pelo aplicativo de chamada e/ou
  2. Todos os parâmetros de URI no CustomAudience fornecidos não são autenticados com o comprador CustomAudience.

Essa chamada vai falhar com LimitExceededException se o pacote de chamada exceder os limites de taxa permitidos e for limitado.

Essa chamada vai falhar com um IllegalStateException se um erro interno de serviço for encontrado.
Requer AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parâmetros
fetchAndJoinCustomAudienceRequest FetchAndJoinCustomAudienceRequest: este valor não pode ser null.

executor Executor: este 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.

receiver OutcomeReceiver: este valor não pode ser null.

get

public static CustomAudienceManager get (Context context)

Método Factory para criar uma instância de CustomAudienceManager.

Parâmetros
context Context: o Context a ser usado. Esse valor não pode ser null.

Returns
CustomAudienceManager Uma instância CustomAudienceManager Esse valor não pode ser null.

getTestCustomAudienceManager

public TestCustomAudienceManager getTestCustomAudienceManager ()

Criar um serviço com APIs de ativação de teste

Returns
TestCustomAudienceManager Esse valor não pode ser null.

joinCustomAudience

public void joinCustomAudience (JoinCustomAudienceRequest joinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

Adiciona o usuário ao CustomAudience especificado.

Uma tentativa de registrar o usuário em um público-alvo personalizado com a mesma combinação de ownerPackageName, buyer e name vai fazer com que as informações do público-alvo personalizado sejam substituídas, incluindo a lista de dados de anúncios.

A lista de anúncios pode ser completamente substituída pelo trabalho de busca diária em segundo plano.

A chamada vai falhar com um SecurityException se

  1. o ownerPackageName não estiver chamando o nome do pacote do app e/ou
  2. o comprador não está autorizado a usar a API.

A chamada vai falhar com um IllegalArgumentException se

  1. o limite de armazenamento foi excedido pelo aplicativo de chamada e/ou
  2. Todos os parâmetros de URI no CustomAudience fornecidos não são autenticados com o comprador CustomAudience.

Essa chamada vai falhar com LimitExceededException se o pacote de chamada exceder os limites de taxa permitidos e for limitado.

Essa chamada vai falhar com um IllegalStateException se um erro interno de serviço for encontrado.
Requer AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parâmetros
joinCustomAudienceRequest JoinCustomAudienceRequest: este valor não pode ser null.

executor Executor: este 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.

receiver OutcomeReceiver: este valor não pode ser null.

saiCustomAudience

public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

Tenta remover um usuário de um público-alvo personalizado excluindo os dados de CustomAudience, identificados por ownerPackageName, buyer e name.

A chamada vai falhar com um SecurityException se

  1. o ownerPackageName não estiver chamando o nome do pacote do app; e/ou
  2. o comprador não está autorizado a usar a API.

Essa chamada vai falhar com LimitExceededException se o pacote de chamada exceder os limites de taxa permitidos e for limitado.

Essa chamada não informa ao autor da chamada se o público-alvo personalizado especificado existia no armazenamento do dispositivo. Em outras palavras, ocorrerá uma falha silenciosa quando um comprador tentar sair de um público-alvo personalizado que não foi associado.
Requer AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parâmetros
leaveCustomAudienceRequest LeaveCustomAudienceRequest: este valor não pode ser null.

executor Executor: este 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.

receiver OutcomeReceiver: este valor não pode ser null.