reconsiderConsent
- 1 Functionality
- 2 Syntax
- 3 Description
- 3.1 Scope
- 4 Examples
Functionality
Users from EEA countries who do not give full consent can be asked again after some time to reconsider their consent decision. This can be done through the reconsiderConsent
function which enables consent reconsideration in AdConsent. This feature applies to users within GDPR consent zone only, and it is disabled by default.
Syntax
function adconsent.gdpr()
argument name | type | optional | value | description |
---|---|---|---|---|
command | string |
|
|
|
parameter | number |
|
| The number of hours until triggering the reconsideration function, passed in the |
callback | function | ✔️ |
| The callback function is to be called when the reconsideration period has passed, having the cookie age in hours passed as a parameter. |
callback
This is the publisher defined function to be called when the reconsideration period triggers. It is called with the cookie age in hours as an input parameter. It can be undefined though, and in that case, the default adconsent('showGUI')
function will be called when the reconsideration is triggered.
parameter
The number of hours until triggering consent reconsideration. It can have the following values:
-1
disable reconsideration (this is the default status)0
enable reconsideration and trigger it every time the consent is found not to be full consent1, 2, ... N
enable reconsideration and trigger it after N hours since the given consent date
Description
When enabled, AdConsent checks if the user hasn’t given full consent and the cookie age is older than the number of hours to reconsider. In that case, if no callback is given, AdConsent will automatically open the GUI in layer 1 (same as showGUI
command). If a callback is given it will be called with the age of the cookie in hours. The callback implementation can decide what to do, the GUI will not show automatically. To show the GUI adconsent('showGUI');
has to be called in the callback function.
When the AdConsent GUI opens, the user can either accept all, keep his previous custom choices, or change to new custom choices. In either way, the user's choice is stored again setting the consent date to the current date and time. This means that reconsider will only be triggered once every configured reconsideration hours. For example, if reconsideration is set to 48 hours, the user will get an AdConsent GUI once every two days.
Even when AdConsent opens the GUI or calls the custom reconsideration function upon a consent reconsideration, all the existing consent event flow is maintained. This means that, e.g., having an ad provider in the page that starts when consent is available will be started as soon as consent is read. This system won't wait for reconsideration, so the ad provider will start and show ads with a non-full consent (if possible) and then, after the reconsideration and if the user indeed reconsidered consent, a new consent event is triggered, thus allowing the existing systems that depend on consent to update their consent values and act accordingly.
Scope
The function must be called before AdConsent start
, i.e. in the stub. Calls after AdConsent is started will be ignored.
Examples
Enable consent reconsideration after 48 hours, without any specific reconsideration function
This configuration will open the AdConsent GUI when there is no full consent and the choice is older than 48 hours. It will store the user's new choices and when no full consent was given, trigger after 48 hours again.
adconsent.gdpr('reconsiderConsent', 48);
Enable consent reconsideration as soon as it is found to be not a full one, using a custom callback function
This configuration will trigger the given callback function since non-full consent was given. In the first 2 days, it won't do anything. Between 2 and 4 days you could show a reminder to reconsider consent. After 4 days, it directly opens the GUI without any questions to the user.
It is advisable that the reminder is not intrusive, like a popup, but embedded within your content. This reminder view should have a button or link which opens the AdConsent GUI when clicked.
This is an example of what can be done, publisher logic and/or means to show information to the user can be completely different.
adconsent.gdpr('reconsiderConsent', 0, function(cookieAge) {
if (cookieAge > 96) {
// after 4 days, just show the GUI
adconsent('showGUI');
} else if (cookieAge > 48) {
// after 2 days, provide a direct way to open the GUI
// for example, you might show a banner or any element embedded in your content to remind the user to reconsider giving full consent.
// Within your custom view, provide a button or link to open the AdConsent GUI with `adconsent('showGUI');`
}
});
Disable consent reconsideration (default mode)
Consent reconsideration is disabled by default, but if for some reason you want to enable and then disable reconsideration, you may do it through this call.
adconsent.gdpr('reconsiderConsent', -1);