Info
Contenu

[iOS] 3. Documentation API

initialiser


La fonction d'initialisation initialisera la couche de consentement et vérifiera automatiquement si l'utilisateur a besoin d'un consentement ou non. Cette fonction ouvrira éventuellement la couche de consentement et interagira avec l'API Apple Tracking Transparency pour demander à l'utilisateur son consentement

Retour

CMPConsentTool

Exemple
let cmpConfig : CmpConfig = CmpConfig.shared.setup(withId: config.appId, domain: config.domain, appName: config.appName, language: config.language);
// Creating the Instance and chaining the initialize function. This can be done also separately 
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig).initialize()

 

avecCloseListener


Ajoute un écouteur proche pour recevoir des notifications lorsque la couche de consentement est fermée.

Paramètres
Nom Type Description
closeÉcouteur fonction Callback qui sera appelé lorsque la couche de consentement sera fermée.
Retour

CMPConsentTool

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

avecOpenListener


Ajoute un écouteur ouvert pour recevoir des notifications lorsque la couche de consentement est ouverte.

Paramètres
Nom Type Description
ouvertListener fonction Callback qui sera appelé lors de l'ouverture de la couche de consentement
Retour

CMPConsentTool

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

 

 

avecErrorListener


Ajoute un écouteur d'erreur pour recevoir des notifications lorsqu'une erreur s'est produite

Paramètres
Nom Type Description
erreurListener fonction Rappel pour ajouter une action si une erreur s'est produite.
Retour

CMPConsentTool

Exemple
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


Ajoute un rappel Cmp non ouvert pour recevoir une notification lorsque la couche de consentement ne s'ouvre pas

Paramètres
Nom Type Description
ouvertListener fonction Callback qui sera appelé lorsque la couche de consentement n'est "pas ouverte". La raison la plus courante est que l'utilisateur a déjà donné son consentement
Retour

CMPConsentTool

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

 

withOnCmpButtonClickedCallback


Définit un rappel pour recevoir des notifications lorsque l'utilisateur clique sur un bouton pour fermer la couche de consentement.

Paramètres
Nom Type Description
ouvertListener fonction Callback qui sera invoqué avec le ``CmpButtonEvent`` indiquant quel bouton a été pressé
Retour

CMPConsentTool

Exemple
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)

 

avecCmpViewControllerConfigurationBlock


Personnaliser le couche de consentement UIViewController

Paramètres
Nom Type Description

configurationBlock

CmpViewControllerConfigurationBlock

Personnaliser le couche de consentement

UIViewController

Retour

CMPConsentTool

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

 

avecCmpViewConfigurationBlock


Personnaliser l'UiView du consentlayer

Paramètres
Nom Type Description

configurationBlock

CmpUIViewConfigurationBlock

Personnaliser le couche de consentement

UiView

Retour

CMPConsentTool

Exemple
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)
            })

 

avecMise à jourConsentement Google


Récupérer le statut du mode consentement de Google 

Paramètres
Nom Type Description

consentementCarte

[Chaîne: Chaîne]?

Statut de consentement
Retour

CMPConsentTool

Exemple
       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


Vérifier et ouvrir la couche de consentement

Retour

Aucune valeur de retour

Exemple
cmpConsentTool.checkAndOpenConsentLayer()

 

openCmpConsentToolView


Ouvre la vue de la couche de consentement CMP

Retour

Aucune valeur de retour

Exemple
cmpConsentTool.openView()

 

vérifier


En cliquant

Paramètres
Nom Type Description
onCmpLayerOpen fonction Rappel lorsque la couche de consentement doit être ouverte.
est en cache Boolean Indicateur BOOL lorsqu'il est VRAI, la demande sera mise en cache et la réponse sera enregistrée
Retour

Aucune valeur de retour

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

a le consentement


Vérifie si l'utilisateur a donné son consentement. La couche de consentement peut avoir la possibilité de simplement fermer la couche. Dans ce cas, l'utilisateur n'a pas donné son consentement.

Retour
Exemple
cmpConsentTool.hasConsent()

 

getAllPurposes


Obtient une chaîne séparée par des virgules des ID de "but" désactivés

Retour

Chaîne de tous les identifiants "purpose"

Exemple
cmpConsentTool.getAllPurposes()

 

getAllPurposeList


Récupère une liste de tous les identifiants de "but" pour le Cmp donné.

Retour

Une `List` contenant tous les identifiants `purpose`.

Exemple
cmpConsentTool.getAllPurposeList()

 

getEnabledPurposes


Obtient une chaîne séparée par des virgules des ID de "but" activés

Retour

`Chaîne` d'identifiants `purpose` activés

Exemple
cmpConsentTool.getEnabledPurposes()

 

getEnabledPurposeList


Obtenir une liste d'objectifs convenus

Retour

 

Exemple
cmpConsentTool?.getEnabledPurposeList()

 

getDisabledPurposes


Obtenir des objectifs désactivés

Retour

 

Exemple
cmpConsentTool?.getDisabledPurposes()

 

getAllVendors


Obtenir tous les fournisseurs

Retour

 

Exemple
cmpConsentTool?.getAllVendors()

 

getAllVendorsList


Obtenir la liste de tous les fournisseurs

Retour

 

Exemple
cmpConsentTool?.getAllVendorsList()

 

getEnabledVendorsgetEnabledVendors


Obtenez des fournisseurs activés

Retour

 

Exemple
cmpConsentTool?.getEnabledVendors()

 

getEnabledVendorListgetEnabledVendorList


Obtenir la liste des fournisseurs activés

Retour

 

Exemple
cmpConsentTool?.getEnabledVendorList()

 

getDisabledVendors


Obtenir des fournisseurs désactivés

Retour

 

Exemple
cmpConsentTool?.getDisabledVendors()

 

activerVendorList


Active une liste de fournisseurs et met à jour le consentement donné

Paramètres
Nom Type Description
fournisseurs tableau Liste des ID de fournisseur à activer.
à la fin fonction Rappel pour la gestion de l'événement de consentement reçu. il sera appelé lorsque le consentement sera reçu et traité.
Retour

Aucune valeur de retour

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

 

désactiverVendorList


Désactive une liste de fournisseurs et met à jour le consentement donné

Paramètres
Nom Type Description
fournisseurs tableau Liste des identifiants de fournisseurs à désactiver.
à la fin fonction Rappel pour la gestion de l'événement de consentement reçu. il sera appelé lorsque le consentement sera reçu et traité.
Retour

Aucune valeur de retour

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

 

activerListeObjectifs


Active une liste d'objectifs et met à jour le consentement donné

Paramètres
Nom Type Description
des fins tableau Liste des identifiants d'objectif à activer.
à la fin fonction (facultatif) Rappel pour la gestion de l'événement de consentement reçu. il sera appelé lorsque le consentement sera reçu et traité.
Retour

Aucune valeur de retour

Exemple
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)

 

désactiverPurposeList


Désactive une liste de finalités et met à jour le consentement donné

Paramètres
Nom Type Description
des fins tableau Liste des identifiants d'objectif à désactiver.
à la fin fonction (facultatif) Rappel pour la gestion de l'événement de consentement reçu. il sera appelé lorsque le consentement sera reçu et traité.
Retour

Aucune valeur de retour

Exemple
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)

 

rejeter tout


Rejette la couche de consentement et se comporte de la même manière lorsque l'utilisateur "n'a pas accepté" le consentement

Paramètres
Nom Type Description
à la fin fonction Rappel pour la gestion de l'événement de consentement reçu. il sera appelé lorsque le consentement sera reçu et traité.
Retour

Aucune valeur de retour

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

 

accepter tout


Accepte la couche de consentement et se comporte de la même manière lorsque l'utilisateur "accepte" le consentement

Paramètres
Nom Type Description
à la fin fonction Rappel pour la gestion de l'événement de consentement reçu. il sera appelé lorsque le consentement sera reçu et traité.
Retour

Aucune valeur de retour

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

 

getUSPrivacyString


Obtenir la chaîne de confidentialité américaine

Retour

`String` La chaîne de confidentialité américaine, qui a été définie par consentmanager

Exemple
cmpConsentTool.getUSPrivacyString()

 

hasVendorConsent


A le consentement du vendeur

Paramètres
Nom Type Description
fournisseur ID Chaîne fournisseur ID
fournisseurEstV1ouV2 BOOL si l'ID du fournisseur est un fournisseur IAB. (obsolète : le drapeau n'est plus nécessaire)
Retour
  • l'utilisateur a donné son consentement au fournisseur spécifié ou
  • pour une raison quelconque liée à une connexion Internet faible ou inexistante sur l'appareil, le consentement du vendeur n'a pas pu être récupéré. Veuillez vous référer à withErrorListener pour gérer ces conditions lors du lancement de l'application, en particulier pour les nouveaux utilisateurs qui n'ont pas encore donné leur consentement.

FAUX sinon.

Exemple
cmpConsentTool.hasVendorConsent("vendorID")

 

aPurposeConsent


Vérifie si l'ID d'objectif est activé en fonction du consentement de l'utilisateur.

Paramètres
Nom Type Description
ID de but Chaîne ID d'objectif
fournisseurEstV1ouV2 BOOL si l'ID du fournisseur est un fournisseur IAB. (obsolète : le drapeau n'est plus nécessaire)
Retour

VRAI si

  • l'utilisateur a donné son consentement à la finalité spécifiée ou
  • pour une raison quelconque liée à une connexion Internet faible ou inexistante sur l'appareil, le consentement à cette fin n'a pas pu être récupéré. Veuillez vous référer à withErrorListener pour gérer ces conditions lors du lancement de l'application, en particulier pour les nouveaux utilisateurs qui n'ont pas encore donné leur consentement.

FAUX sinon.

Exemple
cmpConsentTool.hasPurposeConsent("purposeID")

 

getGoogleACString


Récupère la chaîne d'ID d'ajout Google (`addtlConsent`) qui a été définie par le consent manager.

Retour

Chaîne Google AC

Exemple
cmpConsentTool.getGoogleACString()

 

getConsentstring


Obtenir la dernière chaîne de consentement

Retour
Exemple
getConsentstring()

 

exportCmpString


Exporte la chaîne CmpData

Retour

La chaîne CmpData encodée en base64

Exemple
CMPConsentTool.exportCmpString()

 

consentementDemandéAujourd'hui


Vérifie si la couche de consentement a été demandée aujourd'hui

Retour

VRAI si le CMPConsent Manager Le serveur a été demandé aujourd'hui, sinon FALSE

Exemple
cmpConsentTool.consentRequestedToday()

 

isConsentRequired


Vérifie si l'utilisateur a besoin d'acceptation

Retour

TRUE si l'utilisateur doit donner son consentement.

Exemple
cmpConsentTool.isConsentRequired()

 

réinitialiser


Réinitialise toutes les données définies par le ``CMPConsentTool``

Retour

Aucune valeur de retour

Exemple
CMPConsentTool.reset()

 

Retour en haut de la page