ProtectedSignalsManager
public
class
ProtectedSignalsManager
extends Object
java.lang.Object | |
↳ | android.adservices.signals.ProtectedSignalsManager |
ProtectedSignalsManager proporciona APIs para apps y SDKs de anuncios para administrar sus indicadores protegidos.
Resumen
Métodos públicos | |
---|---|
static
ProtectedSignalsManager
|
get(Context context)
Método de fábrica para crear una instancia de ProtectedSignalsManager. |
void
|
updateSignals(UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
La API de updateSignals recuperará un JSON del URI que describe qué indicadores agregar o quitar. |
Métodos heredados | |
---|---|
Métodos públicos
get
public static ProtectedSignalsManager get (Context context)
Método de fábrica para crear una instancia de ProtectedSignalsManager.
Parámetros | |
---|---|
context |
Context : Es el Context que se usará. Este valor no puede ser null . |
Muestra | |
---|---|
ProtectedSignalsManager |
Una instancia ProtectedSignalsManager . Este valor no puede ser null . |
updateSignals
public void updateSignals (UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
La API de updateSignals recuperará un JSON del URI que describe qué indicadores agregar o quitar. Esta API también permite registrar el extremo del codificador. El extremo se usa para descargar una lógica de codificación, que permite codificar los indicadores.
Las claves de nivel superior del JSON deben corresponder a uno de estos 5 comandos:
"put": Agrega un indicador nuevo y reemplaza los existentes con la misma clave. El valor de esta clave es un objeto JSON en el que las claves son cadenas de base 64 correspondientes a la clave que se va a colocar y los valores son cadenas de base 64 correspondientes al valor que se va a colocar.
"append": Agrega uno o varios indicadores nuevos a una serie temporal de indicadores, y quita los más antiguos para incluir los nuevos si el tamaño de la serie supera el máximo determinado. El valor de esta clave es un objeto JSON en el que las claves son cadenas de base 64 correspondientes a la clave que se agrega y los valores son objetos con dos campos: "values" y "maxSignals" . “values” es una lista de cadenas de base 64 correspondientes a los valores del indicador que se agregarán a las series temporales. "maxSignals" es la cantidad máxima de valores permitidos en esta serie temporal. Si la cantidad actual de indicadores asociados con la clave supera el objeto maxSignals, se quitarán los indicadores más antiguos. Ten en cuenta que puedes agregarlo a una clave introducida por put. Ten en cuenta que, si agregas más valores que la cantidad máxima, se producirá un error.
"put_if_not_present": Agrega un indicador nuevo solo si no hay indicadores existentes con la misma clave. El valor de esta clave es un objeto JSON en el que las claves son cadenas de base 64 correspondientes a la clave que se va a colocar y los valores son cadenas de base 64 correspondientes al valor que se va a colocar.
"remove": Quita el indicador de una clave. El valor es una lista de cadenas de base 64 correspondientes a las claves de los indicadores que se deben borrar.
"update_encoder": Proporciona una acción para actualizar el extremo y un URI que se puede usar para recuperar una lógica de codificación. La subclave para proporcionar una acción de actualización es "action", y los valores que se admiten actualmente son los siguientes:
- “REGISTER”: Registra el extremo del codificador si se proporciona por primera vez o reemplaza el existente por el extremo proporcionado recientemente. Es obligatorio proporcionar el "extremo" para la acción "REGISTER".
La clave secundaria para proporcionar un extremo del codificador es "endpoint" y el valor es la cadena de URI del extremo.
Solo se puede operar la clave en un comando por JSON. Si dos comandos intentan operar en la misma clave, este método generará un IllegalArgumentException
.
Esta llamada falla con un SecurityException
si
ownerPackageName
no llama al nombre del paquete de la app.- el comprador no está autorizado a usar la API.
Esta llamada falla con un IllegalArgumentException
en los siguientes casos:
- El JSON recuperado del servidor no es válido.
- El URI proporcionado no es válido.
Esta llamada falla con LimitExceededException
si el paquete de llamada supera los límites de frecuencia permitidos y se limita.
Esta llamada falla con un IllegalStateException
si se encuentra un error de servicio interno.
Requiere AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE
Parámetros | |
---|---|
updateSignalsRequest |
UpdateSignalsRequest : Este valor no puede ser null . |
executor |
Executor : 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 el subproceso que 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 a un subproceso adecuado. |
receiver |
OutcomeReceiver : Este valor no puede ser null . |