Aperçu de l'OnSite API de consentement Commanders Act.
L'API Commanders Act Consent est utilisée pour interagir avec Commanders Act Consent en JavaScript. Elle ne propose actuellement que des méthodes pour recevoir et mettre à jour le consentement, mais elle sera améliorée à l'avenir avec des méthodes supplémentaires.
Il est nécessaire d'installer un stub JavaScript avant de pouvoir utiliser l'une des méthodes de l'OnSite API. Le stub est utilisé pour mettre en buffer toutes les méthodes dans un tableau JavaScript jusqu'à ce que le JavaScript de la bannière de consentement Commanders Act soit chargé et prêt à traiter les méthodes. Cela permet d'utiliser l'OnSite API avant que la bannière de consentement Commanders Act (fichier JavaScript) soit chargée.
window.caReady = window.caReady || [];
window.cact = function() { window.caReady.push(arguments); };window.caReady est un tableau JavaScript qui met en buffer les interactions avec l'API. window.cact est une fonction JavaScript utilisée pour interagir avec l'OnSite API.
Si vous travaillez au sein d'une grande équipe et n'êtes pas sûr que le stub ait déjà été installé, il est tout à fait acceptable d'installer le stub JavaScript plusieurs fois.
Après avoir installé le stub, il est alors possible d'utiliser n'importe laquelle des méthodes de l'OnSite API via le window.cact fonction.
Les méthodes disponibles sont répertoriées dans la documentation sous ONSITE API.
Chaque méthode suit une signature stricte :
cact(command, [options,] [callback])command
Un identifiant sous forme de chaîne utilisé pour sélectionner la méthode souhaitée.
Obligatoire
options
Un objet JavaScript qui inclut les données transmises à la méthode.
Facultatif
callback
Une fonction de rappel JavaScript utilisée pour recevoir des informations ou des événements de l'OnSite API.
Facultatif
Ci-dessous, vous trouverez un exemple de méthode utilisée pour recevoir le statut de consentement Commanders Act avec l'OnSite API. Cet exemple fournit uniquement une fonction de rappel pour recevoir le consentement, sans fournir d'options.
Les méthodes de l'OnSite API sont appelées de manière asynchrone. Si, par exemple, vous avez besoin d'informations de manière synchrone dans le <head> du document, il est recommandé de mettre en cache et de récupérer le résultat de l'API dans localStorage.
Mis à jour
Ce contenu vous a-t-il été utile ?
Ce contenu vous a-t-il été utile ?
cact('consent.get', function (result) {
if (result.consent.status === "all-on") {
// Consentement disponible pour toutes les catégories.
}
});