Technical Specifications

Clickio Consent Tool 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

The Consent Tool fully supports the TCF v2 CMP Javascript API, which is a part of the IAB Transparency and Consent Framework. There is also a simplified Clickio-specific API available.

Consent applicability determination

By default GDPR consent aware codes (including the consent tool itself) are served by our geo-aware CDN only to EEA users, but the publisher can switch on consent-aware codes for all users in the consent settings inside the platform.

Consent tool logic overview

1. CDN decides which code to serve EEA or non-EEA (those can be the same, if publishers choose in consent tool settings, then EEA === non-EEA)

2.1. EEA code loads on the page

• 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)
  • 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
  • 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.2. non-EEA code loads on the page

• 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 tool 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.