Informacia
Treść
Książki
CMP
Integracja z Twoją aplikacją
[iOS] 3. Dokumentacja API...

[iOS] 3. Dokumentacja API

zainicjować

Funkcja inicjalizacji zainicjuje warstwę zgody i automatycznie sprawdzi, czy użytkownik potrzebuje zgody, czy nie. Ta funkcja ostatecznie otworzy warstwę zgody i wejdzie w interakcję z interfejsem Apple Tracking Transparency API, aby poprosić użytkownika o zgodę

Powrót

Narzędzie CMPConsent

Przykład
let cmpConfig : CmpConfig = CmpConfig.shared.setup(withId: config.appId, domain: config.domain, appName: config.appName, language: config.language);
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig).initialize()

 

z CloseListener

Dodaje bliskiego słuchacza, który będzie otrzymywać powiadomienia, gdy warstwa zgody zostanie zamknięta.

parametry
Imię Rodzaj Nieruchomości Opis
zamknij Słuchacz funkcjonować Wywołanie zwrotne, które zostanie wywołane po zamknięciu warstwy zgody.
Powrót

Narzędzie CMPConsent

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

z OpenListenerem

Dodaje otwartego odbiornika, który będzie otrzymywać powiadomienia o otwarciu warstwy zgody.

parametry
Imię Rodzaj Nieruchomości Opis
Otwórz słuchacza funkcjonować Wywołanie zwrotne, które zostanie wywołane po otwarciu warstwy zgody
Powrót

Narzędzie CMPConsent

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

 

 

za pomocąErrorListener

Dodaje odbiornik błędów, aby otrzymywać powiadomienia o wystąpieniu błędu

parametry
Imię Rodzaj Nieruchomości Opis
słuchacz błędów funkcjonować Wywołanie zwrotne w celu dodania akcji w przypadku wystąpienia błędu.
Powrót

Narzędzie CMPConsent

Przykład
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)

 

z OnCMMPNotOpenedListener

Dodaje wywołanie zwrotne Cmp, które nie zostało otwarte, aby otrzymywać powiadomienia, gdy warstwa zgody się nie otwiera

parametry
Imię Rodzaj Nieruchomości Opis
Otwórz słuchacza funkcjonować Wywołanie zwrotne, które zostanie wywołane, gdy warstwa zgody nie zostanie otwarta. Najczęstszym powodem jest to, że użytkownik wyraził już zgodę
Powrót

Narzędzie CMPConsent

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

 

z OnCmpButtonClickedCallback

Ustawia wywołanie zwrotne w celu otrzymywania powiadomień, gdy użytkownik kliknie przycisk w celu zamknięcia warstwy zgody.

parametry
Imię Rodzaj Nieruchomości Opis
Otwórz słuchacza funkcjonować Wywołanie zwrotne, które zostanie wywołane z ``CmpButtonEvent`` wskazującym, który przycisk został naciśnięty
Powrót

Narzędzie CMPConsent

Przykład
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)

 

z blokiem konfiguracji CmpViewControllerConfiguration

Dostosuj moduł zgody UIViewController

parametry
Imię Rodzaj Nieruchomości Opis

konfiguracjaBlok

Blok konfiguracyjny CmpViewController

 Dostosuj warstwę zgody

Kontroler UIView
Powrót

Narzędzie CMPConsent

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

 

z blokiem CmpViewConfigurationBlock

Dostosuj UiView modułu zgody

parametry
Imię Rodzaj Nieruchomości Opis

konfiguracjaBlok

CmpUIViewConfigurationBlock

 Dostosuj warstwę zgody

UiView
Powrót

Narzędzie CMPConsent

Przykład
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)
            })

 

za pomocą aktualizacji GoogleConsent

Pobierz stan trybu zgody Google 

parametry
Imię Rodzaj Nieruchomości Opis

Mapa zgody

[sznur: sznur]?

 Stan zgody
Powrót

Narzędzie CMPConsent

Przykład
       cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
            .withUpdateGoogleConsent(onCmpUpdateGoogleConsent)
    }

    func onCmpUpdateGoogleConsent(consentMap: [String: String]?) -> Void {
        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
        }
    }

 

checkAndOpenConsentLayer

Sprawdź i otwórz warstwę zgody

Powrót

Brak wartości zwracanej

Przykład
cmpConsentTool.checkAndOpenConsentLayer()

 

openCmpConsentToolView

Otwiera widok warstwy zgody CMP

Powrót

Brak wartości zwracanej

Przykład
cmpConsentTool.openView()

 

ZOBACZ

Kontrola

parametry
Imię Rodzaj Nieruchomości Opis
naCmpLayerOpen funkcjonować Oddzwanianie, gdy warstwa zgody musi być otwarta.
jest w pamięci podręcznej Boolean BOOL, gdy PRAWDA, żądanie zostanie zapisane w pamięci podręcznej, a odpowiedź zostanie zapisana
Powrót

Brak wartości zwracanej

Przykład
cmpConsentTool?.check(
  	{
		print("Layer wants to open")
    	// self.cmpConsentTool?.openView()
    }, 
    isCached: true, 
    onCmpLayerNotOpen: {
     	print("Layer does not want to open")
    }
)

ma zgodę

Sprawdza, czy użytkownik wyraził zgodę. Warstwa zgody może mieć opcję zamknięcia warstwy przez. W takim przypadku użytkownik nie wyraził zgody.

Powrót
Przykład
cmpConsentTool.hasConsent()

 

pobierzWszystkie cele

Pobiera oddzielony przecinkami łańcuch znaków wyłączonych identyfikatorów „przeznaczenia”.

Powrót

Ciąg wszystkich identyfikatorów „przeznaczenia”.

Przykład
cmpConsentTool.getAllPurposes()

 

pobierz listę wszystkich celów

Pobiera listę wszystkich identyfikatorów „celu” dla danego Cmp.

Powrót

„Lista” zawierająca wszystkie identyfikatory „przeznaczenia”.

Przykład
cmpConsentTool.getAllPurposeList()

 

getEnabledCele

Pobiera oddzielony przecinkami ciąg znaków włączonych identyfikatorów „przeznaczenia”.

Powrót

`Ciąg` włączonych identyfikatorów `celu`

Przykład
cmpConsentTool.getEnabledPurposes()

 

getEnabledPurposeList

Uzyskaj uzgodnioną listę celów

Powrót

 

Przykład
cmpConsentTool?.getEnabledPurposeList()

 

getDisabledCele

Zdobądź cele dla osób niepełnosprawnych

Powrót

 

Przykład
cmpConsentTool?.getDisabledPurposes()

 

getAllVendors

Zdobądź wszystkich dostawców

Powrót

 

Przykład
cmpConsentTool?.getAllVendors()

 

pobierz listę wszystkich dostawców

Pobierz listę wszystkich dostawców

Powrót

 

Przykład
cmpConsentTool?.getAllVendorsList()

 

getEnabledVendors

Uzyskaj włączonych dostawców

Powrót

 

Przykład
cmpConsentTool?.getEnabledVendors()

 

getEnabledVendorList

Uzyskaj włączoną listę dostawców

Powrót

 

Przykład
cmpConsentTool?.getEnabledVendorList()

 

getDisabledVendors

Zdobądź wyłączonych dostawców

Powrót

 

Przykład
cmpConsentTool?.getDisabledVendors()

 

włącz listę dostawców

Włącza listę dostawców i aktualizuje udzieloną zgodę

parametry
Imię Rodzaj Nieruchomości Opis
sprzedawców Szyk Lista identyfikatorów dostawców do włączenia.
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

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

 

wyłącz listę dostawców

Wyłącza listę dostawców i aktualizuje udzieloną zgodę

parametry
Imię Rodzaj Nieruchomości Opis
sprzedawców Szyk Lista identyfikatorów dostawców do wyłączenia.
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

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

 

włącz listę celów

Włącza listę celów i aktualizuje udzieloną zgodę

parametry
Imię Rodzaj Nieruchomości Opis
cele Szyk Lista identyfikatorów celów do włączenia.
naZakończ funkcja (opcjonalnie) Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład
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)

 

wyłącz listę celów

Wyłącza listę celów i aktualizuje udzieloną zgodę

parametry
Imię Rodzaj Nieruchomości Opis
cele Szyk Lista identyfikatorów celów do wyłączenia.
naZakończ funkcja (opcjonalnie) Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład
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)

 

odrzuć wszystko

Odrzuca warstwę zgody i zachowuje się tak samo, gdy użytkownik „nie zaakceptował” zgody

parametry
Imię Rodzaj Nieruchomości Opis
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

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

 

Akceptuj wszystkie

Akceptuje warstwę zgody i zachowuje się tak samo, gdy użytkownik „zaakceptuje” zgodę

parametry
Imię Rodzaj Nieruchomości Opis
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

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

 

pobierz USPrivacyString

Uzyskaj amerykański ciąg znaków prywatności

Powrót

`String` Ciąg znaków prywatności USA, który został ustawiony przez consentmanager

Przykład
cmpConsentTool.getUSPrivacyString()

 

mazgodędostawcy

Posiada zgodę sprzedawcy

parametry
Imię Rodzaj Nieruchomości Opis
identyfikator sprzedawcy sznur identyfikator sprzedawcy
dostawcaJestV1lubV2 BOOL jeśli identyfikator dostawcy to dostawca IAB. (przestarzałe: flaga nie jest już potrzebna)
Powrót
Przykład
cmpConsentTool.hasVendorConsent("vendorID")

 

maCelowązgodę

Sprawdza, czy identyfikator celu jest włączony na podstawie zgody użytkownika.

parametry
Imię Rodzaj Nieruchomości Opis
identyfikator celu sznur identyfikator celu
dostawcaJestV1lubV2 BOOL jeśli identyfikator dostawcy to dostawca IAB. (przestarzałe: flaga nie jest już potrzebna)
Powrót

 

Przykład
cmpConsentTool.hasPurposeConsent("purposeID")

 

pobierz GoogleACString

Pobiera ciąg identyfikatora dodania Google (`addtlConsent`), który został ustawiony przez consent manager.

Powrót

Ciąg Google AC

Przykład
cmpConsentTool.getGoogleACString()

 

pobierz ciąg zgody

Pobierz ostatni ciąg zgody

Powrót
Przykład
getConsentstring()

 

eksportCmpString

Eksportuje ciąg CmpData

Powrót

Ciąg znaków CmpData zakodowany w formacie base64

Przykład
CMPConsentTool.exportCmpString()

 

zgoda wymagana dzisiaj

Sprawdza, czy dzisiaj zażądano warstwy zgody

Powrót

PRAWDA, jeśli plik CMPConsent Manager Żądanie serwera zostało wysłane dzisiaj, w przeciwnym razie FAŁSZ

Przykład
cmpConsentTool.consentRequestedToday()

 

jest wymagana zgoda

Sprawdza, czy użytkownik potrzebuje akceptacji

Powrót

PRAWDA, jeśli użytkownik musi wyrazić zgodę.

Przykład
cmpConsentTool.isConsentRequired()

 

zresetuj

Resetuje wszystkie dane ustawione przez ``CMPConsentTool``

Powrót

Brak wartości zwracanej

Przykład
CMPConsentTool.reset()

 

Szczegóły
Wersja #8
Stworzony 11 miesięcy temu by Skandera Bena
Zaktualizowano 2 miesięcy temu by Skandera Bena
Nie masz jeszcze konta?

Zapewnij zgodność z RODO dzięki naszemu plikowi cookie RODO Consent Manager rozwiązanie. Wypróbuj teraz za darmo!

Plik cookie RODO Consent Manager
Powrót do góry