consentmanager Interfejs API Android SDK
API
Konstruktor
Konstruktor do tworzenia obiektu CmpManager
parametry
| Imię i nazwisko | 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 |
otwórz warstwę niestandardową
Otwiera dostosowaną warstwę zgody
parametry
| Imię i nazwisko | Typ |
Opis |
| działalność | FragmentAktywność |
Instancja działania, w której ma być wyświetlana warstwa zgody |
| identyfikator widoku kontenera | @IdRes Int |
Identyfikator interfejsu użytkownika kontenera, w którym ma być wyświetlana warstwa zgody |
Zwroty
Funkcja bez wartości zwracanej
Przykład
val activity = requireActivity()
val containerViewId = R.id.container
openCustomLayer(activity, containerViewId)
checkAndOpenConsentLayer
Sprawdź i ostatecznie otwórz warstwę zgody.
parametry
| Imię i nazwisko | Typ |
Opis |
| kontekst | Kontekst |
Obiekt kontekstu aplikacji. |
Przykład
val cmpManager = CmpManager()
cmpManager.checkAndOpenConsentLayer(context)
otwórzCmpLayer
Zwraca, jeśli cel (id) ma uprawnienia do ustawiania plików cookie
parametry
| Imię i nazwisko | Typ |
Opis |
| kontekst | Kontekst |
Kontekst aplikacji |
| id | sznur |
Identyfikator celu Uwaga: identyfikator celu jest taki sam, jak pokazano na liście celów i może mieć prefiks taki jak C |
| sprawdźZgoda | Boolean |
|
Zwroty
| Typ | Opis |
| Boolean | Wartość logiczna wskazująca, czy dostawca ma zgodę na ustawianie plików cookie. |
Przykład
val vendorID = "1234"
val checkConsent = true
val result = hasVendorConsent(context, vendorID, checkConsent)
if (result) {
// Vendor has the rights to set cookies
} else {
// Vendor does not have the rights to set cookies
}
mazgodędostawcy
Zwraca, jeśli sprzedawca (id) ma uprawnienia do ustawiania plików cookie
parametry
| Imię i nazwisko | Typ |
Opis |
| id | Strunowy: |
Identyfikator sprzedawcy Uwaga: identyfikator dostawcy jest taki sam, jak pokazano na liście celów i może mieć prefiks, taki jak C |
Zwroty
| Typ | Opis |
| Boolean | Jeśli cel ma zgodę na ustawianie plików cookies |
Przykład
val vendorId = "S123"
consentTool.hasVendor(vendorId)
ma cel
Zwraca, jeśli cel (id) ma uprawnienia do ustawiania plików cookie
parametry
| Imię i nazwisko | Typ |
Opis |
| id | Strunowy: |
Identyfikator celu Uwaga: identyfikator celu jest taki sam, jak pokazano na liście celów i może mieć prefiks taki jak C |
Zwroty
| Typ | Opis |
| Boolean | Jeśli cel ma zgodę na ustawianie plików cookies |
Przykład
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
pobierz ciąg dostawcy
Zwraca, jeśli cel (id) ma uprawnienia do ustawiania plików cookie
parametry
| Imię i nazwisko | Typ |
Opis |
| id | Strunowy: |
Identyfikator celu Uwaga: identyfikator celu jest taki sam, jak pokazano na liście celów i może mieć prefiks taki jak C |
Zwroty
| Typ | Opis |
| Boolean | Jeśli cel ma zgodę na ustawianie plików cookies |
Przykład
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposeString
Zwraca cele String, który został ustawiony przez consentmanager
parametry
brak parametrów
Zwroty
| Typ | Opis |
| sznur |
Ciąg celów, który został ustalony consentmanager
|
Przykład
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
pobierz cele
Zwraca cele String, który został ustawiony przez consentmanager w obiekcie listy
parametry
| Imię i nazwisko | Typ |
Opis |
| id | Strunowy: |
Identyfikator celu Uwaga: identyfikator celu jest taki sam, jak pokazano na liście celów i może mieć prefiks taki jak C |
Zwroty
| Typ | Opis |
| Boolean | Jeśli cel ma zgodę na ustawianie plików cookies |
Przykład
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
Stary przegląd (do ustalenia)
|
API |
parametry | Zwroty |
Opis
|
|
openCmpConsentToolView( Kontekst kontekstowy ) |
kontekst: Kontekst aplikacji | unieważnić | Wyświetla widok modalny z internetowym widokiem zgody. Jeśli Zgodność zostanie zaakceptowana lub odrzucona, zostanie wywołana funkcja zamknięcia. Możesz zastąpić tę funkcję zamykania własną. Dlatego zaimplementuj OnCloseCallback i dodaj to jako parametr. @apiNote Interfejs użytkownika -> przykład: Otwórz warstwę za pomocą akcji przycisku |
|
openCmpConsentToolView( kontekst kontekstowy, Oddzwoń zwrotny OnClose ) |
kontekst: Kontekst aplikacji
oddzwonić: OnCloseCallback, który powinien być wywoływany, gdy widok sieciowy jest zamykany przez akcję
|
unieważnić | Wyświetla widok modalny z internetowym widokiem zgody. Jeśli Zgodność zostanie zaakceptowana lub odrzucona, zostanie wywołana funkcja zamknięcia. Możesz zastąpić tę funkcję zamykania własną. Dlatego zaimplementuj OnCloseCallback i nadaj go tej funkcji. Ta metoda nie wyśle ponownie żądania do serwera permissionTool. Użyje ostatniego stanu. Jeśli chcesz tylko ponownie otworzyć narzędzie do wyrażania zgody, jeśli serwer poda status odpowiedzi == 1, użyj metody checkAndProceedConsentUpdate @apiNote Interfejs użytkownika -> przykład: akcja Otwórz warstwę za pomocą przycisku |
|
setCloseCmpConsentToolViewListener( Oddzwoń zwrotny OnClose ) |
oddzwonić: OnCloseCallback, który powinien być wywoływany, gdy widok sieciowy jest zamykany przez akcję | unieważnić | Ustawia słuchacza. Jeśli Zgodność zostanie zaakceptowana lub odrzucona, funkcja ta zostanie wywołana. Możesz zastąpić tę funkcję zamykania własną. Dlatego zaimplementuj OnCloseCallback i dodaj to jako parametr. |
|
setCustomCmpConsentToolViewAction( CustomOpenActionCallback customAction ) |
Akcja niestandardowa: Akcja niestandardowa, która powinna zostać wywołana, oprócz pokazania narzędzia zgody | unieważnić | Ustawia akcję niestandardową na odpowiedź serwera. |
|
setErrorDialogCmpConsentToolViewListener( Oddzwoń zwrotny OnErrorDialog ) |
oddzwonić: OnOpenCallback, który powinien zostać wywołany, gdy widok zostanie otwarty. | unieważnić | Ustawia słuchacza. Jeśli widok zgodności zostanie otwarty, ta funkcja zostanie wywołana. Możesz zastąpić tę otwartą funkcję własną. Dlatego zaimplementuj OnOpenCallback i dodaj to jako parametr. |
|
setNetworkErrorExceptionListener( Oddzwonienie zwrotne w przypadku wyjątku sieci ) |
oddzwonić: OnErrorNetworkCallback, który należy wywołać. | unieważnić | Ustawia odbiornik, który jest wywoływany, jeśli wystąpi błąd sieci. |
|
setOnCMPNotOpenedOddzwonienie( Oddzwoń zwrotny OnCMPNotOpened ) |
oddzwonić: Akcja cmpNotOpenedCallback, która zostanie wywołana | unieważnić | Ustawia akcję, gdy osoba udzielająca zgody nie zamierza się otworzyć |
|
setOpenCmpConsentToolViewListener( kontekst kontekstowy, Przycisk gdprButton ) |
kontekst: Następnie kontekst aplikacji przycisk gdpr: Przycisk, do którego należy dodać openCmpConsentToolViewListener |
unieważnić | Ustawia słuchacza na dany przycisk, jeśli przycisk zostanie kliknięty, zostanie wyświetlony widok modalny z widokiem internetowym zgody. Jeśli Zgodność zostanie zaakceptowana lub odrzucona, zostanie wywołana funkcja zamknięcia. Możesz zastąpić tę funkcję zamykania własną. Dlatego zaimplementuj OnCloseCallback i dodaj to jako inny parametr. Jeśli parametr nie jest ustawiony, ale do dodania detektora do zdarzenia zamknięcia użyto setCloseCmpConsentToolViewListener, zostanie on użyty. |
|
setOpenCmpConsentToolViewListener( kontekst kontekstowy, Przycisk gdprPrzycisk, Oddzwoń zwrotny OnClose ) |
kontekst: Kontekst aplikacji przycisk gdpr: Przycisk, do którego należy dodać openCmpConsentToolViewListener
oddzwonić: OnCloseCallback, który powinien być wywoływany, gdy widok sieciowy jest zamykany przez akcję |
unieważnić | Ustawia słuchacza na dany przycisk, jeśli przycisk zostanie kliknięty, zostanie wyświetlony widok modalny z widokiem internetowym zgody. Jeśli Zgodność zostanie zaakceptowana lub odrzucona, zostanie wywołana funkcja zamknięcia. Możesz zastąpić tę funkcję zamykania własną. Dlatego zaimplementuj OnCloseCallback i dodaj to jako ostatni parametr. |
|
setOpenCmpConsentToolViewListener( Oddzwoń zwrotny OnClose ) |
oddzwonić: OnCloseCallback, który powinien być wywoływany, gdy widok sieciowy jest zamykany przez akcję |
unieważnić | Ustawia słuchacza. Jeśli widok zgodności zostanie otwarty, ta funkcja zostanie wywołana. Możesz zastąpić tę otwartą funkcję własną. Dlatego zaimplementuj OnOpenCallback i dodaj to jako parametr. |
|
setOpenPlaceHolderViewListener( kontekst kontekstowy, przycisk guzika, Sprzedawca ciągów ) |
kontekst: Kontekst aplikacji przycisk: przycisk akcji do tworzenia widoku zastępczego sprzedawca: Sprzedawca przypisany do symbolu zastępczego |
unieważnić | Otwiera widok zastępczy po kliknięciu przycisku dla przypisanego dostawcy |
|
|
|||
|
nazwanyTenDzień( Kontekst) |
kontekst: Kontekst aplikacji |
boolean: jeśli z serwerem skontaktowano się już tego dnia | Zwraca, jeśli tego dnia kontaktowano się już z serwerem. |
|
clearAllValues(kontekst kontekstu) |
kontekst: Kontekst aplikacji |
unieważnić | Resetuje dane zgody |
|
utwórz symbol zastępczy ( kontekst kontekstowy, CMPPlaceholderParams cmpPlaceholderParams, CmpPlaceholderEventListener cmpPlaceholderEventListener) |
kontekst: Kontekst aplikacji cmpPlaceholderParams: przypisz wymagane parametry zastępcze cmpPlaceholderEventListener: Interfejs EventListener dla niestandardowych funkcji procesu |
Cmp Placeholder: UIView symbolu zastępczego | Tworzy widok zastępczy do dynamicznego blokowania treści |
|
exportCMPData (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
sznur: ciąg zgody | Funkcja eksportu, którą można wywołać, aby wyeksportować pełny ciąg zgody wygenerowany przez ConsentWebView i zapisany we wspólnych preferencjach tego urządzenia. |
|
getCalledLast (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
Data: Data ostatniego połączenia z serwerem | Podaje informacje o ostatniej dacie kontaktu z serwerem |
|
getConfig() |
|
Konfiguracja CMP: Obiekt CMPConfig |
Zwraca CMPConfig, który jest aktualnie ustawiony |
|
pobierz GoogleACString() |
kontekst: Kontekst aplikacji |
sznur: Prywatność w USA Ciąg dostawców, który został ustawiony przez consentmanager |
Zwraca US Privacy String, który został ustawiony przez consentmanager |
|
uzyskac instancje() |
|
Narzędzie CMPConsent: Zainicjowana pojedyncza chwila consentmanager |
Zwraca Narzędzie CMPConsent. Jeśli nie zainicjalizowałeś Narzędzie CMPConsent wcześniej zostanie zgłoszony wyjątek CMPConsentToolInitialisation. |
|
getInstanceUnsafe() |
|
Narzędzie CMPConsent: zainicjowany singleton Instant of the consent Managerlub null. |
Zwraca Narzędzie CMPConsentlub null, jeśli nie został zainicjowany. Ta metoda jest niebezpieczna, ponieważ może prowadzić do wyjątków zerowego wskaźnika, ale jeśli masz pewność, że narzędzie ConsentTool zostało wcześniej zainicjowane, możesz użyć tej metody bez konieczności wyłapywania błędu. Zalecamy zapisanie zwróconego obiektu z metody createInstant, aby użyć metod consentManager. |
|
pobierzLastConsentString( Kontekst) |
kontekst: Kontekst aplikacji |
sznur: Ostatni zestaw zgody |
Zwraca ostatnią wyrażoną zgodę, przedstawioną w base64 przez consentManager |
|
getPurposes (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
sznur: Ciąg celów, który został ustalony consentmanager |
Zwraca cele String, który został ustawiony przez consentmanager |
|
getUSPrivacyString (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
sznur: Amerykański łańcuch prywatności dostawców, który został ustalony consentmanager |
Zwraca US Privacy String, który został ustawiony przez consentmanager |
|
getVendorsString (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
sznur: Ciąg dostawców, który został ustalony consentmanager |
Zwraca ciąg dostawcy, który został ustawiony przez consentmanager |
|
hasPurposeConsent (kontekst kontekstu, Identyfikator ciągu, wartość logiczna to IABCel) |
kontekst: kontekst aplikacji id: identyfikator celu isIABPcel: Jeśli cel jest określony przez standard IAB (V1/V2) |
boolean: Jeśli cel ma zgodę na ustawianie plików cookies |
Zwraca, jeśli cel (id) ma uprawnienia do ustawiania plików cookie. Uwaga: Identyfikator celu jest taki sam, jak pokazano na liście celów i może mieć przedrostek, taki jak C |
|
ma zgodę dostawcy ( kontekst kontekstowy, Identyfikator ciągu, wartość logiczna isIABVendor) |
kontekst: Kontekst aplikacji id: identyfikator sprzedawcy isIABDostawca: jeśli dostawca jest ustawiony przez standard IAB (V1/V2) |
boolean: Jeśli Sprzedawca ma Zgodę na ustawianie plików cookie. |
Zwraca, jeśli Sprzedawca (id) ma uprawnienia do ustawiania plików cookies
Uwaga: Identyfikator dostawcy jest taki sam, jak pokazano na liście dostawców i może mieć przedrostek, taki jak C, S. |
|
importujDane CMP( kontekst kontekstowy, Ciąg cmpData ) |
kontekst: Kontekst aplikacji cmpDane: Ciąg, który zostanie ustawiony. ZgodaString powinna być przekazana jako zakodowana base64 |
boolean: Jeśli import się powiódł lub wystąpiły błędy w ciągu? |
Metoda importu, którą można wywołać w celu zaimportowania pełnej zgodyString wygenerowanej przez ConsentWebView do Shared Preferences tego urządzenia. |
|
Akceptacja potrzeb (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
boolean: jeśli użytkownik musi wyrazić zgodę |
Zwraca, jeśli użytkownik musi wyrazić zgodę, ponieważ nie robił tego w przeszłości lub ponieważ serwer zgody zwrócił, że wymagana jest nowa zgoda |
|
NeedServerUpdate (kontekst kontekstu) |
kontekst: Kontekst aplikacji |
boolean: Jeśli consentmanager wymaga aktualizacji |
Jeśli ustawienia CMPSettings muszą zostać zaktualizowane z serwera, ponieważ nie było ich w tym dniu. |
|
|
|
|
|
