Informacia
Treść
Książki
CMP
API JavaScript
API JavaScript

API JavaScript

Opona consentmanager.net CMP obsługuje różne interfejsy API JavaScript, aby umożliwić witrynom pobieranie informacji o zgodzie.

Korzystanie z API

W przypadku wszystkich żądań do API zawsze używaj tylko funkcji publicznych wymienionych poniżej. Proszę nie uzyskaj bezpośredni dostęp do wewnętrznego obiektu window.cmpmngr!

W celu wysyłania lub odbierania informacji z/do API możesz skorzystać z funkcji general public __cmp(...). Ta funkcja może obsłużyć większość ogólnych żądań. Oprócz tego CMP oferuje również funkcje publiczne __tcfapi(...) dla zgodności IAB TCF v2 i __uspapi(...) dla zgodności IAB US Privacy.

Przykład:

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

Funkcje API

Te trzy funkcje API używają różnych parametrów ze względu na różne specyfikacje, które te funkcje mają. Funkcje API to:

__cmp( Command, Parameter, Callback, Async )
__uspapi( Command, Version, Callback, Parameter )
__tcfapi( Command, Version, Callback, Parameter )

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

Polecenia

API obsługuje następujące polecenia:

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

Command Funkcjonować Opis Projektu
getTCData __tcfapi() Uzyskaj obiekt danych zgody zgodnie z IAB TCF v2.
noncompliant_getTCData __tcfapi() Uzyskaj obiekt danych zgody zgodnie z IAB TCF v2 w przypadku niezgodnej konfiguracji CMP.
getUSPData __uspapi() Uzyskaj ciąg danych zgody zgodnie ze specyfikacją IAB US Privacy.
ping

__cmp()

__tcfapi()

W zależności od używanej funkcji:

__cmp('ping') zwróci fałsz.

__tcfapi('ping') zwróci obiekt ping IAB TCF v2.
addEventListener

__cmp()

__tcfapi()

Dodaje nowy detektor zdarzeń. Zobacz szczegóły tutaj.

Należy pamiętać, że parametry zależą od używanej funkcji.
removeEventListener

__cmp()

__tcfapi()

 Usuwa detektor zdarzeń. Patrz wyżej.
getCMPData __cmp()

Uzyskaj obiekt, który zawiera 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()

Uzyskaj ciąg zgody i informacje, jeśli użytkownik wybierze. Zwrócony obiekt statusu będzie wyglądał tak: {'consentExists': true/false, 'consentData': '…'}

Należy pamiętać, że to nie nie sygnalizować zgodę, ale tylko wtedy, gdy użytkownik dokonał wyboru.
setConsent __cmp() Zasymuluj kliknięcie przez użytkownika zaakceptuj wszystko (Parametr = 1) lub odrzuć wszystkie (Parametr = 0).
setVendorConsent __cmp()

Ustawia stan zgody dla określonego dostawcy. Identyfikator dostawcy i status muszą być przekazane jako tablica za pomocą parametru 2, np. __cmp('setVendorConsent',['s30', 1 ]) ustawia zgodę (akceptację) dla sprzedawcy s30. Możliwe wartości statusu:

0 = odrzuć

1 = akceptuj

2 = odrzuć, nie licz

3 = akceptuj, nie licz
setPurposeConsent __cmp()

Ustawia status zgody na określony cel. Identyfikator celu i status muszą być przekazane jako tablica za pomocą parametru 2, np. __cmp('setPurposeConsent',[52, 1 ]) wyraża zgodę (akceptuje) na cel 52.

Jeśli chcesz ustawić zgodę na określony cel i wszystkich dostawców przypisanych do tego celu, możesz ustawić trzecie pole na wartość true, np.

__cmp('setPurposeConsent',[52, 1, true ])
exportConsent __cmp() Eksportuje informacje o zgodzie dla udostępnianie zgody na różne urządzenia.
importConsent __cmp() Importuje informacje o zgodzie dla tego gościa.
cancelwait __cmp() Powstrzymaj CMP przed oczekiwaniem na przychodzące wywołania importu zgody.
     
showScreen __cmp() Pokaż ekran powitalny (w zależności od lokalizacji odwiedzających/konfiguracji konta).
showGDPRScreen __cmp() Pokaż ekran powitalny dla RODO
showCCPAScreen __cmp() Pokaż ekran powitalny dla CCPA
showScreenAdvanced __cmp() Pokaż menedżera preferencji (w zależności od lokalizacji/konfiguracji konta odwiedzającego). Uwaga: Za pomocą drugiego parametru możesz wskazać, która strona ma zostać otwarta (np. użyj „c52”, aby otworzyć stronę w celu c52).
showGDPRScreenAdvanced __cmp() Pokaż menedżera preferencji dla RODO
showGDPRScreenVendors __cmp() Pokaż menedżera preferencji dla RODO > Strona Wszyscy dostawcy
showCCPAScreenAdvanced __cmp() Pokaż menedżera preferencji dla CCPA
showCookies __cmp() Pokaż tabelę ciasteczek.
close __cmp() Zamknij warstwę zgody.
     
setAgeCallback __cmp() Zestaw funkcja oddzwaniania do weryfikacji wieku.
setUserID __cmp()

Ustaw zewnętrzny identyfikator użytkownika 1.

setUserID ustawia identyfikator zewnętrzny (ID 2, ID 3), dla którego znany jest użytkownik. getUserID i 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 wyzwoleniu zdarzenia „ustawienia” (patrz Wydarzenia CMP).
setUserID2 __cmp() Ustaw zewnętrzny identyfikator użytkownika 2
setUserID3 __cmp() Ustaw zewnętrzny identyfikator użytkownika 3
getUserID __cmp() Uzyskaj wszystkie identyfikatory użytkowników
checkBlocking __cmp() Sprawdza, czy zablokowane elementy można odblokować i odblokować.
checkShowScreen __cmp() Sprawdza, czy wyświetlić warstwę zgody (ponownie).
     
privacyLink __cmp() Przekierowuje odwiedzającego na stronę polityki prywatności.
tacLink __cmp() Przekierowuje odwiedzającego na stronę Regulamin.
imprintLink __cmp() Przekierowuje odwiedzającego na stronę z informacjami prawnymi/wydrukami.

 

Szczegóły
Wersja #18
Stworzony 4 lat temu by Styczeń
Zaktualizowano 2 tydzień temu by Styczeń
Nie masz jeszcze konta?

Zapewnij zgodność z RODO dzięki naszemu plikowi cookie RODO Consent Manager rozwiązanie. Wypróbuj teraz za darmo!

Plik cookie RODO Consent Manager
Powrót do góry