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