Informacia
Treść

[Android] 2. Dokumentacja API

Akceptuj wszystkie

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

Brak wartości zwracanej

Liczba wyświetleń strony

1

Przykład
func acceptAll(onFinish: @escaping () -> Void) {
  cmpManager?.acceptAll(onFinish: onFinish)
}


ZOBACZ

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
isCached Wartość logiczna = fałsz jeśli ma wartość true, wynik jest buforowany przez jeden dzień
Powrót

Brak.

Liczba wyświetleń strony

1 jeśli parametr isCached() ma wartość TRUE i zgoda w pamięci podręcznej WYGASŁA

1 jeśli parametry isCached() mają wartość FALSE

0 jeśli isCached() ma wartość TRUE i zgoda w pamięci podręcznej NIE wygasła

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 warstwy zgody.

parametry
Imię Typ Opis Projektu
context Kontekst Kontekst aplikacji
appInterface Interfejs CmpLayerAppEventListener? = zero  
Powrót

Brak wartości zwracanej

Liczba wyświetleń strony

1

Przykład
context.getActivity()?.let { activity ->
                cmpManager.checkAndOpenConsentLayer(activity)
            }


o nazwie ThisDay

Sprawdza, czy dzisiaj zażądano warstwy zgody.

parametry
Brak.
Powrót

PRAWDA, jeśli zgoda użytkownika została już poproszona dzisiaj.

W przeciwnym razie FAŁSZ.

Liczba wyświetleń strony

0

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ę.

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

Liczba wyświetleń strony

1

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 wyrażoną zgodę.

parametry
Imię Typ Opis Projektu
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.

Liczba wyświetleń strony

1

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ę.

parametry
Imię Typ Opis Projektu
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.

Liczba wyświetleń strony

1

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 udzieloną zgodę.

parametry
Imię Typ Opis Projektu
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.

Liczba wyświetleń strony

1

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 dotyczące zgody użytkownika.  

parametry
Brak.
Powrót

Ciąg zakodowany w standardzie CMP base64.

Liczba wyświetleń strony

0

Przykład

fun exportConsentStringAction() {
    val exportString = cmpManager?.exportCmpString()
    println(exportString ?: "No string to export.")
}

pobierzWszystkie cele

Zwraca identyfikatory wszystkich celów.

parametry
Brak.
Powrót

Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich celów.

Liczba wyświetleń strony

0

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.

parametry
Brak.
Powrót

Lista

Liczba wyświetleń strony

0

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.

parametry
Brak.
Powrót

Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich dostawców.

Liczba wyświetleń strony

0

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ę identyfikatorów wszystkich dostawców dla danego CMP.

parametry
Brak.
Powrót

Lista zawierający wszystkie identyfikatory dostawców.

Liczba wyświetleń strony

0

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 znaków z ostatnią wyrażoną zgodą.

parametry
Brak.
Powrót

Ciąg znaków z ostatnią zgodą potwierdzoną przez użytkownika.

Liczba wyświetleń strony

0

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 identyfikatory wszystkich wyłączonych celów dla danego CMP.

parametry
Brak.
Powrót

Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich wyłączonych celów.

Liczba wyświetleń strony

0

Przykład
fun getDisabledPurposesAction() {
    val disabledPurposes = cmpManager?.getDisabledPurposes()
    if (disabledPurposes != null) {
        println("Disabled purposes: $disabledPurposes")
    } else {
        println("Failed to retrieve disabled purposes.")
    }
}

getDisabledVendors

Zwraca identyfikatory wszystkich wyłączonych dostawców dla danego CMP.

parametry
Brak.
Powrót

Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich wyłączonych dostawców.

Liczba wyświetleń strony

0

Przykład
fun getDisabledVendorsAction() {
    val disabledVendors = cmpManager?.getDisabledVendors()
    if (disabledVendors != null) {
        println("Disabled vendors: $disabledVendors")
    } else {
        println("Failed to retrieve disabled vendors.")
    }
}

getEnabledCele

Zwraca identyfikatory wszystkich włączonych dostawców dla danego CMP.

parametry
Brak.
Powrót

Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich włączonych dostawców.

Liczba wyświetleń strony

0

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ę identyfikatorów wszystkich włączonych celów dla danego CMP.

parametry
Brak.
Powrót

Lista zawierający identyfikatory wszystkich włączonych celów.

Liczba wyświetleń strony

0

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 identyfikatory wszystkich włączonych dostawców dla danego CMP.

parametry
Brak.
Powrót

Ciąg rozdzielany przecinkami zawierający identyfikatory wszystkich włączonych dostawców.

Liczba wyświetleń strony

0

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ę wszystkich włączonych identyfikatorów dostawców dla danego CMP.

parametry
Brak.
Powrót

Lista zawierający identyfikatory wszystkich włączonych dostawców.

Liczba wyświetleń strony

0

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.  

parametry
Brak.
Powrót

Lista zawierający identyfikatory wszystkich włączonych dostawców.

Liczba wyświetleń strony

0

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 ciąg znaków prywatności w USA. Ten amerykański ciąg znaków prywatności to plik cookie przechowujący informacje o dokonanych ujawnieniach i wyborach wybranych przez osobę odwiedzającą witrynę w zakresie jej praw konsumenckich.

parametry
Brak.
Powrót

Ciąg znaków z danymi dotyczącymi prywatności w USA ustawionymi przez consentmanager.

Liczba wyświetleń strony

0

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 wyraził już zgodę. Warstwa zgody może mieć opcję zamknięcia warstwy. W takim przypadku użytkownik nie wyraził zgody.

parametry
Brak.
Powrót

Ciąg znaków z danymi dotyczącymi prywatności w USA ustawionymi przez consentmanager.

Liczba wyświetleń strony

0

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.")
    }
}

maCelowązgodę

Sprawdza, czy identyfikator celu jest włączony na podstawie zgody użytkownika.

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

PRAWDA jeśli

  • użytkownik wyraził zgodę na określony cel LUB
  • z jakiegokolwiek powodu związanego ze słabym połączeniem internetowym lub jego brakiem na urządzeniu, nie można było uzyskać zgody na ten cel. Proszę zapoznać się z withErrorListener, aby poradzić sobie z tymi warunkami podczas uruchamiania aplikacji, szczególnie w przypadku nowych użytkowników, którzy nie wyrazili jeszcze żadnej zgody

W przeciwnym razie FAŁSZ.

Liczba wyświetleń strony

0

Przykład
fun getHasPurposeConsentAction() {
    val purposeId = "purposeID" // Replace with actual purpose ID
    val hasPurposeConsent = cmpManager?.hasPurposeConsent(purposeId)
    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.")
    }
}

mazgodędostawcy

Sprawdza, czy identyfikator dostawcy jest włączony na podstawie zgody użytkownika.

parametry
Imię Typ Opis Projektu
vendorId sznur identyfikator sprzedawcy
Powrót
  • użytkownik wyraził zgodę określonemu dostawcy LUB
  • z jakiegokolwiek powodu związanego ze słabym połączeniem internetowym lub jego brakiem na urządzeniu, nie udało się uzyskać zgody sprzedawcy. Proszę zapoznać się z withErrorListener, aby poradzić sobie z tymi warunkami podczas uruchamiania aplikacji, szczególnie w przypadku nowych użytkowników, którzy nie wyrazili jeszcze żadnej zgody

W przeciwnym razie FAŁSZ.

Liczba wyświetleń strony

0

Przykład
fun getHasVendorConsentAction() {
    val vendorId = "vendorID" // Replace with actual vendor ID
    val hasVendorConsent = cmpManager?.hasVendorConsent(vendorId)
    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 być zakodowany w formacie Base64

parametry
Imię Typ Opis Projektu
ciąg zgody  sznur Ciąg zakodowany w formacie Base64 reprezentujący zgodę
zakończenieHandler funkcja (opcjonalnie) Procedura obsługi zakończenia wywołania zwrotnego do metody.
Powrót

Brak.

Liczba wyświetleń strony

0

Przykład
val cmpString = "YourBase64EncodedConsentStringHere"

  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 inicjalizacji zainicjuje warstwę zgody i automatycznie sprawdzi, czy użytkownik potrzebuje zgody, czy nie. Ta funkcja ostatecznie otworzy warstwę zgody i wejdzie w interakcję z interfejsem Apple Tracking Transparency API, aby poprosić użytkownika o zgodę

parametry
Imię Typ Opis Projektu
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 CMMPManage.

Liczba wyświetleń strony

1

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

Wymusza otwarcie widoku internetowego warstwy zgody CMP.

parametry
Imię Typ Opis Projektu
context Kontekst Kontekst aplikacji.
Powrót

Brak wartości zwracanej.

Liczba wyświetleń strony

1

Przykład
ActionButtonsRow("Open", "Check", "Open?") { action ->
  when (action) {
  "Open" -> context.getActivity()?.let {
    	cmpManager.openConsentLayer(it.applicationContext)
    }
  	.
  	.
    .
}


potrzebuje Akceptacji

parametry
Brak.
Powrót

PRAWDA, jeśli użytkownik musi wyrazić zgodę.

W przeciwnym razie FAŁSZ.

Liczba wyświetleń strony

0

Przykład
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

parametry
Imię Typ Opis Projektu
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.

Liczba wyświetleń strony

1

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
Imię Typ Opis Projektu
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
Imię Typ Opis Projektu
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)
  }
}


 

 

Powrót do góry