JavaScript-API
De consentmanager.net CMP ondersteunt verschillende JavaScript-API's zodat websites toestemmingsinformatie kunnen ophalen.
Met behulp van de API
Gebruik voor alle verzoeken aan de API altijd alleen de hieronder vermelde openbare functies. Alstublieft geen toegang tot het interne window.cmpmngr-object direct!
Om informatie van / naar de API te verzenden of te ontvangen, kunt u de algemene openbare functie gebruiken __cmp(...)
. Deze functie kan de meeste algemene verzoeken afhandelen. Daarnaast biedt het CMP ook publieke functies __tcfapi(...)
voor IAB TCF v2-conformiteit en __uspapi(...)
voor IAB US Privacy-naleving.
Voorbeeld:
var x = __cmp('consentStatus');
if(x.consentExists){/* do something */}
API-functies
De drie API-functies gebruiken verschillende parameters vanwege de verschillende specificaties die deze functies volgen. De API-functies zijn:
__cmp( Command, Parameter, Callback, Async )
__uspapi( Command, Version, Callback, Parameter )
__tcfapi( Command, Version, Callback, Parameter )
Let op, dat voor __cmp()
alle parameters behalve Command
zijn optioneel.
commando's
De API ondersteunt de volgende opdrachten:
Houd er rekening mee dat onze API objecten kan retourneren naar TCF v1 + v2-opdrachten, die afwijken van de standaard. Zie hier voor meer details.
commando | Functie | Beschrijving |
getTCData |
__tcfapi() |
Krijg toestemmingsgegevensobject volgens IAB TCF v2. |
noncompliant_getTCData |
__tcfapi() |
Krijg toestemmingsgegevensobject volgens IAB TCF v2 in het geval van een niet-conforme installatie van de CMP. |
getUSPData |
__uspapi() |
Tekenreeks voor toestemmingsgegevens ophalen volgens IAB US Privacy-specificatie |
ping |
|
Afhankelijk van gebruikte functie:
|
addEventListener |
|
Voegt een nieuwe gebeurtenislistener toe. Zie details hier. Houd er rekening mee dat de parameters afhankelijk zijn van de gebruikte functie. |
removeEventListener |
|
Verwijdert een gebeurtenislistener. Zie hierboven. |
getCMPData |
__cmp() |
Koop een object dat alle relevante toestemmingsgegevens bevat.
|
|
||
consentStatus |
__cmp() |
Krijg toestemmingsreeks en info als gebruikerskeuze wordt gegeven. Het geretourneerde statusobject ziet er als volgt uit: Houd er rekening mee dat dit wel het geval is niet signaal toestemming, maar alleen als de gebruiker een keuze heeft gemaakt. |
setConsent |
__cmp() |
Simuleer een gebruiker klik op alles accepteren (Parameter = 1) of alles afwijzen (Parameter = 0). |
setVendorConsent |
__cmp() |
Stelt de toestemmingsstatus in voor een bepaalde leverancier. Vendor-ID en status moeten worden doorgegeven als array via parameter 2, bijv 0 = afwijzen 1 = accepteren 2 = afwijzen, tellen niet mee 3 = accepteren, tellen niet mee |
setPurposeConsent |
__cmp() |
Stelt de toestemmingsstatus in voor een bepaald doel. Purpose-ID en status moeten worden doorgegeven als array via parameter 2, bijv Als u toestemming wilt instellen voor een bepaald doel en alle leveranciers die aan dit doel zijn toegewezen, kunt u het derde veld op waar instellen, bijvoorbeeld
|
exportConsent |
__cmp() |
Exporteert toestemmingsinformatie voor het delen van toestemmingen op verschillende apparaten. |
importConsent |
__cmp() |
Importeert toestemmingsinformatie voor deze bezoeker. |
cancelwait |
__cmp() |
Voorkom dat de CMP wacht op inkomende importaanroepen voor toestemming. |
showScreen |
__cmp() |
Welkomstscherm tonen (afhankelijk van de locatie van de bezoeker / accountconfiguratie). |
showGDPRScreen |
__cmp() |
Welkomstscherm voor GDPR weergeven |
showCCPAScreen |
__cmp() |
Welkomstscherm voor CCPA weergeven |
showScreenAdvanced |
__cmp() |
Toon voorkeurenmanager (afhankelijk van bezoekerslocatie/accountconfiguratie). Let op: U kunt de tweede parameter gebruiken om aan te geven welke pagina geopend moet worden (gebruik bijvoorbeeld "c52" om de pagina te openen voor doel c52). |
showGDPRScreenAdvanced |
__cmp() |
Toon voorkeurmanager voor GDPR |
showGDPRScreenVendors |
__cmp() |
Voorkeurenbeheer voor AVG weergeven> Alle leveranciers oproepen |
showCCPAScreenAdvanced |
__cmp() |
Toon voorkeursmanager voor CCPA |
showCookies |
__cmp() |
Laat de cookietabel zien. |
close |
__cmp() |
Sluit de toestemmingslaag. |
setAgeCallback |
__cmp() |
Zet de callback-functie voor leeftijdsverificatie. |
setUserID |
__cmp() |
Stel externe gebruikers-ID 1 in.
|
setUserID2 |
__cmp() |
Stel externe gebruikers-ID 2 in |
setUserID3 |
__cmp() |
Stel externe gebruikers-ID 3 in |
getUserID |
__cmp() |
Verkrijg alle gebruikers-ID's |
checkBlocking |
__cmp() |
Controleert of geblokkeerde elementen kunnen worden gedeblokkeerd en deblokkeren. |
checkShowScreen |
__cmp() |
Controleert of de toestemmingslaag (opnieuw) moet worden weergegeven. |
privacyLink |
__cmp() |
Leidt de bezoeker om naar de privacybeleidspagina. |
tacLink |
__cmp() |
Brengt de bezoeker door naar de pagina Algemene voorwaarden. |
imprintLink |
__cmp() |
Leidt de bezoeker door naar de juridische kennisgeving / afdrukpagina. |