API Consent Ready

Ajoutez la balise UniConsent une seule fois, avec votre clé de licence. La balise définit deux fonctions immédiatement, puis charge la CMP complète en arrière-plan.

<script src="https://cmp.uniconsent.com/v2/cmp.js" data-license="YOUR_LICENSE"></script>

Vous trouverez votre clé de licence dans la section Installation et Configuration. Consultez Installer les tags UniConsent pour le Web pour le guide d'installation complet, y compris la balise classique en deux parties pour les installations existantes.

unicReady(callback)

Se déclenche une seule fois, lorsque l'état du consentement est définitif.

• RGPD et IAB TCF Canada : après que l'utilisateur a fait un choix, ou qu'un choix enregistré a été restauré.
• CCPA / lois des États américains / autres régions en opt-out : dès que la CMP est chargée.
• Bannières de catégories de consentement : après le choix dans votre région RGPD, ou partout lorsque le RGPD est configuré au niveau mondial, sauf en Californie lorsque CCPA est activé et au Canada lorsque IAB TCF Canada est activé. Ailleurs, dès le chargement de la CMP : vérifiez donc UNIC_EP_1 … UNIC_EP_4 avant de charger des tags de catégories soumises à consentement préalable.

Un abonnement après le déclenchement est rappelé immédiatement.

unicReady(function (status) {
  if (status.UNIC_P_1) {
    loadAnalytics();
  }
});

unicUpdate(callback)

Se déclenche en même temps que unicReady, puis à chaque changement de consentement (par exemple lorsque l'utilisateur rouvre les paramètres et modifie une finalité). Un abonnement tardif est rappelé immédiatement avec l'état actuel, puis à chaque changement ultérieur. Les enregistrements sans changement sont ignorés.

unicUpdate(function (status) {
  applyConsent(status);
});

Événements DOM

Les mêmes données sont émises sur window sous les noms unic:ready et unic:update. Enregistrez les écouteurs avant la balise afin qu'ils existent au moment du déclenchement.

window.addEventListener('unic:update', function (e) {
  applyConsent(e.detail);
});

Chargement synchrone

Placez votre code n'importe où après la balise. Rien d'autre n'est nécessaire.

<script src="https://cmp.uniconsent.com/v2/cmp.js" data-license="YOUR_LICENSE"></script>
<script>
  unicReady(function (status) { /* le consentement est définitif */ });
  unicUpdate(function (status) { /* chaque changement */ });
</script>

Chargement asynchrone

Avec async, votre code inline peut s'exécuter avant la balise. Ajoutez la garde de file d'attente en deux lignes pour que les appels anticipés soient rejoués une fois la balise chargée.

<script async src="https://cmp.uniconsent.com/v2/cmp.js" data-license="YOUR_LICENSE"></script>
<script>
  window.unicReady  = window.unicReady  || function (cb) { (window.unicReady.q  = window.unicReady.q  || []).push(cb); };
  window.unicUpdate = window.unicUpdate || function (cb) { (window.unicUpdate.q = window.unicUpdate.q || []).push(cb); };

  unicReady(function (status) { /* le consentement est définitif */ });
  unicUpdate(function (status) { /* chaque changement */ });
</script>

Objet status

Remarques

• unicReady et unicUpdate sont des noms réservés sur window. Ne définissez pas de fonctions portant ces noms à d'autres fins.
• Les callbacks sont encapsulés dans un try/catch. Une erreur dans l'un n'arrête pas les autres.
• Les deux fonctions acceptent un nombre illimité d'abonnés.
• La balise s'ignore elle-même si le script de la CMP est déjà présent sur la page.
• La balise définit une valeur par défaut Google Consent Mode avec tout le stockage refusé et un wait_for_update de 3 secondes. Si vous définissez déjà vos propres valeurs par défaut de Consent Mode, placez-les après la balise, sinon elles seront écrasées.

Voir aussi

• Installer les tags UniConsent pour le Web
• UniConsent JavaScript API
• Intégration des Balises JavaScript Tierces
• Google Consent Mode

Vous avez encore des questions ?

Contactez-nous : support@uniconsent.com