$wsConsent - Cookies & Services - WEBSALE Dokumentation

Mit dem $wsConsent Modul können Sie die Zustimmung des Kunden zu Cookies und Services im Shop auswerten und Inhalte entsprechend steuern.

Modulübersicht

Beispiel / Ausschnitt über $wsConsent

{{= $wsConsent | json }}

JSON-Ausgabe:

{
  "alreadySet": false,
  "allAllowed": false,
  "groups": [
    {
      "name": "...",
      "label": "...",
      "description": "...",
      "allowed": false,
      "services": [
        {
          "name": "...",
          "label": "...",
          "description": "...",
          "allowed": false
        }
      ]
    }
  ],
  "services": [
    {
      "name": "...",
      "label": "...",
      "description": "...",
      "allowed": false
    }
  ],
  "checkAllowed": "ƒ()"
}

Anmerkung: "ƒ()" kennzeichnet eine Funktion. Variablen und Methoden in der Übersicht

Name	Rückgabe-Typ	Beschreibung
`alreadySet`	bool	Gibt aus, ob die Einwilligung zu Cookies/Services bereits gegeben wurde.
`allAllowed`	bool	Gibt aus, ob allen Cookies/Services zugestimmt wurde.
`groups`	array	Gibt eine Liste aller konfigurierten Cookie/Services Gruppen aus.
`name`	string	Gibt den technischen Namen der Gruppe aus.
`label`	string	Gibt die sprechende Bezeichnung der Gruppe aus.
`description`	string	Gibt die Beschreibung der Gruppe aus.
`allowed`	bool	Gibt aus, ob die Gruppe erlaubt ist.
`services`	array	Gibt eine Liste aller konfigurierten Services aus.
`name`	string	Gibt den technischen Namen des Services aus.
`label`	string	Gibt die sprechende Bezeichnung des Services aus.
`description`	string	Gibt die Beschreibung des Services aus.
`allowed`	bool	Gibt aus, ob der Service erlaubt ist.
`services`	array	Gibt eine Liste aller konfigurierten Services aus.
`name`	string	Gibt den technischen Namen des Services aus.
`label`	string	Gibt die sprechende Bezeichnung des Services aus.
`description`	string	Gibt die Beschreibung des Services aus.
`allowed`	bool	Gibt aus, ob der Service erlaubt ist.
`checkAllowed()`	bool	Prüft, ob ein bestimmter Service vom Kunden akzeptiert wurde.

Templates

Der Consent Layer kann global aufgerufen werden und wird aus dem Template consent.htm geladen.

Variablen

$wsConsent.alreadySet

Gibt aus, ob der Kunde bereits eine Cookie-/Service-Zustimmung gesetzt hat.

{{ if $wsConsent.alreadySet }}
  //Es wurde bereits eine Einwilligung abgegeben
{{ /if }}

$wsConsent.allAllowed

Gibt aus, ob alle Services erlaubt sind (alle Services erlaubt bedeutet, dass der Nutzer bei “Alle erlauben” zugestimmt hat).

{{ if $wsConsent.allAllowed }}
  //Es wurde allen Services zugestimmt
{{ /if }}

$wsConsent.groups

Gibt alle konfigurierten Cookie-/Consent-Gruppen aus.

{{ foreach $myConsentGroupVariable in $wsConsent.groups }}
  {{= $myConsentGroupVariable.name }} 
{{ /foreach }}

$wsConsent.groups\[$ i].name

Gibt den technischen Namen der Gruppe aus.

Technischer Name: {{= $wsConsent.groups[0].name }}

$wsConsent.groups\[$ i].label

Gibt die für den Kunden sichtbare Bezeichnung der Gruppe aus.

Bezeichnung: {{= $wsConsent.groups[0].label }}

$wsConsent.groups\[$ i].description

Gibt die Beschreibung zur Gruppe aus.

Beschreibung: {{= $wsConsent.groups[0].description }}

$wsConsent.groups\[$ i].allowed

Gibt aus, ob die Gruppe in den Services akzeptiert wurde.

{{ if $wsConsent.groups[0].allowed }}
  //Die Gruppe wurde akzeptiert
{{ /if }}

$wsConsent.groups\[$ i].services

Enthält alle Services, die einer Gruppe zugeordnet sind.

{{ foreach $myGroupVariable in $wsConsent.groups }}
  {{ foreach $myServiceVariable in $myGroupVariable.services }}
    Service: {{= $myServiceVariable.name }} 
  {{ /foreach }}
{{ /foreach }}

$wsConsent.services

Gibt alle konfigurierten Services als Liste aus.

{{ foreach $myServiceVariable in $wsConsent.services }}
  Service Name: {{= $myServiceVariable.name }}
{{ /foreach }}

$wsConsent.services\[$ i].name

Gibt den technischen Namen des Services aus.

Service Name: {{= $wsConsent.services[0].name }}

$wsConsent.services\[$ i].label

Gibt die Bezeichnung des Services aus.

Service Label: {{= $wsConsent.services[0].label }}

$wsConsent.services\[$ i].description

Gibt die Beschreibung des Services aus.

Service Beschreibung: {{= $wsConsent.services[0].description }}

$wsConsent.services\[$ i].allowed

Gibt aus, ob der Service erlaubt (akzeptiert) wurde.

{{ if $wsConsent.services[0].allowed }}
  //Der Service wurde akzeptiert
{{ /if }}

Methoden

$wsConsent.checkAllowed()

Prüft, ob ein bestimmter Service vom Kunden akzeptiert wurde. Dies ist die empfohlene Methode, um vor dem Laden externer Skripte die Zustimmung zu prüfen. Signatur
$wsConsent.checkAllowed(serviceName) Rückgabe
bool - true wenn Service akzeptiert, sonst false. Parameter

Parameter	Typ	Pflicht	Beschreibung
`serviceName`	string	ja	Technischer Name des Services.

Beispiel, das prüft, ob Google Analytics akzeptiert wurde.

{{ if $wsConsent.checkAllowed("googleAnalytics") }}
  // Google Analytics Tracking-Code einbinden
{{ /if }}

Aktionen

Aktionen zu diesem Modul sind separat im Kapitel “Aktionen” dokumentiert: Consent

Prüfen, ob Cookies bereits gesetzt wurden

In diesem Beispiel wird überprüft, ob durch den Kunden Cookies bereits gesetzt wurden.

{{ if $wsConsent.alreadySet }}
  Cookiepräferenzen wurden bereits gesetzt
{{ /if }} 

Prüfen, ob alle Cookies bereits akzeptiert wurden

In diesem Beispiel wird überprüft, ob durch den Kunden alle Cookies akzeptiert wurden. Diese Prüfung kann beispielsweise verwendet werden um die Anzeige des Consent-Layers zu steuern.

{{ if $wsConsent.allAllowed }}
  Alle Cookies wurden bereits akzeptiert
{{ /if }}

Durch eine foreach Schleife kann auf die Infos der jeweiligen Cookie-Gruppe zugegriffen werden. In diesem Beispiel werden die Namen sowie die Beschreibungen der jeweiligen Cookie-Gruppen ausgelesen.

{{ foreach $group in $wsConsent.groups }}
	Name: {{=$group.name}}
	Beschreibung: {{= $group.description }}
{{ /foreach }}

Anzeige der Cookies einer Gruppe

Durch eine foreach Schleife kann auf die Infos der jeweiligen Cookies einer Gruppe zugegriffen werden. Typischerweise findet sich diese Schleife innerhalb der Cookie-Gruppen Schleife. In diesem Beispiel werden die Namen und Beschreibungen der jeweiligen Cookies einer Gruppe ausgelesen.

{{ foreach $group in $wsConsent.groups }}
	Cookie-Gruppe:	{{=$group.name}}
	Beschreibung:	{{= $group.description }}
	{{ foreach $service in $group.services }}
		Cookie-Name: {{=$group.name}}
		Cookie-Beschreibung: {{= $service.description }}
	{{ /foreach }}
{{ /foreach }}

Falls Inhalte erst angezeigt werden sollen, nachdem ein entsprechendes Cookie gesetzt wurde, kann der Status dieses Cookies überprüft werden. In diesem Beispiel wird geprüft, ob das Cookie „myCookieService“ akzeptiert wurde, um die Anzeige des Inhalts zu steuern.

{{ if $wsConsent.checkAllowed("myCookieService") }}
   
   {{ else }}
     Um diese Inhalte zu sehen, muss das Cookie myCookieService akzeptiert werden
{{ /if }}

Frontend

Die Basics

Getting Started

Funktionsübersicht

Referenz – Aktionen

Referenz – Sprache

Referenz – Module

$wsConsent - Cookies & Services

Modulübersicht

Templates

Variablen

$wsConsent.alreadySet

$wsConsent.allAllowed

$wsConsent.groups

$wsConsent.groups\[$ i].name

$wsConsent.groups\[$ i].label

$wsConsent.groups\[$ i].description

$wsConsent.groups\[$ i].allowed

$wsConsent.groups\[$ i].services

$wsConsent.services

$wsConsent.services\[$ i].name

$wsConsent.services\[$ i].label

$wsConsent.services\[$ i].description

$wsConsent.services\[$ i].allowed

Methoden

$wsConsent.checkAllowed()

Aktionen

Prüfen, ob Cookies bereits gesetzt wurden

Prüfen, ob alle Cookies bereits akzeptiert wurden

Anzeige der Cookies einer Gruppe

Weiterführende Links

Frontend

Die Basics

Getting Started

Funktionsübersicht

Referenz – Aktionen

Referenz – Sprache

Referenz – Module

Documentation Index

​Modulübersicht

​Templates

​Variablen

​$wsConsent.alreadySet

​$wsConsent.allAllowed

​$wsConsent.groups

​wsConsent.groups\[wsConsent.groups\[wsConsent.groups\[i].name

​wsConsent.groups\[wsConsent.groups\[wsConsent.groups\[i].label

​wsConsent.groups\[wsConsent.groups\[wsConsent.groups\[i].description

​wsConsent.groups\[wsConsent.groups\[wsConsent.groups\[i].allowed

​wsConsent.groups\[wsConsent.groups\[wsConsent.groups\[i].services

​$wsConsent.services

​wsConsent.services\[wsConsent.services\[wsConsent.services\[i].name

​wsConsent.services\[wsConsent.services\[wsConsent.services\[i].label

​wsConsent.services\[wsConsent.services\[wsConsent.services\[i].description

​wsConsent.services\[wsConsent.services\[wsConsent.services\[i].allowed

​Methoden

​$wsConsent.checkAllowed()

​Aktionen

​Beispiele für die Anzeige vom Consent Layer

​Prüfen, ob Cookies bereits gesetzt wurden

​Prüfen, ob alle Cookies bereits akzeptiert wurden

​Anzeige der Cookie Gruppen

​Anzeige der Cookies einer Gruppe

​Inhalt abhängig vom Cookie darstellen

​Weiterführende Links

Modulübersicht

Templates

Variablen

$wsConsent.alreadySet

$wsConsent.allAllowed

$wsConsent.groups

$wsConsent.groups\[$ i].name

$wsConsent.groups\[$ i].label

$wsConsent.groups\[$ i].description

$wsConsent.groups\[$ i].allowed

$wsConsent.groups\[$ i].services

$wsConsent.services

$wsConsent.services\[$ i].name

$wsConsent.services\[$ i].label

$wsConsent.services\[$ i].description

$wsConsent.services\[$ i].allowed

Methoden

$wsConsent.checkAllowed()

Aktionen

Beispiele für die Anzeige vom Consent Layer

Prüfen, ob Cookies bereits gesetzt wurden

Prüfen, ob alle Cookies bereits akzeptiert wurden

Anzeige der Cookie Gruppen

Anzeige der Cookies einer Gruppe

Inhalt abhängig vom Cookie darstellen

Weiterführende Links