Skip to main content

Entwickler

Dokumentation für Webseitenentwickler​

Hier findest du eine Dokumentation der technischen Details des Banners, wenn du zum Beispiel auf bestimmte Events reagieren oder den Status der Einwilligung abfragen willst.

Der Banner setzt, je nach Auswahl durch den Benutzer, bestimmte Cookies. Diese werden entweder als First-Party Cookie gesetzt oder in den Local Storage geschrieben (das kann in den erweiterten Einstellungen des Consent Banners konfiguriert werden). Standardmäßig werden die Consent Cookies als First-Party Cookie abgelegt.

cookieconsent_status:​

Dieses Cookie kann nur die Werte "allow" oder "deny" enthalten und beschreibt das Standardverhalten des Banners:

  • allow bedeutet, dass der Benutzer "Alles erlauben" ausgewählt hat. Das cookieconsent_mode Cookie wird dann eigentlich gar nicht mehr benötigt, da zu allem zugestimmt wurde.
  • deny bedeutet, dass der Benutzer entweder "Nur technisch erforderliche" Cookies oder eine benutzerdefinierte Auswahl getroffen hat. Hier findet man die erlaubten Kategorien im Cookie cookieconsent_mode.

cookieconsent_mode:​

In diesem Cookie werden die eingewilligten Kategorien als JSON-kodiertes Array aus Strings abgelegt.

Die Strings können folgende Werte enthalten:

  • statistic: Cookies die zu Analysezwecken verwendet werden (etwa Matomo oder Google Analytics) sind erlaubt
  • marketing: Cookies die zu Marketingzwecken verwendet werden (etwa Werbetracking oder Profilerstellung) sind erlaubt
  • unclassified: Cookies die von uns noch nicht klassifiziert wurden sind erlaubt.

Der Benutzer klickt auf "Alles erlauben":

cookieconsent_status = allow
cookieconsent_mode = ["statistic", "marketing", "unclassified"]

Der Benutzer klickt auf "Nur notwendige":

cookieconsent_status = deny
cookieconsent_mode = []

Der Benutzer wählt nur "Statistik" und klickt auf "Übernehmen":

cookieconsent_status = deny
cookieconsent_mode = ["statistic"]

Für die Verwendung dieser Funktion muss der Banner auf der Seite eingebunden sein.

Mit dem Aufruf der Funktion

<script>
  var status = window.cookieconsent.currentConsentStatus();
</script>

wird der aktuelle Consent-Status ermittelt und als JSON Objekt zurückgegeben. Dieses Objekt hat die folgenden Inhalte:

{
  "tech": true,  // technisch erforderliche Cookies erlaubt (ist immer true)
  "preferences": true, // preferences (oder performance) Cookies erlaubt
  "statistic": true, // Statistik erlaubt
  "marketing": false, // Marketing ist nicht eingewilligt
  "unknown": false, // Unclassified ist nicht eingewilligt
  "drAllow": false, // true wenn cookieconsent_status === allow
  "drDeny": false // true wenn cookieconsent_status === deny
}

Wenn du darauf reagieren musst wenn sich der Consent-Status ändert, kannst du bei der Konfiguration des Banners folgende Callbacks definieren:

<link href="https://webcache-eu.datareporter.eu/c/<ids>/banner.css" rel="stylesheet">
<script src="https://webcache-eu.datareporter.eu/c/<ids>/banner.js" type="text/javascript" charset="utf-8"></script>
<script>
  // set callback hooks
  dr_cookiebanner_options.dr_onEnableCookies = function(enable) {
    if (enable) {
      // insert code here that enables cookies
      console.log("Enable Cookies");
    } else {
      // insert code here that disables cookies
      console.log("Disable Cookies")
    }
  }

  // show cookiebanner
  window.cookieconsent.initialise(dr_cookiebanner_options);
<script>

Enable / Disable bezieht sich dabei auf den allow / deny Status des cookieconsent_status Cookies.

Wenn du genauere Informationen über den Einwilligungsstatus benötigst, kannst du in den Handlern natürlich die Funktion window.cookieconsent.currentConsentStatus(), wie oben beschrieben, verwenden.

Eigene Plugins für CMS, Shopsysteme, etc. entwickeln​

Eine Anleitung zur Entwicklung von Plugins kannst du hier auf Github einsehen:

https://github.com/datareporter-gmbh/integration-webcare