[Android] 2. Dokumentacja API
Akceptuj wszystkie
Akceptuje warstwę zgody i zachowuje się tak samo, gdy użytkownik akceptuje zgodę. Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
onConsentReceivedCallback |
Oddzwonienie po otrzymaniu zgody? | Wywołanie zwrotne dotyczące obsługi zdarzenia otrzymanej zgody. |
Powrót
Brak wartości zwracanej.
Przykład
func acceptAll(onFinish: @escaping () -> Void) {
cmpManager?.acceptAll(onFinish: onFinish)
}
ZOBACZ
Sprawdza, czy wymagana jest zgoda użytkownika, opcjonalnie zwracając buforowane wyniki. Ta metoda zużywa jedną odsłonę strony, jeśli parametr isCached() ma wartość TRUE, a buforowana zgoda JEST wygasła, jedną odsłonę strony, jeśli parametry isCached() mają wartość FALSE, i żadnych odsłon, jeśli buforowana zgoda nie wygasła. Buforowana zgoda wygasa i jest usuwana co 24 godziny.
parametry
Nazwa | Typ | Opis |
onCheckIsConsentRequiredCallback |
Wymagana jest zgoda OnCheckIs | zabawa jest wymagana zgoda (isConsentRequired: wartość logiczna) wywołanie zwrotne w celu ustalenia, czy zgoda jest wymagana, czy nie |
isCached |
Wartość logiczna = fałsz | jeśli ma wartość true, wynik jest buforowany przez jeden dzień |
Powrót
Brak.
Przykład
cmpManager.acceptAll {
coroutineScope.launch {
snackbarHostState.showSnackbar(
message = "All consents accepted",
duration = SnackbarDuration.Short
)
consentStatus.value = showConsentStatus(cmpManager)
}
}
checkAndOpenConsentLayer
Sprawdza, czy wymagana jest zgoda użytkownika i jeśli tak, otwiera interfejs użytkownika warstwy zgody. Ta metoda zużywa jedną odsłonę strony.
parametry
Nazwa | Typ | Opis |
context |
Kontekst | Kontekst aplikacji |
appInterface |
Interfejs CmpLayerAppEventListener? = zero |
Powrót
Brak wartości zwracanej
Przykład
context.getActivity()?.let { activity ->
cmpManager.checkAndOpenConsentLayer(activity)
}
o nazwie ThisDay
Sprawdza, czy warstwa zgody została zażądana dzisiaj. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
PRAWDA, jeśli zgoda użytkownika została już poproszona dzisiaj.
W przeciwnym razie FAŁSZ.
Przykład
fun consentRequestedTodayAction() {
val calledToday = cmpManager?.calledThisDay()
if (calledToday != null) {
println("Consent requested today: $calledToday")
} else {
println("Failed to retrieve consent request status for today.")
}
}
wyłącz listę celów
Wyłącza listę celów i aktualizuje wyrażoną zgodę. Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
purposes |
Lista | Lista identyfikatorów celów do wyłączenia |
updateVendor |
Boolean | flaga, jeśli prawda, wyłącza również odpowiednich dostawców |
onConsentReceivedCallback |
Oddzwonienie po otrzymaniu zgody? |
Powrót
Brak wartości zwracanej
Przykład
fun onFinish() {
println("Notification: New consent received")
}
val purposes = listOf("1", "2")
// Option with callback
cmpManager?.disablePurposeList(purposes, ::onFinish)
// Option without callback
cmpManager?.disablePurposeList(purposes)
wyłącz listę dostawców
Wyłącza listę dostawców i aktualizuje udzieloną zgodę. Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
vendors |
Lista | Lista identyfikatorów dostawców do włączenia. |
onConsentReceivedCallback |
Oddzwonienie po otrzymaniu zgody? | Wywołanie zwrotne dotyczące obsługi zdarzenia otrzymanej zgody. zostanie wywołany, gdy zgoda zostanie otrzymana i przetworzona |
Powrót
Brak wartości zwracanej.
Przykład
fun onFinish() {
println("Notification: New consent received")
}
val vendors = listOf("1", "2")
// Option with callback
cmpManager?.disableVendorList(vendors, ::onFinish)
// Option without callback
cmpManager?.disableVendorList(vendors)
włącz listę dostawców
Włącza listę celów i aktualizuje wyrażoną zgodę. Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
vendors |
Lista | Lista identyfikatorów celów do włączenia. |
onConsentReceivedCallback |
funkcja (opcjonalnie) | Wywołanie zwrotne dotyczące obsługi zdarzenia otrzymanej zgody. Zostanie wywołany, gdy zgoda zostanie otrzymana i przetworzona |
Powrót
Brak wartości zwracanej.
Przykład
fun onFinish() {
println("Notification: New consent received")
}
val vendors = listOf("1", "2")
// Option with callback
cmpManager?.enableVendorList(vendors, ::onFinish)
// Option without callback
cmpManager?.enableVendorList(vendors)
włącz listę celów
Włącza listę dostawców i aktualizuje wyrażoną zgodę. Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
purposes |
Lista | Lista identyfikatorów celów do włączenia. |
updateVendor |
Boolean | flaga, jeśli prawda, włącz również odpowiednich dostawców |
onConsentReceivedCallback |
Funkcja (opcjonalnie) |
Powrót
Brak wartości zwracanej.
Przykład
fun onFinish() {
println("Notification: New consent received")
}
val purposes = listOf("1", "2")
// Option with callback
cmpManager?.enablePurposeList(purposes, ::onFinish)
// Option without callback
cmpManager?.enablePurposeList(purposes)
eksportCmpString
Eksportuje bieżący ciąg CMP reprezentujący preferencje zgody użytkownika. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg zgody CMP.
Przykład
fun exportConsentStringAction() {
val exportString = cmpManager?.exportCmpString()
println(exportString ?: "No string to export.")
}
pobierzWszystkie cele
Zwraca identyfikatory wszystkich celów. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich celów.
Przykład
fun getAllPurposesAction() {
val allPurposes = cmpManager?.getAllPurposes()
if (allPurposes != null) {
println("All purposes: $allPurposes")
// Additional actions for getAllPurposes function can be added here
} else {
println("Failed to retrieve all purposes.")
}
}
pobierz listę wszystkich celów
Zwraca listę identyfikatorów wszystkich celów dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Lista
Przykład
fun getAllPurposeListAction() {
// Action for getAllPurposeList function
val allPurposes = cmpManager?.getAllPurposesList()
if (allPurposes != null) {
println("All purposes list: ${allPurposes.joinToString(", ")}")
} else {
println("Failed to retrieve all purposes list.")
}
}
getAllVendors
Zwraca identyfikatory wszystkich dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich dostawców.
Przykład
fun getAllVendorsAction() {
// Action for getAllVendors function
val allVendors = cmpManager?.getAllVendors()
if (allVendors != null) {
println("Printing all Vendors: $allVendors")
} else {
println("Failed to retrieve all vendors.")
}
}
pobierz listę wszystkich dostawców
Zwraca listę wszystkich identyfikatorów dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Lista zawierający wszystkie identyfikatory dostawców.
Przykład
fun getAllVendorsListAction() {
val allVendors = cmpManager?.getAllVendorsList()
if (allVendors != null) {
println("All vendors list: ${allVendors.joinToString(", ")}")
} else {
println("Failed to retrieve all vendors list.")
}
}
pobierz ciąg zgody
Zwraca ciąg z ostatnio udzieloną zgodą. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg znaków z ostatnią zgodą potwierdzoną przez użytkownika.
Przykład
fun getAllVendorsListAction() {
val allVendors = cmpManager?.getAllVendorsList()
if (allVendors != null) {
println("All vendors list: ${allVendors.joinToString(", ")}")
} else {
println("Failed to retrieve all vendors list.")
}
}
getDisabledCele
Zwraca wszystkie wyłączone identyfikatory celów dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich wyłączonych celów.
Przykład
fun getDisabledPurposesAction() {
val disabledPurposes = cmpManager?.getDisabledPurposes()
if (disabledPurposes != null) {
println("Disabled purposes: $disabledPurposes")
} else {
println("Failed to retrieve disabled purposes.")
}
}
getDisabledVendors
Zwraca wszystkie wyłączone identyfikatory dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich wyłączonych dostawców.
Przykład
fun getDisabledVendorsAction() {
val disabledVendors = cmpManager?.getDisabledVendors()
if (disabledVendors != null) {
println("Disabled vendors: $disabledVendors")
} else {
println("Failed to retrieve disabled vendors.")
}
}
getEnabledCele
Zwraca wszystkie włączone identyfikatory dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich włączonych dostawców.
Przykład
fun getEnabledPurposesAction() {
val enabledPurposes = cmpManager?.getEnabledPurposes()
if (enabledPurposes != null) {
println("Disabled purposes: $enabledPurposes")
} else {
println("Failed to retrieve enabled purposes.")
}
}
getEnabledPurposeList
Zwraca listę wszystkich włączonych identyfikatorów celów dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Lista zawierający identyfikatory wszystkich włączonych celów.
Przykład
fun getEnabledPurposesAction() {
val enabledPurposes = cmpManager?.getEnabledPurposes()
if (enabledPurposes != null) {
println("Enabled purposes: ${enabledPurposes.joinToString(", ")}")
} else {
println("Failed to retrieve enabled purposes list.")
}
}
getEnabledVendors
Zwraca wszystkie włączone identyfikatory dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich włączonych dostawców.
Przykład
fun getEnabledVendorsAction() {
val enabledVendors = cmpManager?.getEnabledVendors()
if (enabledVendors != null) {
println("Enabled vendors: $enabledVendors")
} else {
println("Failed to retrieve enabled vendors.")
}
}
getEnabledVendorList
Zwraca listę ze wszystkimi włączonymi identyfikatorami dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Lista zawierający identyfikatory wszystkich włączonych dostawców.
Przykład
fun getEnabledVendorsAction() {
val enabledVendors = cmpManager?.getEnabledVendors()
if (enabledVendors != null) {
println("Enabled vendors: ${enabledVendors.joinToString(", ")}")
} else {
println("Failed to retrieve enabled vendors.")
}
}
pobierz GoogleACString
Pobiera ciąg identyfikatora dodatkowej zgody Google („addtlConsent”) ustawiony przez consent manager.
Aby uzyskać więcej informacji, sprawdź Specyfikacja techniczna dodatkowej zgody Google.
Metoda ta nie zużywa żadnej liczby odsłon.
parametry
Brak. |
Powrót
Lista zawierający identyfikatory wszystkich włączonych dostawców.
Przykład
fun getGoogleConsentStringAction() {
val googleACString = cmpManager?.getGoogleACString()
if (googleACString != null) {
println("Google Additional Consent String: $googleACString")
} else {
println("Failed to retrieve Google Additional Consent String.")
}
}
pobierz USPrivacyString
Pobiera US Privacy String. Ten US privacy string to plik cookie, który przechowuje informacje o ujawnieniach dokonanych i wyborach dokonanych przez odwiedzającego witrynę w odniesieniu do jego praw konsumenckich. Ta metoda nie zużywa żadnych odsłon stron.
parametry
Brak. |
Powrót
Ciąg znaków z danymi dotyczącymi prywatności w USA ustawionymi przez consentmanager.
Przykład
fun getUSPrivacyStringAction() {
val usPrivacyString = cmpManager?.getUSPrivacyString()
if (usPrivacyString != null) {
println("US Privacy string contents: $usPrivacyString")
} else {
println("Failed to retrieve US Privacy string.")
}
}
ma zgodę
Sprawdza, czy użytkownik już wyraził zgodę. Warstwa zgody może mieć opcję po prostu zamknięcia warstwy. W takim przypadku użytkownik nie wyraził zgody. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
Ciąg znaków z danymi dotyczącymi prywatności w USA ustawionymi przez consentmanager.
Przykład
fun getHasConsentAction() {
val hasConsent = cmpManager?.hasConsent()
if (hasConsent != null) {
val consentStatus = if (hasConsent) "Yes" else "No"
println("Consent provided by the user? $consentStatus")
} else {
println("Failed to retrieve user consent.")
}
}
hasPurpose (od wersji 2.5.1)
hasPurposeConsent (przestarzałe)
Sprawdza, czy identyfikator celu jest włączony na podstawie zgody użytkownika. Ta metoda nie zużywa żadnych odsłon.
parametry
Nazwa | Typ | Opis |
purposeId |
sznur | identyfikator celu |
defaultReturn |
Boolean | Wartość zwracana domyślnie przez metodę, w przypadku gdy nie ma jeszcze zgody. Zobacz ostrzeżenie poniżej. |
Powrót
PRAWDA, jeśli użytkownik wyraził zgodę na określony cel.
W przeciwnym razie FAŁSZ.
Należy pamiętać, że jeśli z jakiegokolwiek powodu związanego ze słabym połączeniem internetowym lub jego brakiem na urządzeniu lub w przypadku braku zgody, wartość ustawiona za pomocą defaultReturn
parametr zostanie zwrócony.
Kurs defaultReturn
parametr nie istnieje w wersjach starszych niż 2.5.1.
Przykład
fun getHasPurposeConsentAction() {
val purposeId = "purposeID" // Replace with actual purpose ID
val hasPurposeConsent = cmpManager?.hasPurpose(purposeId, false)
if (hasPurposeConsent != null) {
val consentStatus = if (hasPurposeConsent) "Yes" else "No"
println("Purpose has consent provided by the user? $consentStatus")
} else {
println("Failed to retrieve user purpose consent.")
}
}
hasVendor (od wersji 2.5.1)
hasVendorConsent (przestarzałe)
Sprawdza, czy identyfikator dostawcy jest włączony na podstawie zgody użytkownika. Ta metoda nie zużywa żadnych odsłon.
parametry
Nazwa | Typ | Opis |
vendorId |
sznur | identyfikator sprzedawcy |
defaultReturn |
Boolean | Wartość zwracana domyślnie przez metodę, w przypadku gdy nie ma jeszcze zgody. |
Powrót
PRAWDA, jeśli użytkownik wyraził zgodę na korzystanie z usług określonego dostawcy.
W przeciwnym razie FAŁSZ.
Należy pamiętać, że jeżeli z jakiegokolwiek powodu związanego ze słabym połączeniem internetowym lub jego brakiem na urządzeniu nie można uzyskać zgody na ten cel, wartość ustawiona za pomocą defaultReturn
parametr zostanie zwrócony.
Kurs defaultReturn
parametr nie istnieje w wersjach starszych niż 2.5.1.
Przykład
fun getHasVendorConsentAction() {
val vendorId = "vendorID" // Replace with actual vendor ID
val hasVendorConsent = cmpManager?.hasVendor(vendorId, false)
if (hasVendorConsent != null) {
val consentStatus = if (hasVendorConsent) "Yes" else "No"
println("Vendor has consent provided by the user? $consentStatus")
} else {
println("Failed to retrieve user vendor consent.")
}
}
importCmpString
Importuje ciąg CMP reprezentujący preferencje dotyczące zgody użytkownika. Ciąg musi zostać poinformowany w stanie „AS-IS” podczas pobierania za pomocą metody exportCmpString(). Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
ciąg zgody | sznur | Ciąg reprezentujący zgodę |
zakończenieHandler | funkcja (opcjonalnie) | Procedura obsługi zakończenia wywołania zwrotnego do metody. |
Powrót
Brak.
Przykład
val cmpString = "YourConsentStringHere"
typealias CmpImportCompletionHandler = (Error?) -> Unit
// Define the completion handler function
val completionHandler: CmpImportCompletionHandler = { error ->
if (error != null) {
println("Failed to import CMP string: ${error.message}")
} else {
println("CMP string imported successfully")
}
}
cmpManager?.importCmpString(cmpString, completion = completionHandler)
zainicjować
Funkcja Initialize zainicjuje warstwę zgody i automatycznie sprawdzi, czy użytkownik potrzebuje zgody, czy nie. Ta funkcja ostatecznie otworzy warstwę zgody i będzie współpracować z Apple Tracking Transparency API, aby poprosić użytkownika o zgodę. Ta metoda zużywa jedną odsłonę strony.
parametry
Nazwa | Typ | Opis |
context |
Kontekst | Kontekst aplikacji |
cmpConfig |
Konfiguracja Cmp | Do obiektu CmpConfig przekazywane są informacje dotyczące identyfikatora aplikacji, domeny, nazwy aplikacji i języka (opcjonalnie) |
Powrót
Obiekt CMPManager.
Przykład
private fun initializeCmpManager() {
CmpConfig.apply {
id = cmpId
domain = CMP_DOMAIN
appName = cmpAppName
language = cmpLanguage
domainWhitelist = cmpDomainWhitelist
timeout = 2000
isDebugMode = true
}
CmpLog.setLogLevel(Log.VERBOSE)
cmpManager = CmpManager.createInstance(this, CmpConfig)
}
otwórz warstwę zgody
Otwiera siłą webview warstwy zgody CMP. Ta metoda zużywa jedną odsłonę strony.
parametry
Nazwa | Typ | Opis |
context |
Kontekst | Kontekst aplikacji. |
Powrót
Brak wartości zwracanej.
Przykład
ActionButtonsRow("Open", "Check", "Open?") { action ->
when (action) {
"Open" -> context.getActivity()?.let {
cmpManager.openConsentLayer(it.applicationContext)
}
.
.
.
}
potrzebuje Akceptacji
Sprawdza, czy zgoda musi zostać udzielona przez bieżącego użytkownika aplikacji. Ta metoda nie zużywa żadnych odsłon.
parametry
Brak. |
Powrót
PRAWDA, jeśli użytkownik musi wyrazić zgodę.
W przeciwnym razie FAŁSZ.
fun showConsentStatus(cmpManager: CmpManager?): String {
return buildString {
append("Cmp ID: ${CmpConfig.id}\n")
append("Need Acceptance: ${cmpManager?.needsAcceptance()}\n") // <=========
append("ConsentString: ${cmpManager?.getConsentString()}\n")
append("Has Consent: ${cmpManager?.hasConsent()}\n")
}
}
odrzuć wszystko
Odrzuca warstwę zgody i zachowuje się tak samo, gdy użytkownik nie zaakceptował zgody. Ta metoda zużywa jedną odsłonę.
parametry
Nazwa | Typ | Opis |
onFinish |
funkcjonować | Opcjonalny. Wywołanie zwrotne dotyczące obsługi zdarzenia otrzymanej zgody. zostanie wywołany, gdy zgoda zostanie otrzymana i przetworzona. |
Powrót
Brak wartości zwracanej.
Przykład
// Define the onFinish function
fun onFinish() {
println("Notification: New consent has been received with a Reject All response.")
}
cmpManager?.rejectAll(::onFinish)
ustaw wywołania zwrotne
Konfiguruje dostępne wywołania zwrotne.
parametry
Nazwa | Typ | Opis |
openListener |
OnOpenCallback |
Wywołanie zwrotne, które ma zostać wywołane po otwarciu warstwy zgody. |
closeListener |
Przy zamknięciu oddzwaniania |
Wywołanie zwrotne, które ma zostać wywołane, gdy warstwa zgody zostanie zamknięta. |
cmpNotOpenedCallback |
OnCMPNotOpenedOddzwonienie |
Wywołanie zwrotne, które ma zostać wywołane, gdy nie można otworzyć warstwy zgody. |
onErrorCallback |
Przy oddzwonieniu po błędzie |
Wywołanie zwrotne, które ma zostać wywołane w przypadku błędu. |
onButtonClickedCallback |
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
val existingInstance = instance?.get()
existingInstance.setCallbacks(
openListener = openListener,
closeListener = closeListener,
cmpNotOpenedCallback = cmpNotOpenedCallback,
onErrorCallback = errorCallback,
onButtonClickedCallback = cmpButtonClickedCallback
)
za pomocą połączenia zwrotnego GoogleAnalytics
Ustaw wywołanie zwrotne umożliwiające pobieranie wartości trybu zgody Google.
parametry
Nazwa | Typ | Opis |
analyticsListener |
Interfejs CmpGoogleAnalytics | Implementacja interfejsu umożliwiającego otrzymywanie aktualizacji dotyczących trybu zgody Google Analytics. |
Powrót
Bieżące wystąpienie CmpManagerInterface do tworzenia łańcuchów.
Przykład
private fun initializeCmpManager() {
cmpManager = CmpManager.createInstance(this, CmpConfig).apply {
withOpenListener(this@ConsentActivity)
withCloseListener(this@ConsentActivity)
withNotOpenedCallback(this@ConsentActivity)
withErrorCallback(this@ConsentActivity)
withButtonClickedCallback(this@ConsentActivity)
withOnClickLinkCallback(this@ConsentActivity)
withGoogleAnalyticsCallback(this@ConsentActivity) // <=============
initialize(this@ConsentActivity)
}
}