Sündmused

Küpsiste korduva kontrollimise asemel telli sündmusi. Cookiesh edastab samu sündmusi kolmel viisil, nii et saad neid kuulata seal, kus sinu kood asub:

• JavaScripti API: cookiesh.on(name, handler).
• DOM-sündmused objektil window, eesliitega cookiesh:.
• dataLayer’i kirjed Google Tag Manageri jaoks.

Tellimine

on(event: string, handler: (detail) => void): () => void
off(event: string, handler: (detail) => void): void

on() tagastab funktsiooni, mis kuulaja eemaldab:

import { cookiesh } from '@cookiesh/js';

const stop = cookiesh.on('consent:updated', ({ categories, changed }) => {
  if (changed.includes('analytics')) analytics.setEnabled(categories.analytics);
});

// Hiljem, näiteks kui komponent eemaldatakse
stop();

Kui tellid sündmuse consent:ready pärast seda, kui see on juba toimunud, käivitub käsitleja kohe praeguse olekuga. Laadimisjärjekorra pärast ei pea muretsema.

Sündmuste teatmik

Sündmus	Millal see toimub	Andmed
consent:ready	Kord lehe kohta, kui nõusoleku olek on teada	{ categories, method, region }
consent:updated	Iga kord, kui külastaja või sinu kood salvestab uue valiku	{ categories, changed, method, consentId }
banner:shown	Ilmub esimese tasandi bänner	{ bannerVersion, region }
banner:hidden	Bänner sulgub, valikuga või ilma	{ reason }
preferences:opened	Avaneb eelistuste keskus	{}
preferences:closed	Eelistuste keskus sulgub	{ saved }
script:unblocked	Cookiesh käivitab skripti või laadib iframe’i, mida ta seni tagasi hoidis	{ category, src }

Nendes andmetes:

• categories on objekt, milles on iga kategooria kohta tõeväärtus: { necessary, preferences, analytics, marketing }.
• changed loetleb kategooriad, mille väärtus muutus, näiteks ['analytics'].
• method on üks väärtustest default, banner, preferences, api või gpc.
• reason on accepted, rejected, saved või closed.

DOM-sündmused

Iga sündmus saadetakse ka objektile window kui CustomEvent. See on mugav skriptide jaoks, mis paketti ei impordi:

<script>
  window.addEventListener('cookiesh:consent:updated', (event) => {
    console.log('New choice', event.detail.categories);
  });
</script>

Google Tag Manager

Cookiesh lisab dataLayer’isse kaks sündmust, mille põhjal saad päästikuid luua:

{
  event: 'cookiesh_consent_ready',
  cookiesh: { necessary: true, preferences: false, analytics: true, marketing: false, method: 'banner' }
}

{
  event: 'cookiesh_consent_updated',
  cookiesh: { necessary: true, preferences: true, analytics: true, marketing: false, method: 'preferences' }
}

Loo sündmusele cookiesh_consent_updated päästik Custom Event ja väärtuse cookiesh.marketing jaoks muutuja Data Layer Variable, et käivitada mitte-Google’i märgendid alles pärast nõusolekut. Google’i märgendid seda ei vaja: nad loevad Consent Mode’i signaale, mida Cookiesh saadab automaatselt.

Serveripoolsed sündmused

Need sündmused toimuvad külastaja brauseris. Nõusoleku muutuste vastuvõtmiseks oma serveris, näiteks nende sünkroonimiseks CRM-iga, kasuta webhook’e.