[Android] 2. API-Dokumentation
API
Bauherr
Konstruktor zum Erstellen eines CmpManager-Objekts
Parameter
| Name | Art |
Beschreibung |
| Kontext | Kontext |
Der Kontext der App |
| Config | CMPConfig |
Das Konfigurationsobjekt für die consent manager |
| closeListener | OnCloseCallback |
Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene geschlossen wird |
| openListener | OnOpenCallback |
Der Callback, der aufgerufen werden soll, wenn die Einwilligungsebene geöffnet 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 |
initialisieren
Initialisieren
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | |
| appInterface | CmpLayerAppEventListenerInterface? = null |
Return
Beispiel
initialize(context = ...,appInterface = ...)
setCallbacks
Rückrufe festlegen
Parameter
| Name | Art | Beschreibung |
| openListener | OnOpenCallback? | |
| closeListener | OnCloseCallback? | |
| cmpNotOpenedCallback | OnCMPNotOpenedCallback? | |
| onErrorCallback | OnErrorCallback? | |
| onCmpButtonClickedCallback | OnCmpButtonClickedCallback? |
Return
Kein Rückgabewert
Beispiel
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)
checkAndOpenConsentLayer
Einwilligungsschicht prüfen und öffnen
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| appInterface | CmpLayerAppEventListenerInterface? = null |
Return
Kein Rückgabewert
Beispiel
checkAndOpenConsentLayer(context = ...,appInterface = ...)
openCustomLayer
öffnet die benutzerdefinierte Einwilligungsebene
Parameter
| Name | Art | Beschreibung |
| Aktivität | FragmentAktivität | Instanz |
| ContainerViewId | Int |
Return
Kein Rückgabewert
Beispiel
openCustomLayer(activity = ...,containerViewId = ...)
aus der Ferne überprüfen
Shau
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | |
| onCmpLayerOpenCallback | OnCmpLayerOpenCallback | |
| ist zwischengespeichert | Boolesch = falsch |
Return
Kein Rückgabewert
Beispiel
check(context = ...,onCmpLayerOpenCallback = ...,isCached = ...)
openCustomLayer
öffnet die benutzerdefinierte Einwilligungsebene
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| appInterface | CmpLayerAppEventListenerInterface |
Return
Kein Rückgabewert
Beispiel
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
öffnet die Einwilligungsebene
Return
Kein Rückgabewert
Beispiel
openConsentLayer()
createCustomLayerFragment
Erstellen Sie ein benutzerdefiniertes Ebenenfragment
Return
CmpLayerFragment
Beispiel
createCustomLayerFragment()
hatZustimmung
Überprüfen Sie, ob der Benutzer seine Einwilligung gegeben hat
Return
App hat Zustimmung oder nicht
Beispiel
hasConsent()
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()
enableVendorList
Lieferantenliste aktivieren
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| Anbieter | Liste | |
| onConsentReceivedCallback | OnConsentReceivedCallback? = null |
Return
Kein Rückgabewert
Beispiel
enableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
disableVendorList
Anbieterliste deaktivieren
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| Anbieter | Liste | Liste der zu aktivierenden Anbieter-IDs. |
| onConsentReceivedCallback | OnConsentReceivedCallback? = null |
Return
Kein Rückgabewert
Beispiel
disableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
enablePurposeList
Zweckliste aktivieren
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| 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(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
Zweckliste deaktivieren
Deaktivieren Sie eine Liste von Zwecken
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| 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(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
Alles ablehnen
Rejects
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
Return
Kein Rückgabewert
Beispiel
rejectAll(context = ...)
akzeptiere alle
Alle akzeptieren
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
Return
Kein Rückgabewert
Beispiel
acceptAll(context = ...)
getUSPrivacyString
Besorgen Sie sich eine Datenschutzerklärung
Return
US-Datenschutzzeichenfolge
Beispiel
getUSPrivacyString()
hasVendorConsent
Hat die Zustimmung des Anbieters
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| id | Schnur | Hersteller-ID |
Return
Boolescher Wert, wenn der Anbieter seine Zustimmung erteilt hat
Beispiel
hasVendorConsent(context = ...,id = ...)
hasPurposeConsent
Hat eine Zweckeinwilligung
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| id | Schnur | Zweck-ID |
| isIABZweck | Boolean | (veraltet), wenn der Zweck ein IAB-Zweck ist |
| Zustimmung prüfen | Boolesch = wahr |
Return
Beispiel
hasPurposeConsent(context = ...,id = ...,isIABPurpose = ...,checkConsent = ...)
getGoogleACString
Rufen Sie den Google AC-String ab
Return
Google AC-String
Beispiel
getGoogleACString()
getConsentstring
Holen Sie sich die letzte Einwilligungszeichenfolge
Return
gespeicherte Einwilligungszeichenfolge
Beispiel
getConsentstring()
exportCmpString
Einwilligungszeichenfolge exportieren
Return
gespeicherter Cmp-String
Beispiel
exportCmpString()
getCalledLast
Werde zuletzt angerufen
Return
zuletzt aufgerufenes Cmp-Layer-Datum
Beispiel
getCalledLast()
namensThisDay
Heute angerufen
Return
wenn Layer heute aufgerufen wurde
Beispiel
calledThisDay()
brauchtAkzeptanz
Braucht Akzeptanz
Return
wenn der Benutzer eine Akzeptanz benötigt
Beispiel
needsAcceptance()
setOpenCmpConsentToolViewListener
öffnet die Einwilligungsebene
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| gdprButton | Taste | Aktionsknopf |
| callback | OnCloseCallback? |
Return
Kein Rückgabewert
Beispiel
setOpenCmpConsentToolViewListener(context = ...,gdprButton = ...,callback = ...)
setOpenPlaceHolderViewListener
Diese Methode ist veraltet und wurde in Version 1.7.0 entfernt
Legen Sie den Listener für die offene Platzhalteransicht fest
Parameter
| Name | Art | Beschreibung |
| Kontext | Kontext | Anwendungskontext |
| Aktionsknopf | Taste |
Return
Kein Rückgabewert
Beispiel
setOpenPlaceHolderViewListener(context = ...,actionButton = ...)
