Microsoft Clarity Integration Pro – Heatmaps, Recordings & Consent


Installationsanleitung, Dokumentation und FAQs zum Shopware Plugin

Microsoft Clarity liefert Heatmaps, Session Recordings und Insights für deinen Shop – kostenlos, ohne Session-Limit und ohne Sampling. Microsoft Clarity Integration Pro bindet den Dienst sauber in Shopware 6 ein und kümmert sich um Cookie-Consent, Custom Tags und den Schutz sensibler Checkout-Daten. Alle Einstellungen erfolgen über die Plugin-Konfiguration in der Shopware-Administration – Code-Anpassungen sind nicht nötig.

  1. Einbindung von Microsoft Clarity (Tracking-Code, asynchron geladen)
  2. Integration in den Shopware Cookie Manager (Gruppen Statistik, Marketing oder Komfort wählbar)
  3. SHA256-gehashte User-Identifikation für eingeloggte Kunden (kein Klartext-PII an Microsoft)
  4. Custom Tags für Sales Channel, Sprache und Kundengruppe
  5. Automatische Maskierung aller Checkout-Eingaben (Adresse, Zahlung, E-Mail)
  6. Purchase-Event auf der Finish-Seite für Conversion-Auswertungen

Voraussetzungen

  • Shopware 6.6 oder 6.7
  • Ein aktives Microsoft-Clarity-Projekt mit gültiger Project-ID (Anlage kostenlos unter clarity.microsoft.com)
  • Aktiver Shopware Cookie Manager – ohne Consent lädt Clarity nicht

Kompatibilität

  • Shopware 6.7 – vollständig getestet, Anbindung über die neue CookieGroupCollectEvent-API
  • Shopware 6.6 – kompatibel über die klassische CookieProviderInterface-API
  • Verwendet ausschließlich die offizielle Microsoft-Clarity-Client-API (consent, set, identify, event, upgrade)
  • Keine Drittplugins erforderlich

Installation

  1. Plugin im Shopware Store erwerben und im Shop installieren.
  2. Unter Erweiterungen → Meine Erweiterungen aktivieren.
  3. Cache leeren und Storefront per F5 neu laden.
  4. Die Plugin-Konfiguration öffnen und die Microsoft-Clarity-Project-ID eintragen (siehe nächster Abschnitt).

Einrichtung

Microsoft-Clarity-Projekt anlegen

  1. clarity.microsoft.com öffnen und anmelden (Microsoft-, Google- oder Facebook-Konto).
  2. Oben links auf Meine Projekte klicken.
  3. Über Neues Projekt das Formular ausfüllen: Name (z. B. der Shop-Name), Website-URL, passende Kategorie.
  4. Projekt anlegen.

Project-ID herauskopieren

  1. Nach dem Anlegen das neue Projekt oben rechts über die Projekt-Auswahl aktivieren.
  2. Im linken Menü auf Einstellungen klicken.
  3. Ganz oben steht die Project-ID (alphanumerisch, z. B. abc1234xyz). Diese ID kopieren.

Plugin konfigurieren

  1. In der Shopware-Administration Erweiterungen → Meine Erweiterungen → Microsoft Clarity Integration Pro → Konfiguration öffnen.
  2. Project-ID eintragen.
  3. Bei Bedarf pro Sales Channel konfigurieren, wenn nur bestimmte Kanäle getrackt werden sollen.
  4. Speichern.

Die Project-ID wird beim Speichern validiert – nur alphanumerische Zeichen werden akzeptiert. Ungültige Eingaben werden ignoriert und Clarity lädt nicht.


1 · Grundkonfiguration

Die Grundkonfiguration schaltet Clarity ein und bestimmt, wie der Cookie in den Cookie Manager eingeordnet wird.

FeldBedeutung
Plugin aktivSchaltet die gesamte Clarity-Einbindung ein oder aus.
Clarity Project-IDDie alphanumerische ID aus dem Clarity-Dashboard.
Cookie-GruppeIn welche Shopware-Cookie-Gruppe der Clarity-Cookie eingeordnet wird: Statistik (Default, DSGVO-Empfehlung), Marketing oder Komfort.
Cookie-Consent umgehenNur für interne Test-Shops: Clarity lädt sofort ohne Cookie-Banner. Nicht in Produktivshops aktivieren!

2 · Optionen

Die Optionen steuern zusätzliche Clarity-Features rund um Kundenerkennung, Conversion-Tracking und Datenschutz im Checkout.

FeldBedeutung
User-Identifikation aktivierenRuft für eingeloggte Kunden clarity("identify", <sha256-hash>) auf. Die Kunden-ID wird vor dem Senden per SHA256 gehasht – kein Klartext-PII erreicht Microsoft.
Purchase-Event auf Finish-SeiteFeuert nach abgeschlossener Bestellung clarity("event", "purchase") auf /checkout/finish.
Checkout-Felder maskierenWrappt den gesamten Checkout-Content in <div data-clarity-mask>. Clarity blendet alle Formulareingaben (Adresse, Zahlung, E-Mail) in Session Recordings und Heatmaps automatisch aus.

3 · Custom Tags

Custom Tags sind Key-Value-Paare, die bei jeder Session an Clarity übergeben werden (clarity("set", key, value)). Sie tauchen im Clarity-Dashboard als Filter auf – so lassen sich Heatmaps und Recordings nach Sprache, Sales Channel oder Kundengruppe segmentieren.

FeldBedeutung
Sales-Channel taggenSendet den Namen des aktuellen Sales Channels als Tag salesChannel.
Sprache taggenSendet den aktuellen Locale-Code (z. B. de-DE, en-GB) als Tag language.
Kundengruppe taggenSendet den Namen der Kundengruppe als Tag customerGroup (nur wenn der Kunde eingeloggt ist).

4 · Cookie-Banner & Consent

Nach der Installation erscheint der Cookie biloba-clarity-enabled automatisch im Shopware Cookie Manager, in der konfigurierten Gruppe (Statistik, Marketing oder Komfort).

  • Stimmt der Kunde zu, wird das Clarity-Script asynchron nachgeladen und beginnt zu tracken.
  • Stimmt der Kunde nicht zu, lädt Clarity nicht – es gehen keinerlei Daten an Microsoft.
  • Widerruft der Kunde später die Zustimmung, wird Clarity beim nächsten Seitenaufruf nicht mehr geladen.

Das Plugin unterstützt beide Shopware-Cookie-APIs: die klassische CookieProviderInterface (vor 6.7.3) und die neue CookieGroupCollectEvent-basierte API (6.7.3+).


5 · Checkout-Maskierung

Wenn Checkout-Felder maskieren aktiv ist, werden im gesamten Checkout (/checkout/*) alle Eingabefelder für Clarity unsichtbar gemacht:

  • Adress-Eingaben
  • Zahlungsdaten
  • E-Mail-Adresse
  • Rechnungsanschrift

In Clarity-Aufzeichnungen erscheinen diese Felder als graue Rechtecke, Heatmaps zeigen nur die Position der Felder, nicht den Inhalt. Das ist die native Clarity-Funktion über das HTML-Attribut data-clarity-mask – keine eigene Magie, sondern Microsoft-Standard.


FAQs

Nein. Clarity ist ein kostenloses Tool von Microsoft, ohne Session-Limit und ohne Sampling. Nur dieses Plugin kostet – weil wir die saubere Shopware-Integration gebaut haben.

Nur wenn der Kunde dem Cookie zustimmt. Selbst dann verlassen keine Klartext-Kundendaten den Shop: die User-Identifikation ist SHA256-gehasht, Checkout-Felder werden maskiert. Clarity empfängt anonyme Bewegungsdaten und die Custom Tags, die im Plugin konfiguriert wurden.

Project-ID auf Tippfehler prüfen (muss alphanumerisch sein), in den Browser-Devtools kontrollieren, ob das Clarity-Script mit der ID biloba-clarity-script geladen wird, dem Cookie-Banner zustimmen oder den Bypass-Modus für den Test aktivieren. Clarity braucht typischerweise 20–30 Minuten, bis die erste Session im Dashboard erscheint.

Der Cookie-Eintrag biloba-clarity-enabled wird unabhängig von der verwendeten UI im Cookie Manager registriert. Ein Drittanbieter-Banner muss denselben Cookie-Namen setzen, damit die Einwilligung korrekt erkannt wird.

Im UI sind aktuell Sales Channel, Sprache und Kundengruppe verfügbar. Eigene Tags per Twig-Erweiterung sind über das offizielle Clarity-API (clarity("set", key, value)) jederzeit möglich – sprich uns dazu gern über den Support an.

Nur wenn der Kunde zuvor zugestimmt hat oder der Bypass-Modus aktiv ist. Der purchase-Event wird nur dann gefeuert, wenn Clarity bereits läuft – nichts wird nachträglich getrackt.


Support

Bei Fragen oder Problemen stehen wir zur Verfügung: