[Android] 2. Dokumentacja API
API
Konstruktor
Konstruktor do tworzenia obiektu CmpManager
parametry
| Imię | Typ |
Opis |
| kontekst | Kontekst |
Kontekst aplikacji |
| config | Konfiguracja CMP |
Obiekt konfiguracji dla consent manager |
| zamknij Słuchacz | Przy zamknięciu oddzwaniania |
Wywołanie zwrotne, które ma zostać wywołane po zamknięciu warstwy zgody |
| Otwórz słuchacza | OnOpenCallback |
Wywołanie zwrotne, które ma zostać wywołane po otwarciu warstwy zgody |
| cmpNieotwarte wywołanie zwrotne | OnCMPNotOpenedOddzwonienie |
Wywołanie zwrotne, które ma zostać wywołane, gdy nie można otworzyć warstwy zgody |
| przy oddzwonieniu po błędzie | Przy oddzwonieniu po błędzie |
Wywołanie zwrotne, które ma zostać wywołane w przypadku błędu |
zainicjować
Inicjalizacja
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | |
| interfejs aplikacji | Interfejs CmpLayerAppEventListener? = zero |
Powrót
Przykład
initialize(context = ...,appInterface = ...)
ustaw wywołania zwrotne
Ustaw wywołania zwrotne
parametry
| Imię | Typ | Opis |
| Otwórz słuchacza | OnOpenCallback? | |
| zamknij Słuchacz | Po zamknięciu oddzwaniania? | |
| cmpNieotwarte wywołanie zwrotne | OnCMMPNotOpenedCallback? | |
| przy oddzwonieniu po błędzie | Przy oddzwonieniu po błędzie? | |
| onCmpButtonClickedCallback | OnCmpButtonClickedOddzwonienie? |
Powrót
Brak wartości zwracanej
Przykład
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)
checkAndOpenConsentLayer
Sprawdź i otwórz warstwę zgody
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| interfejs aplikacji | Interfejs CmpLayerAppEventListener? = zero |
Powrót
Brak wartości zwracanej
Przykład
checkAndOpenConsentLayer(context = ...,appInterface = ...)
otwórz warstwę niestandardową
otwiera dostosowaną warstwę zgody
parametry
| Imię | Typ | Opis |
| działalność | FragmentAktywność | przykład |
| identyfikator widoku kontenera | Int |
Powrót
Brak wartości zwracanej
Przykład
openCustomLayer(activity = ...,containerViewId = ...)
ZOBACZ
Kontrola
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | |
| onCmpLayerOpenCallback | OnCmpLayerOpenCallback | |
| jest w pamięci podręcznej | Wartość logiczna = fałsz |
Powrót
Brak wartości zwracanej
Przykład
check(context = ...,onCmpLayerOpenCallback = ...,isCached = ...)
otwórz warstwę niestandardową
otwiera dostosowaną warstwę zgody
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| interfejs aplikacji | Interfejs CmpLayerAppEventListener |
Powrót
Brak wartości zwracanej
Przykład
openCustomLayer(context = ...,appInterface = ...)
otwórz warstwę zgody
otwiera warstwę zgody
Powrót
Brak wartości zwracanej
Przykład
openConsentLayer()
utwórzCustomLayerFragment
Utwórz niestandardowy fragment warstwy
Powrót
Fragment warstwy Cmp
Przykład
createCustomLayerFragment()
ma zgodę
sprawdzić, czy użytkownik wyraził zgodę
Powrót
aplikacja ma zgodę, czy nie
Przykład
hasConsent()
pobierzWszystkie cele
zwraca wszystkie cele jako ciąg znaków
Powrót
cel Ciąg
Przykład
getAllPurposes()
pobierz listę wszystkich celów
zwraca wszystkie cele jako listę ciągów
Powrót
Lista celów
Przykład
getAllPurposeList()
getEnabledCele
Uzyskaj uzgodnione cele
Powrót
Przykład
getEnabledPurposes()
getEnabledPurposeList
Uzyskaj uzgodnioną listę celów
Powrót
Przykład
getEnabledPurposeList()
getDisabledCele
Zdobądź cele dla osób niepełnosprawnych
Powrót
Przykład
getDisabledPurposes()
getAllVendors
Zdobądź wszystkich dostawców
Powrót
Przykład
getAllVendors()
pobierz listę wszystkich dostawców
Pobierz listę wszystkich dostawców
Powrót
Przykład
getAllVendorsList()
getEnabledVendors
Uzyskaj uzgodnionych dostawców
Powrót
Przykład
getEnabledVendors()
getEnabledVendorList
Uzyskaj uzgodnioną listę dostawców
Powrót
Przykład
getEnabledVendorList()
getDisabledVendors
Zdobądź wyłączonych dostawców
Powrót
Przykład
getDisabledVendors()
włącz listę dostawców
Włącz listę dostawców
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| sprzedawców | Lista | |
| onConsentReceivedOddzwonienie zwrotne | Oddzwanianie po otrzymaniu zgody? = zero |
Powrót
Brak wartości zwracanej
Przykład
enableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
wyłącz listę dostawców
Wyłącz listę dostawców
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| sprzedawców | Lista | Lista identyfikatorów dostawców do włączenia. |
| onConsentReceivedOddzwonienie zwrotne | Oddzwanianie po otrzymaniu zgody? = zero |
Powrót
Brak wartości zwracanej
Przykład
disableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
włącz listę celów
Włącz listę celów
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| cele | Lista | Lista identyfikatorów celów do włączenia. |
| dostawca aktualizacji | Wartość logiczna = prawda | flaga, jeśli prawda, włącz również odpowiednich dostawców |
| onConsentReceivedOddzwonienie zwrotne | Oddzwanianie po otrzymaniu zgody? = zero |
Powrót
Brak wartości zwracanej
Przykład
enablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
wyłącz listę celów
Wyłącz listę celów
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| cele | Lista | Lista identyfikatorów celów do wyłączenia |
| dostawca aktualizacji | Wartość logiczna = prawda | flaga, jeśli prawda, wyłącza również odpowiednich dostawców |
| onConsentReceivedOddzwonienie zwrotne | Oddzwanianie po otrzymaniu zgody? = zero |
Powrót
Brak wartości zwracanej
Przykład
disablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
odrzuć wszystko
Odrzuca
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
Powrót
Brak wartości zwracanej
Przykład
rejectAll(context = ...)
Akceptuj wszystkie
Akceptuj wszystkie
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
Powrót
Brak wartości zwracanej
Przykład
acceptAll(context = ...)
pobierz USPrivacyString
Zdobądź dla nas ciąg dotyczący prywatności
Powrót
Ciąg dotyczący prywatności w USA
Przykład
getUSPrivacyString()
mazgodędostawcy
Posiada zgodę sprzedawcy
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| id | sznur | identyfikator sprzedawcy |
Powrót
Wartość logiczna, jeśli dostawca wyraził zgodę
Przykład
hasVendorConsent(context = ...,id = ...)
maCelowązgodę
Ma zgodę na cel
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| id | sznur | identyfikator celu |
| isIABPcel | Boolean | (przestarzałe), jeśli cel jest celem IAB |
| sprawdźZgoda | Wartość logiczna = prawda |
Powrót
Przykład
hasPurposeConsent(context = ...,id = ...,isIABPurpose = ...,checkConsent = ...)
pobierz GoogleACString
Uzyskaj ciąg Google AC
Powrót
Ciąg Google AC
Przykład
getGoogleACString()
pobierz ciąg zgody
Pobierz ostatni ciąg zgody
Powrót
zapisany ciąg zgody
Przykład
getConsentstring()
eksportCmpString
Wyeksportuj ciąg zgody
Powrót
zapisany ciąg Cmp
Przykład
exportCmpString()
getCalledLast
Zostań wezwany jako ostatni
Powrót
ostatnio o nazwie Data warstwy Cmp
Przykład
getCalledLast()
o nazwie ThisDay
Zadzwoniono tego dnia
Powrót
gdyby warstwa została wywołana dzisiaj
Przykład
calledThisDay()
potrzebuje Akceptacji
Potrzebuje akceptacji
Powrót
jeśli użytkownik potrzebuje akceptacji
Przykład
needsAcceptance()
setOpenCmpConsentToolViewListener
otwiera warstwę zgody
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| przycisk gdpr | Przycisk | przycisk akcji |
| oddzwonić | Po zamknięciu oddzwaniania? |
Powrót
Brak wartości zwracanej
Przykład
setOpenCmpConsentToolViewListener(context = ...,gdprButton = ...,callback = ...)
setOpenPlaceHolderViewListener
Ustaw odbiornik widoku otwartego miejsca
parametry
| Imię | Typ | Opis |
| kontekst | Kontekst | Kontekst aplikacji |
| przycisk akcji | Przycisk |
Powrót
Brak wartości zwracanej
Przykład
setOpenPlaceHolderViewListener(context = ...,actionButton = ...)
