[Android] 2. API-documentatie
accepteer alles
Accepteert de toestemmingslaag en gedraagt zich hetzelfde wanneer de gebruiker de toestemming accepteert. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
onConsentReceivedCallback |
Bij ToestemmingOntvangenTerugbellen? | Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. |
Retourneren
Geen retourwaarde.
Voorbeeld
func acceptAll(onFinish: @escaping () -> Void) {
cmpManager?.acceptAll(onFinish: onFinish)
}
controle
Controleert of toestemming van de gebruiker vereist is, en retourneert optioneel gecachte resultaten. Deze methode verbruikt één paginaweergave als de parameter isCached() TRUE is en de gecachte toestemming IS verlopen, één paginaweergave als de parameter isCached() FALSE is, en geen paginaweergaven als de gecachte toestemming niet is verlopen. De gecachte toestemming is elke 24 uur verlopen en verwijderd.
parameters
Naam | Type | Beschrijving |
onCheckIsConsentRequiredCallback |
OnCheckIsToestemming vereist | fun isConsentRequired(isConsentRequired: Boolean) terugbellen om te bepalen of toestemming vereist is of niet |
isCached |
Booleaans = onwaar | indien waar, wordt het resultaat één dag in de cache bewaard |
Retourneren
Geen.
Voorbeeld
cmpManager.acceptAll {
coroutineScope.launch {
snackbarHostState.showSnackbar(
message = "All consents accepted",
duration = SnackbarDuration.Short
)
consentStatus.value = showConsentStatus(cmpManager)
}
}
checkAndOpenConsentLayer
Controleert of toestemming van de gebruiker vereist is en opent, indien dit het geval is, de gebruikersinterface van de toestemmingslaag. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
context |
Context | Toepassingscontext |
appInterface |
CmpLayerAppEventListenerInterface? = nul |
Retourneren
Geen retourwaarde
Voorbeeld
context.getActivity()?.let { activity ->
cmpManager.checkAndOpenConsentLayer(activity)
}
genaamdThisDay
Controleert of de toestemmingslaag vandaag is aangevraagd. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
WAAR als de toestemming van de gebruiker vandaag al is gevraagd.
Anders ONWAAR.
Voorbeeld
fun consentRequestedTodayAction() {
val calledToday = cmpManager?.calledThisDay()
if (calledToday != null) {
println("Consent requested today: $calledToday")
} else {
println("Failed to retrieve consent request status for today.")
}
}
uitschakelenPurposeList
Schakelt een lijst met doeleinden uit en werkt de gegeven toestemming bij. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
purposes |
Lijst | Lijst met doel-ID's die moeten worden uitgeschakeld |
updateVendor |
Boolean | vlag indien waar, schakel ook overeenkomstige leveranciers uit |
onConsentReceivedCallback |
Bij ToestemmingOntvangenTerugbellen? |
Retourneren
Geen retourwaarde
Voorbeeld
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)
leverancierslijst uitschakelen
Schakelt een lijst met leveranciers uit en werkt de gegeven toestemming bij. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
vendors |
Lijst | Lijst met leveranciers-ID's die moeten worden ingeschakeld. |
onConsentReceivedCallback |
Bij ToestemmingOntvangenTerugbellen? | Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. het wordt opgeroepen wanneer toestemming is ontvangen en verwerkt |
Retourneren
Geen retourwaarde.
Voorbeeld
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)
leverancierslijst inschakelen
Schakelt een lijst met doeleinden in en werkt de gegeven toestemming bij. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
vendors |
Lijst | Lijst met doel-ID's die moeten worden ingeschakeld. |
onConsentReceivedCallback |
functie (optioneel) | Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. Het wordt opgeroepen wanneer de toestemming is ontvangen en verwerkt |
Retourneren
Geen retourwaarde.
Voorbeeld
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)
SchakelPurposeList in
Schakelt een lijst met leveranciers in en werkt de gegeven toestemming bij. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
purposes |
Lijst | Lijst met doel-ID's die moeten worden ingeschakeld. |
updateVendor |
Boolean | vlag indien waar, schakel ook overeenkomstige leveranciers in |
onConsentReceivedCallback |
Functie (optioneel) |
Retourneren
Geen retourwaarde.
Voorbeeld
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)
exportCmpString
Exporteert de huidige CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
De CMP-toestemmingsstring.
Voorbeeld
fun exportConsentStringAction() {
val exportString = cmpManager?.exportCmpString()
println(exportString ?: "No string to export.")
}
GetAllPurposes
Retourneert alle doeleinden-ID's. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een door komma's gescheiden tekenreeks die ID's voor alle doeleinden bevat.
Voorbeeld
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.")
}
}
getAllPurposeList
Retourneert een lijst met alle doel-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Lijst
Voorbeeld
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.")
}
}
haalAlleVerkopers
Retourneert alle leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een door komma's gescheiden tekenreeks die alle leveranciers-ID's bevat.
Voorbeeld
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.")
}
}
getAllVendorsLijst
Retourneert een lijst met alle leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een lijst met alle leveranciers-ID's.
Voorbeeld
fun getAllVendorsListAction() {
val allVendors = cmpManager?.getAllVendorsList()
if (allVendors != null) {
println("All vendors list: ${allVendors.joinToString(", ")}")
} else {
println("Failed to retrieve all vendors list.")
}
}
getConsentstring
Retourneert een string met de laatst gegeven toestemming. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een tekenreeks waarvan de laatste toestemming door de gebruiker is bevestigd.
Voorbeeld
fun getAllVendorsListAction() {
val allVendors = cmpManager?.getAllVendorsList()
if (allVendors != null) {
println("All vendors list: ${allVendors.joinToString(", ")}")
} else {
println("Failed to retrieve all vendors list.")
}
}
getDisabledPurposes
Retourneert alle ID's van uitgeschakelde doeleinden voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een door komma's gescheiden tekenreeks met de ID's van alle uitgeschakelde doeleinden.
Voorbeeld
fun getDisabledPurposesAction() {
val disabledPurposes = cmpManager?.getDisabledPurposes()
if (disabledPurposes != null) {
println("Disabled purposes: $disabledPurposes")
} else {
println("Failed to retrieve disabled purposes.")
}
}
getDisabledVendors
Retourneert alle uitgeschakelde leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een door komma's gescheiden tekenreeks met de ID's van alle uitgeschakelde leveranciers.
Voorbeeld
fun getDisabledVendorsAction() {
val disabledVendors = cmpManager?.getDisabledVendors()
if (disabledVendors != null) {
println("Disabled vendors: $disabledVendors")
} else {
println("Failed to retrieve disabled vendors.")
}
}
getEnabledPurposes
Retourneert alle ingeschakelde leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een door komma's gescheiden tekenreeks met de ID's van alle ingeschakelde leveranciers.
Voorbeeld
fun getEnabledPurposesAction() {
val enabledPurposes = cmpManager?.getEnabledPurposes()
if (enabledPurposes != null) {
println("Disabled purposes: $enabledPurposes")
} else {
println("Failed to retrieve enabled purposes.")
}
}
getEnabledPurposeList
Retourneert een lijst met alle ingeschakelde doeleinden-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een lijst met de ID's van alle ingeschakelde doeleinden.
Voorbeeld
fun getEnabledPurposesAction() {
val enabledPurposes = cmpManager?.getEnabledPurposes()
if (enabledPurposes != null) {
println("Enabled purposes: ${enabledPurposes.joinToString(", ")}")
} else {
println("Failed to retrieve enabled purposes list.")
}
}
getEnabledVendors
Retourneert alle ingeschakelde leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een door komma's gescheiden tekenreeks met de ID's van alle ingeschakelde leveranciers.
Voorbeeld
fun getEnabledVendorsAction() {
val enabledVendors = cmpManager?.getEnabledVendors()
if (enabledVendors != null) {
println("Enabled vendors: $enabledVendors")
} else {
println("Failed to retrieve enabled vendors.")
}
}
getEnabledVendorList
Retourneert een lijst met alle ingeschakelde leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een lijst met alle ingeschakelde leveranciers-ID's.
Voorbeeld
fun getEnabledVendorsAction() {
val enabledVendors = cmpManager?.getEnabledVendors()
if (enabledVendors != null) {
println("Enabled vendors: ${enabledVendors.joinToString(", ")}")
} else {
println("Failed to retrieve enabled vendors.")
}
}
getGoogleACString
Haalt de Google-tekenreeks voor aanvullende toestemmings-ID (`addtlConsent`) op die is ingesteld door de consent manager.
Voor meer informatie, kijk op de Technische specificatie voor aanvullende toestemming van Google.
Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een lijst met alle ingeschakelde leveranciers-ID's.
Voorbeeld
fun getGoogleConsentStringAction() {
val googleACString = cmpManager?.getGoogleACString()
if (googleACString != null) {
println("Google Additional Consent String: $googleACString")
} else {
println("Failed to retrieve Google Additional Consent String.")
}
}
getUSPrivacyString
Haalt de US Privacy String op. Deze US privacy string is een cookie die informatie opslaat over de openbaarmakingen en keuzes die de bezoeker van de website heeft gemaakt met betrekking tot zijn consumentenrechten. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een string met de Amerikaanse privacygegevens die zijn ingesteld door consentmanager.
Voorbeeld
fun getUSPrivacyStringAction() {
val usPrivacyString = cmpManager?.getUSPrivacyString()
if (usPrivacyString != null) {
println("US Privacy string contents: $usPrivacyString")
} else {
println("Failed to retrieve US Privacy string.")
}
}
heeftToestemming
Controleert of de gebruiker al toestemming heeft gegeven. De toestemmingslaag kan de optie hebben om de laag gewoon te sluiten. In dat geval heeft de gebruiker geen toestemming gegeven. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
Een string met de Amerikaanse privacygegevens die zijn ingesteld door consentmanager.
Voorbeeld
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 (vanaf versie 2.5.1)
hasPurposeConsent (verouderd)
Controleert of de doel-ID is ingeschakeld op basis van de toestemming van de gebruiker. Deze methode verbruikt geen paginaweergaven.
parameters
Naam | Type | Beschrijving |
purposeId |
Draad | doel-id |
defaultReturn |
Boolean | Waarde die standaard door de methode wordt geretourneerd, als er nog geen toestemming is. Zie onderstaande waarschuwing. |
Retourneren
WAAR als de gebruiker toestemming heeft gegeven voor het opgegeven doel.
Anders ONWAAR.
Houd er rekening mee dat als er om welke reden dan ook sprake is van een slechte of geen internetverbinding op het apparaat of als er geen toestemming is verleend, de waarde die via de defaultReturn
parameter wordt geretourneerd.
De defaultReturn
parameter bestaat niet in versies ouder dan 2.5.1.
Voorbeeld
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 (vanaf versie 2.5.1)
hasVendorConsent (verouderd)
Controleert of de leveranciers-ID is ingeschakeld op basis van de toestemming van de gebruiker. Deze methode verbruikt geen paginaweergaven.
parameters
Naam | Type | Beschrijving |
vendorId |
Draad | verkopers ID |
defaultReturn |
Boolean | Waarde die standaard door de methode wordt geretourneerd, als er nog geen toestemming is. |
Retourneren
TRUE als de gebruiker toestemming heeft gegeven aan de opgegeven leverancier.
Anders ONWAAR.
Houd er rekening mee dat als de toestemming voor het doel om welke reden dan ook, gerelateerd aan een slechte of geen internetverbinding op het apparaat, niet kon worden opgehaald, de waarde die via de defaultReturn
parameter wordt geretourneerd.
De defaultReturn
parameter bestaat niet in versies ouder dan 2.5.1.
Voorbeeld
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
Importeert een CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt. De string moet AS-IS worden geïnformeerd wanneer deze wordt opgehaald via de exportCmpString()-methodeDeze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
toestemmingString | Draad | String die de toestemming vertegenwoordigt |
voltooiingHandler | functie (optioneel) | Callback-voltooiingshandler naar de methode. |
Retourneren
Geen.
Voorbeeld
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)
initialiseren
De functie Initialize initialiseert de toestemmingslaag en controleert automatisch of de gebruiker toestemming nodig heeft of niet. Deze functie opent uiteindelijk de toestemmingslaag en zal interacteren met de Apple Tracking Transparency API om de gebruiker om toestemming te vragen. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
context |
Context | App-context |
cmpConfig |
CmpConfig | Het CmpConfig-object wordt doorgegeven met de informatie over de appId, Domain, appName en taal (optioneel) |
Retourneren
Het CMPManager-object.
Voorbeeld
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)
}
openConsentLayer
Opent geforceerd de CMP-toestemmingslaag webview. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
context |
Context | App-context. |
Retourneren
Geen retourwaarde.
Voorbeeld
ActionButtonsRow("Open", "Check", "Open?") { action ->
when (action) {
"Open" -> context.getActivity()?.let {
cmpManager.openConsentLayer(it.applicationContext)
}
.
.
.
}
heeft Acceptatie nodig
Controleert of toestemming moet worden gegeven door de huidige app-gebruiker. Deze methode verbruikt geen paginaweergaven.
parameters
Geen. |
Retourneren
TRUE als de gebruiker toestemming moet geven.
Anders ONWAAR.
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")
}
}
weigerAlles
Verwerpt de toestemmingslaag en gedraagt zich hetzelfde wanneer de gebruiker de toestemming niet heeft geaccepteerd. Deze methode verbruikt één paginaweergave.
parameters
Naam | Type | Beschrijving |
onFinish |
functie | Optioneel. Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. het wordt opgeroepen wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde.
Voorbeeld
// Define the onFinish function
fun onFinish() {
println("Notification: New consent has been received with a Reject All response.")
}
cmpManager?.rejectAll(::onFinish)
terugbellen instellen
Configureert de beschikbare terugbelverzoeken.
parameters
Naam | Type | Beschrijving |
openListener |
AanOpenTerugbellen |
De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt geopend. |
closeListener |
BijSluitenTerugbellen |
De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt gesloten. |
cmpNotOpenedCallback |
AanCMPNietGeopendTerugbellen |
De callback die moet worden aangeroepen wanneer de toestemmingslaag niet kan worden geopend. |
onErrorCallback |
OnErrorTerugbellen |
De callback die moet worden aangeroepen bij een fout. |
onButtonClickedCallback |
OnButtonClickedCallback |
De callback die moet worden aangeroepen om informatie te krijgen over welke knop is ingedrukt om de toestemmingslaag te sluiten. |
Retourneren
Geen retourwaarde
Voorbeeld
val existingInstance = instance?.get()
existingInstance.setCallbacks(
openListener = openListener,
closeListener = closeListener,
cmpNotOpenedCallback = cmpNotOpenedCallback,
onErrorCallback = errorCallback,
onButtonClickedCallback = cmpButtonClickedCallback
)
met GoogleAnalyticsTerugbellen
Callback instellen voor het ophalen van Google Consentmode-waarden.
parameters
Naam | Type | Beschrijving |
analyticsListener |
CmpGoogleAnalyticsInterface | De interface-implementatie om updates te ontvangen over de toestemmingsmodus van Google Analytics. |
Retourneren
Het huidige exemplaar van CmpManagerInterface voor ketenvorming.
Voorbeeld
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)
}
}