Styr samtykke fra din frontend-kode med JavaScript API’et.
Med CookieHubs JavaScript API i browseren kan du læse den besøgendes samtykketilstand, reagere, så snart den ændres, og åbne eller lukke CookieHubs samtykkedialog fra din egen kode — alt sammen via window.cookiehub.
- Samtykketilstand
- Samtykke-events
- Styring af brugerfladen fra koden
Samtykke, som din frontend-kode kan læse og reagere på.
Når CookieHub-tagget er initialiseret på en side, er JavaScript API’et tilgængeligt på window.cookiehub. Dine egne scripts kan bruge det til at tjekke, hvad en besøgende har givet samtykke til, før noget kører — og til at reagere, så snart valget ændres, uden at siden genindlæses.
API’et består af to dele: offentlige metoder, som du kalder for at forespørge samtykke eller styre samtykkedialogen, og events, som CookieHub udløser, når det er indlæst, og hver gang en besøgende tillader, tilbagekalder eller opdaterer sit valg.
Se samtykketilstanden
Tjek, om en besøgende har truffet et valg, og hvilke kategorier vedkommende har tilladt, med hasAnswered() og hasConsented(category).
Kør scripts betinget
Start analyse-, marketing- og anden ikke-nødvendig kode først, når den besøgende har tilladt den kategori, koden hører til.
Reager på ændringer i samtykke
Brug onAllow, onRevoke og onStatusChange til at starte eller stoppe tjenester, så snart en besøgende opdaterer sit valg.
Styr samtykkedialogen
Åbn samtykkedialogen eller præferencecenteret fra dine egne knapper og links, og luk dem igen fra koden.
Reager, når samtykke indlæses, gives eller ændres.
CookieHub udløser et event på hvert trin i samtykkeprocessen. Tilføj callbacks til cpm-objektet i CookieHubs standardkode, eller lyt — fra version 2.8.13 — efter de samme events på document med addEventListener:
- onInitialise (cookiehub_onInitialise) udløses, når CookieHub er færdigindlæst, med den besøgendes oprindelige samtykkestatus
- onAllow (cookiehub_onAllow) udløses, når en besøgende tillader en kategori, der ikke var tilladt før
- onRevoke (cookiehub_onRevoke) udløses, når en besøgende tilbagekalder en kategori, vedkommende havde tilladt
- onStatusChange (cookiehub_onStatusChange) udløses, når en besøgende ændrer sine præferencer, f.eks. ved at gemme indstillinger eller tillade alle
Callbacks modtager kategorien eller statussen som argumenter. Browser-events har de samme data i event.detail: detail.category eller detail.status og detail.previousStatus.
Se events i referencenTjek samtykket, og styr samtykkedialogen fra din kode.
Med de offentlige metoder på window.cookiehub kan din kode spørge til samtykke og styre CookieHubs brugerflade. Dem, du oftest får brug for:
- isReady(), hasAnswered() og hasConsented(category) tjekker, om CookieHub er initialiseret, om den besøgende har truffet et valg, og om en kategori er tilladt
- openDialog() og closeDialog() åbner og lukker samtykkedialogen
- openSettings() og closeSettings() åbner og lukker præferencecenteret; openSettings(tab) åbner det på en bestemt fane, f.eks. declaration eller vendors
- allowAll() og denyAll() registrerer et valg for alle kategorier, mens allow(category) og deny(category) anvender det på en enkelt kategori
allowAll(), denyAll(), allow() og deny() er beregnet til samtykkekontroller, du selv bygger, f.eks. dine egne knapper: De udfører et valg, den besøgende træffer — ikke et valg truffet på vedkommendes vegne. API-referencen viser alle metoder, herunder openPersonalData() og isSellingAllowed(), og hvilken CookieHub-version hver enkelt kræver.
Se alle metoderTypiske måder at bruge JavaScript API’et på.
Korte eksempler på de scenarier, der oftest dukker op. Hvert eksempel bruger kun dokumenterede metoder og events, så du kan tilpasse det til din egen kode.
Indlæs kun analyse efter samtykke
Tilføj callbacks til cpm-objektet i din CookieHub-kode: onInitialise dækker besøgende, der allerede har tilladt analyse, og onAllow dækker besøgende, der tillader det senere. Samtykke-events kan udløses mere end én gang på en side, fx når en besøgende trækker samtykket til analyse tilbage og senere giver det igen, så lad loadAnalytics() tjekke, om scriptet allerede er indlæst, så det ikke tilføjes to gange.
analytics.jsEksempelvar cpm = {onInitialise: function (status) {if (this.hasConsented('analytics')) {loadAnalytics();}},onAllow: function (category) {if (category === 'analytics') {loadAnalytics();}},};Reager med det samme, når præferencer ændres
Lyt efter browser-eventet fra et hvilket som helst script på siden. Når en besøgende tilbagekalder marketing, kører du din egen oprydning for de tjenester, der afhænger af det.
consent-events.jsEksempeldocument.addEventListener('cookiehub_onRevoke', function (event) {if (event.detail.category === 'marketing') {stopMarketingTags();}});Tilføj et link til cookieindstillinger i din footer
Giv besøgende en fast vej tilbage til deres valg ved at åbne præferencecenteret fra et link i din egen footer — praktisk, hvis du har skjult CookieHubs indstillingsikon.
footer.jsEksempelvar link = document.getElementById('cookie-settings');link.addEventListener('click', function (event) {event.preventDefault();window.cookiehub.openSettings();});Hold din apps brugerflade i takt med samtykket
Opdatér brugerfladen, når CookieHub indlæses, og hver gang samtykket ændres — f.eks. ved at slå en klasse til eller fra, der viser eller skjuler funktioner, som afhænger af samtykke til præferencer.
consent-ui.jsEksempelfunction syncConsentUi() {var allowed = window.cookiehub.hasConsented('preferences');document.body.classList.toggle('preferences-allowed', allowed);}document.addEventListener('cookiehub_onInitialise', syncConsentUi);document.addEventListener('cookiehub_onStatusChange', syncConsentUi);
Brug API’et med din eksisterende CookieHub-kode.
Der er ingen separat pakke at installere. JavaScript API’et er en del af CookieHubs standardkode: Tilføj CookieHub til dit website som normalt, så er API’et tilgængeligt på window.cookiehub, når det er initialiseret.
- 01
Tilføj CookieHub-koden til dit website
Åbn fanen Implementering for dit domæne i CookieHub-dashboardet, og indsæt koden øverst i <head> på alle sider.
- 02
Tilføj callbacks til cpm-objektet
Standardkoden sender et cpm-objekt til window.cookiehub.load(). Tilføj onInitialise, onAllow, onRevoke eller onStatusChange til det. load() kører én gang pr. side; senere kald ignoreres.
window.cookiehub.load(cpm) - 03
Eller lyt efter browser-events
Fra version 2.8.13 udsender CookieHub også hvert event på document, så scripts, der indlæses separat, kan lytte med addEventListener.
cookiehub_onStatusChange - 04
Kald metoder, når CookieHub er klar
Brug isReady() til at tjekke, om CookieHub er færdig med at initialisere, eller kør din kode fra onInitialise, så den starter, når den besøgendes samtykkestatus er kendt.
window.cookiehub.isReady()
Spørgsmål om JavaScript API’et, besvaret.
Via det globale objekt window.cookiehub. Det er tilgængeligt, så snart CookieHub-koden er indlæst på siden og initialiseret; isReady() fortæller dig, om initialiseringen er færdig.
Kald window.cookiehub.hasConsented(category) med kategoriens navn eller ID, f.eks. 'analytics' eller 'marketing'. Metoden returnerer, om den besøgende har tilladt kategorien. hasAnswered() fortæller dig, om vedkommende overhovedet har truffet et valg.
Med events. onAllow og onRevoke udløses, når en enkelt kategori tillades eller tilbagekaldes, og onStatusChange, når den besøgende ændrer sine præferencer, f.eks. ved at gemme indstillinger eller tillade alle. Tilføj dem som callbacks til cpm-objektet, eller lyt efter cookiehub_onAllow, cookiehub_onRevoke og cookiehub_onStatusChange på document (fra version 2.8.13).
Ja. Kald window.cookiehub.openSettings() for at åbne præferencecenteret eller openDialog() for at åbne samtykkedialogen. openSettings(tab) åbner en bestemt fane, f.eks. declaration for cookie-erklæringen. Det er praktisk, hvis du skjuler CookieHubs indstillingsikon og i stedet linker til indstillingerne fra din footer.
Ja. allow(category) og deny(category) tillader eller afviser en enkelt kategori eller et formål — preferences, analytics, marketing, uncategorized eller sale-and-share — og allowAll() og denyAll() dækker alle kategorier på én gang. De findes, så du kan bygge dine egne samtykkekontroller: Brug dem til at udføre et valg, den besøgende træffer, ikke til at tilsidesætte det. allow() og deny() kræver CookieHub version 2.8.10 eller nyere.
Brug en metode, når din kode skal spørge om eller gøre noget nu: tjekke samtykke med hasConsented() eller åbne præferencecenteret med openSettings(). Brug et event, når din kode skal vente på, at noget sker: at CookieHub er færdigindlæst, eller at en besøgende tillader, tilbagekalder eller opdaterer sit samtykke.
Ja. Lyt efter cookiehub_onStatusChange, der udløses, hver gang en besøgende ændrer sine præferencer, og send den nye samtykketilstand til datalaget, så dine tags kan reagere med det samme. Installerer du CookieHub via Google Tag Manager med CookieHub CMP-skabelonen, sender skabelonen også datalag-events, som du kan bruge som triggere.
Ja. Indsæt <div class="cookiehub-declaration"></div>, hvor du vil have den, f.eks. på din cookiepolitik, så viser CookieHub erklæringen der som en tabel uden styling, der arver dit websites CSS. Vil du i stedet vise den i præferencecenteret, kalder du window.cookiehub.openSettings('declaration').
Nej. JavaScript API’et kører i den besøgendes browser og arbejder med samtykket på siden. Management API’et er et REST API til konfiguration og automatisering i backend, f.eks. til at arbejde med domæner og hente data fra samtykkeloggen, og det er tilgængeligt for Enterprise-kunder.
Byg samtykke ind i din frontend.
Tilføj CookieHub til dit website, og brug derefter JavaScript API’et til at læse samtykke, reagere på ændringer og give besøgende din egen vej tilbage til deres indstillinger.