Cookie Services¶
A cookie service allows for the management of scripts, cookies, and iframes.
For example: Thirdparty Scripts and Iframe Manager.
Global Settings¶
name Display Name in Frontend
identifier System Identifier (do not change)
description Service Description
provider Provider URLS seperated by ","
dsgvo_link Link to Service AGB's
category_suggestion Used for simple MM Selection
Iframe Manager¶
The iframe manager is responsible for blocking third-party content.
In the field, iframe_notice text is stored that the user sees when the content is blocked.
iframe_load_btn Loads the Content of current Div
iframe_load_all_btn Loads all Content from same Service on same site
Advanced Iframe Configuration¶
iframe_thumbnail_url set valid url for automatic thumbnails or use a Javascript function
iframe_embed_url is called on Successful Accept can also use a Javascript function
Example Iframe Thumbnail function
1 function(id, callback){
2 let parts = id.split("/");
3 let videoId = parts[parts.length - 1];
4 let videoIdParts = videoId.split("?");
5 let videoIds = videoIdParts[0];
6 var url = "https://vimeo.com/api/v2/video/"+videoIds +".json";
7 var xhttp = new XMLHttpRequest();
8 xhttp.onreadystatechange = function() {
9 if (this.readyState == 4 && this.status == 200) {
10 var src = JSON.parse(this.response)[0].thumbnail_large;
11 callback(src);
12 }
13 };
14 xhttp.open("GET", url, true);
15 xhttp.send();
16 }
Script Configuration¶
OptInCode opt_in_code is executed when the user accepts the service. By default, some services do not have an OptInCode as cookie management happens automatically based on the assigned cookies. This code is only needed to execute additional JavaScript when the user accepts the service.
OptOutCode opt_out_code is executed when the user block the service. By default, some services do not have an OptOutCode as cookie management happens automatically based on the assigned cookies. This code is only needed to execute additional JavaScript when the user block the service.
Fallback Code [fallback_code] is not in use, TODO.
External Script Configuration¶
External scripts are used for example for Google Analytics. Including these is easy, here is how to create an external script.
Fields:
name Display and lable name
link The external link
async Embed the script tag asynchronous
Tip
You can provide GET parameters like in this Example: https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXX
Variable Provider¶
Variable providers detect defined variables in the fields opt_in_code opt_out_code fallback_code.
A variable is declared with the [## and closed with ##]. In the Google Analytics service you find this example: [##googleTagManagerID##]
Replace G-XXXXXXXX with your Google Tag manager ID.
Fields:
name Display and lable name
identifier the Variable in the [##myvariable##] like myvariable
value The stored string