Die CookieHub JavaScript-API bietet eine flexible Auswahl an öffentlichen Methoden und Ereignissen, mit denen Frontend-Entwickler direkt auf der Website mit dem CMP-Widget interagieren und es steuern können. Diese API ist unerlässlich für die Gewährleistung einer umfassenden Compliance, da Sie den Einwilligungsstatus eines Nutzers manuell überprüfen können, bevor Marketing-, Analyse- oder Funktionsskripte von Drittanbietern ausgeführt werden.
Alle Funktionen sind über das globale `window.cookiehub`-Objekt zugänglich, das nach der Initialisierung des CookieHub-Tags verfügbar ist.
Die Verwendung der API gewährleistet, dass Ihre Website konform und dynamisch ist und ein reibungsloses Benutzererlebnis bietet.
Bedingtes Laden von Skripten
Verwenden Sie die Methode hasConsented(), um Tags von Drittanbietern (z. B. Google Analytics, Facebook Pixel) nur dann zu laden, wenn der Benutzer die erforderliche Einwilligungskategorie angegeben hat.
Echtzeitintegration
Nutzen Sie Ereignisse wie cookiehub_onStatusChange, um Skripte auszulösen oder Ihre Datenschicht zu aktualisieren, sobald ein Benutzer seine Einstellungen ändert, ohne dass ein Seitenneuladen erforderlich ist.
Individuelle Benutzererfahrung
Erstellen Sie benutzerdefinierte Schaltflächen oder Links, die programmatisch den Zustimmungsdialog (openDialog()) oder das Einstellungsfeld (openSettings()) von jeder beliebigen Stelle Ihrer Website aus öffnen.
Flexibilität des Entwicklers
Bietet einfache Methoden wie allowAll() oder denyAll() für fortgeschrittene Integrationsszenarien, in denen Sie die Zustimmungszustände manuell steuern müssen.
Die Funktionalität der JavaScript-API ist in zwei Hauptgruppen unterteilt: Öffentliche Methoden (zum Abfragen von Status und zur Steuerung) und Ereignisse (zum Reagieren auf Änderungen).
Um sicherzustellen, dass das API-Objekt verfügbar ist, muss das Standard-CookieHub-Tag in den <head>-Bereich Ihrer Website eingebunden werden:
Installationsanleitung: Informationen zum einzubindenden Skript – CookieHub-Tag
Diese Methoden ermöglichen es Ihnen, den Einwilligungsstatus des Nutzers aktiv zu überprüfen oder die Darstellung des Dialogs zu steuern.
hasConsented(Kategorie)
Zweck: Die wichtigste Methode. Prüft, ob der Nutzer die angegebene Cookie-Kategorie (z. B. „analytics“, „marketing“) zugelassen hat.
Beispiel: if (window.cookiehub.hasConsented("analytics")) { loadAnalytics(); }
hasAnswered()
Zweck: Gibt true zurück, wenn der Nutzer zuvor eine Auswahl getroffen hat, indem er alle Cookies zugelassen oder die Einstellungen gespeichert hat.
openSettings(Registerkarte)
Zweck: Öffnet den Einstellungsdialog. Optional kann eine Registerkarte angegeben werden (z. B. „declaration“).
Beispiel: window.cookiehub.openSettings('declaration');
openDialog()
Zweck: Öffnet programmatisch den Hauptdialog zur Einwilligung.
allowAll() / denyAll()
Zweck: Erteilt oder widerruft programmatisch die Einwilligung für alle Kategorien. Nützlich zur Implementierung benutzerdefinierter Steuerelemente außerhalb des Hauptdialogs.
Ereignisse sind entscheidend für die Codeausführung nach der Interaktion des Nutzers mit der Cookie-Management-Plattform (CMP). Diese Ereignisse können mithilfe des Standard-Dokuments `document.addEventListener` überwacht werden.
`cookiehub_onInitialise`
Auslöser: Wird ausgelöst, sobald CookieHub geladen ist und der aktuelle Einwilligungsstatus des Nutzers bekannt ist.
Wichtigster Anwendungsfall: Ausführung der Logik der Startseite, die von der vorherigen Einwilligung abhängt.
`cookiehub_onStatusChange`
Auslöser: Wird ausgelöst, sobald der Nutzer seine Cookie-Einstellungen ändert (z. B. durch Klicken auf „Einstellungen speichern“ oder „Alle zulassen“).
Wichtigster Anwendungsfall: Das zuverlässigste Ereignis, um GTM oder Skripte nach einer Aktualisierung der Einwilligung erneut auszuführen.
`cookiehub_onAllow`
Auslöser: Wird ausgelöst, wenn ein Nutzer eine zuvor gesperrte Kategorie explizit zulässt.
Wichtigster Anwendungsfall: Laden eines einzelnen, kategorieabhängigen Skripts zum Zeitpunkt der Einwilligung.
`cookiehub_onRevoke`
Auslöser: Wird ausgelöst, wenn ein Nutzer die Einwilligung für eine zuvor erlaubte Kategorie explizit widerruft.
Wichtigster Anwendungsfall: Stoppen der Ausführung eines bestimmten Tracking-Skripts.
Alle öffentlichen Methoden und Eigenschaften sind unter dem globalen Objekt window.cookiehub verfügbar, sobald das Haupt-CookieHub-Tag geladen ist.
Ja, absolut. Wenn Sie das standardmäßige schwebende Symbol im CookieHub-Dashboard deaktivieren, können Sie einen benutzerdefinierten Link oder Button an beliebiger Stelle auf Ihrer Website erstellen (z. B. in der Fußzeile), der die öffentliche Methode openDialog() auslöst.
Ja. Die vollständige Cookie-Erklärung kann mithilfe eines einfachen HTML-Codes direkt auf jeder beliebigen Seite (z. B. Ihrer Cookie-Richtlinienseite) eingebettet werden. Dabei wird die Erklärung als unformatierte Tabelle dargestellt, die das CSS Ihrer Website übernimmt und so für ein einheitliches Erscheinungsbild sorgt. So betten Sie die Erklärung ein: Fügen Sie den folgenden HTML-Code genau an der gewünschten Stelle ein: <div class="cookiehub-declaration"></div> Hinweis: Falls Sie möchten, dass Benutzer die Deklaration innerhalb des CMP-Dialog-Overlays sehen, können Sie weiterhin die Methode window.cookiehub.openSettings('declaration') verwenden.
Verwenden Sie eine öffentliche Methode (wie z. B. `hasConsented()`), wenn Ihr Code einen Status abfragen oder den Dialog steuern muss (eine aktive Operation). Verwenden Sie ein Ereignis (wie z. B. `cookiehub_onStatusChange`), wenn Ihr Code auf eine Benutzeraktion (eine passive Operation) oder einen Initialisierungsvorgang reagieren muss.
Nein. Die API-Methoden wie allowAll() oder denyAll() dienen dazu, dem Nutzer alternative Möglichkeiten zur Zustimmung zu bieten (z. B. über eine benutzerdefinierte Schaltfläche). Sie sollten nicht dazu verwendet werden, die ausdrückliche Entscheidung des Nutzers oder den CMP-Workflow zu umgehen.
Das Ereignis „cookiehub_onStatusChange“ ist das zuverlässigste Ereignis für die GTM-Integration. Es wird immer dann ausgelöst, wenn der Benutzer seine Cookie-Einstellungen ändert, sodass Sie Ihre GTM-Datenschicht sofort aktualisieren können, um den neuen Einwilligungsstatus widerzuspiegeln.
©2018-2025 CookieHub ehf.
CookieHub CMP offers tools and services for managing cookies and online privacy.
