Javascript API

Alle öffentlichen API-Methoden sind auf dem CookieFirst-Objekt im globalen Namensraum verfügbar. Auf sie kann auch als Eigenschaft des Window-Objekts zugegriffen werden.

javascript
const CF = CookieFirst;
// or
const CF = window.CookieFirst;

1. Cookie panel

Es gibt 2 Methoden, mit denen Entwickler das Cookie-Panel programmgesteuert öffnen und schließen können:

1.1 Öffnen Sie das Panel.

Öffnet das Cookie-Panel, wenn es derzeit nicht geöffnet ist, und gibt einen Fehler im Stealth-Modus aus.

javascript
CookieFirst.openPanel();

1.2. Schließen Sie das Panel.

Schließt das Cookie-Panel, wenn es geöffnet ist. Wirft einen Fehler im Stealth-Modus.

javascript
CookieFirst.closePanel();

2. Einwilligung der Besucher

Diese Methoden und Eigenschaften ermöglichen es den Entwicklern, die aktuelle Zustimmung des Besuchers zu einer Domain abzurufen und programmgesteuert verschiedene Aktionen auszulösen, die diese Domain verändern.

2.1 Informationen über die Zustimmung der Besucher erhalten

javascript
const consent = CookieFirst.consent;

// if consent is available, it will be an object of this structure:
{
 necessary: true, // necessary category can't be disabled
 performance: true|false,
 functional: true|false,
 advertising: true|false,
}

// otherwise it will be empty
consent === null; // true

2.2 withdrawConsent()

Die Funktion zum Zurückziehen der Zustimmung löscht die Zustimmung des Besuchers und protokolliert diese Änderung in unserem Zustimmungsprotokoll. Nachdem diese Aktion ausgeführt wurde, wird die Website neu geladen, um dem Besucher einen Neustart auf einer Domain zu ermöglichen. Das Banner wird erneut angezeigt, und es stehen keine Methoden zur Änderung der Zustimmung zur Verfügung, bis der Besucher erneut zustimmt.

javascript
CookieFirst.withdrawConsent();

2.3 updateConsent()

Diese Funktion ermöglicht es den Entwicklern, die Zustimmung der Besucher zu aktualisieren und auf einen bestimmten Wert zu setzen. Sie akzeptiert ein Zustimmungsobjekt als Parameter.

javascript
const newConsent = {...CookieFirst.consent};
newConsent.functional = true;
CookieFirst.updateConsent(newConsent);

2.4 acceptCategory()

This function allows you to perform basically the same action as above, but with one line of code.

javascript
CookieFirst.acceptCategory("functional");

2.5 acceptAllCategories()

Diese Funktion ermöglicht es Ihnen, allen verfügbaren Kategorien von Cookies zuzustimmen.

javascript
CookieFirst.acceptAllCategories();

2.6 acceptPreselectedCategories()

This function allows you to accept only the categories, which have been previously pre-selected in the domain settings screen in CookieFirst admin panel.

javascript
CookieFirst.acceptPreselectedCategories();

2.7 declineAllCategories()

Mit dieser Funktion können Sie mit einer Codezeile nur die erforderliche Kategorie akzeptieren und alle anderen Kategorien ablehnen. Obwohl sie ähnlich wie die Funktion withdrawConsent() aussieht, löscht sie die Zustimmung nicht vollständig und zeigt das Cookie-Banner nicht an. Sie aktualisiert die Zustimmung so, dass nur die erforderlichen Cookies aktiviert sind.

javascript
CookieFirst.declineAllCategories();

2.8 declineCategory()

Diese Funktion ermöglicht es Ihnen, nur eine Cookie-Kategorie abzulehnen und den Rest der Zustimmung so zu erhalten, wie sie zuvor gespeichert wurde. (funktional, Werbung, Leistung)

javascript
CookieFirst.declineCategory("functional");

2.9. acceptService()

Mit dieser Funktion können Sie bestimmte Dienste anhand ihres eindeutigen Bezeichners akzeptieren. Wenn die Option Zustimmungsrichtlinie auf "kategoriebasiert" und nicht auf "dienstbasiert" eingestellt ist, akzeptiert die Funktion alle Kategorien, zu denen dieser Dienst gehört.

CookieFirst.acceptService("service_id");// orCookieFirst.acceptService(["service_id_1","service_id_2"]);

2.10. declineService()

Mit dieser Funktion können Sie einen oder mehrere Dienste ablehnen und den Rest der Zustimmung so beibehalten, wie er zuvor gespeichert wurde. Wenn die Option für die Einverständniserklärung auf "kategoriebasiert" und nicht auf "dienstbasiert" eingestellt ist, lehnt die Funktion alle Kategorien ab, zu denen dieser Dienst gehört.

CookieFirst.declineService("service_id");// orCookieFirst.declineService(["service_id_1","service_id_2"]);

3. Integrationseinstellungen

Es gibt ein paar Einstellungen, mit denen Sie das Verhalten des Banners auf Ihrer Website steuern können. Sie werden über Datenattribute oder Url-Attribute in Ihrem Banner-Einbettungscode aktiviert.

Beispiel mit Datenattribut:

<script 
src="https://consent.cookiefirst.com/banner.js" 
data-cookiefirst-key="YOUR_API_KEY" 
data-stealth-mode="true"
></script>

Beispiel mit url-Attribut:

<script 
src="https://consent.cookiefirst.com/banner.js?stealth-mode=true" 
data-cookiefirst-key="YOUR_API_KEY"
></script>

Tatsächlich kann der API-Schlüssel auch als url-Attribut verwendet werden, etwa so:

<script 
src="https://consent.cookiefirst.com/banner.js?cookiefirst-key=YOUR_API_KEY" 
></script>

Wenn Sie mehrere url-Attribute gleichzeitig verwenden, stellen Sie sicher, dass Sie z. B. vor jedem Attributnamen ein &-Zeichen einfügen:

src="[...]/banner.js?cookiefirst-key=YOUR_API_KEY&stealth-mode=true"

3.1 Stealth-Modus

Im Stealth-Modus stellt CookieFirst Banner keine Schnittstelle für die Verwaltung von Zustimmungen dar. Der einzige gerenderte Inhalt ist die Cookie-Deklaration auf einer Seite, die ihn unterstützt. Im Stealth-Modus ist es auch nicht möglich, das Cookie-Banner programmatisch zu steuern, weil Sie nicht etwas steuern können, das nicht existiert.

Verwendung als Datenattribut: data-stealth-mode="true" or data-stealth-mode="false"

Verwendung als url-Attribut: stealth-mode=true or stealth-mode=false

3.2 Stiller Modus

Wenn sich CookieFirst Banner im stillen Modus befindet, protokolliert es keine Informationen in der Browser-Konsole.

Verwendung als Datenattribut: data-silent-mode="true" or data-silent-mode="false"

Verwendung als url-Attribut: silent-mode=true or silent-mode=false

3.3 Sprache

Wenn kein Sprachattribut an unser Banner übergeben wird, überprüft es den Browser des Benutzers, um festzustellen, ob die bevorzugte Sprache eine der für Ihr Banner konfigurierten Sprachen ist. Ist dies nicht der Fall, wird auf die erste Sprache auf der Liste zurückgegriffen. Sie können diese Prüfung jedoch umgehen, um zum Beispiel die Bannersprache mit der Sprachumschaltung Ihrer Website zu synchronisieren. Zu diesem Zweck können Sie die language Attribut.

Verwendung als Datenattribut: data-language="en" or data-language="en"

Verwendung als url-Attribut: language=en or language=en

Hinweis: für Sprachen verwenden wir 2 Buchstaben ISO-639-1 codes. Zum Beispiel: en und nichten-GB

4. Events

CookieFirst-Banner sendet während seines Lebenszyklus verschiedene Ereignisse, die auf dem globalen Window objekt angehört werden können.

4.1. cf_consent

Dieses Ereignis wird immer dann ausgelöst, wenn der Benutzer seine Zustimmung erteilt oder ändert (einschließlich Widerruf). Verwenden Sie es, wenn Sie einige Aktionen durchführen möchten, wenn die Zustimmung erteilt wird. Es ist besonders nützlich, wenn man auf die erste Zustimmung hört, denn wenn die Zustimmung aktualisiert oder zurückgezogen wird, lädt unser Banner die Seite neu, um sicherzustellen, dass nur der akzeptierte Drittanbietercode entsprechend den Präferenzen des Benutzers ausgeführt wird.

Example listener:

window.addEventListener("cf_consent", function(event) {
var newlyGivenConsent = event.detail;
}):

5. fetchLatestScan()

Die JS-API ermöglicht es Ihnen, die Liste der auf Ihrer Website gefundenen Cookies zusammen mit dem letzten Scandatum zu erhalten. Verwenden Sie dazu die Cookiefirst.fetchLatestScan() method.Sie wird ein Versprechen zurückgeben, das zu folgender Antwort führt:

{
updated_at: "2020-10-29T13:30:23+00:00", // latest scan date and time in ISO 8601 format
cookies: [], // an array of cookies found on your site together with any custom cookies you may have added as well as our own cookies needed for banner to work
}

6. renderEmbeds()

Mit der JS-API können Sie das Rendern von eingebetteten Inhalten (wie der Cookie-Richtlinie oder der Cookie-Tabelle) erzwingen. Dies in Integrationen, bei denen der Container div für die Einbettungen im Moment nicht verfügbar ist, wenn unser Banner geladen wird. Dies könnte der Fall sein, wenn Sie es dem DOM dynamisch über die Navigation in der Einzelseitenansicht der Anwendung oder einfach durch einfachen JS-Code hinzufügen. Nachdem das div zum DOM hinzugefügt wurde, führen Sie Cookiefirst.renderEmbeds() aus, um den eingebetteten Inhalt innerhalb des DOMs zu platzieren.