Informacia
Treść

[Android] 2. Dokumentacja API

Konstruktor


Konstruktor do tworzenia obiektu CmpManager

parametry
Imię Typ

Opis Projektu

kontekst Kontekst

W przypadku korzystania z układu niestandardowego kontekstem aplikacji powinien być FragmentActivity

config Konfiguracja Cmp

Obiekt konfiguracji dla consent manager

Otwórz słuchacza OnOpenCallback

Wywołanie zwrotne, które ma zostać wywołane po otwarciu warstwy zgody

zamknij Słuchacz Przy zamknięciu oddzwaniania

Wywołanie zwrotne, które ma zostać wywołane po zamknięciu 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

onButtonClickedOddzwonienie
OnButtonClickedOddzwonienie

Wywołanie zwrotne, które ma zostać wywołane w celu uzyskania informacji o tym, który przycisk został naciśnięty w celu zamknięcia warstwy zgody

Przykład
            CmpManager.createInstance(
                context = this,
                codeId = config.id,
                serverDomain = config.domain,
                appName = config.appName,
                lang = config.language,
                closeListener = this,
                openListener = this,
                errorCallback = this,
                cmpButtonClickedCallback = this,
                cmpNotOpenedCallback = this
            )

 

zainicjować


Połączenia initialize Funkcja ma na celu skonfigurowanie pakietu SDK CMP w kontekście aplikacji oraz automatyczne sprawdzanie i otwieranie warstwy zgody, jeśli jest to wymagane. The initialize można powiązać z tworzeniem instancji

parametry
Imię Typ Opis Projektu
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 Projektu
Otwórz słuchacza OnOpenCallback

Wywołanie zwrotne, które ma zostać wywołane po otwarciu warstwy zgody

zamknij Słuchacz Przy zamknięciu oddzwaniania

Wywołanie zwrotne, które ma zostać wywołane po zamknięciu 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

onButtonClickedOddzwonienie
OnButtonClickedOddzwonienie

Wywołanie zwrotne, które ma zostać wywołane w celu uzyskania informacji o tym, który przycisk został naciśnięty w celu zamknięcia warstwy zgody

Powrót

Brak wartości zwracanej

Przykład
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)

setGoogleAnalyticsCallback


Ustaw wywołanie zwrotne umożliwiające pobieranie wartości trybu zgody Google

parametry
Imię Typ Opis Projektu
AnalitykSłuchacz Interfejs CmpGoogleAnalytics  
Powrót

Brak wartości zwracanej

Przykład
 override fun updateGoogleConsent(consentMap: Map<ConsentType, ConsentStatus>) {
     val firebaseConsentMap = consentMap.entries.associate { entry ->
         val firebaseConsentType = when (entry.key) {
             ConsentType.ANALYTICS_STORAGE -> FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE
             ConsentType.AD_STORAGE -> FirebaseAnalytics.ConsentType.AD_STORAGE
             ConsentType.AD_USER_DATA -> FirebaseAnalytics.ConsentType.AD_USER_DATA
             ConsentType.AD_PERSONALIZATION -> FirebaseAnalytics.ConsentType.AD_PERSONALIZATION
       }
         val firebaseConsentStatus = when (entry.value) {
             ConsentStatus.GRANTED -> FirebaseAnalytics.ConsentStatus.GRANTED
             ConsentStatus.DENIED -> FirebaseAnalytics.ConsentStatus.DENIED
       }
         firebaseConsentType to firebaseConsentStatus
   }
     FirebaseAnalytics.getInstance(applicationContext).setConsent(firebaseConsentMap)
 }



setGoogleAnalyticsCallback(consentModeUpdate = ...)

checkAndOpenConsentLayer


Sprawdź i otwórz warstwę zgody

parametry
Imię Typ Opis Projektu
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 Projektu
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 Projektu
onCheckIsConsentRequiredCallback Wymagana jest zgoda OnCheckIs zabawa jest wymagana zgoda (isConsentRequired: wartość logiczna) wywołanie zwrotne w celu ustalenia, czy zgoda jest wymagana, czy nie
jest w pamięci podręcznej Wartość logiczna = fałsz jeśli ma wartość true, wynik jest buforowany przez jeden dzień
Powrót

Brak wartości zwracanej

Przykład
check(onCheckIsConsentRequiredCallback = ...,isCached = ...)

 

otwórz warstwę niestandardową


otwiera dostosowaną warstwę zgody

parametry
Imię Typ Opis Projektu
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(context)

ma zgodę


sprawdzić, czy użytkownik wyraził zgodę

Powrót
Przykład
hasConsent()

 

włącz listę dostawców


Włącz listę dostawców

parametry
Imię Typ Opis Projektu
sprzedawców Lista  
onConsentReceivedOddzwonienie zwrotne Oddzwanianie po otrzymaniu zgody? = zero  
Powrót

Brak wartości zwracanej

Przykład
enableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

wyłącz listę dostawców


Wyłącz listę dostawców

parametry
Imię Typ Opis Projektu
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(vendors = ...,onConsentReceivedCallback = ...)

 

włącz listę celów


Włącz listę celów

parametry
Imię Typ Opis Projektu
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(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

wyłącz listę celów


Wyłącz listę celów

parametry
Imię Typ Opis Projektu
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(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

odrzuć wszystko


Odrzuć wszystko 

parametry
Imię Typ Opis Projektu
onConsentReceivedOddzwonienie zwrotne Oddzwanianie po otrzymaniu zgody? = zero Wywołanie zwrotne dotyczące obsługi zdarzenia otrzymanej zgody.
Powrót

Brak wartości zwracanej

Przykład
cmpManager.rejectAll {
                    // consent request done
                }

 

Akceptuj wszystkie


Akceptuj wszystkie

parametry
Imię Typ Opis Projektu
onConsentReceivedOddzwonienie zwrotne Oddzwanianie po otrzymaniu zgody? = zero Wywołanie zwrotne dotyczące obsługi zdarzenia otrzymanej zgody.
Powrót

Brak wartości zwracanej

Przykład
 cmpManager.acceptAll {
                    // consent request done
                }

 

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 Projektu
id sznur identyfikator sprzedawcy
Powrót
Przykład
hasVendorConsent(id = ...)

 

maCelowązgodę


Ma zgodę na cel

parametry
Imię Typ Opis Projektu
id sznur identyfikator celu
Powrót

 

Przykład
hasPurposeConsent(id = ...)

 

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
Przykład
getConsentstring()

 

eksportCmpString


Wyeksportuj ciąg zgody

Powrót

zapisany ciąg Cmp

Przykład
exportCmpString()

 

importCmpString


Kontrola

parametry
Imię Typ Opis Projektu
cmpString sznur cmpString do zaimportowania
importuj oddzwonienie CmpImportCallback zabawa onImportResult (sukces: wartość logiczna, wiadomość: ciąg znaków)
Powrót

Brak wartości zwracanej

Przykład
                    cmpManager?.importCmpString(
                        "..."
                    ) { _, message ->
                        coroutineScope.launch {
                            snackbarHostState.showSnackbar(
                                message = message,
                                actionLabel = "Action",
                                duration = SnackbarDuration.Short
                            )
                        }
                    }

 

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()

 

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()

 

potrzebuje Akceptacji


Potrzebuje akceptacji

Powrót

jeśli użytkownik potrzebuje akceptacji

Przykład
needsAcceptance()
Powrót do góry