In order to establish the functionality of schlau.io, an integration with the website must first take place. This includes the implementation of the global site tag, the definition of events and the establishment of the opt-out process. Optionally, an opt-in process can also be established.
The global site tag should be inserted between the <head></head> tags of every page of your website. You only need to install the global site tag once, even if you are tracking multiple events. If the global site tag is implemented correctly, visits with the gclid (Google Ads) and msclkid (Microsoft Advertising) parameters are automatically tracked as clicks.
<!DOCTYPE html>
<html>
<head>
...
<script src="https://app.schlau.io/api/js/gst/XXXXXXXXXXX.js" async></script>
</head>
<body>
...
</body>
</html>Please note that the example above does not use the specific global site tag for your project. To avoid errors, you have to implement the global site tag associated with your project on your website. You will be able to locate the correct global site tag when you open the respective project.
With regard to the integration of external scripts, there are different views on data privacy compliance. To ensure compliance even according to stricter opinions, it is possible to host the global site tag yourself. If you would like to host the Global Site Tag yourself, you can download the JavaScript snippet associated with your project directly in the schlau.io project view.
Even if you host the global site tag yourself, the IP addresses of your users are transferred to schlau.io when clicks and events are tracked. Depending on the viewpoint, this transfer of IP addresses can be classified as problematic from a data privacy perspective. The PHP proxy script is available to address this problem. If you use the PHP proxy script, the transfer of your users' IP addresses to schlau.io is prevented.
To use the PHP proxy script, you must first download it and then make it available under any publicly accessible URL.
To ensure that the PHP proxy script is actually used, you will need a modified global site tag in the second step. To download the modified global site tag, please enter your project number, which you can find in the respective schlau.io project, and the URL under which you have provided the PHP proxy script.
Events can be defined freely but you should only define events that you also want to import as conversions in your advertising accounts and each event must have a name, a value and a currency. The following example shows an event with the name purchase a value of 1250.00 and the currency EUR:
<script>
window['schlau_io'] = window['schlau_io'] || [];
window['schlau_io'].push({
type: 'event',
event: {
name: 'purchase',
value: 1250.00,
currency: 'EUR'
}
});
</script>If the values of events are not to be differentiated, the value 1 can simply be used for each event. Of course, the event can be part of a function or method and can be triggered as required. The following example shows an event with the name lead, a value of 1 and the currency USD, which is part of a function that is triggered by a click on a button with the id example-button.
<script>
function triggerLeadEvent() {
window['schlau_io'] = window['schlau_io'] || [];
window['schlau_io'].push({
type: 'event',
event: {
name: 'lead',
value: 1,
currency: 'USD'
}
});
}
document.getElementById('example-button').addEventListener('click', () => {
triggerLeadEvent();
});
</script>Please note that you should choose the names of the events carefully, as the name of the event must match the name of the conversion in the advertising account if you want to import an event as a conversion. How you name the events is up to you, in the simplest case you can give all events the same name. Of course, you can set the value and currency of an event dynamically and the value and currency can differ regardless of the same name of an event.
It is necessary to provide the user with the opportunity to object to the tracking by schlau.io. The easiest way to implement the opt-out option is to provide a link with the parameter schlau_io_opt_out=true.
<a href="./?schlau_io_opt_out=true">Opt-out</a>If a user clicks on a link with the mentioned parameter, the user is informed about the opt-out with a JavaScript alert, a technically necessary cookie with the name schlau_io_opt_out and the value true is set and a possibly existing opt-in cookie is deleted. As long as the mentioned opt-out cookie is set, the user will not be tracked by schlau.io.
Alternatively, you can also notify schlau.io programmatically about an opt-out. Please note that in this case the user will not be informed with a JavaScript alert. This provides you with the opportunity to establish your own feedback to the user.
<script>
window['schlau_io'] = window['schlau_io'] || [];
window['schlau_io'].push({
type: 'optOut'
});
</script>Even if there are not many practical use cases, we do not want to hide the fact that it is possible to withdraw an opt-out. As soon as an opt-out is withdrawn, the cookie with the name schlau_io_opt_out is deleted and the tracking of the user is resumed.
<script>
window['schlau_io'] = window['schlau_io'] || [];
window['schlau_io'].push({
type: 'revokeOptOut'
});
</script>Although schlau.io is designed to track conversions even without the user's consent, you can notify us if consent has been given. In this case, a cookie with the name schlau_io_opt_in and a user-specific hash value is set that improves the recognition of recurring visits.
<script>
window['schlau_io'] = window['schlau_io'] || [];
window['schlau_io'].push({
type: 'optIn'
});
</script>If the user withdraws their consent, you should inform schlau.io accordingly. In this case, the cookie with the name schlau_io_opt_in will be deleted immediately.
<script>
window['schlau_io'] = window['schlau_io'] || [];
window['schlau_io'].push({
type: 'revokeOptIn'
});
</script>Please note that you should not use the opt-in option if you want to establish cross-domain tracking, as cookies cannot be set and read across domains and therefore implementing the opt-in option as part of cross-domain tracking would lead to incorrect data.