Callback function for onReject and logging for statistics

[lparikka]

Hi
Thank you for this nice cookie consent plugin.

I would like to get some statistics on the rejection of the cookies. As far as I understand, I can't get any feedback on rejection of the cookies as there is no onReject callback function. And it would be nice to be able to log the settings the users have selected for statistical reasons.

Regards,
Lauri

[orestbida]

Hi @lparikka,

the "reject" action is treated as a special case of the accept action ("accept none", or "accept none except categories marked as necessary"). You can check #46 to find which categories have been accepted using the onAccept.

[orestbida]

Ok. I could add a new (optional) parameter inside the onAccept method: analytics_summary

onAccept : function(cookie_value, analytics_summary){ ... }

analytics_summary (an object) could have the following structure:

{
  accept_type: 'accept_all',  //'accept_all' or 'accept_necessary' (reject all) or 'accept_selection'
  accepted_categories: ['necessary', 'analytics'],
  rejected_categories: ['advertisement']
}

We also need to make sure to only send this data once! We can use .validCookie() to check if the cookie exists or not:

// if cookie doesn't exist => firstTime = true
const firstTime = !cc.validCookie('cc_cookie');

So if we put together the pieces, it would become something like this:

const cc = initCookieConsent();
const firstTime = !cc.validCookie('cc_cookie');

cc.run({
    ..,
    onAccept: function(cookie_value, analytics_summary){

        if(firstTime){
            console.log('accept_type:', analytics_summary.accept_type);
            // [TODO] send analytics data to the server ...
        }
    },
    ...
});

[lparikka]

Sounds good. Do you think universal enough for people to use?

[orestbida]

One other way could be to make use of the data field inside the cookie (initially empty/null).

onAccept: function(cookie_value, analytics_summary){
    if(!cc.get('data')){
        // [TODO] send analytics data to the server ...
        cc.set('data', { value: true );
    }
}

I think it's easy enough to use, perhaphs there are better ways to do this. I'm open to suggestions!

[OndraM]

This is what we use right now:

onAccept: (cookie) => {
      const givenLevels = cookieconsent.get('level');
      const acceptedOnlyNecessary = givenLevels.length === 1 && givenLevels[0] === 'necessary'; // we have "necessary" as the default readonly level

    if (acceptedOnlyNecessary) { // aka "reject_all"
        // ...
    }
}

However using something like:

onAccept: (cookie, analytics_summary) => {
    if (analytics_summary.accept_type === 'reject_all') {
        // ...
    }
}

... would make it a bit cleaner.

[orestbida]

Yes, the only "issue" is to log user choices only once as @lparikka wanted.

We'd need to log the preferences of:

• users who have already given consent (and whose preferences are not logged yet)
• new users

The only way to achieve this (as of now) is to rely on the data field inside the cookie (by default set to null) :

if(!cc.get('data')){
    // [TODO] send analytics data to the server ...
    cc.set('data', { value: true );
}

Needless to say, the implementation would be different for those who already utilize data - which, is not ideal.

[orestbida]

@lparikka ,

A solution to this was implemented in v2.7.0. To make it easier — than what was discussed above — a new function prop. called onFirstAction was added. It will run only the first time the user makes a choice.

the only parameter of the function - "user_preferences" - returns the following object:

{
    accept_type: string,            // 'all', 'necessary', 'custom'
    accepted_categories: string[],  // e.g. ['necessary', 'analytics']
    rejected_categories: string[]   // e.g. ['ads']
}

Example:

// ...
cc.run({
    // ...
    onFirstAction: function(user_preferences){
        console.log('user accept type:', user_preferences.accept_type);
    },
    // ...
});

For more flexibility, a .getUserPreferences()method was also added for usage outside the onFirstAction function. It returns the same object as "user_preferences" parameter.