Info
Inhalt

[Android] 2. API-Dokumentation

Bauherr


Konstruktor zum Erstellen eines CmpManager-Objekts

Parameter
Name und Vorname Typ

Beschreibung

Kontext Kontext

Der Kontext der App sollte FragmentActivity sein, wenn ein benutzerdefiniertes Layout verwendet wird

Config CmpConfig

Das Konfigurationsobjekt für die consent manager

openListener OnOpenCallback

Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene geöffnet wird

closeListener OnCloseCallback

Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene geschlossen wird

cmpNotOpenedCallback OnCMPNotOpenedCallback

Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene nicht geöffnet werden konnte

onErrorCallback OnErrorCallback

Der Callback, der bei einem Fehler aufgerufen werden soll

onButtonClickedCallback
OnButtonClickedCallback

Der Rückruf, der aufgerufen werden soll, um Informationen darüber zu erhalten, welche Schaltfläche zum Schließen der Einwilligungsschicht gedrückt wurde

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

 

initialisieren


Das initialize Die Funktion dient dazu, das CMP SDK in Ihrem Anwendungskontext einzurichten und die Zustimmungsebene bei Bedarf automatisch zu überprüfen und zu öffnen. Der initialize kann mit der Instanzerstellung verkettet werden

Parameter
Name und Vorname Typ Beschreibung
Kontext Kontext  
appInterface CmpLayerAppEventListenerInterface? = null  
Return

 

Beispiel
initialize(context = ...,appInterface = ...)

 

setCallbacks


Rückrufe festlegen

Parameter
Name und Vorname Typ Beschreibung
openListener OnOpenCallback

Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene geöffnet wird

closeListener OnCloseCallback

Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene geschlossen wird

cmpNotOpenedCallback OnCMPNotOpenedCallback

Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene nicht geöffnet werden konnte

onErrorCallback OnErrorCallback

Der Callback, der bei einem Fehler aufgerufen werden soll

onButtonClickedCallback
OnButtonClickedCallback

Der Rückruf, der aufgerufen werden soll, um Informationen darüber zu erhalten, welche Schaltfläche zum Schließen der Einwilligungsschicht gedrückt wurde

Return

Kein Rückgabewert

Beispiel
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)

setGoogleAnalyticsCallback


Rückruf zum Abrufen von Google Consentmode-Werten festlegen

Parameter
Name und Vorname Typ Beschreibung
AnalyticsListener CmpGoogleAnalyticsInterface  
Return

Kein Rückgabewert

Beispiel
 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


Einwilligungsschicht prüfen und öffnen

Parameter
Name und Vorname Typ Beschreibung
Kontext Kontext Anwendungskontext
appInterface CmpLayerAppEventListenerInterface? = null  
Return

Kein Rückgabewert

Beispiel
checkAndOpenConsentLayer(context = ...,appInterface = ...)

 

openCustomLayer


öffnet die benutzerdefinierte Einwilligungsebene

Parameter
Name und Vorname Typ Beschreibung
Aktivität FragmentAktivität Instanz
ContainerViewId Int  
Return

Kein Rückgabewert

Beispiel
openCustomLayer(activity = ...,containerViewId = ...)

 

aus der Ferne überprüfen


Shau

Parameter
Name und Vorname Typ Beschreibung
onCheckIsConsentRequiredCallback OnCheckIsConsentRequired Spaß isConsentRequired(isConsentRequired: Boolean) Rückruf, um festzustellen, ob eine Einwilligung erforderlich ist oder nicht
ist zwischengespeichert Boolesch = falsch Wenn true, wird das Ergebnis einen Tag lang zwischengespeichert
Return

Kein Rückgabewert

Beispiel
check(onCheckIsConsentRequiredCallback = ...,isCached = ...)

 

openCustomLayer


öffnet die benutzerdefinierte Einwilligungsebene

Parameter
Name und Vorname Typ Beschreibung
Kontext Kontext Anwendungskontext
appInterface CmpLayerAppEventListenerInterface  
Return

Kein Rückgabewert

Beispiel
openCustomLayer(context = ...,appInterface = ...)

 

openConsentLayer


öffnet die Einwilligungsebene

Return

Kein Rückgabewert

Beispiel
openConsentLayer(context)

hatZustimmung


Überprüfen Sie, ob der Benutzer seine Einwilligung gegeben hat

Return
Beispiel
hasConsent()

 

enableVendorList


Lieferantenliste aktivieren

Parameter
Name und Vorname Typ Beschreibung
Anbieter Liste  
onConsentReceivedCallback OnConsentReceivedCallback? = null  
Return

Kein Rückgabewert

Beispiel
enableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

disableVendorList


Anbieterliste deaktivieren

Parameter
Name und Vorname Typ Beschreibung
Anbieter Liste Liste der zu aktivierenden Anbieter-IDs.
onConsentReceivedCallback OnConsentReceivedCallback? = null  
Return

Kein Rückgabewert

Beispiel
disableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

enablePurposeList


Zweckliste aktivieren

Parameter
Name und Vorname Typ Beschreibung
Zwecke Liste Liste der zu aktivierenden Zweck-IDs.
updateVendor Boolesch = wahr Flag, wenn true, aktiviert auch entsprechende Anbieter
onConsentReceivedCallback OnConsentReceivedCallback? = null  
Return

Kein Rückgabewert

Beispiel
enablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

Zweckliste deaktivieren


Deaktivieren Sie eine Liste von Zwecken

Parameter
Name und Vorname Typ Beschreibung
Zwecke Liste Liste der zu deaktivierenden Zweck-IDs
updateVendor Boolesch = wahr Flag, wenn true, deaktiviert auch entsprechende Anbieter
onConsentReceivedCallback OnConsentReceivedCallback? = null  
Return

Kein Rückgabewert

Beispiel
disablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

Alles ablehnen


Alles ablehnen 

Parameter
Name und Vorname Typ Beschreibung
onConsentReceivedCallback OnConsentReceivedCallback? = null Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“.
Return

Kein Rückgabewert

Beispiel
cmpManager.rejectAll {
                    // consent request done
                }

 

akzeptiere alle


Alle akzeptieren

Parameter
Name und Vorname Typ Beschreibung
onConsentReceivedCallback OnConsentReceivedCallback? = null Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“.
Return

Kein Rückgabewert

Beispiel
 cmpManager.acceptAll {
                    // consent request done
                }

 

getUSPrivacyString


Besorgen Sie sich eine Datenschutzerklärung

Return

US-Datenschutzzeichenfolge

Beispiel
getUSPrivacyString()

 

hasVendorConsent


Hat die Zustimmung des Anbieters

Parameter
Name und Vorname Typ Beschreibung
id Schnur Hersteller-ID
Return
Beispiel
hasVendorConsent(id = ...)

 

hasPurposeConsent


Hat eine Zweckeinwilligung

Parameter
Name und Vorname Typ Beschreibung
id Schnur Zweck-ID
Return

 

Beispiel
hasPurposeConsent(id = ...)

 

getGoogleACString


Rufen Sie den Google AC-String ab

Return

Google AC-String

Beispiel
getGoogleACString()

 

getConsentstring


Holen Sie sich die letzte Einwilligungszeichenfolge

Return
Beispiel
getConsentstring()

 

exportCmpString


Einwilligungszeichenfolge exportieren

Return

gespeicherter Cmp-String

Beispiel
exportCmpString()

 

importCmpString


Shau

Parameter
Name und Vorname Typ Beschreibung
cmpString Schnur cmpString zum Importieren
importCallback CmpImportCallback Spaß amImportResult(Erfolg: Boolean, Nachricht: String)
Return

Kein Rückgabewert

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

 

getCalledLast


Werde zuletzt angerufen

Return

zuletzt aufgerufenes Cmp-Layer-Datum

Beispiel
getCalledLast()

 

namensThisDay


Heute angerufen

Return

wenn Layer heute aufgerufen wurde

Beispiel
calledThisDay()

 

getAllPurposes


Gibt alle Zwecke als String zurück

Return

Zweck Zeichenfolge

Beispiel
getAllPurposes()

 

getAllPurposeList


Gibt alle Zwecke als Liste von Zeichenfolgen zurück

Return

Zweckliste

Beispiel
getAllPurposeList()

 

getEnabledPurposes


Holen Sie sich vereinbarte Ziele

Return

 

Beispiel
getEnabledPurposes()

 

getEnabledPurposeList


Erhalten Sie eine vereinbarte Zweckliste

Return

 

Beispiel
getEnabledPurposeList()

 

getDisabledPurposes


Erhalten Sie deaktivierte Zwecke

Return

 

Beispiel
getDisabledPurposes()

 

getAllVendors


Holen Sie sich alle Anbieter

Return

 

Beispiel
getAllVendors()

 

getAllVendorsList


Holen Sie sich die Liste aller Anbieter

Return

 

Beispiel
getAllVendorsList()

 

getEnabledVendors


Holen Sie sich vereinbarte Anbieter

Return

 

Beispiel
getEnabledVendors()

 

getEnabledVendorList


Holen Sie sich eine vereinbarte Lieferantenliste

Return

 

Beispiel
getEnabledVendorList()

 

getDisabledVendors


Holen Sie sich deaktivierte Anbieter

Return

 

Beispiel
getDisabledVendors()

 

brauchtAkzeptanz


Braucht Akzeptanz

Return

wenn der Benutzer eine Akzeptanz benötigt

Beispiel
needsAcceptance()
Nach oben