[iOS] 3. Documentation API
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
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.initialize()
withCloseListener
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 |
| openListener | 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)
withErrorListener
Ajoute un écouteur d'erreur pour recevoir des notifications lorsqu'une erreur s'est produite
Paramètres
| Nom | Type | Description |
| errorListener | 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 |
| openListener | 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 |
| openListener | 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)
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
Visite
Paramètres
| Nom | Type | Description |
| onCmpLayerOpen | fonction | Rappel lorsque la couche de consentement doit être ouverte. |
| isCached | 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({() -> Void in
print("Notification, that consent layer needs to be open")
}, isCached: false)
openCustomLayer
ouvre la couche de consentement personnalisée
Paramètres
| Nom | Type | Description |
| contexte | Comportementale | Contexte de l'application |
| appInterface | CmpLayerAppEventListenerInterfaceCmpLayerAppEventListenerInterface |
Retour
Aucune valeur de retour
Exemple
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
ouvre la couche de consentement
Retour
Aucune valeur de retour
Exemple
openConsentLayer()
createCustomLayerFragment
Créer un fragment de calque personnalisé
Retour
CmpLayerFragmentCmpLayerFragment
Exemple
createCustomLayerFragment()
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
true si l'utilisateur a donné son consentement.
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
getEnabledPurposes()
getEnabledPurposeList
Obtenir une liste d'objectifs convenus
Retour
Exemple
getEnabledPurposeList()
getDisabledPurposes
Obtenir des objectifs désactivés
Retour
Exemple
getDisabledPurposes()
getAllVendors
Obtenir tous les fournisseurs
Retour
Exemple
getAllVendors()
getAllVendorsList
Obtenir la liste de tous les fournisseurs
Retour
Exemple
getAllVendorsList()
getEnabledVendorsgetEnabledVendors
Obtenir des fournisseurs agréés
Retour
Exemple
getEnabledVendors()
getEnabledVendorListgetEnabledVendorList
Obtenir une liste de fournisseurs convenue
Retour
Exemple
getEnabledVendorList()
getDisabledVendors
Obtenir des fournisseurs désactivés
Retour
Exemple
getDisabledVendors()
enableVendorList
Active une liste de fournisseurs et met à jour le consentement donné
Paramètres
| Nom | Type | Description |
| vendeurs | 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 |
| vendeurs | 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)
enablePurposeList
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
TRUE si l'utilisateur a donné son consentement au fournisseur spécifié, FALSE sinon.
Exemple
cmpConsentTool.hasVendorConsent("vendorID", FALSE)
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
Exemple
cmpConsentTool.hasPurposeConsent("purposeID", FALSE)
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
Chaîne de consentement enregistrée
Exemple
getConsentstring()
exportCmpString
Exporte la chaîne CmpData
Retour
La chaîne CmpData encodée en base64
Exemple
CMPConsentTool.exportCmpString()
appeléCeJour
Vérifie si la couche de consentement a été appelée aujourd'hui
Retour
VRAI si le CMPConsent Manager Le serveur a été demandé aujourd'hui, sinon FALSE
Exemple
cmpConsentTool.calledThisDay()
BesoinsAcceptation
Vérifie si l'utilisateur a besoin d'acceptation
Retour
TRUE si l'utilisateur doit donner son consentement.
Exemple
cmpConsentTool.needsAcceptance()
réinitialiser
Réinitialise toutes les données définies par le ``CMPConsentTool``
Retour
Aucune valeur de retour
Exemple
CMPConsentTool.reset()
