Leading Consent Management Platform

Compliant with GDPR, CCPA, COPPA, LGPD, PECR, PDPA, PIPEDA, and more.

Consent Ready API

Aggiungi il tag di UniConsent una sola volta, con la tua chiave di licenza. Il tag definisce subito due funzioni e poi carica la CMP completa in background.

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

Trovi la tua chiave di licenza nella sezione Install & Setup. Consulta Installare i tag di UniConsent per il web per la guida completa all'installazione, incluso il classico tag in due parti per le installazioni esistenti.

unicReady(callback)

Viene attivata una sola volta, quando lo stato del consenso è definitivo.

  • GDPR e IAB TCF Canada: dopo che l'utente ha fatto una scelta o quando viene ripristinata una scelta memorizzata.
  • CCPA / leggi degli stati USA / altre regioni opt-out: non appena la CMP viene caricata.
  • Banner delle categorie di consenso: dopo la scelta nella tua regione GDPR, oppure ovunque quando il GDPR è impostato a livello mondiale, tranne in California quando CCPA è attivo e in Canada quando IAB TCF Canada è attivo. Altrove, appena la CMP viene caricata, quindi controlla da UNIC_EP_1 a UNIC_EP_4 prima di caricare tag di categorie che richiedono il consenso preventivo.

Se ti iscrivi dopo che è già stata attivata, la callback viene chiamata immediatamente.

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

unicUpdate(callback)

Viene attivata nello stesso momento di unicReady e di nuovo dopo ogni modifica del consenso (ad esempio quando l'utente riapre le impostazioni e modifica una finalità). Se ti iscrivi in ritardo, la callback viene chiamata subito con lo stato corrente e poi a ogni modifica successiva. I salvataggi che non modificano nulla vengono ignorati.

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

Eventi DOM

Gli stessi dati vengono inviati su window come unic:ready e unic:update. Registra i listener prima del tag, in modo che esistano quando gli eventi vengono attivati.

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

Caricamento sincrono

Inserisci il tuo codice in qualsiasi punto dopo il tag. Non serve altro.

<script src="https://cmp.uniconsent.com/v2/cmp.js" data-license="YOUR_LICENSE"></script>
<script>
  unicReady(function (status) { /* consent is final */ });
  unicUpdate(function (status) { /* every change */ });
</script>

Caricamento asincrono

Con async, il tuo codice inline potrebbe essere eseguito prima del tag. Aggiungi le due righe di protezione con coda, in modo che le chiamate effettuate in anticipo vengano rieseguite una volta caricato il tag.

<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) { /* consent is final */ });
  unicUpdate(function (status) { /* every change */ });
</script>

Oggetto di stato

CampoTipoSignificato
IS_LOADbooleanDove si applica IAB TCF, true solo quando il visitatore consente l'archiviazione o un fornitore personalizzato: false prima di una scelta e dopo un rifiuto. Sempre true dove IAB TCF non si applica. Le scelte delle categorie di consenso e gli opt-out negli Stati Uniti non lo modificano; usa da UNIC_EP_1 a UNIC_EP_4 e gli indicatori delle finalità per decidere quali tag caricare
LOCstringPosizione rilevata dell'utente
GEOstringRegione le cui regole si applicano: EU, CA, USCA, uno stato USA come USTX, US, BR, CN, ZA, VN, oppure N se nessuna
EU, US, CA, BR, CN, NbooleanIl flag indicato da GEO è true, ad esempio USTX. I banner con categorie di consenso attivano anche ciascuno dei propri flag di regione
NPA0 o 11 quando devono essere pubblicati solo annunci non personalizzati
customVendorsobjectID del fornitore personalizzato associato al consenso booleano
UNIC_CP_{id}booleanLe tue finalità personalizzate, per ID
UNIC_P_1 … UNIC_P_10booleanFinalità IAB TCF da 1 a 10. Fuori da IAB TCF seguono la policy applicabile: le finalità pubblicitarie si disattivano dopo un opt-out USA
UNIC_SF_1, UNIC_SF_2booleanFunzionalità speciali TCF (solo GDPR)
UNIC_EP_1 … UNIC_EP_4booleanCategorie di consenso da 1 a 4, impostate in ogni regione. Dove si applica IAB TCF seguono le sue finalità, e la categoria 4 (marketing) si disattiva dopo un opt-out USA

Note

  • unicReady e unicUpdate sono nomi riservati su window. Non definire funzioni con questi nomi per altri scopi.
  • Le callback sono racchiuse in try/catch. Un errore in una non blocca le altre.
  • Entrambe le funzioni accettano un numero qualsiasi di iscritti.
  • Il tag si ignora se lo script della CMP è già presente nella pagina.
  • Il tag imposta un valore predefinito di Google Consent Mode con tutti gli storage negati e un wait_for_update di 3 secondi. Se imposti già i tuoi valori predefiniti di Consent Mode, inseriscili dopo il tag, altrimenti verranno sovrascritti.

Risorse correlate

Hai ancora domande?

Contattaci: support@uniconsent.com