Javascript APIs

CCM19 offers several Javascript APIs that can be used to access Cookie Manager functionalities and respond to user interactions.

Global object

The direct control options of CCM19 are bundled in the global Javascript object CCM:

Alternatively, the dialogs can also be controlled via links with the targets #CCM.openWidget, #CCM.closeWidget, #CCM.openControlPanel and #CCM.closeControlPanel.

Extension for ad-free and tracking-free networks

If the option "My website is part of an ad-free and tracking-free network " is active in the Developer settings > Frontend behavior area of the domain, the following endpoints are defined and can be used in the frontend.

The following endpoints were published with version 2023.03.20 and are not available in older versions.

As the above interfaces are only available if the corresponding option for ad-free and tracking-free networks is active, the network operator should check the availability in their code to prevent access to undefined properties. The own code should therefore be bracketed as follows, for example.

if (typeof window.CCM == 'object' && typeof window.CCM.denyAllPrivileges == 'function') {
    // option "My website is part of an ad-free and tracking-free network" is active
    // and the properties can be accessed.
}
else {
    console.log('Please activate option in CCM19.');
}

Javascript events

Some events in CCM19 are mapped to CustomEvents on the window object and can be reacted to with window.addEventListener(...).