[iOS] 3. API-dokumentation

Utfasad SDK/uppgradera till v3: Den här dokumentationen beskriver version 2.x av vår SDK. 2.x SDK är utfasad och kommer att tas bort av EOY 2025. Uppgradera till SDK version 3.x. Se hjälpavsnittet om SDK v3 här.

acceptera alla

Accepterar samtyckesskiktet och beter sig på samma sätt när användaren accepterar samtycket. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

func onFinish() {
    print("Notification: New consent was received")
}

// Accept all consent with a callback
cmpConsentTool.acceptAll(onFinish)

ta

Kontrollerar om samtycke krävs från användaren och returnerar eventuellt cachade resultat. Denna metod förbrukar en sidvisning if isCached parametern är TRUE och cachelagrat samtycke har löpt ut, en sidvisning om isCached parametern är FALSE och inga sidvisningar om det cachade samtycket inte har löpt ut. Det cachade samtycket upphör att gälla och rensas var 24:e timme. 

parametrar

Retur

Inget returvärde.

Exempelvis

@objc func checkCmpLayer() {
    print("Checking need for consent.")

    cmpManager?.check(
        {
            // Callback for when the consent layer needs to be opened
            print("Consent layer will open")
            self.cmpConsentTool?.openView()
        }, 
        isCached: true
    )
}

checkAndOpenConsentLayer

Kontrollerar om användarens samtycke krävs och, i så fall, öppnar användargränssnittet för samtyckeslagret. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

@objc func checkAndOpenConsentLayerAction() {
    cmpManager?.checkAndOpenConsentLayer()
}

samtyckeBegärt Idag

Kontrollerar om samtyckeslagret begärdes idag. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

TRUE om användarens samtycke begärdes redan idag.

FALSK annars.

Exempelvis

@objc func consentRequestedTodayAction() {
    if let calledToday = cmpManager?.consentRequestedToday() {
        print("Consent requested today: \(calledToday)")
    } else {
        print("Failed to retrieve consent request status for today.")
    }
}

disablePurposeList

Inaktiverar en lista med syften och uppdaterar det givna samtycket. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

func onFinish() {
    print("Notification: New consent received")
}

let purposes = ["1", "2"]

// Option with callback
cmpManager?.disablePurposeList(purposes, onFinish: onFinish)

// Option without callback
cmpManager?.disablePurposeList(purposes)

inaktiveraVendorList

Inaktiverar en lista över leverantörer och uppdaterar det givna samtycket. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

func onFinish() {
    print("Notification: New consent received")
}

let vendors = ["1", "2"]

// Option with callback
cmpManager?.disableVendorList(vendors, onFinish: onFinish)

// Option without callback
cmpManager?.disableVendorList(vendors)

enablePurposeList

Aktiverar en lista över syften och uppdaterar det givna samtycket. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde

Exempelvis

func onFinish() {
    print("Notification: New consent received")
}

let purposes = ["1", "2"]

// Option with callback
cmpManager?.enablePurposeList(purposes, onFinish: onFinish)

// Option without callback
cmpManager?.enablePurposeList(purposes)

aktiveraVendorList

Aktiverar en lista över leverantörer och uppdaterar det givna samtycket. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

func onFinish() {
    print("Notification: New consent received")
}

let vendors = ["1", "2"]

// Option with callback
cmpManager?.enableVendorList(vendors, onFinish: onFinish)

// Option without callback
cmpManager?.enableVendorList(vendors)

exportCmpString

Exporterar den aktuella CMP-strängen som representerar användarens samtyckespreferenser. Denna metod nås på ett statiskt sätt. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

Samtyckessträngen.

Exempelvis

@objc func exportConsentStringAction() {
    let exportString = cmpManager.exportCmpString()
    print(exportString ?? "No string to export.");
}

getAllPurposes

Returnerar ID:n för alla ändamål. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En kommaseparerad sträng som innehåller ID:n för alla ändamål.

Exempelvis

@objc func getAllPurposesAction() {
    if let allPurposes = cmpManager?.getAllPurposes() {
        print("All purposes: \(allPurposes)")
        // Additional actions for getAllPurposes function can be added here
    } else {
        print("Failed to retrieve all purposes.")
    }
}

getAllPurposeList

Returnerar en lista över ID:n för alla ändamål för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En lista som innehåller ID:n för alla ändamål.

Exempelvis

@objc func getAllPurposeListAction() {
    // Action for getAllPurposeList function
    if let allPurposes = cmpManager?.getAllPurposesList() {
        print("All purposes list: \(allPurposes.joined(separator: ", "))")
    } else {
        print("Failed to retrieve all purposes list.")
    }
}

getAllVendors

Returnerar alla leverantörers ID för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En kommaseparerad sträng som innehåller alla leverantörs-ID:n.

Exempelvis

@objc func getAllVendorsAction() {
    if let allPurposes = cmpManager?.getAllVendors() {
        print("Printing all Vendors: \(allPurposes)")
    } else {
        print("Failed to retrieve all vendors.")
    }
}

getAllVendorsList

Returnerar en lista över alla leverantörers ID:n för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En lista som innehåller alla leverantörs-ID:n.

Exempelvis

@objc func getAllVendorsListAction() {
    if let allVendors = cmpManager?.getAllVendorsList() {
        print("All vendors list: \(allVendors.joined(separator: ", "))")
    } else {
        print("Failed to retrieve all vendors list.")
    }
}

getConsentString

Returnerar en sträng med det senaste samtycket. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En sträng med det senaste samtycket som har bekräftats av användaren.

Exempelvis

@objc func getAllVendorsListAction() {
    if let allVendors = cmpManager?.getAllVendorsList() {
        print("All vendors list: \(allVendors.joined(separator: ", "))")
    } else {
        print("Failed to retrieve all vendors list.")
    }
}

getDisabledPurposes

Returnerar ID:n för alla inaktiverade ändamål för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En kommaseparerad sträng som innehåller ID:n för alla inaktiverade ändamål.

Exempelvis

@objc func getDisabledPurposesAction() {
    if let disabledPurposes = cmpManager?.getDisabledPurposes() {
        print("Disabled purposes: \(disabledPurposes)")
    } else {
        print("Failed to retrieve disabled purposes.")
    }
}

getDisabledVendors

Returnerar alla inaktiverade leverantörers ID för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En kommaseparerad sträng som innehåller alla inaktiverade leverantörers ID:n.

Exempelvis

@objc func getDisabledVendorsAction() {
    if let disabledVendors = cmpManager?.getDisabledVendors() {
        print("Disabled vendors: \(disabledVendors)")
    } else {
        print("Failed to retrieve disabled vendors.")
    }
}

getEnabledPurposes

Returnerar alla aktiverade leverantörers ID:n för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En kommaseparerad sträng som innehåller alla aktiverade leverantörers ID:n.

Exempelvis

@objc func getEnabledVendorsAction() {
    if let enabledVendors = cmpManager?.getEnabledVendors() {
        print("Enabled vendors: \(enabledVendors)")
    } else {
        print("Failed to retrieve enabled vendors.")
    }
}

getEnabledPurposeList

Returnerar en lista över alla aktiverade ändamåls ID:n för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En lista som innehåller ID:n för alla aktiverade ändamål.

Exempelvis

@objc func getEnabledPurposesAction() {
    if let enabledPurposes = cmpManager?.getEnabledPurposes() {
        print("Enabled purposes: \(enabledPurposes.joined(separator: ", "))")
    } else {
        print("Failed to retrieve enabled purposes list.")
    }
}

getEnabledVendors

Returnerar alla aktiverade leverantörers ID:n för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En kommaseparerad sträng som innehåller alla aktiverade leverantörers ID:n.

Exempelvis

@objc func getEnabledVendorsAction() {
    if let enabledVendors = cmpManager?.getEnabledVendors() {
        print("Enabled vendors: \(enabledVendors)")
    } else {
        print("Failed to retrieve enabled vendors.")
    }
}

getEnabledVendorList

Returnerar en lista med alla aktiverade leverantörers ID:n för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En lista som innehåller alla aktiverade leverantörers ID:n.

Exempelvis

@objc func getEnabledVendorsAction() {
    if let enabledVendors = cmpManager?.getEnabledVendors() {
        print("Enabled vendors: \(enabledVendors.joined(separator: ", "))")
    } else {
        print("Failed to retrieve enabled vendors.")
    }
}

getGoogleACString

Hämtar Googles extra samtyckes-ID (`addtlConsent`)-strängen som ställts in av consent manager.

För ytterligare information, kolla Teknisk specifikation för Google Ytterligare samtycke.  

Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En lista som innehåller alla aktiverade leverantörers ID:n.

Exempelvis

@objc func getGoogleConsentStringAction() {
    if let googleACString = cmpManager?.getGoogleACString() {
        print("Google Additional Consent String: \(googleACString)")
    } else {
        print("Failed to retrieve Google Additional Consent String.")
    }
}

getUSPrivacyString

Hämtar US Privacy String. Denna amerikanska integritetssträng är en cookie som lagrar information om avslöjande som gjorts och val som webbplatsbesökaren valt angående deras konsumenträttigheter. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En sträng med USA:s sekretessdata satt av consentmanager.

Exempelvis

@objc func getUSPrivacyStringAction() {
    if let theUSPrivacyString = cmpManager?.getUSPrivacyString() {
        print("US Privacy string contents: \(theUSPrivacyString)")
    } else {
        print("Failed to retrieve US Privacy string.")
    }
}

har samtycke

Kontrollerar om användaren redan gett sitt samtycke. Samtyckeslagret kan ha möjlighet att bara stänga lagret. I så fall lämnade användaren inget samtycke. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

En sträng med USA:s sekretessdata satt av consentmanager.

Exempelvis

@objc func getHasConsentAction() {
    if let hasConsent = cmpManager?.hasConsent() {
        let consentStatus = hasConsent ? "Yes" : "No"
        print("Consent provided by the user? \(consentStatus)")
    } else {
        print("Failed to retrieve user consent.")
    }
}

hasPurpose (från version 2.5.3 och framåt)

hasPurposeConsent (utfasad)

Kontrollerar om ändamåls-ID är aktiverat baserat på användarens samtycke. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

SANT om användaren har gett sitt samtycke till det angivna syftet.

FALSK annars.

Observera att om, av någon anledning relaterad till dålig eller ingen internetanslutning på enheten eller i fall av frånvaro av ett samtycke, värdet som ställts in via defaultReturn parameter kommer att returneras.

Smakämnen defaultReturn parameter existerar inte i versioner äldre än 2.5.3.

Exempelvis

@objc func getHasPurposeConsentAction() {
    if let hasPurposeConsent = cmpManager?.hasPurpose("purposeID", false) {
        let consentStatus = hasPurposeConsent ? "Yes" : "No"
        print("Purpose has consent provided by the user? \(consentStatus)")
    } else {
        print("Failed to retrieve user purpose consent.")
    }
}

hasVendor (från version 2.5.3 och framåt)

hasVendorConsent (utfasad)

Kontrollerar om leverantörs-ID är aktiverat baserat på användarens samtycke. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

TRUE om användaren har gett sitt samtycke till den angivna leverantören.

FALSK annars.

Observera att om, av någon anledning relaterad till dålig eller ingen internetanslutning på enheten eller i fall av frånvaro av ett samtycke, värdet som ställts in via defaultReturn parameter kommer att returneras.

Smakämnen defaultReturn parameter existerar inte i versioner äldre än 2.5.3.

Exempelvis

@objc func getHasVendorConsentAction() {
    if let hasVendorConsent = cmpManager?.hasVendor("vendorID") {
        let consentStatus = hasVendorConsent ? "Yes" : "No"
        print("Vendor has consent provided by the user? \(consentStatus)")
    } else {
        print("Failed to retrieve user vendor consent.")
    }
}

importCmpString

Importerar en CMP-sträng som representerar användarens samtyckespreferenser. Strängen måste informeras AS-IS när den hämtas via exportCmpString()-metoden. Denna metod förbrukar en sidvisning.

parametrar

Retur

Inga.

Exempelvis

let cmpString = "YourConsentStringHere"

// Define the completion handler
let completionHandler: CmpImportCompletionHandler = { error in
    if let error = error {
        print("Failed to import CMP string: \(error.localizedDescription)")
    } else {
        print("CMP string imported successfully")
    }
}

cmpManager.importCmpString(cmpString, completion: completionHandler)

initialisera

Initialiseringsfunktionen initierar samtyckesskiktet och kontrollerar automatiskt om användaren behöver ett samtycke eller inte. Denna funktion kommer så småningom att öppna samtyckeslagret och kommer att interagera med Apple Tracking Transparency API för att be användaren om samtycke. Denna metod förbrukar en sidvisning.

parametrar

Retur

CMPManagerobjektet.

Exempelvis

// Example of a default implementation of the SDK.

class ViewController: UIViewController {

  // Usual implementation of a View Controller
  
  var cmpManager: CMPConsentTool? = nil

  override func viewDidLoad() {

      super.viewDidLoad()

      // Configure your CMP
      let cmpConfig: CmpConfig = CmpConfig.shared.setup(
                                          withId: "<YOUR-CONSENTMANAGER-APP-ID>, example: a000aaaa0a", 
                                          domain: "<YOUR-CONSENTMANAGER-APP-DOMAIN>, example: delivery.consentmanager.net", 
                                          appName: "<YOUR-CONSENTMANAGER-APP-NAME>, example: testApp", 
                                          language: "<YOUR-CONSENTMANAGER-APP-LANGUAGE, example: DE");

      // You can also determine log levels or ask for Apple's App Tracking Transparency, for example
      cmpConfig.logLevel = CmpLogLevel.verbose;
      cmpConfig.isAutomaticATTRequest = true;

      // Then you pass the cmpConfig to set up and initialize the instance of our SDK		
      cmpManager = CMPConsentTool(cmpConfig: cmpConfig)
              .withErrorListener(onCMPError)
              .withCloseListener(onClose)
              .withOpenListener(onOpen)
              .withOnCMPNotOpenedListener(onCMPNotOpened)
              .withOnCmpButtonClickedCallback(onButtonClickedEvent)
              .initialize()  // This method will trigger the webview loading to collect consent, if necessary
  }
}

är SamtyckeKrävs

Kontrollerar om samtycke måste lämnas av den aktuella appanvändaren. Denna metod förbrukar inga sidvisningar.

parametrar

Retur

SANT om användaren behöver ge ett samtycke.

FALSK annars.

Exempelvis

@objc func checkIfConsentIsRequired() {
    if let isConsentRequired = cmpConsentTool?.isConsentRequired() {
        let consentRequiredStatus = isConsentRequired ? "Yes" : "No"
        print("Is user consent required? \(consentRequiredStatus)")
    } else {
        print("Failed to determine if user consent is required.")
    }
}

openView

Öppnar CMP-samtyckesskiktets webbvy med kraft. Denna metod förbrukar en sidvisning.

parametrar

Retur

Inget returvärde.

Exempelvis

self.cmpConsentTool?.openView()

avvisaAlla

Avvisar samtyckeslagret och beter sig på samma sätt när användaren inte accepterade samtycket. Denna metod förbrukar en sidvisning.

parametrar

Retur

Inget returvärde

Exempelvis

func onFinish() {
    print("Notification: New consent has been received with a Reject All response.")
}

// Reject all consent with a callback
cmpManager.rejectAll(onFinish)

återställa

Återställer alla egenskaper till standardvärden. Denna metod förbrukar inga sidvisningar.

parametrar

Retur

Inget returvärde.

Exempelvis

CMPManager.reset()

med CloseListener

Lägger till en nära lyssnare för att få aviseringar när samtyckeslagret stängs.

parametrar

Retur

CMPConsentTool

Exempelvis

func onClose() {
    print("APP: CLOSED")
    // Add custom business logic here
}

// Initialize cmpManager with configuration and close listener
cmpManager = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
    .withCloseListener(onClose)

med OpenListener

Lägger till en öppen lyssnare för att få aviseringar när samtyckeslagret öppnas.

parametrar

Retur

CMPConsentTool

Exempelvis

func onOpen() {
    print("APP: OPENED")
    // Add custom business logic here
}

// Initialize cmpManager with configuration and open listener
cmpManager = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
    .withCloseListener(onOpen)

med ErrorListener

Lägger till en fellyssnare för att få aviseringar när ett fel inträffade.

parametrar

Retur

CMPConsentTool

Exempelvis

func onCMPError(type: CmpErrorType, message: String?) {
    if let errorMessage = message {
        print(errorMessage)
    } else {
        print("An error occurred.")
    }

    switch type {
    case .networkError:
        print("Network error")
    case .timeoutError:
        print("Timeout error")
    case .consentDataReadWriteError:
        print("Consent data read/write error")
    case .unknownError:
        print("Unknown error")
    @unknown default:
        print("Unexpected error")
    }
}

// Initialize cmpManager with configuration and error listener
cmpManager = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
    .withErrorListener(onCMPError)

med OnCMPNotOpenedListener

Lägger till en Cmp ej öppnad återuppringning för att få meddelande när samtyckeslagret inte öppnas. Den vanligaste orsaken är att användaren redan lämnat ett samtycke.

parametrar

Retur

CMPConsentTool

Exempelvis

func onCMPNotOpened() {
    print("CMP: NOT OPENED")
    // Add custom business logic here
}

// Initialize cmpConsentTool with configuration and CMP not opened listener
cmpManager = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
    .withOnCMPNotOpenedListener(onCMPNotOpened)

withOnCmpButtonClickedCallback

Ställer in en återuppringning för att ta emot aviseringar när användaren klickar på en knapp för att stänga samtyckeslagret.

parametrar

Retur

CMPConsentTool

Exempelvis

func onButtonClickedEvent(event: CmpButtonEvent) {
    switch event {
    case .acceptAll:
        print("User accepted all.")
    case .rejectAll:
        print("User rejected all.")
    case .save:
        print("User saved custom settings.")
    case .close:
        print("User closed consent layer without giving consent.")
    @unknown default:
        print("Unknown button event.")
    }
}

// Initialize cmpManager with configuration and button click callback
cmpManager = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
    .withOnCmpButtonClickedCallback(onButtonClickedEvent)

med CmpViewControllerConfigurationBlock

Anpassa samtyckeslagret UIViewController.

parametrar

Retur

CMPConsentTool

Exempelvis

cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
    .withCmpViewControllerConfigurationBlock { viewController in
        viewController?.modalPresentationStyle = .formSheet
    }

med CmpViewConfigurationBlock

Anpassa samtyckesskiktets UiView.

parametrar

Retur

CMPConsentTool

Exempelvis

let cmpLayout = CmpLayout.default()
cmpLayout?.cornerRadius = 10.0
cmpLayout?.customLayout = CGRect(x: 0, y: 0, width: 200, height: 300)

cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
    .withCmpViewConfigurationBlock { uiView in
        cmpLayout?.apply(to: uiView)
    }

medUpdateGoogleConsent

Hämtar status för Googles samtyckesläge. 

parametrar

Retur

CMPConsentTool

Exempelvis

cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
    .withUpdateGoogleConsent(onCmpUpdateGoogleConsent)

func onCmpUpdateGoogleConsent(consentMap: [String: String]?) {
    guard let consentMap = consentMap else { return }

    var firebaseConsentMap: [ConsentType: ConsentStatus] = [:]

    consentMap.forEach { key, value in
        if let consentType = convertToFirebaseConsentType(from: key),
           let consentStatus = convertToFirebaseConsentStatus(from: value) {
            firebaseConsentMap[consentType] = consentStatus
        }
    }

    Analytics.setConsent(firebaseConsentMap)
}

func convertToFirebaseConsentType(from key: String) -> ConsentType? {
    switch key {
    case "analytics_storage":
        return .analyticsStorage
    case "ad_storage":
        return .adStorage
    case "ad_user_data":
        return .adUserData
    case "ad_personalization":
        return .adPersonalization
    default:
        return nil
    }
}

func convertToFirebaseConsentStatus(from value: String) -> ConsentStatus? {
    switch value {
    case "granted":
        return .granted
    case "denied":
        return .denied
    default:
        return nil
    }
}