Prise en main
Aperçu de l'OnSite API Commanders Act Consent.
L'API Commanders Act Consent est utilisée pour interagir avec Commanders Act Consent via JavaScript. Elle offre actuellement uniquement des méthodes pour recevoir et mettre à jour le consentement, mais elle sera améliorée avec des méthodes supplémentaires à l'avenir.
Stub API
Il est nécessaire d'installer un stub JavaScript avant de pouvoir utiliser l'une des méthodes de l'OnSite API. Le stub sert à mettre en tampon toutes les méthodes dans un tableau JavaScript jusqu'à ce que le JavaScript de la bannière Commanders Act consent soit chargé et prêt à traiter les méthodes. Cela permet d'utiliser l'OnSite API avant que la bannière Commanders Act Consent (fichier JavaScript) ne soit chargée.
window.caReady = window.caReady || [];
window.cact = function() { window.caReady.push(arguments); };window.caReady est un tableau JavaScript qui met en tampon les interactions avec l'API. window.cact est une fonction JavaScript utilisée pour interagir avec l'OnSite API.
Si vous travaillez dans une grande équipe et n'êtes pas sûr que le stub a déjà été installé, il est acceptable d'installer le JavaScript stub plusieurs fois.
Méthodes
Après l'installation du stub, il est alors possible d'utiliser n'importe laquelle des méthodes de l'OnSite API via le window.cact function.
Chaque méthode suit une signature stricte :
cact(command, [options,] [callback])command
Un identifiant chaîne utilisé pour sélectionner la méthode désirée.
Requis
options
Un objet JavaScript qui inclut les données transmises à la méthode.
Optionnel
callback
Une fonction de rappel JavaScript qui est utilisée pour recevoir des informations ou des événements de l'OnSite API.
Optionnel
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 ne fournit qu'un callback pour recevoir le consentement sans fournir d'options.
cact('consent.get', function (result) {
if (result.consent.status === "all-on") {
// Consentement disponible pour toutes les catégories.
}
});Les méthodes de l'OnSite API sont appelées de manière asynchrone. Dans le cas où, par exemple, vous auriez 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 ?