JavaScript-API

Hier beginnen: auf den Status warten

Die Cookiemark-Zeile steht ganz oben in Ihrem Head und läuft sofort, daher existiert window.Cookiemark für jedes Skript darunter. Die Auswahl des Besuchers steht etwas später fest, sobald die Seite eingelesen ist. Verwenden Sie das Event ready, um den Status beim Laden der Seite zu erfahren, und change, um zu verfolgen, was danach passiert.

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

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

Vor Ihrer ersten Veröffentlichung enthält das Skript nichts, und window.Cookiemark existiert nicht. Prüfen Sie, ob es vorhanden ist, bevor Sie es aufrufen, damit Ihr Code auch auf einer Website funktioniert, die noch ein Entwurf ist.

Eine Funktion, die Sie mit on('ready') hinzufügen, nachdem der Status bekannt ist, läuft sofort. Die anderen Events werden für spät hinzugefügte Listener nicht wiederholt. Zusammen verpassen ready und change nie etwas.

Jedes Event wird außerdem auf window als CustomEvent mit dem Präfix cookiemark: gesendet. Die Daten stehen in event.detail.

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

Eigenschaften

Alle Eigenschaften sind schreibgeschützt und zeigen immer den aktuellen Status.

declined ist auch bei einem neuen Besucher true, der noch nicht geantwortet hat, weil zu diesem Zeitpunkt nichts erlaubt ist. Prüfen Sie zusätzlich hasResponse, wenn Sie wissen müssen, dass der Besucher abgelehnt hat.

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

Methoden

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

Jede Auswahl, die Sie über die API speichern, ist eine echte Auswahl. Sie setzt das Cookie, landet im Einwilligungsprotokoll und gibt Skripte frei oder widerruft sie, genau wie ein Klick im Banner.

Events

Jeder Listener erhält dasselbe Objekt. consent enthält die vier Kategorien. action ist nach einer Auswahl accept_all, deny_all, custom, withdraw oder signal, sonst leer. first ist true, wenn es die erste Auswahl des Besuchers ist.

Die Listener-Warteschlange

window.cookiemarkListeners ist eine Warteschlange für Code, der vor dem Cookiemark-Skript laufen kann, etwa eine Vorlage in Tag Manager. Hängen Sie eine Funktion an. Cookiemark ruft sie auf, sobald die Auswahl bekannt ist, und nach jeder Änderung erneut.

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 }
});

Das erste Argument folgt der Zuordnung im Tab Google und GTM. Bei einem neuen Besucher ruft Cookiemark die Funktion auf, sobald er eine Auswahl trifft.

Markup, das das Skript versteht

Sie können eigene Schaltflächen und Links bauen, ohne JavaScript zu schreiben. Cookiemark verarbeitet einen Klick auf jedes Element mit diesen Attributen.

Cookiemark füllt außerdem Elemente mit den Daten des jeweiligen Besuchers. Weil das der Browser erledigt, bleibt die Seite selbst für alle gleich und kann gefahrlos gecacht werden.

<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>

Eine Seite mit der Cookie-Richtlinie ist ein guter Ort für die Einwilligungs-ID. Ein Besucher, der wissen möchte, wozu er zugestimmt hat, kann sie angeben, und Sie schlagen sie im Einwilligungsprotokoll nach.

Das Einwilligungs-Cookie

Cookiemark speichert die Auswahl in einem First-Party-Cookie namens cookiemark_consent. Sein Wert ist URL-kodiertes JSON wie dieses.

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

v ist die Einwilligungsversion und ts der Zeitpunkt der Auswahl in Sekunden. Ein Cookie mit einer älteren Einwilligungsversion zählt, als wäre keine Auswahl getroffen worden, daher erscheint das Banner erneut. Lesen Sie die Auswahl nach Möglichkeit über die API statt über das Cookie, denn die API berücksichtigt auch Regionen und Datenschutzsignale.

Die Cookiebot-API

Theme- und Plugin-Code, der für Cookiebot geschrieben wurde, fragt oft Cookiebot.consent.marketing ab oder hört auf CookiebotOnAccept. Aktivieren Sie im Tab Google und GTM die Option Auf die JavaScript-API von Cookiebot antworten, dann antwortet Cookiemark diesem Code. Cookiemark hält sich heraus, solange das echte Cookiebot-Skript noch auf der Seite ist.

Die Events CookiebotOnLoad, CookiebotOnConsentReady, CookiebotOnAccept, CookiebotOnDecline, CookiebotOnDialogInit, CookiebotOnDialogDisplay und CookiebotOnTagsExecuted werden auf window ausgelöst. Die älteren Callback-Funktionen wie CookiebotCallback_OnAccept werden ebenfalls aufgerufen.