JavaScript-API
La consentmanager.net CMP prend en charge diverses API JavaScript afin de permettre aux sites Web de récupérer les informations de consentement.
Utilisation de l'API
Pour toutes les demandes adressées à l'API, veuillez toujours utiliser uniquement les fonctions publiques mentionnées ci-dessous. S'il vous plaît elle n'est pas accédez directement à l'objet window.cmpmngr interne!
Pour envoyer ou recevoir des informations de / vers l'API, vous pouvez utiliser la fonction grand public __cmp(...)
. Cette fonction peut gérer la plupart des requêtes génériques. En plus de cela, le CMP propose également des fonctions publiques __tcfapi(...)
pour la conformité IAB TCF v2 et __uspapi(...)
pour la conformité IAB US Privacy.
Exemple:
var x = __cmp('consentStatus');
if(x.consentExists){/* do something */}
Fonctions API
Les trois fonctions API utilisent des paramètres différents en raison des différentes spécifications que ces fonctions suivent. Les fonctions de l'API sont:
__cmp( Command, Parameter, Callback, Async )
__uspapi( Command, Version, Callback, Parameter )
__tcfapi( Command, Version, Callback, Parameter )
Veuillez noter que pour __cmp()
tous les paramètres sauf Command
sont optionnels.
Commandes
L'API prend en charge les commandes suivantes:
Veuillez noter que notre API peut renvoyer des objets aux commandes TCF v1 + v2, qui sont différents de la norme. Voir ici pour plus de détails.
commandement | Fonction | Description |
getVendorConsents |
__cmp() |
Obtenez l'objet de données de consentement du fournisseur selon IAB TCF v1. |
noncompliant_getVendorConsents |
__cmp() |
Obtenez l'objet de données de consentement du fournisseur selon IAB TCF v1 en cas de configuration non conforme du CMP. |
getConsentData |
__cmp() |
Obtention de l'objet de données de consentement selon IAB TCF v1. |
noncompliant_getConsentData |
__cmp() |
Obtenir l'objet de données de consentement selon IAB TCF v1 en cas de configuration non conforme du CMP. |
getTCData |
__tcfapi() |
Obtention de l'objet de données de consentement selon IAB TCF v2. |
noncompliant_getTCData |
__tcfapi() |
Obtenir l'objet de données de consentement selon IAB TCF v2 en cas de configuration non conforme du CMP. |
getUSPData |
__uspapi() |
Obtenez la chaîne de données de consentement conformément aux spécifications de confidentialité américaines de l'IAB. |
ping |
|
Selon la fonction utilisée:
|
addEventListener |
|
Ajoute un nouvel écouteur d'événements. Voir les détails ici. Veuillez noter que les paramètres dépendent de la fonction utilisée. |
removeEventListener |
|
Supprime un écouteur d'événement. Voir au dessus. |
getCMPData |
__cmp() |
Obtenez un objet contenant toutes les données de consentement pertinentes.
|
|
||
consentStatus |
__cmp() |
Obtenez une chaîne de consentement et des informations si le choix de l'utilisateur est donné. L'objet d'état renvoyé ressemblera à ceci: Veuillez noter que cela ne ne sont pas signalez votre consentement, mais seulement si l'utilisateur a fait un choix. |
setConsent |
__cmp() |
Simuler un utilisateur clique sur tout accepter (paramètre = 1) ou tout rejeter (paramètre = 0). |
setVendorConsent |
__cmp() |
Définit le statut de consentement pour un certain fournisseur. L'ID et le statut du fournisseur doivent être transmis en tant que tableau via le paramètre 2, par exemple __cmp('setVendorConsent',['s30', 1 ]) définit le consentement (accepter) pour le fournisseur s30. |
setPurposeConsent |
__cmp() |
Définit le statut de consentement pour un certain objectif. L'ID de fonction et l'état doivent être transmis en tant que tableau via le paramètre 2, par ex. __cmp('setPurposeConsent',[52, 1 ]) définit le consentement (accepter) à des fins 52. |
exportConsent |
__cmp() |
Exporte les informations de consentement pour partage de consentement entre appareils. |
importConsent |
__cmp() |
Importe les informations de consentement pour ce visiteur. |
showScreen |
__cmp() |
Afficher l'écran de bienvenue (selon l'emplacement des visiteurs / la configuration du compte). |
showGDPRScreen |
__cmp() |
Afficher l'écran de bienvenue pour le RGPD |
showCCPAScreen |
__cmp() |
Afficher l'écran de bienvenue pour CCPA |
showScreenAdvanced |
__cmp() |
Afficher le gestionnaire de préférences (en fonction de l'emplacement des visiteurs / de la configuration du compte). |
showGDPRScreenAdvanced |
__cmp() |
Afficher le gestionnaire de préférences pour le GDPR |
showGDPRScreenVendors |
__cmp() |
Afficher le gestionnaire de préférences pour GDPR> Page Tous les fournisseurs |
showCCPAScreenAdvanced |
__cmp() |
Afficher le gestionnaire de préférences pour CCPA |
showCookies |
__cmp() |
Afficher la table des cookies. |
close |
__cmp() |
Fermer la couche de consentement. |
setAgeCallback |
__cmp() |
Ensemble fonction de rappel pour la vérification de l'âge. |
setUserID |
__cmp() |
Définir l'ID utilisateur externe 1.
|
setUserID2 |
__cmp() |
Définir l'ID utilisateur externe 2 |
setUserID3 |
__cmp() |
Définir l'ID utilisateur externe 3 |
getUserID |
__cmp() |
Obtenez tous les ID utilisateur |
checkBlocking |
__cmp() |
Vérifie si les éléments bloqués peuvent être débloqués et les débloquer. |