Cookie & Tracking Plugin (Cookie Banner) für xt:Commerce
DSGVO und EuGH konformes Plugin zu korrekten Einbindung aller Tracking Codes und Cookies inkl. der entsprechenden Cookie Einwilligungen.
Kurz und knapp — Fakten:
- Cookie Informationsbanner (Cookie Einwilligung)
- Jedes Cookie kann Pflichtfeld oder vorausgewählt sein
- Speicherung der Zustimmung zu Cookies mit Datum und IP
- Cookies können in Kategorien zusammengefasst werden (z.B. Notwendig, Marketing etc.)
- Integration aller Tracking Codes möglich (z.B. Google Analytics, Adwords etc.)
- Google Einwilligunsmodus integriert (Consent Mode V2)
Kompatibilität
Das Plugin ist für das Shopsystem xt:Commerce entwickelt und für die folgenden Versionen getestet:
5 & 6
Hinweis: Eine optimale Darstellung kann nur im Standard-Template des Shopsystems gewährleistet werden. Sollten Sie ein eigenes oder modifiziertes Template einsetzen, müssen Sie ggf. Änderungen am Template für die Integration vornehmen.
Ioncube: Sie benötigen für unsere Plugins eine aktuelle Ioncube Version. Es gibt keinen Grund eine veraltete Ioncube Version auf dem Server ein zu setzen, da diese stets abwärtskompatibel sind.
Cookie-Einwilligung und Tracking Code Integration
Die EU-Datenschutz Grundverordnung (DSGVO) und das Urteil vom Europäischen Gerichtshof (EuGH) schreiben vor, dass Tracking Cookies nur noch mit ausdrücklicher Einwilligung des Nutzers gesetzt werden dürfen.
Mit unserem Plugin kannst du selbst bestimmen, wie detailliert du deine Kunden über den Einsatz von Cookies in deinem Webshop informierst. Du legst selbst fest welche und wie viele Kategorien und Cookies es gibt und welchen davon der Besucher zustimmen muss. Dabei kannst du ganz einfach jeden Tracking Code wie z.B. google Analytics oder Adwords über dein Shopbackend selbst anlegen und einfügen und das ganz ohne Programmierkenntnisse. Deine Tracking Codes ordnest du in Kategorien deiner Wahl ein (z.B. Notwendig, Statistik, Marketing) und bestimmst selbst welchen davon zugestimmt werden muss. Das Cookie Informationsbanner kannst du entweder ganz oben im Shop, ganz unten oder mittig anzeigen lassen. Selbstverständlich kannst du das Erscheinungsbild weiter mit CSS anpassen wenn du möchtest.
Kein lästiges fummeln im Code mehr
Alle deine Tracking Codes können über das Cookie Plugin für xt:Commerce eingebunden werden. Ein schöner Nebeneffekt davon ist, dass du nicht mehr zwangsläufig Anpassungen an deinem Template (Code) vornehmen musst, sondern alle Tracking Codes bequem über den Adminbereich verwaltest. Möchtest du irgendwann einen bestimmen Tracking Code nicht mehr nutzen, deaktivierst oder löscht du ihn einfach und der entsprechende Cookie Hinweis dazu erscheint auch nicht mehr.
Standardmäßig sind Hookpoints zum integrieren deiner Tracking Codes an folgenden Stellen vorhanden:
- Header
- Body oben, unten
- Produkt
- Warenkorb
- Checkout: Versandkosten, Zahlungsarten, Überblick/Bestätigung, Bestellung abgeschlossen,
- Kunde: Login/Kudenaccount erstellen, übersicht Bestellungen
Wenn dir die vorhandenen Hookpoints nicht ausreichen, kannst du ganz einfach eigene Hookpoints über das Plugin anlegen und an beliebigen Stellen im Template einfügen. So kannst du selbst komplexe und individuelle Tracking Codes integrieren und diese sind immer automatisch im Cookie Banner enthalten.
Anbindung an Google Analytics, Conversion Tracking & Facebook Pixel Plugin
Das Plugin kann direkt an die folgenden Plugins angebunden werden und diese werden dann entsprechend im Cookie Banner berücksichtigt:
- Facebook Pixel Plugin
- xt:Commerce Google Analytics (xt_googleanalytics und xt_ga4)
- xt:Commerce Google Conversion Tracking (xt_google_ct)
Der Google Einwilligunsmodus ist bereits integriert und kann genutzt werden (Google Consent Mode V2).
Das Plugin kann für 21-Tage kostenfrei getestet werden! kostenfrei Testen
Downloads
Bitte achten Sie darauf, dass Sie das Plugin mit der passenden PHP Version für Ihren Shop downloaden.
Ihre PHP Version können Sie im Adminbereich
unter: System -> phpinfo einsehen.
Hinweis: Unsere Plugins werden für folgende PHP/ionCube Versionen verschlüsselt:
- PHP 7.4 bis PHP 8.3
Kompatibilität
Das Plugin ist für das Shopsystem xt:Commerce entwickelt und für die folgenden Versionen getestet:
5 & 6
Hinweis: Eine optimale Darstellung kann nur im Standard-Template des Shopsystems gewährleistet werden. Sollten Sie ein eigenes oder modifiziertes Template einsetzen, müssen Sie ggf. Änderungen am Template für die Integration vornehmen.
Ioncube: Sie benötigen für unsere Plugins eine aktuelle Ioncube Version. Es gibt keinen Grund eine veraltete Ioncube Version auf dem Server ein zu setzen, da diese stets abwärtskompatibel sind.
Installation
Vor der Installation eines Plugins sollten stets alle Daten gesichert werden. Besonders wichtig ist die Shopdatenbank.
Ablauf der Installation:
- Backup (Sicherung) des Shopsystems erstellen.
- Das Plugin entpacken und die entpackten Daten (Plugin Name) per FTP auf den Server in den Ordner: /plugins des Shops hochladen.
Hinweis: Überprüfen Sie das wirklich alle Dateien (achten Sie auch auf mögliche .htaccess-Dateien) korrekt hochgeladen wurden. - Die Lizenz-Datei des Plugins (Plugin Name.txt) per FTP in den Ordner /lic des Shops hochladen. Ohne Lizenz-Datei ist das Plugin nicht funktionsfähig!
- Im Adminbereich des Shops das Plugin über den Menüpunkt: Inhalte -> Plugin -> deinstallierte Plugins installieren.
- Im Adminbereich des Shops das Plugin über den Menüpunkt: Inhalte -> Plugins -> installierte Plugins aktivieren (ggf. auch für den jeweiligen Mandanten).
- Zuletzt muss noch der komplette Adminbereich neu geladen werden. Dies geht über den "neu laden" -Button Ihres Browsers oder z.B. die F5-Taste.
- Weitere Informationen und eine Anleitung finden Sie weiter unten.
Integration & Konfiguration
Das Cookie Tracking Plugin muss sorgfälltig eingerichtet werden, damit es korrekt arbeiten kann. Jeder Cookie (Tracking Code) im Shop muss über das Cookie Plugin eingebunden werden, damit Sie ihrer Informationspflicht nachkommen. Achten Sie darauf keine Tracking Codes außerhalb des Plugins z.B. direkt in das Template ein zu binden.
Wenn keine Cookie Kategorien und Tracking Codes angelegt wurden, wird ein einfacher Cookie-Hinweis angezeigt. Über die im Cooke und Tracking Plugin bereitgestellten Hookpoints können überall im Shop Tracking Codes direkt über den Adminbereich eingebunden werden. Zusätzlich können beliebig eigene Hookpoints erzeugt und in das Template eingebunden werden.
Plugin Konfiguration
- Plugin aktivieren: Aktiviert das Plugin für den jeweiligen Mandanten
- Cookie Name: Der Name des Cookie in dem die Daten für die Cookie-Einwilligung gespeichert werden. Eine Veränderung des Namens bewirkt das alle Webseitenbesucher erneut die Cookie-Hinweise angezeigt bekommen. Dies ist nützlich wenn Änderungen vorgenommen wurden und der Besucher den neuen Bedingungen zustimmen muss.
- Cookie Ablaufzeit in Tagen: Standard 30. Gibt an (in Tagen) wie lange die Cookie-Einwilligung gültig ist. Nach Ablauf werden alle Hinweise erneut angezeigt.
- Beschreibung anzeigen: Allgemeine Cookie-Informationen und Link zur Datenschutzerklärung anzeigen
- Position: Das Cookie-Banner kann oben, unten oder Fullscreen angezeigt werden
- Datenschutzerklärung Content-ID: Content-ID für die Datenschutzerklärung
Plugin Einstellungen (Menüs)
Das Plugin besteht grundsätzlich aus 4 Bereichen: Cookie Kategorien, Tracking Codes, Hookpoints und die Logs. Das Plugin-Menü ist im Shopbackend unter "Einstellungen -> Cookies & Tracking" zu finden.
Cookie Kategorien:
Über die Kategorien können Tracking Codes (Cookies) zusammengefasst werden. In der Regel gibt es mehrere Tracking Codes die in die gleiche Kategorie (z.B. Marketing, Tracking oder erforderlich) gehören und somit gemeinsam und gebündelt dargestellt werden können. Dies vereinfacht nicht nur die optische Darstellung sondern macht es auch für den Webseitenbesucher übersichtlicher.
Hinweis: Das Plugin basiert auf den Kategorien, jeder Tracking Code sollte also einer Kategorie zugeordnet sein.
Tracking Codes in einer Kategorie können jeweils mit einem Klick zusammen bestätigt werden. Das ist nützlich, damit der Besucher nicht jeden Code einzeln anklicken muss.
Einstellungen:
- Reihenfolge: Anzeige Reihenfolge im Frontend
- Vorausgewählt: Die Tracking Codes sind automatisch vorausgewählt
- Pflichtfeld: Tracking Codes müssen bestätigt werden
- Details direkt anzeigen: sorgt dafür dass die "Beschreibung Zusatz" und einzelnen Cookies direkt angezeigt werden.
- Name: Kategorie Name
- Beschreibung: Wird unterhalb des Namens angezeigt
- Beschreibung Zusatz: Wird nach klick auf "(mehr anzeigen)" geladen oder wenn "Details direkt anzeigen" aktiv ist.
Hinweis: Die Einstellungen "Vorausgewählt und Pflichtfeld" sind sowohl auf Kategorie-Ebene als auch auf Tracking Code Ebene vorhanden. Entscheiden Sie sich vorher ob Sie es global pro Kategorie oder auf Code Ebene vergeben möchten.
Tracking Codes:
Hier werden die einzelnen Tracking Codes (z.B. Google Analytics) eingebunden, die einen Cookie setzen. Natürlich können auch Tracking Codes oder allgemeiner Code eingebunden werden, der kein Cookie setzt.
Jeder Tracking Code wird einzeln im Cookie-Banner angezeigt und muss je nach Einstellunge bestätigt werden.
Einstellungen:
- Kategorie: Zuordnung zur Cookie Kategorie
- Position: Ausgabepunkt im Shop (Hookpoint) wo der Tracking Code ausgegeben wird. Es können die vordefinierten Hookpoints genutzt werden oder eigene erstellt werden (siehe Abschnitt: Hookpoints)
- Pflichtfeld: Wenn aktiv, muss der Tracking Code zwingend bestätigt werden.
- Vorausgewählt: Der Tracking Code ist bereits automatisch vorausgewählt
- Name: Tracking Code Name
- Beschreibung: Zusatzinfos für den Tracking Code
- Code: Hier wird das Code-Snippet (in der Regel Javascript) eingefügt, dass am entsprechenden Hookpoint ausgegeben werden soll.
Hier würde also z.B. der Google Analytics Code hingehören.
Wichtig: Achten Sie darauf den Code korrekt ein zu geben. Der Code wird direkt so wie er hier eingegeben wurde im Template ausgegeben.
Hookpoints:
Es sind bereits eine ganze Reihe an wichtigen Hookpoints, die für die Integration von gängigen Tracking Codes ausreichen sollten, vorhanden. Wenn Sie weitere Hookpoints benötigen, können Sie diese hier erzeugen und im Template einbinden. Ein Hookpoint ist nichts anderes als ein Verweis zu der Stelle wo der Tracking Code eingefügt werden soll.
Ebenso können vorhandenen Hookpoints aus dem Shopcore genutzt werden und hier (sofern noch nicht vorhanden) einfach angelegt werden.
Eigene Hookpoints können an beliebiger Stelle im Template eingebunden werden. Ein Hookpoint im Template sieht wie folgt aus:
{hook key=meinHookpoint}
Beispiel:
Sie erzeugen im Backend einen Hookpoint mit dem Namen "Mein Hookpoint". Als Hookpoint vergeben Sie "meinHookpoint".
Diesen Hookpoint können Sie nun an beliebiger Stelle im Template einfügen: {hook key=meinHookpoint} und jeder diesem Hookpoint zugeordnete Tracking Code wird dort ausgegeben und natürlich vom Cookie Tracking Plugin entsprechend berücksichtigt.
Logfiles:
Das Plugin Logt alle Cookie Bestätigungen automatisch mit und speichert diese in der Datenbank.
Achtung: Wenn Sie das Plugin deinstallieren, werden alle Daten und Logfiles gelöscht!
Es werden die folgenden Daten gespeichert:
- Eindeutige User ID
- Datum und Uhrzeit
- IP-Adresse
- Welche Cookies bestätigt wurden
Falls keine IP-Adresse ermittelt werden kann, wird "unknown" gespeichert.
Falls keine Tracking Codes und Kategorien vorhanden sind und nur das allgemeine Infobanner angezeigt wird, wird "accept_cookies|ok" gespeichert.
Es werden nur Cookies aufgelistet denen zugestimmt wurde.
Facebook Pixel, Google Analytics & Conversion Tracking Integration
Das Cookie & Tracking Plugin kann mit folgenden Plugins verknüpft werden:
- Facebook Pixel Plugin
- xt:Commerce Google Analytics (xt_googleanalytics)
- xt:Commerce Google Conversion Tracking (xt_google_ct)
Um Facebook Pixel Plugin zu verknüpfen muss es mindestens in der Version 1.3.0 installiert sein.
Verknüpfung:
Erstellen Sie im Cookie & Tracking Plugin für xt:Commerce einen neuen Tracking Code mit den folgenden Daten:
- Status: an
- Kategorie: beliebige Kategorie
- Position (Hook): Facebook Pixel / Google Analytics / Google Conversion Tracking
- Name: Frei vergeben (z.B. Facebook Pixel Tracking)
Nun sind die beiden Plugins verknüpft und das Plugin ist nur nach Zustimmung des Cookie-Baner aktiv.
Hinweis: Aus Sicherheitsgründen wird das Google Analytics und Conversion Tracking Plugin automatisch deaktiviert, sobald das Cookie & Tracking Plugin aktiv ist. Es können trotzdem nach wie vor alle Einstellungen im jeweiligen Plugin vorgenommen werden.
Template
Im Template kann abgefragt werden ob einem entsprechenden Cookie zugestimmt wurde. Das ist z.B. nützlich, wenn man einen Tracking Code erst nach Zustimmung ausführen möchte.
Beispiel im Template:
{foreach from=$ad_ct_trackingCodes item=code_id} {if $code_id == "1"} wert {$code_id} gefunden! {/if} {/foreach}
Wobei "code_id" für die ID des jeweiligen Tracking Codes steht. Zu finden unter Admin -> Einstellungen -> Cookies & Tracking -> Tracking Codes
Weitere Anpassungen
Anpassungen am Design (CSS)
Grundsätzlich können Sie das Plugin optisch frei nach Ihren Wünschen anpassen, ohne dass Sie Dateien des Plugins "Plugin Name" verändern müssen. Das hat den Vorteil, dass bei einem Update keine Dateien überschrieben und Änderungen verloren gehen.
CSS Anpassungen:
Sie können die gewünschten CSS-Regeln in Ihre CSS-Datei des aktiven Templates einfügen und beeinflussen. Regeln in Ihrer eigenen CSS-Datei werden die Regeln im Plugin überschreiben.
Erweiterte Anpassungen:
Darüber hinaus können Sie die Template-Datei des Plugins in Ihr eigenes Template kopieren und so auch dieses anpassen. Sie können auch die Template-Dateien direkt im Plugin ändern, wir empfehlen aber das Vorgehen wie zuvor beschrieben.
Gehen Sie zum kopieren der Template-Dateien (sofern im Plugin vorhanden) wie folgt vor:
- Kopieren aller Dateien im Ordner: plugins/Plugin Name/templates/
- Einfügen in: templates/[MY_TEMPLATE]/plugins/Plugin Name/
Achtung: Unsachgemäße Änderungen an der Template-Datei (auch in Ihrem eigenem Template) können dazu führen, dass das Plugin oder der Shop nicht mehr korrekt funktionieren.
Language Keys (Sprachtexte)
Wenn Sie Texte im Shop (Template) ausgeben möchten oder vorhandenen bearbeiten möchten, wird das am besten über die sog. Language Keys realisiert. Das hat den Vorteil das diese mehrsprachig angelegt werden können und außerdem über den Adminbereich verwaltet werden.
Die Language Keys finden Sie hier: Einstellungen -> Lokalisierung -> Sprachtexte
Über den Button "Neu" können Sie einen neuen Language Key anlegen.
Über den "Bearbeiten" Button können vorhandene Texte angepasst werden.
Bei "Schlüssel" hinterlegen Sie den Namen für den Language Key, so wie dieser im Templat eingefügt wird. Beispiel: TEXT_MEIN_LANGUAGE_KEY
Bei "Klasse" können Sie wählen ob der Language Key im Frontend, Backend oder an beiden Stellen zur Verfügung stehen soll.
Bei "Text" wird die jeweilige Übersetzung (Text) eingegeben.
Nun kann der Language Key wie folgt an einer beliebigen Stelle im Shop (auch in Plugins) eingefügt werden:
{txt key=TEXT_MEIN_LANGUAGE_KEY}