consentmanager Android-SDK-API
API
Bauherr
Konstruktor zum Erstellen eines CmpManager-Objekts
Parameter
| Name | Typ |
Infos |
| 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 |
openCustomLayer
Öffnet die angepasste Einwilligungsebene
Parameter
| Name | Typ |
Infos |
| Aktivität | FragmentAktivität |
Die Aktivitätsinstanz, in der die Einwilligungsebene angezeigt werden soll |
| containerViewId | @IdRes Int |
Die ID der Container-UI, in der die Einwilligungsebene angezeigt werden soll |
Rücksendungen
Eine Funktion ohne Rückgabewert
Beispiel
val activity = requireActivity()
val containerViewId = R.id.container
openCustomLayer(activity, containerViewId)
checkAndOpenConsentLayer
Überprüfen und öffnen Sie schließlich die Zustimmungsebene.
Parameter
| Name | Typ |
Infos |
| Kontext | Kontext |
Das Kontextobjekt der App. |
Beispiel
val cmpManager = CmpManager()
cmpManager.checkAndOpenConsentLayer(context)
openCmpLayer
Gibt zurück, ob der Zweck (id) die Rechte zum Setzen von Cookies hat
Parameter
| Name | Typ |
Infos |
| Kontext | Kontext |
Der Kontext der App |
| id | Schnur |
Die ID des Zwecks Achtung: Die Zweck-ID ist dieselbe wie in der Zweckliste und kann ein Präfix wie C haben |
| Zustimmung prüfen | Boolean |
|
Rücksendungen
| Typ | Infos |
| Boolean | Ein boolescher Wert, der angibt, ob der Anbieter die Zustimmung zum Setzen von Cookies hat. |
Beispiel
val vendorID = "1234"
val checkConsent = true
val result = hasVendorConsent(context, vendorID, checkConsent)
if (result) {
// Vendor has the rights to set cookies
} else {
// Vendor does not have the rights to set cookies
}
hasVendorConsent
Gibt zurück, ob der Anbieter (id) die Rechte zum Setzen von Cookies hat
Parameter
| Name | Typ |
Infos |
| id | Zeichenfolge: |
Die ID des Anbieters Achtung: Die Hersteller-ID ist dieselbe wie in der Verwendungszweckliste und kann ein Präfix wie C haben |
Rücksendungen
| Typ | Infos |
| Boolean | Wenn der Zweck die Zustimmung zum Setzen von Cookies hat |
Beispiel
val vendorId = "S123"
consentTool.hasVendor(vendorId)
hatZweck
Gibt zurück, ob der Zweck (id) die Rechte zum Setzen von Cookies hat
Parameter
| Name | Typ |
Infos |
| id | Zeichenfolge: |
Die ID des Zwecks Achtung: Die Zweck-ID ist dieselbe wie in der Zweckliste und kann ein Präfix wie C haben |
Rücksendungen
| Typ | Infos |
| Boolean | Wenn der Zweck die Zustimmung zum Setzen von Cookies hat |
Beispiel
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getVendorString
Gibt zurück, ob der Zweck (id) die Rechte zum Setzen von Cookies hat
Parameter
| Name | Typ |
Infos |
| id | Zeichenfolge: |
Die ID des Zwecks Achtung: Die Zweck-ID ist dieselbe wie in der Zweckliste und kann ein Präfix wie C haben |
Rücksendungen
| Typ | Infos |
| Boolean | Wenn der Zweck die Zustimmung zum Setzen von Cookies hat |
Beispiel
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposeString
Gibt den Zweck-String zurück, der von . gesetzt wurde consentmanager
Parameter
keine Parameter
Rücksendungen
| Typ | Infos |
| Schnur |
Die Reihe von Zwecken, die durchgesetzt wurde consentmanager
|
Beispiel
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposes
Gibt den Zweck-String zurück, der von . gesetzt wurde consentmanager in einem List-Objekt
Parameter
| Name | Typ |
Infos |
| id | Zeichenfolge: |
Die ID des Zwecks Achtung: Die Zweck-ID ist dieselbe wie in der Zweckliste und kann ein Präfix wie C haben |
Rücksendungen
| Typ | Infos |
| Boolean | Wenn der Zweck die Zustimmung zum Setzen von Cookies hat |
Beispiel
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
Alte Übersicht (tbd)
|
API |
Parameter | Rücksendungen |
Infos
|
|
openCmpConsentToolView( Kontextkontext ) |
Kontext: Der Kontext der App | ungültig | Zeigt eine modale Ansicht mit der Zustimmungs-Webansicht an. Wenn die Compliance akzeptiert oder abgelehnt wird, wird eine Close-Funktion aufgerufen. Sie können diese Schließfunktion mit Ihrer eigenen überschreiben. Implementieren Sie daher den OnCloseCallback und fügen Sie diesen als Parameter hinzu. @apiNote-Benutzeroberfläche -> Beispiel: Ebene durch Schaltflächenaktion öffnen |
|
openCmpConsentToolView( Kontext Kontext, OnCloseCallback Rückruf ) |
Kontext: Der Kontext der App
callback : Der OnCloseCallback, der aufgerufen werden soll, wenn die Webansicht durch Aktion geschlossen wird
|
ungültig | Zeigt eine modale Ansicht mit der Zustimmungs-Webansicht an. Wenn die Compliance akzeptiert oder abgelehnt wird, wird eine Close-Funktion aufgerufen. Sie können diese Schließfunktion mit Ihrer eigenen überschreiben. Implementieren Sie dazu den OnCloseCallback und geben Sie ihn dieser Funktion. Diese Methode sendet keine erneute Anfrage an den ConsentTool-Server. Es wird den letzten Zustand verwenden. Wenn Sie die Einwilligungs-Tool-Ansicht nur wieder öffnen möchten, wenn der Server einen Antwortstatus == 1 gibt, verwenden Sie die checkAndProceedConsentUpdate-Methode @apiNote User Interface -> Beispiel: Open Layer by button action |
|
setCloseCmpConsentToolViewListener( OnCloseCallback Rückruf ) |
callback : Der OnCloseCallback, der aufgerufen werden soll, wenn die Webansicht durch Aktion geschlossen wird | ungültig | Legt einen Listener fest. Wenn die Konformität akzeptiert oder abgelehnt wird, wird diese Funktion aufgerufen. Sie können diese Schließfunktion mit Ihrer eigenen überschreiben. Implementieren Sie dazu den OnCloseCallback und fügen Sie diesen als Parameter hinzu. |
|
setCustomCmpConsentToolViewAction( CustomOpenActionCallback customAction ) |
benutzerdefinierte Aktion: Die benutzerdefinierte Aktion, die aufgerufen werden soll, abgesehen von der Anzeige des Zustimmungstools | ungültig | Legt eine benutzerdefinierte Aktion auf eine Serverantwort fest. |
|
setErrorDialogCmpConsentToolViewListener( OnErrorDialogCallback-Rückruf ) |
callback : Der OnOpenCallback, der aufgerufen werden soll, wenn die View geöffnet wird. | ungültig | Setzt einen Listener. Wird die Compliance View geöffnet, wird diese Funktion aufgerufen. Sie können diese offene Funktion mit Ihrer eigenen überschreiben. Implementieren Sie dazu den OnOpenCallback und fügen Sie diesen als Parameter hinzu. |
|
setNetworkErrorExceptionListener( OnNetworkExceptionCallback-Rückruf ) |
callback : Der OnErrorNetworkCallback, der aufgerufen werden muss. | ungültig | Setzt einen Listener, der aufgerufen wird, wenn ein Netzwerkfehler auftritt. |
|
setOnCMPNotOpenedCallback( OnCMPNotOpenedCallback-Rückruf ) |
callback : Die Aktion cmpNotOpenedCallback, die aufgerufen wird | ungültig | Legt eine Aktion fest, wenn der Consentlayer nicht geöffnet wird |
|
setOpenCmpConsentToolViewListener( Kontext Kontext, Schaltfläche gdprSchaltfläche ) |
Kontext: Dann Kontext der App gdprButton: Der Button, dem openCmpConsentToolViewListener hinzugefügt werden sollte |
ungültig | Setzt einen Listener auf die angegebene Schaltfläche. Wenn auf die Schaltfläche geklickt wird, wird eine modale Ansicht mit der Zustimmungs-Webansicht angezeigt. Wenn die Compliance akzeptiert oder abgelehnt wird, wird eine Close-Funktion aufgerufen. Sie können diese Schließfunktion mit Ihrer eigenen überschreiben. Implementieren Sie dazu den OnCloseCallback und fügen Sie diesen als weiteren Parameter hinzu. Wenn der Parameter nicht gesetzt ist, aber setCloseCmpConsentToolViewListener verwendet wurde, um dem close-Ereignis einen Listener hinzuzufügen, wird dieser verwendet. |
|
setOpenCmpConsentToolViewListener( Kontext Kontext, Schaltfläche gdprSchaltfläche, OnCloseCallback Rückruf ) |
Kontext: Der Kontext der App gdprButton: Der Button, dem openCmpConsentToolViewListener hinzugefügt werden sollte
callback : Der OnCloseCallback, der aufgerufen werden soll, wenn die Webansicht durch Aktion geschlossen wird |
ungültig | Setzt einen Listener auf die angegebene Schaltfläche. Wenn auf die Schaltfläche geklickt wird, wird eine modale Ansicht mit der Zustimmungs-Webansicht angezeigt. Wenn die Compliance akzeptiert oder abgelehnt wird, wird eine Close-Funktion aufgerufen. Sie können diese Schließfunktion mit Ihrer eigenen überschreiben. Implementieren Sie dazu den OnCloseCallback und fügen Sie diesen als letzten Parameter hinzu. |
|
setOpenCmpConsentToolViewListener( OnCloseCallback Rückruf ) |
callback : Der OnCloseCallback, der aufgerufen werden soll, wenn die Webansicht durch Aktion geschlossen wird |
ungültig | Setzt einen Listener. Wird die Compliance View geöffnet, wird diese Funktion aufgerufen. Sie können diese offene Funktion mit Ihrer eigenen überschreiben. Implementieren Sie dazu den OnOpenCallback und fügen Sie diesen als Parameter hinzu. |
|
setOpenPlaceHolderViewListener( Kontext Kontext, Knopf-Taste, String-Anbieter ) |
Kontext: Der Kontext der App Taste im nun erscheinenden Bestätigungsfenster nun wieder los.: Eine Aktionsschaltfläche zum Erstellen der Platzhalteransicht Verkäufer: Der Lieferant, der dem Platzhalter zugeordnet ist |
ungültig | Öffnet die Platzhalteransicht beim Klicken auf die Schaltfläche für den zugewiesenen Lieferanten |
|
|
|||
|
namensThisDay( Kontextkontext) |
Kontext: Der Kontext der App |
boolean: wenn der Server an diesem Tag bereits kontaktiert wurde | Gibt zurück, wenn der Server an diesem Tag bereits kontaktiert wurde. |
|
clearAllValues(Kontextkontext) |
Kontext: Der Kontext der App |
ungültig | Setzt Einwilligungsdaten zurück |
|
Platzhalter erstellen( Kontext Kontext, CMPPlatzhalterParams cmpPlatzhalterParams, CmpPlaceholderEventListener (cmpPlaceholderEventListener) |
Kontext: Der App-Kontext cmpPlaceholderParams: erforderliche Platzhalterparameter zuweisen cmpPlaceholderEventListener: EventListener Interface für benutzerdefinierte Prozessfunktionen |
CmpPlatzhalter: UIView des Platzhalters | Erstellt eine Platzhalteransicht für die dynamische Inhaltsblockierung |
|
exportCMPData(Kontextkontext) |
Kontext: Der App-Kontext |
Schnur: Die Einwilligungszeichenfolge | Eine Exportfunktion, die aufgerufen werden kann, um den vollständigen ConsentString zu exportieren, der von einem ConsentWebView generiert und in den Shared Preferences dieses Geräts gespeichert wurde. |
|
getCalledLast(Kontextkontext) |
Kontext: Der App-Kontext |
Datum: Datum des letzten Aufrufs des Servers | Gibt Auskunft über das letzte Datum, an dem der Server kontaktiert wurde |
|
getConfig() |
|
CMPConfig: CMPConfig-Objekt |
Gibt die aktuell eingestellte CMPConfig zurück |
|
getGoogleACString() |
Kontext: Der App-Kontext |
Schnur: US-Datenschutzzeichenfolge von Anbietern, die durchgesetzt wurde consentmanager |
Gibt den US Privacy String zurück, der von . gesetzt wurde consentmanager |
|
bekomme Instanz() |
|
CMPConsentTool: Der initialisierte Singleton-Moment des consentmanager |
Liefert die CMPConsentTool. Wenn Sie die nicht initialisiert haben CMPConsentTool zuvor wird die CMPConsentToolInitialisation Exception ausgelöst. |
|
getInstanceUnsafe() |
|
CMPConsentTool: der initialisierte Singleton-Instant der consent Manager, oder null. |
Liefert die CMPConsentTool, oder null, wenn es nicht initialisiert wurde. Diese Methode ist unsicher, da sie zu Nullzeiger-Ausnahmen führen kann, aber wenn Sie sicher sind, dass das ConsentTool zuvor initialisiert wurde, können Sie diese Methode verwenden, ohne den Fehler abfangen zu müssen. Wir empfehlen, das zurückgegebene Objekt aus der createInstant-Methode zu speichern, um die Methoden der consentManager. |
|
getLastConsentString( Kontextkontext) |
Kontext: Der App-Kontext |
Schnur: Der letzte eingestellte Zustimmungsstring |
Gibt die zuletzt erteilte Einwilligung zurück, die in base64 von . dargestellt wird consentManager |
|
getPurposes (Kontextkontext) |
Kontext: Der App-Kontext |
Schnur: Der String von Zwecken, der durchgesetzt wurde consentmanager |
Gibt den Zweck-String zurück, der von . gesetzt wurde consentmanager |
|
getUSPrivacyString (Kontextkontext) |
Kontext: Der App-Kontext |
Schnur: Der US-Datenschutzstring von Anbietern, der durchgesetzt wurde consentmanager |
Gibt den US Privacy String zurück, der von . gesetzt wurde consentmanager |
|
getVendorsString(Kontextkontext) |
Kontext: Der App-Kontext |
Schnur: Der String von Vendoren, der durchgesetzt wurde consentmanager |
Gibt den Vendor String zurück, der gesetzt wurde consentmanager |
|
hasPurposeConsent(Kontextkontext, String-ID, boolescher isIABPurpose) |
Kontext: der App-Kontext id: Die ID des Zwecks isIABZweck: Wenn der Zweck durch den IAB-Standard (V1/V2) festgelegt ist |
boolean: Wenn der Zweck die Zustimmung zum Setzen von Cookies hat |
Gibt zurück, ob der Zweck (id) die Rechte zum Setzen von Cookies hat. Aufmerksamkeit: Die Zweck-ID ist dieselbe wie in der Zweckliste und kann ein Präfix wie haben C |
|
hat die Zustimmung des Anbieters ( Kontext Kontext, String-ID, boolescher isIABVendor) |
Kontext: Der App-Kontext id: Die ID des Anbieters isIABVendor: wenn der Anbieter nach IAB-Standard (V1/V2) eingestellt ist |
boolean: Wenn der Anbieter die Zustimmung zum Setzen von Cookies hat. |
Gibt zurück, wenn der Anbieter (ID) das Recht hat, Cookies zu setzen
Aufmerksamkeit: Die Anbieter-ID ist die gleiche wie in der Anbieterliste und kann ein Präfix wie haben C, S. |
|
importCMPData( Kontext Kontext, Zeichenfolge cmpData ) |
Kontext: Der App-Kontext cmpDaten: Der String, der festgelegt wird. Der ConsentString sollte als codiertes base64 übergeben werden |
boolean: Wenn der Import erfolgreich war oder Fehler in der String |
Eine Importmethode, die aufgerufen werden kann, um den von einem ConsentWebView generierten vollständigen ConsentString in die Shared Preferences dieses Geräts zu importieren. |
|
brauchtAkzeptanz(Kontextkontext) |
Kontext: Der App-Kontext |
boolean: wenn der Benutzer eine Zustimmung geben muss |
Gibt zurück, wenn der Benutzer eine Zustimmung geben muss, weil er dies in der Vergangenheit nicht getan hat oder weil der Zustimmungsserver zurückgegeben hat, dass eine neue Zustimmung erforderlich ist |
|
brauchtServerUpdate(Kontextkontext) |
Kontext: Der App-Kontext |
boolean: Wenn die consentmanager muss aktualisiert werden |
Wenn die CMPSettings vom Server aktualisiert werden müssen, weil sie an diesem Tag nicht waren. |
|
|
|
|
|
