API JavaScript - Consentmanager Staging

Le CMP consentmanager.net 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 requêtes adressées à l'API, veuillez toujours utiliser uniquement les fonctions publiques mentionnées ci-dessous. Veuillez ne pas accéder directement à l'objet interne window.cmpmngr !

Pour envoyer ou recevoir des informations depuis/vers l'API, vous pouvez utiliser la fonction publique générale __cmp(...). Cette fonction peut traiter la plupart des requêtes génériques. En outre, le CMP propose également des fonctions publiques __tcfapi(...) pour la conformité IAB TCF v2 et __gpp(...) pour la conformité IAB GPP.

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 spécifications différentes auxquelles elles se conforment. Les fonctions API sont les suivantes :

__cmp( Command, Parameter, Callback, Async )

__tcfapi( Command, Version, Callback, Parameter )

__gpp( Command, Version, Callback, Parameter )

Supprimé : veuillez noter que la fonction __uspapi() n'existe plus et a été remplacée par la fonction __gpp().

Veuillez noter que pour __cmp() tous les paramètres, à l'exception de Command sont facultatifs.

Commandes

L'API prend en charge les commandes suivantes :

Veuillez noter que notre API peut renvoyer des objets aux commandes TCF v1+v2 qui diffèrent de la norme. Cliquez ici pour plus de détails.

Commande	Fonction	Description
`getTCData`	`__tcfapi()`	Obtenir l'objet de données de consentement conformément à la norme IAB TCF v2.
`noncompliant_getTCData`	`__tcfapi()`	Récupérer l'objet de données de consentement conformément à la norme IAB TCF v2 en cas de configuration non conforme du CMP.
`ping`	`__cmp()` `__tcfapi()` `__gpp()`	Selon la fonction utilisée : `__cmp('ping')` renverra false. `__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énements. Voir ci-dessus.
`getCMPData`	`__cmp()`	Récupère 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()`	Récupère la chaîne de consentement et les informations si l'utilisateur a fait un choix. L'objet d'état renvoyé ressemblera à ceci : `{'consentExists': true/false, 'consentData': '…'}` Veuillez noter que cela n'indique pas un consentement, mais seulement que l'utilisateur a fait un choix.
`setConsent`	`__cmp()`	Simule un clic de l'utilisateur sur « Tout accepter » (Paramètre = 1) ou « Tout refuser » (Paramètre = 0).
`setVendorConsent`	`__cmp()`	Définit le statut de consentement pour un fournisseur donné. L'ID du fournisseur et le statut doivent être transmis sous forme de tableau via le paramètre 2, par exemple `__cmp('setVendorConsent',['s30', 1 ])` définit le consentement (accepter) pour le fournisseur s30. Valeurs de statut possibles : 0 = refuser 1 = accepter 2 = refuser, ne pas compter 3 = accepter, ne pas compter
`setPurposeConsent`	`__cmp()`	Définit le statut de consentement pour une finalité donnée. L'ID de la finalité et le statut doivent être transmis sous forme de tableau via le paramètre 2, par exemple `__cmp('setPurposeConsent',[52, 1 ])` définit le consentement (accepter) pour la finalité 52. Si vous souhaitez définir le consentement pour une finalité et tous les fournisseurs associés à cette finalité, vous pouvez définir le troisième champ sur true, par exemple `__cmp('setPurposeConsent',[52, 1, true ])`
`exportConsent`	`__cmp()`	Exporte les informations de consentement pour le partage du consentement entre appareils.
`importConsent`	`__cmp()`	Importe les informations de consentement pour ce visiteur.
`cancelwait`	`__cmp()`	Empêche la CMP d'attendre les appels d'importation de consentement entrants.

`showScreen`	`__cmp()`	Affiche l'écran d'accueil (en fonction de la localisation du visiteur et de la configuration du compte).
`showScreenAdvanced`	`__cmp()`	Afficher le gestionnaire de préférences (en fonction de la localisation du visiteur et de la configuration du compte). Remarque : vous pouvez utiliser le deuxième paramètre pour indiquer quelle page doit s'ouvrir (par exemple, utilisez « c52 » pour ouvrir la page correspondant à la finalité c52).
`showCookies`	`__cmp()`	Afficher le tableau des cookies.
`close`	`__cmp()`	Fermer la couche de consentement.

`setAgeCallback`	`__cmp()`	Définir la fonction de rappel pour la vérification de l'âge.
`setUserID`	`__cmp()`	Définir l'ID utilisateur externe 1. `setUserID` Définit l'identifiant externe (ID 2, ID 3) sous lequel l'utilisateur est connu. `getUserID` et `setUserID` les deux renvoient un objet d'identifiant utilisateur : `{'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}` Remarque : l'identifiant 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 « settings » (voir Événements CMP).
`setUserID2`	`__cmp()`	Définir l'ID utilisateur externe 2
`setUserID3`	`__cmp()`	Définir l'ID utilisateur externe 3
`getUserID`	`__cmp()`	Récupérer tous les identifiants utilisateur
`checkBlocking`	`__cmp()`	Vérifie si les éléments bloqués peuvent être débloqués et les débloque.
`checkShowScreen`	`__cmp()`	Vérifie s'il faut afficher (à nouveau) la couche de consentement.

`privacyLink`	`__cmp()`	Redirige le visiteur vers la page de la politique de confidentialité.
`tacLink`	`__cmp()`	Redirige le visiteur vers la page des conditions générales.
`imprintLink`	`__cmp()`	Redirige le visiteur vers la page des mentions légales.

We do our best to keep this purely informative documentation up to date. However, if you notice that any of these guides need a little touch-up, let us know!