Info
Inhalt

[iOS] 3. API-Dokumentation

API


 

initialisieren


Die Initialisierungsfunktion initialisiert die Einwilligungsschicht und prüft automatisch, ob der Benutzer eine Einwilligung benötigt oder nicht. Diese Funktion öffnet schließlich die Einwilligungsebene und interagiert mit der Apple Tracking Transparency API, um den Benutzer um seine Einwilligung zu bitten

Rendite

CMPConsentTool

Beispiel

          cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .initialize()

 

withCloseListener


Fügt einen Close-Listener hinzu, um Benachrichtigungen zu erhalten, wenn die Einwilligungsebene geschlossen wird.

Parameter
Name Typ Beschreibung
closeListener Funktion Rückruf, der aufgerufen wird, wenn die Einwilligungsschicht geschlossen wird.
Rendite

CMPConsentTool

Beispiel

func onClose() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withCloseListener(onClose)

mitOpenListener


Fügt einen offenen Listener hinzu, um Benachrichtigungen zu empfangen, wenn die Einwilligungsebene geöffnet wird.

Parameter
Name Typ Beschreibung
openListener Funktion Rückruf, der aufgerufen wird, wenn die Zustimmungsebene geöffnet wird
Rendite

CMPConsentTool

Beispiel

func onOpen() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withCloseListener(onOpen)

 

 

withErrorListener


Fügt einen Fehler-Listener hinzu, um Benachrichtigungen zu empfangen, wenn ein Fehler aufgetreten ist

Parameter
Name Typ Beschreibung
errorListener Funktion Rückruf zum Hinzufügen einer Aktion, wenn ein Fehler aufgetreten ist.
Rendite

CMPConsentTool

Beispiel

func onCMPError(type: CmpErrorType, message: String?) -> Void {
    switch type {
    case .networkError:
        print(message)
        print("error network")
        break
    case .timeoutError:
        print(message)
        print("error timeout")
        break
    case .consentDataReadWriteError:
        print(message)
        print("error consent read/write")
        break
    case .unknownError:
        print(message)
        print("error unknown")
        break
    @unknown default:
        print(message)
        print("error network")
        break
    }
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withErrorListener(onCMPError)

 

 

 

withOnCMPNotOpenedListener


Fügt einen Rückruf „Cmp nicht geöffnet“ hinzu, um eine Benachrichtigung zu erhalten, wenn die Einwilligungsebene nicht geöffnet wird

Parameter
Name Typ Beschreibung
openListener Funktion Rückruf, der aufgerufen wird, wenn die Zustimmungsschicht „nicht geöffnet“ ist. Der häufigste Grund ist, dass der Benutzer bereits seine Einwilligung gegeben hat
Rendite

CMPConsentTool

Beispiel

func onCMPNotOpened() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withOnCMPNotOpenedListener(onCMPNotOpened)

 

 

 

withOnCmpButtonClickedCallback


Legt einen Rückruf fest, um Benachrichtigungen zu erhalten, wenn der Benutzer auf eine Schaltfläche klickt, um die Einwilligungsebene zu schließen.

Parameter
Name Typ Beschreibung
openListener Funktion Rückruf, der mit dem „CmpButtonEvent“ aufgerufen wird, das angibt, welche Taste gedrückt wurde
Rendite

CMPConsentTool

Beispiel

func onButtonClickedEvent(event: CmpButtonEvent) -> Void {
    switch event {
    case .acceptAll:
        print("user accepted all")
        break
    case .rejectAll:
        print("user accepted all")
        break
    case .save:
        print("user saved custom settings")
        break
    case .close:
        print("user closed consent layer without giving consent")
        break
    @unknown default:
        print("unknown button event")
    }
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withOnCmpButtonClickedCallback(onButtonClickedEvent)

 

 

checkAndOpenConsentLayer


Einwilligungsschicht prüfen und öffnen

Rendite

Kein Rückgabewert

Beispiel
cmpConsentTool.checkAndOpenConsentLayer()

 

openCmpConsentToolView


Öffnet die Ansicht der CMP-Zustimmungsebene

Rendite

Kein Rückgabewert

Beispiel
cmpConsentTool.openView()

 

aus der Ferne überprüfen


Shau

Parameter
Name Typ Beschreibung
onCmpLayerOpen Funktion Rückruf, wenn die Zustimmungsschicht geöffnet sein muss.
ist zwischengespeichert Boolean Wenn das BOOL-Flag TRUE ist, wird die Anfrage zwischengespeichert und die Antwort gespeichert
Rendite

Kein Rückgabewert

Beispiel

cmpConsentTool?.check({() -> Void in
  print("Notification, that consent layer needs to be open")
}, isCached: false)

 

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


Prüft, ob der Benutzer seine Einwilligung gegeben hat. Die Einwilligungsebene kann die Option haben, die Ebene einfach zu schließen. In diesem Fall liegt keine Einwilligung des Nutzers vor.

Rendite
Beispiel
cmpConsentTool.hasConsent()

 

getAllPurposes


Ruft eine durch Kommas getrennte Zeichenfolge der deaktivierten „Zweck“-IDs ab

Rendite

Zeichenfolge aller „Zweck“-IDs

Beispiel
cmpConsentTool.getAllPurposes()

 

getAllPurposeList


Ruft eine Liste aller „Zweck“-IDs für den angegebenen Cmp ab.

Rendite

Eine „Liste“, die alle „Zweck“-IDs enthält.

Beispiel
cmpConsentTool.getAllPurposeList()

 

getEnabledPurposes


Ruft eine durch Kommas getrennte Zeichenfolge der aktivierten „Zweck“-IDs ab

Rendite

„String“ der aktivierten „Zweck“-IDs

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


Aktiviert eine Liste von Anbietern und aktualisiert die gegebene Einwilligung

Parameter
Name Typ Beschreibung
Anbieter Feld Liste der zu aktivierenden Anbieter-IDs.
onFinish Funktion Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“. Der Aufruf erfolgt, wenn die Einwilligung vorliegt und verarbeitet wird.
Rendite

Kein Rückgabewert

Beispiel

func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enableVendorList(vendors, onFinish: onFinish)

 

disableVendorList


Deaktiviert eine Liste von Anbietern und aktualisiert die erteilte Einwilligung

Parameter
Name Typ Beschreibung
Anbieter Feld Liste der zu deaktivierenden Anbieter-IDs.
onFinish Funktion Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“. Der Aufruf erfolgt, wenn die Einwilligung vorliegt und verarbeitet wird.
Rendite

Kein Rückgabewert

Beispiel

func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disableVendorList(vendors, onFinish: onFinish)

 

enablePurposeList


Aktiviert eine Liste von Zwecken und aktualisiert die erteilte Einwilligung

Parameter
Name Typ Beschreibung
Zwecke Feld Liste der zu aktivierenden Zweck-IDs.
onFinish Funktion (optional) Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“. Der Aufruf erfolgt, wenn die Einwilligung vorliegt und verarbeitet wird.
Rendite

Kein Rückgabewert

Beispiel

func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enablePurposeList(vendors, onFinish: onFinish)

// or without callback
cmpConsentTool?.enablePurposeList(vendors)

 

Zweckliste deaktivieren


Deaktiviert eine Liste von Zwecken und aktualisiert die erteilte Einwilligung

Parameter
Name Typ Beschreibung
Zwecke Feld Liste der zu deaktivierenden Zweck-IDs.
onFinish Funktion (optional) Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“. Der Aufruf erfolgt, wenn die Einwilligung vorliegt und verarbeitet wird.
Rendite

Kein Rückgabewert

Beispiel

func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disablePurposeList(vendors, onFinish: onFinish)

// or without callback
cmpConsentTool?.disablePurposeList(vendors)

 

Alles ablehnen


Lehnt die Zustimmungsschicht ab und verhält sich genauso, wenn der Benutzer die Zustimmung „nicht akzeptiert“ hat

Parameter
Name Typ Beschreibung
onFinish Funktion Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“. Der Aufruf erfolgt, wenn die Einwilligung vorliegt und verarbeitet wird.
Rendite

Kein Rückgabewert

Beispiel

func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
cmpConsentTool.rejectAll(onFinish)

 

akzeptiere alle


Akzeptiert die Zustimmungsschicht und verhält sich genauso, wenn der Benutzer die Zustimmung „akzeptiert“.

Parameter
Name Typ Beschreibung
onFinish Funktion Rückruf zur Bearbeitung des Ereignisses „Zustimmung erhalten“. Der Aufruf erfolgt, wenn die Einwilligung vorliegt und verarbeitet wird.
Rendite

Kein Rückgabewert

Beispiel

func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
cmpConsentTool.acceptAll(onFinish)

 

getUSPrivacyString


Holen Sie sich die US-Datenschutzzeichenfolge

Rendite

„String“ Der US-Datenschutzstring, der von festgelegt wurde consentmanager

Beispiel
cmpConsentTool.getUSPrivacyString()

 

hasVendorConsent


Hat die Zustimmung des Anbieters

Parameter
Name Typ Beschreibung
Hersteller-ID Schnur Hersteller-ID
VendorIsV1orV2 BOOl wenn die Lieferanten-ID ein IAB-Anbieter ist. (veraltet: Das Flag wird nicht mehr benötigt)
Rendite
Beispiel
cmpConsentTool.hasVendorConsent("vendorID", FALSE)

 

hasPurposeConsent


Überprüft, ob die Zweck-ID basierend auf der Benutzereinwilligung aktiviert ist.

Parameter
Name Typ Beschreibung
ZweckId Schnur Zweck-ID
VendorIsV1orV2 BOOl wenn die Lieferanten-ID ein IAB-Anbieter ist. (veraltet: Das Flag wird nicht mehr benötigt)
Rendite

 

Beispiel
cmpConsentTool.hasPurposeConsent("purposeID", FALSE)

 

getGoogleACString


Ruft die Google-Add-ID-Zeichenfolge („addtlConsent“) ab, die von festgelegt wurde consent manager.

Rendite

Google AC-String

Beispiel
cmpConsentTool.getGoogleACString()

 

getConsentstring


Holen Sie sich die letzte Einwilligungszeichenfolge

Rendite
Beispiel
getConsentstring()

 

exportCmpString


Exportiert den CmpData-String

Rendite

Der CmpData-String base64-codiert

Beispiel
CMPConsentTool.exportCmpString()

 

namensThisDay


Überprüft, ob die Einwilligungsschicht heute aufgerufen wurde

Rendite

TRUE, wenn der CMPConsent Manager Server wurde heute angefordert, sonst FALSE

Beispiel
cmpConsentTool.calledThisDay()

 

brauchtAkzeptanz


Prüft, ob der Benutzer eine Akzeptanz benötigt

Rendite

TRUE, wenn der Benutzer eine Einwilligung geben muss.

Beispiel
cmpConsentTool.needsAcceptance()

 

zurückstellen


Setzt alle vom „CMPConsentTool“ festgelegten Datensätze zurück

Rendite

Kein Rückgabewert

Beispiel
CMPConsentTool.reset()

 

Nach oben