Prise en main
Aperçu de l'OnSite API de Commanders Act Consent.
L'API Commanders Act Consent est utilisée pour interagir avec Commanders Act Consent via JavaScript. Elle propose actuellement uniquement des méthodes pour recevoir et mettre à jour le consentement, mais elle sera enrichie avec des méthodes supplémentaires à l'avenir.
Stub d'API
Il est nécessaire d'installer un stub JavaScript avant que l'une des méthodes de l'API OnSite puisse être utilisée. 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'API OnSite 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'API OnSite.
Si vous travaillez dans une grande équipe et n'êtes pas sûr que le stub ait déjà été installé, il est acceptable d'installer le stub JavaScript plusieurs fois.
Méthodes
Après avoir installé le stub, il est alors possible d'utiliser n'importe laquelle des méthodes de l'API OnSite via la window.cact fonction.
Chaque méthode suit une signature stricte :
cact(command, [options,] [callback])Argument
Descriptions
Requis
command
Un identifiant de type chaîne utilisé pour sélectionner la méthode souhaitée.
Requis
options
Un objet JavaScript qui inclut les données passées à la méthode.
Optionnel
callback
Une fonction de rappel JavaScript utilisée pour recevoir des informations ou des événements de l'API OnSite.
Optionnel
Ci-dessous vous trouverez un exemple de méthode utilisée pour recevoir le statut de consentement Commanders Act avec l'API OnSite. Cet exemple fournit uniquement 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'API OnSite sont appelées de manière asynchrone. Dans le cas, par exemple, où 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 ?