Technical Overview
Clickio Consent (CMP) is easy to use and does not require coding to set up. However, if you want to integrate it with other solutions or introduce custom workflows, the following documentation would be useful for you.
CMP API
Clickio Consent fully supports the TCF v2.2 CMP Javascript API, which is a part of the IAB Transparency and Consent Framework. There is also a simplified Clickio-specific API available.
Clickio Consent logic overview
Clickio CMP supports two GDPR scopes:
- EEA/UK Only
- All Users (Global)
1. User is the scope chosen for GDPR
- Code checks for existing consent:
- No consent
- Ads codes are paused (AdManager, AdSense, Clickio)
- __tcfapi initializes
- consentCallback is triggered and clickioConsentEvent is dispatched with state: -1
- Consent popup UI is shown
- User makes choice
- __tcfapi state updated
- Consent information is stored in the browser
- Ads codes are unpaused:
- Clickio
- AdManager, AdSense (if a user has granted Google consent)
- Tags with type="text/clickiocmp" in accordance with their parameters
- consentCallback is triggered and clickioConsentEvent is dispatched with the state: 1
- Existing consent
- __tcfapi initializes
- Ads codes are paused (AdManager, AdSense) if the user has not granted Google consent
- Tags with type="text/clickiocmp" are unpaused in accordance with their parameters
- If consent information needs an update - popup UI is shown (not ads blocking)
- consentCallback is triggered and clickioConsentEvent is dispatched with the state: 1
2. User is out of scope chosen for GDPR
- No consent
- Clickio simplified API methods are instanced with corresponding permissive values
- __tcfapi initializes if turned on
- consentCallback is triggered and clickioConsentEvent is dispatched with the state: null
- Existing consent (user visited EEA and has provided consent)
- __tcfapi initializes if turned on
- Ads codes are paused (AdManager, AdSense) if the user has not granted Google consent
- consentCallback is triggered and clickioConsentEvent is dispatched with the state: 1
How to force the consent dialog to be shown
You can use the following code to forcefully show the consent UI. You do not need to do this unless you are absolutely sure it`s mandatory, otherwise Clickio Consent shows the popup automatically when needed. Please note that it will only be shown to EEA users.
window.__lxG__consent__.showConsent();
Alternatively, you can add ?showConsent=1
parameter to the page URL, also applies only to EEA users.
How to prevent the consent dialog from showing
To disable the Consent dialog for all users, place the following codes on your page:
<script>
window.__lxG__consent__ = window.__lxG__consent__ || {};
window.__lxG__consent__.disableConsentDialog = true;
</script>
Alternatively, you can append ?showConsent=no
to the page URL. For instance, this can be applied to the Privacy Policy URL to prevent the dialog from appearing.
How to disable automatic calls to Google ad tags
<script>
window.disableGoogleLoadControl = true;
</script>