API JavaScript

Inizia da qui: aspetta lo stato

La riga di Cookiemark è la prima nel tuo head e parte subito, quindi window.Cookiemark esiste per ogni script che sta sotto. La scelta del visitatore si conosce poco dopo, quando la pagina è stata letta. Usa l'evento ready per conoscere lo stato al caricamento della pagina e change per seguire quello che succede dopo.

Cookiemark.on('ready', function (detail) {
  if (detail.consent.statistics) {
    startMyAnalytics();
  }
});

Cookiemark.on('change', function (detail) {
  if (detail.consent.marketing) {
    loadChatWidget();
  }
});

Prima della tua prima pubblicazione lo script non contiene niente e window.Cookiemark non esiste. Verifica che esista prima di chiamarlo, così il tuo codice funziona anche su un sito ancora in bozza.

Una funzione che aggiungi con on('ready') dopo che lo stato è noto parte subito. Gli altri eventi non vengono ripetuti per i listener aggiunti in ritardo. Insieme, ready e change non perdono mai nulla.

Ogni evento viene inviato anche su window come CustomEvent con il prefisso cookiemark:. I dati sono in event.detail.

window.addEventListener('cookiemark:change', function (event) {
  console.log(event.detail.action, event.detail.consent);
});

Proprietà

Tutte le proprietà sono di sola lettura e mostrano sempre lo stato attuale.

declined è true anche per un nuovo visitatore che non ha ancora risposto, perché in quel momento non è consentito niente. Controlla anche hasResponse quando ti serve sapere che il visitatore ha detto no.

if (Cookiemark.hasResponse && Cookiemark.declined) {
  // The visitor chose to reject everything.
}

Metodi

Cookiemark.submitConsent({ preferences: true, statistics: true, marketing: false });

Ogni scelta che salvi tramite l'API è una scelta a tutti gli effetti. Imposta il cookie, finisce nel registro dei consensi e sblocca o revoca gli script, esattamente come un clic nel banner.

Eventi

Ogni listener riceve lo stesso oggetto. consent contiene le quattro categorie. action vale accept_all, deny_all, custom, withdraw o signal dopo una scelta, ed è vuoto negli altri casi. first è true quando si tratta della prima scelta del visitatore.

La coda dei listener

window.cookiemarkListeners è una coda per il codice che potrebbe partire prima dello script di Cookiemark, come un modello di Tag Manager. Aggiungi una funzione alla coda. Cookiemark la chiama quando la scelta è nota, e di nuovo dopo ogni modifica.

window.cookiemarkListeners = window.cookiemarkListeners || [];
window.cookiemarkListeners.push(function (googleState, categories) {
  // googleState: { analytics_storage: 'granted', ad_storage: 'denied', ... }
  // categories:  { necessary: true, preferences: false, statistics: true, marketing: false }
});

Il primo argomento segue l'associazione nella scheda Google e GTM. Per un nuovo visitatore, Cookiemark chiama la funzione quando sceglie.

Markup che lo script capisce

Puoi creare pulsanti e link tuoi senza scrivere JavaScript. Cookiemark gestisce un clic su qualsiasi elemento con questi attributi.

Cookiemark compila anche elementi con i dati del visitatore. Dato che è il browser a farlo, la pagina resta uguale per tutti e si può mettere in cache senza problemi.

<a href="#cookiemark-preferences">Cookie settings</a>
<button type="button" data-cookiemark-action="withdraw">Withdraw my consent</button>
<button type="button" data-cmk-allow="marketing">Allow marketing cookies</button>

<p>Your consent ID: <span data-cookiemark-consent-id></span></p>
<p>Chosen on: <span data-cookiemark-consent-date></span></p>

La pagina dell'informativa sui cookie è un buon posto per l'ID di consenso. Un visitatore che chiede a cosa ha acconsentito può indicartelo e tu lo cerchi nel registro dei consensi.

Il cookie di consenso

Cookiemark salva la scelta in un cookie di prima parte chiamato cookiemark_consent. Il suo valore è JSON con codifica URL, come questo.

{"necessary":true,"preferences":false,"statistics":true,"marketing":false,
 "v":1,"id":"0b0f6c1e-3d0a-4c54-9f0e-2f1c8a4e7b11","ts":1791974400}

v è la versione del consenso e ts l'ora della scelta in secondi. Un cookie con una versione del consenso più vecchia conta come nessuna scelta, quindi il banner ricompare. Dove puoi, leggi la scelta tramite l'API invece che dal cookie, perché l'API conosce anche le regioni e i segnali di privacy.

L'API Cookiebot

Il codice di temi e plugin scritto per Cookiebot spesso interroga Cookiebot.consent.marketing o resta in ascolto di CookiebotOnAccept. Attiva Rispondi all'API JavaScript di Cookiebot nella scheda Google e GTM e Cookiemark risponde a quel codice. Si fa da parte quando sulla pagina c'è ancora il vero script di Cookiebot.

Gli eventi CookiebotOnLoad, CookiebotOnConsentReady, CookiebotOnAccept, CookiebotOnDecline, CookiebotOnDialogInit, CookiebotOnDialogDisplay e CookiebotOnTagsExecuted vengono attivati su window. Vengono chiamate anche le vecchie funzioni di callback come CookiebotCallback_OnAccept.