API JavaScript - Consentmanager Staging

CMP consentmanager.net obsługuje różne interfejsy API JavaScript, aby umożliwić stronom internetowym pobieranie informacji o zgodach.

Korzystanie z API

W przypadku wszystkich żądań kierowanych do API prosimy zawsze korzystać wyłącznie z funkcji publicznych wymienionych poniżej. Prosimy nie uzyskiwać bezpośredniego dostępu do wewnętrznego obiektu window.cmpmngr!

Aby wysłać lub odebrać informacje z/do API, możesz skorzystać z funkcji ogólnodostępnej __cmp(...). Funkcja ta obsługuje większość typowych żądań. Oprócz tego CMP oferuje również funkcje publiczne __tcfapi(...) zgodności z IAB TCF v2 oraz __gpp(...) zgodności z IAB GPP

Przykład:

var x = __cmp('consentStatus');
if(x.consentExists){/* do something */}

Funkcje API

Trzy funkcje API wykorzystują różne parametry ze względu na różne specyfikacje, którym te funkcje podlegają. Funkcje API to:

__cmp( Command, Parameter, Callback, Async )

__tcfapi( Command, Version, Callback, Parameter )

__gpp( Command, Version, Callback, Parameter )

Usunięto: Należy pamiętać, że funkcja __uspapi() już nie istnieje i została zastąpiona przez __gpp().

Należy pamiętać, że w przypadku __cmp() wszystkie parametry z wyjątkiem Command są opcjonalne.

Zlecenia

API obsługuje następujące polecenia:

Należy pamiętać, że nasze API może zwracać obiekty dla poleceń TCF v1+v2, które różnią się od standardu. Więcej szczegółów znajdziesz tutaj.

Polecenie	Funkcja	Opis
`getTCData`	`__tcfapi()`	Pobierz obiekt danych zgody zgodnie z IAB TCF v2.
`noncompliant_getTCData`	`__tcfapi()`	Pobierz obiekt danych zgody zgodnie z IAB TCF v2 w przypadku niezgodnej konfiguracji CMP.
`ping`	`__cmp()` `__tcfapi()` `__gpp()`	W zależności od użytej funkcji: `__cmp('ping')` zwróci wartość false. `__tcfapi('ping')` zwróci obiekt ping IAB TCF v2. `__gpp('ping',callback)` zwróci obiekt ping GPP.
`addEventListener`	`__cmp()` `__tcfapi()`	Dodaje nowy detektor zdarzeń. Szczegóły znajdziesz tutaj. Należy pamiętać, że parametry zależą od użytej funkcji.
`removeEventListener`	`__cmp()` `__tcfapi()`	Usuwa detektor zdarzeń. Zobacz powyżej.
`getCMPData`	`__cmp()`	Pobierz obiekt zawierający wszystkie istotne dane dotyczące zgody. `{ consentstring: "IAB TCF consent string", uspstring: "IAB US Privacy String", gdprApplies: true/false, hasGlobalScope: true/false, tcfversion: 0/1/2, tcfcompliant: true/false, regulation: 0/1/2 (none / GDPR / CCPA), purposeConsents: {}, vendorConsents: {}, purposeLI: {}, vendorLI: {} googleVendorConsents: {} }`

`consentStatus`	`__cmp()`	Pobierz ciąg znaków zgody i informacje, jeśli użytkownik dokonał wyboru. Zwrócony obiekt statusu będzie wyglądał następująco: `{'consentExists': true/false, 'consentData': '…'}` Należy pamiętać, że nie oznacza to zgody, a jedynie to, że użytkownik dokonał wyboru.
`setConsent`	`__cmp()`	Symuluje kliknięcie użytkownika na „zaakceptuj wszystko” (parametr = 1) lub „odrzuć wszystko” (parametr = 0).
`setVendorConsent`	`__cmp()`	Ustawia status zgody dla określonego dostawcy. Identyfikator dostawcy i status należy przekazać jako tablicę za pomocą parametru 2, np. `__cmp('setVendorConsent',['s30', 1 ])` ustawia zgodę (akceptację) dla dostawcy s30. Możliwe wartości statusu: 0 = odrzucenie 1 = akceptacja 2 = odrzuć, nie uwzględniaj 3 = akceptacja, nie uwzględniać
`setPurposeConsent`	`__cmp()`	Ustawia status zgody dla określonego celu. Identyfikator celu i status należy przekazać jako tablicę za pomocą parametru 2, np. `__cmp('setPurposeConsent',[52, 1 ])` ustawia zgodę (akceptację) dla celu 52. Jeśli chcesz ustawić zgodę dla celu i wszystkich dostawców przypisanych do tego celu, możesz ustawić trzecie pole na true, np. `__cmp('setPurposeConsent',[52, 1, true ])`
`exportConsent`	`__cmp()`	Eksportuje informacje o zgodzie w celu udostępniania zgody na różnych urządzeniach.
`importConsent`	`__cmp()`	Importuje informacje o zgodzie dla tego gościa.
`cancelwait`	`__cmp()`	Zatrzymuje CMP przed oczekiwaniem na przychodzące wywołania importu zgody.

`showScreen`	`__cmp()`	Wyświetla ekran powitalny (w zależności od lokalizacji odwiedzających/konfiguracji konta).
`showScreenAdvanced`	`__cmp()`	Wyświetla menedżera preferencji (w zależności od lokalizacji odwiedzających/konfiguracji konta). Uwaga: Możesz użyć drugiego parametru, aby wskazać, która strona powinna zostać otwarta (np. użyj „c52”, aby otworzyć stronę dla celu c52).
`showCookies`	`__cmp()`	Wyświetl tabelę plików cookie.
`close`	`__cmp()`	Zamknij warstwę zgody.

`setAgeCallback`	`__cmp()`	Ustaw funkcję wywołania zwrotnego dla weryfikacji wieku.
`setUserID`	`__cmp()`	Ustaw zewnętrzny identyfikator użytkownika 1. `setUserID` ustawia identyfikator zewnętrzny (ID 2, ID 3), pod którym użytkownik jest znany. `getUserID` oraz `setUserID` oba zwracają obiekt identyfikatora użytkownika: `{'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}` Uwaga: Wewnętrzny identyfikator użytkownika jest dostępny tylko wtedy, gdy jest włączony w ustawieniach CMP i po wywołaniu zdarzenia „settings” (zobacz zdarzenia CMP).
`setUserID2`	`__cmp()`	Ustaw zewnętrzny identyfikator użytkownika 2
`setUserID3`	`__cmp()`	Ustaw zewnętrzny identyfikator użytkownika 3
`getUserID`	`__cmp()`	Pobierz wszystkie identyfikatory użytkownika
`checkBlocking`	`__cmp()`	Sprawdza, czy zablokowane elementy można odblokować, i odblokowuje je.
`checkShowScreen`	`__cmp()`	Sprawdza, czy należy (ponownie) wyświetlić warstwę zgody.

`privacyLink`	`__cmp()`	Przekierowuje odwiedzającego na stronę z polityką prywatności.
`tacLink`	`__cmp()`	Przekierowuje użytkownika na stronę z Warunkami korzystania z serwisu.
`imprintLink`	`__cmp()`	Przekierowuje użytkownika na stronę z informacjami prawnymi/stopką redakcyjną.

We do our best to keep this purely informative documentation up to date. However, if you notice that any of these guides need a little touch-up, let us know!