Benutzerdefinierte Funktionen

Wie erstelle ich benutzerdefinierte Funktionen des Banners?

Nelson
Geschrieben von NelsonLetzte Aktualisierung vor 1 Monat

In einigen Fällen müssen Sie möglicherweise in der Lage sein, das Verhalten Ihres Cookie-Banners programmgesteuert zu steuern oder den aktuellen Stand der Benutzereinwilligung zu lesen. CookieScript bietet eine Reihe von Funktionen, mit denen die Cookie-Steuerelemente programmgesteuert angepasst werden können.

Auf diese Funktionen kann über CookieScript.Instance zugegriffen werden, sobald sie initialisiert wurden.

Liste der CookieScript-Funktionen und deren Beschreibung

Name

Parameter

Beschreibung

show

Nichts

Erzwingt das Erscheinen des Cookie-Banners.

hide

Nichts

erzwingt das Schließen des Cookie-Banners

currentState

Nichts

Gibt den aktuellen Status der Benutzereinwilligung als Objekt mit zwei Eigenschaften zurück:

Aktion: 'accept' | 'reject' ;

Kategorien: ['strict', 'performance', 'targeting', 'functionality', 'unclassified'].

categories

Nichts

Gibt ein Array der verfügbaren Cookie-Kategorien als Array der folgenden Cookie-Typen zurück:

['strict', 'performance', 'targeting', 'functionality', 'unclassified'].

acceptAllAction

Nichts

Akzeptiert manuell alle Cookies.

rejectAllAction

Nichts

Lehnt alle Cookies manuell ab, mit Ausnahme der unbedingt erforderlichen.

acceptAction

String-Array-Kategorien

Akzeptiert manuell einige der als Parameter übergebenen Cookie-Kategorien:

CookieScript.instance.acceptAction(['performance', 'targeting']).

Wie / Cookie-Banner ausblenden

CookieScript-Banner können mit folgenden Funktionen ein- oder ausgeblendet werden:

CookieScript.instance.show() 
CookieScript.instance.hide()

Dies entspricht dem Einblenden des Banners durch Klicken auf das Cookie-Logo oder dem Schließen des Banners durch Klicken auf die Schaltfläche „Schließen“.

Holen Sie sich den aktuellen Zustimmungsstatus

Die aktuelle Cookie-Auswahl des Benutzers kann gelesen werden, indem Sie diese Funktion aufrufen:

CookieScript.instance.currentState()

Die Funktion gibt ein Objekt mit 2 Eigenschaften zurück:

{
    action: 'accept' | 'reject',
    categories: ['strict', 'performance', 'targeting', 'functionality', 'unclassified']
}

Die action kann entweder accept oder reject lauten.

Die Eigenschaft categories besteht aus einer Reihe von Inhalten, denen der Benutzer zugestimmt hat, und kann jede der folgenden Kategorien enthalten: [strictperformancetargetingfunctionalityunclassified]

Name

Beschreibung

accept

Bedeutet, dass der Benutzer einer oder mehreren Cookie-Kategorien zugestimmt hat. Eine Liste der akzeptierten Kategorien finden Sie in der Eigenschaft category.

reject

Bedeutet, dass der Benutzer alle Cookies abgelehnt hat. In diesem Fall speichert die category eigenschaft weiterhin strict Cookie-Kategorien, da sie nicht abgelehnt werden können.

Verfügbare Kategorien abrufen

Einige Websites erfordern und verwenden nicht alle oben genannten Cookie-Kategorien. Welche Cookie-Typen dem Nutzer aktuell zur Auswahl stehen, kann über die folgende Funktion eingesehen werden:

CookieScript.instance.categories()

Die Funktion gibt ein Array verfügbarer Kategorieschlüssel zurück:

let categories = CookieScript.instance.categories();
// the variable categories is going to look
// somewhat like this:
// ['performance', 'targeting', 'functionality']

Akzeptieren/Cookie-Richtlinie ablehnen

Sie können die Cookie-Richtlinie mit integrierten Funktionen akzeptieren oder ablehnen. Dies kann praktisch sein, wenn Sie einen Link platzieren möchten, in dem der Benutzer aufgefordert wird, Cookies zu akzeptieren, bevor einige Funktionen verfügbar sind.

Alle Cookies

Akzeptieren Alle Cookies

Können mit der folgenden Funktion akzeptiert werden:

cookieScript.instance.acceptAllAction () 

Dies entspricht dem Klicken auf die Schaltfläche „Alle akzeptieren“.

Ablehnen Alle Cookies

Alle Cookies (außer unbedingt erforderlich) können mit dieser Funktion abgelehnt werden:

CookieScript.instance.rejectAllAction()

Dies entspricht dem Klicken auf die Schaltfläche „Alle ablehnen“.

Einige Cookies akzeptieren

Falls Cookie-Kategorien aktiviert sind, können sie mithilfe dieser Funktion programmgesteuert akzeptiert werden:

cookiescript.instance.acceptAction (categories)

Die Funktion erfordert einen Parameter mit einer Liste der Kategorien, die akzeptiert werden müssen, wie in diesem Beispiel:

var categories = ['performance', 'targeting', 'functionality', 'unclassified'] cookieScript.Instance.acceptAction (categories)

Codebeispiele

Wie kann ich das Anzeigen des CookieScript-Cookie-Banners beenden?

Wenn es ein Problem gibt, dass einige Website-Editoren immer das CookieScript-Cookie-Banner anzeigen, können Sie die Anzeige mit diesem Code beenden. Der Code ist auch nützlich, wenn Ihr Banner im Iframe angezeigt wird, der unter derselben Domain geladen wird, und Sie das Banner nicht in diesem Iframe anzeigen müssen.

<script type="text/javascript" 
        charset="UTF-8" 
        src="//cdn.cookie-script.com/s/xxxxxxxxxxxxxxxxxxxxxxxxxxxx.js" 
        data-cs-restrict-domain="true">
</script>

Ein Link, der das Cookie-Banner erscheinen lässt:

<a href="javascript:CookieScript.instance.show()">show popup</a>

Dies entspricht dem Klicken auf das CookieScript-Badge.

Ein Link, über den der Benutzer alle Cookies akzeptieren kann:


<a href="javascript:CookieScript.instance.acceptAllAction()">
    By continuing you are accepting all cookies.
</a>

Ein Link, über den der Benutzer einige Kategorien akzeptieren kann:


<a href="javascript:CookieScript.instance.acceptAction(['performance', 'targeting'])">
    Accept
</a>

CookieScript-Ereignisse

CookieScript bietet auch eine Vielzahl von Ereignissen, um die Aktionen von Cookie Banner abzuhören. Wir haben eine ausführliche Erklärung zur Funktionsweise benutzerdefinierter Ereignisse erstellt.

Hat das deine Frage beantwortet?