Gestionnaire des signaux protégés

public class ProtectedSignalsManager
extends Object

java.lang.Object
   ↳ android.adservices.signals.ProtectedSignalsManager.


ProtectedSignalsManager fournit des API permettant aux applications et aux SDK publicitaires de gérer leurs signaux protégés.

Résumé

Méthodes publiques

static ProtectedSignalsManager get(Context context)

Méthode par défaut permettant de créer une instance de ProtectedSignalsManager.

void updateSignals(UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

L'API updateSignals récupère à partir de l'URI un fichier JSON décrivant les signaux à ajouter. ou supprimer.

Méthodes héritées

Méthodes publiques

get

public static ProtectedSignalsManager get (Context context)

Méthode par défaut permettant de créer une instance de ProtectedSignalsManager.

Paramètres
context Context: Context à utiliser Cette valeur ne peut pas être null.

Renvoie
ProtectedSignalsManager Une instance ProtectedSignalsManager Cette valeur ne peut pas être null.

Les signaux de mise à jour

public void updateSignals (UpdateSignalsRequest updateSignalsRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

L'API updateSignals récupère à partir de l'URI un fichier JSON décrivant les signaux à ajouter. ou supprimer. Cette API permet également d'enregistrer le point de terminaison de l'encodeur. Le point de terminaison sert à télécharger une logique d'encodage, qui permet d'encoder les signaux ;

Les clés de niveau supérieur pour le fichier JSON doivent correspondre à l'une des cinq commandes suivantes:

"put" : ajoute un nouveau signal en écrasant tous les signaux existants ayant la même clé. La valeur Il s'agit d'un objet JSON dans lequel les clés sont des chaînes en base64 correspondant à la clé à insérer et les valeurs sont des chaînes en base64 correspondant à la valeur à mettre.

"ajouter" - Ajoute un ou plusieurs nouveaux signaux à une série temporelle de signaux, en supprimant les plus anciens afin de faire de la place pour les nouveaux si la taille de la série dépasse la taille maximale donnée. La valeur est un objet JSON dans lequel les clés sont des chaînes en base64 correspondant aux à ajouter et les valeurs sont des objets avec deux champs : "values" et "maxSignals" pour en savoir plus. "valeurs" est une liste de chaînes en base64 correspondant aux valeurs de signaux à ajouter à l'heure. de la série. "maxSignals" correspond au nombre maximal de valeurs autorisées dans cette série temporelle. Si le nombre actuel de signaux associés à la clé dépasse la valeur maxSignals ; les signaux les plus anciens sera supprimé. Notez que vous pouvez ajouter des signaux à une clé ajoutée par le biais de la méthode "put". L'ajout de plus de le nombre maximal de valeurs provoque un échec.

"put_if_not_present" - Ajoute un nouveau signal uniquement s'il n'existe aucun signal avec le paramètre avec la même clé. La valeur est un objet JSON dans lequel les clés sont des chaînes en base64. correspondant à la clé à saisir. Les valeurs sont des chaînes en base64 correspondant à à saisir.

"supprimer" - Supprime le signal d'une clé. La valeur est une liste de chaînes en base64 correspondant aux clés de signaux à supprimer.

"update_encoder" - Fournit une action pour mettre à jour le point de terminaison et un URI qui peut être utilisé pour récupérer une logique d'encodage. La sous-clé permettant de fournir une action de mise à jour est "action" et valeurs actuellement prises en charge sont les suivantes:

  1. "S'INSCRIRE" : enregistre le point de terminaison de l'encodeur s'il est fourni pour la première fois ou remplace le point de terminaison existant par le nouveau point de terminaison fourni. Fournir le "point de terminaison" est obligatoire pour le "S'INSCRIRE". action.

La sous-clé permettant de fournir un point de terminaison d'encodeur est "endpoint" dont la valeur est l'URI pour le point de terminaison.

La clé ne peut être utilisée que par une seule commande par JSON. Si deux commandes tentent de fonctionner sur pour la même clé, cette méthode utilise un IllegalArgumentException

Cet appel échoue avec une erreur SecurityException si

  1. ownerPackageName n'appelle pas le nom de package de l'application et/ou
  2. l'acheteur n'est pas autorisé à utiliser l'API.

Cet appel échoue avec une erreur IllegalArgumentException si

  1. Le fichier JSON récupéré à partir du serveur n'est pas valide.
  2. L'URI fourni n'est pas valide.

Cet appel échoue avec LimitExceededException si le package à l'origine de l'appel dépasse la et est limité.

Cet appel échoue et affiche le message IllegalStateException si une erreur de service interne est rencontrés.
Nécessite AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Paramètres
updateSignalsRequest UpdateSignalsRequest : cette valeur ne peut pas être null.

executor Executor : cette valeur ne peut pas être null. Les événements de rappel et d'écouteur sont envoyés via ce Executor, ce qui permet de contrôler facilement le thread qui est utilisé. Pour envoyer des événements via le thread principal de votre vous pouvez utiliser Context.getMainExecutor() Sinon, fournissez un Executor qui sera envoyé à un thread approprié.

receiver OutcomeReceiver : cette valeur ne peut pas être null.