blickfang Cookie Consent Manager (CCM) integrieren

Zur Einbindung des CCM benötigen Sie einen entsprechenden Account. Bitte kontaktieren Sie uns, falls Ihnen dieser noch nicht vorliegt.

Einbindung benötigter Scripte

Fügen Sie die folgenden Scripte in den head-Bereich jeder Seite Ihrer Webseite ein und ersetzen Sie den api_key und die domain mit Ihren entsprechenden Werten. Um eine bestmögliche Ausführung zu erhalten, achten Sie darauf, die Scripte möglichst weit oben im Quellcode zu platzieren.

<script src="https://ccm.blickfang-media.com/public/app.js?apiKey=api_key&amp;domain=domain"></script>
<script src="https://ccm.blickfang-media.com/public/helper.js"></script>

Anpassung Cookie-setzender Script-Tags

Um eine vorherige Zustimmung durch den Benutzer zu ermöglich, müssen Sie Cookie-setzende Scripte entsprechend anpassen. Hierfür ergänzen Sie das Attribut data-cookie-consent und setzen den Wert auf den Namen der Einbindung, welcher im CCM-Account vergeben wurde. Anschließend ändern Sie das Attribut type von text/javascript auf text/plain. Handelt es sich bei dem eingesetzten Javascript nicht um einen Block, sondern eine Datei, ändern Sie außerdem das Attribut src auf data-src.

<script type="text/plain" data-cookie-consent="Google Analytics">...</script>
<script type="text/plain" data-cookie-consent="Google Maps" data-src="..."></script>

Javascript-API

Der CCM bietet eine Javascript-API, mit welcher auf Eigenschaften und Funktionalitäten zugegriffen werden können. Somit erhalten Sie die volle Kontrolle und können noch besser auf Benutzerinteraktionen reagieren. 

Eigenschaften

NameTypBeschreibung
CCM.acceptedCookies string[] Liste der Namen aller akzeptierten Cookies.
CCM.acceptedEmbeddings object[] Liste aller akzeptieren Einbindungen.
CCM.consent bool Wahr, wenn der Consent-Dialog geschlossen wurde.
CCM.ucid ?string Eindeutige Consent-ID. null, wenn noch kein Consent erteilt wurde.

Methoden

NameBeschreibung
CCM.closeControlPanel() Schließt den Dialog zur Auswahl der zu akzeptierenden Zwecke.
CCM.openControlPanel() Öffnet den Dialog zur Auswahl der zu akzeptierenden Zwecke.
CCM.closeWidget() Schließt den Cookie-Dialog.
CCM.openWidget() Öffnet den Cookie-Dialog.

Alternativ können Sie die Dialoge auch über Links mit den Zielen #CCM.openWidget, #CCM.closeWidget, #CCM.openControlPanel und #CCM.closeControlPanel steuern.

Events

Die Ereignisse des CCM werden auf dem globalen window-Objekt ausgeführt. 

NameBeschreibung
ccm19EmbeddingAccepted Wird ausgelöst, sobald eine Einbindung durch den Benutzer akzeptiert wurde. Dieser Event erfolgt sowohl beim Erteilen der Zustimmung, als auch beim wiederholten Seitenaufruf.
ccm19WidgetLoaded Wird ausgelöst, sobald die Initialisierung des CCM abgeschlossen ist.