ProtectedSignalsManager
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 de fabrique permettant de créer une instance de ProtectedSignalsManager. |
void
|
updateSignals(UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
L'API updateSignals récupère à partir de l'URI un JSON qui décrit 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 . |
Mises à jourSignaux
public void updateSignals (UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> 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 permet de télécharger une logique d'encodage, qui permet d'encoder les signaux.
Les clés de niveau supérieur de l'objet 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 correspondante est un objet JSON dans lequel les clés sont des chaînes en base64 correspondant à la clé à insérer et les valeurs sont une chaîne en base64 correspondant à la valeur à mettre.
"append" : ajoute un ou plusieurs nouveaux signaux à une série temporelle de signaux, en supprimant les signaux les plus anciens pour faire de la place pour les nouveaux si la taille de la série dépasse la taille maximale donnée. La valeur correspondante est un objet JSON dans lequel les clés sont des chaînes en base64 correspondant à la clé à ajouter. Les valeurs sont des objets comportant deux champs: "values" et "maxSignals". "values" est une liste de chaînes en base64 correspondant aux valeurs de signaux à ajouter à la série temporelle. "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 seront supprimés. Notez que vous pouvez ajouter des signaux à une clé ajoutée par le biais de la méthode "put". Notez que si vous ajoutez plus de valeurs que le nombre maximal autorisé, un échec se produira.
"put_if_not_present" : ajoute un nouveau signal uniquement s'il n'existe aucun signal avec la même clé. La valeur de cet objet est un objet JSON dans lequel les clés sont des chaînes en base64 correspondant à la clé à mettre, et les valeurs sont des chaînes en base64 correspondant à la valeur à mettre.
"remove" : supprime le signal d'une clé. La valeur correspondante 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 les valeurs actuellement acceptées sont les suivantes:
- "REGISTER" : enregistre le point de terminaison de l'encodeur s'il est fourni pour la première fois ou écrase le point de terminaison existant par le nouveau point de terminaison fourni. Vous devez indiquer le "point de terminaison" pour l'action "REGISTER".
La sous-clé permettant de fournir un point de terminaison d'encodeur est "endpoint" et sa valeur est la chaîne d'URI du point de terminaison.
Une clé ne peut être utilisée que par une seule commande par fichier JSON. Si deux commandes tentent d'utiliser la même clé, cette méthode génère une erreur IllegalArgumentException
.
Cet appel échoue avec une erreur SecurityException
si
ownerPackageName
n'appelle pas le nom de package de l'application et/ou- l'acheteur n'est pas autorisé à utiliser l'API.
Cet appel échoue avec une IllegalArgumentException
si :
- Le fichier JSON récupéré sur le serveur n'est pas valide.
- L'URI fourni n'est pas valide.
Cet appel échoue avec LimitExceededException
si le package appelant dépasse les limites de débit autorisées et est limité.
Cet appel échoue et affiche le message IllegalStateException
si une erreur de service interne se produit.
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 distribués via ce Executor , ce qui permet de contrôler facilement le thread utilisé. Pour distribuer des événements via le thread principal de votre application, vous pouvez utiliser Context.getMainExecutor() .
Sinon, fournissez un Executor qui sera envoyé à un thread approprié. |
receiver |
OutcomeReceiver : cette valeur ne peut pas être null . |