Info
Contenu
Livres
CMP
API JavaScript
API JavaScript

API JavaScript

Vue d'ensemble 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 n' 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 __gpp(...) pour la conformité IAB GPP.

Mise en situation :

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 )
__tcfapi( Command, Version, Callback, Parameter )
__gpp( Command, Version, Callback, Parameter )

Supprimé: Veuillez noter que __uspapi() n'existe plus et a été remplacé par __gpp().

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.

Command Fonction Description
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.
ping

__cmp()

__tcfapi()

__gpp()

Selon la fonction utilisée:

__cmp('ping') retournera faux.

__tcfapi('ping') renverra l'objet ping IAB TCF v2.

__gpp('ping',callback) renverra l'objet ping GPP.
addEventListener

__cmp()

__tcfapi()

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

__cmp()

__tcfapi()

 Supprime un écouteur d'événement. Voir au dessus.
getCMPData __cmp()

Obtenez un objet contenant toutes les données de consentement pertinentes.

{
 consentstring: "IAB TCF consent string", 
 uspstring: "IAB US Privacy String", 
 gdprApplies: true/false,
 hasGlobalScope: true/false, 
 tcfversion: 0/1/2, 
 tcfcompliant: true/false, 
 regulation: 0/1/2 (none / GDPR / CCPA), 
 purposeConsents: {},
 vendorConsents: {}, 
 purposeLI: {}, 
 vendorLI: {}
 googleVendorConsents: {}
}
   

 
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: {'consentExists': true/false, 'consentData': '…'}

Veuillez noter que cela ne 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. Valeurs d'état possibles :

0 = rejeter

1 = accepter

2 = rejeter, ne pas compter

3 = accepter, ne pas compter
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.

Si vous souhaitez définir le consentement pour un objectif et tous les fournisseurs affectés à cet objectif, vous pouvez définir le troisième champ sur vrai, par exemple

__cmp('setPurposeConsent',[52, 1, true ])
exportConsent __cmp() Exporte les informations de consentement pour partage de consentement entre appareils.
importConsent __cmp() Importe les informations de consentement pour ce visiteur.
cancelwait __cmp() Empêchez le CMP d'attendre les appels entrants d'importation de consentement.
     
showScreen __cmp() Afficher l'écran de bienvenue (selon l'emplacement des visiteurs / la configuration du compte).
showScreenAdvanced __cmp() Afficher le gestionnaire de préférences (en fonction de l'emplacement des visiteurs/de la configuration du compte). Remarque : Vous pouvez utiliser le deuxième paramètre pour indiquer quelle page doit être ouverte (par exemple, utilisez "c52" afin d'ouvrir la page pour l'objectif c52).
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.

setUserID définit l'ID externe (ID 2, ID 3) pour lequel l'utilisateur est connu. getUserID et mes setUserID les deux renvoient un objet ID utilisateur: {'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}
Remarque: l'ID utilisateur interne n'est disponible que s'il est activé dans les paramètres CMP et après le déclenchement de l'événement «paramètres» (voir Événements CMP).
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.
checkShowScreen __cmp() Vérifie s'il faut afficher la couche de consentement (à nouveau).
     
privacyLink __cmp() Redirige le visiteur vers la page de politique de confidentialité.
tacLink __cmp() Redirige le visiteur vers la page Conditions générales.
imprintLink __cmp() Redirige le visiteur vers la page des mentions légales / mentions légales.

 

Détails
Révision # 21
Créé 5 ans by Janvier
Le kit de préparation mis à jour il y a des mois 2 by Janvier
Navigation de Page
  • Utilisation de l'API
  • Fonctions API
  • Commandes
    • Pas encore de compte?

    Devenez conforme au GDPR avec notre cookie GDPR Consent Manager Solution. Essayez maintenant gratuitement!

    Cookie GDPR Consent Manager
    Retour en haut de la page