API

INFO

Available from version 1.22.0 of the Pixel Manager

The Pixel Manager Cookie Consent API allows you to command the Pixel Manager if you are using a custom-made cookie consent banner. The API can also be used by publicly distributed Consent Management Platforms (CMPs) to integrate with the Pixel Manager.

Use the Pixel Manager Command Queue

You never know when the Pixel Manager is loaded. A shop manager might have enabled lazy loading in the Pixel Manager settings. Or, third-party plugins might load the Pixel Manager asynchronously. To make sure that the Pixel Manager is loaded before you call the API, use the Pixel Manager Command Queue (from version 1.49.0). The command queue is a global array called window._pmwq. You can push your commands to this array and they will be executed when the Pixel Manager is loaded (or executed immediately if the Pixel Manager is already loaded).
window._pmwq = window._pmwq || [];
window._pmwq.push(function () {
/// Add your command here
pmw.consent.api.acceptAll();
});

Use the Pixel Manager Command Queue

Accept all cookies and fire all pixels

↑ Back to top

pmw.consentAcceptAll()

Adjust cookie consent selectively

↑ Back to top

pmw.consentAdjustSelectively({
    analytics: true,
    ads: true,
})

Revoke consent for all cookies

↑ Back to top

pmw.consentRevokeAll()

Cookie consent duration

↑ Back to top

By default, the Pixel Manager sets the cookie duration to 365 days.You can adjust this by passing the additional duration parameter (in an object).

pmw.consentAcceptAll({duration: 30})
pmw.consentAdjustSelectively({
    analytics: true,
    ads: true,
    duration: 30,
})