Dans ce document, vous trouverez des informations générales sur la manière d'intégrer notre SDK à votre projet. Pour plus de détails, veuillez vous reporter à notre documentation de référence API. Tous les extraits de code ci-dessous ont été extraits de notre application de démonstration.
1. Installation
consentmanager SDK est une solution complète pour la gestion du consentement des utilisateurs dans les applications mobiles. Conçu pour gérer la conformité au RGPD, les préférences de confidentialité des utilisateurs et la transparence du suivi publicitaire, ce SDK offre une intégration transparente pour les plateformes iOS et Android. De plus, il propose des plugins/ponts d'encapsulation pour React Native, Flutter et Unity, ce qui le rend polyvalent dans divers environnements de développement.
Étapes – Description générale
-
Intégration et configuration :
- Intégrez le SDK dans votre application.
- Configurez les paramètres du SDK en fonction de vos besoins.
-
Création d'une instance et affichage de la couche de consentement :
- Au démarrage de l'application, créez une instance de la
CMPManagerclasse. Cette instance gérera le processus de consentement. - Le SDK affichera automatiquement l'écran de consentement si nécessaire.
- Au démarrage de l'application, créez une instance de la
-
Traitement des données de consentement des utilisateurs :
- Une fois les consentements recueillis, les informations sont stockées et peuvent être consultées via différentes propriétés et méthodes exposées par notre SDK. Vous disposerez d'informations sur les consentements refusés ou acceptés, les fournisseurs et les finalités.
1.1 Intégration et configuration
Option 1 : CocoaPods
Ajoutez la ligne suivante à votre Podfile :
pod 'cm-sdk-ios-v3', '3.2.0'
Ensuite, lancez :
pod install --repo-update
Option 2 : Swift Package Manager
- Téléchargez la dernière version de XCFramework depuis notre page de publications GitHub.
- Dans XCode, allez dans le menu
File>Add Package Dependency. - Ajoutez l'URL du référentiel SDK ci-dessus
- SPM va maintenant récupérer le référentiel et vous demander de sélectionner une version.
Vous pouvez choisir d'ajouter le paquet en sélectionnant une règle de version
:Up to Next Major: Cela mettra à jour le paquet jusqu'à la prochaine version majeure. C'est l'option recommandée car elle ajoute des mises à jour qui n'entraînent pas de changements majeurs
.Up to Next Minor: Cela mettra à jour le paquet jusqu'à la prochaine version
mineure.Exact: Cela verrouillera le paquet sur une version spécifique. Aucune mise à jour ne sera installée. - Importez le SDK en insérant la ligne ci-dessous en haut des classes qui implémentent les méthodes du SDK :
import cm_sdk_ios_v3
- Dans les paramètres de votre cible, allez dans « Général » > « Frameworks, bibliothèques et contenu intégré » et assurez-vous que le framework est réglé sur « Intégrer et signer ».
1.2 Création d'une instance et affichage de la couche de consentement
Au démarrage de l'application (votre viewDidLoad ), vous devez créer une instance de la classe CMPManager. Vous devrez configurer deux objets qui seront transmis à la méthode getInstance : UrlConfig, qui gère votre configuration CMP, comme l'identifiant de code et la langue par défaut, et ConsentLayerUIConfig. qui configurera l'apparence de la WKWebView qui affichera la couche de consentement. Ensuite, vous passerez l'instance actuelle ViewController à l'aide de la méthode setPresentingViewControlleret attribuer le délégué, comme indiqué ci-dessous. Dans l'exemple ci-dessous, vous pouvez voir les deux objets qui sont transmis. La checkWithServerAndOpenIfNecessary() fonction récupérera automatiquement les données nécessaires depuis notre serveur et déterminera si l'écran de consentement doit s'afficher ou non. Si tel est le cas, le SDK affichera automatiquement l'écran de consentement à ce stade, via un WKWebView créée par notre SDK, qui affichera la couche de consentement avec le texte et les boutons correspondant à vos configurations CMP (choisies via le Code-ID de votre CMP), collectera les données et enregistrera les informations de consentement dans la zone NSUserDefaults de l'appareil, afin que l'application puisse afficher les publicités ciblées en conséquence.
Veuillez noter qu'il est essentiel de déclarer et d'initialiser le CMPManager SDK dans la viewDidLoad méthode, sinon la vue risque de ne pas être prête à l'emploi et le SDK peut échouer. Veuillez également vous assurer que vous utilisez les données de configuration correctes. Les données de configuration se trouvent dans votre compte ConsentManager sous Menu > CMP > Obtenir le code pour les applications > ID du code
Veuillez également noter que les fonctionnalités permettant de déterminer si le consentement est nécessaire ou non, ainsi que l'affichage de la couche de consentement, dépendent d'une connexion réseau fiable. S'il n'y a pas de connexion disponible ou si le mécanisme de réessai ne parvient pas à atteindre notre serveur, l'événement didReceiveError renverra une erreur de délai d'attente, et le SDK sera donc totalement incapable de déterminer la nécessité d'un consentement, car il sera totalement incapable d'afficher la couche de consentement. Veuillez vous assurer que votre logique en tient compte.
Exemple :
import cm_sdk_ios_v3
class YourViewController: UIViewController, CMPManagerDelegate {
override func viewDidLoad() {
super.viewDidLoad()
let cmpManager = CMPManager.shared
cmpManager.setUrlConfig(UrlConfig(
id: "your_id_here", // example: a000aaaaa1a
domain: "your_domain_here", // usually, delivery.consentmanager.net
language: "your_language_here", // example: DE
appName: "Your App Name")) // example: testApp
cmpManager.setWebViewConfig(ConsentLayerUIConfig(
position: .fullScreen,
backgroundStyle: .dimmed(.black, 0.5),
cornerRadius: 5,
respectsSafeArea: true,
allowsOrientationChanges: true))
cmpManager.setPresentingViewController(self)
cmpManager.delegate = self
cmpManager.checkAndOpen { error in
if let error = error {
print("Error initializing consent: (error)")
} else {
print("ConsentManager initialized and consent received and stored on the device's NSUserDefaults.")
}
}
}
1.3 Traitement des données relatives au consentement des utilisateurs
Vérification des consentements des utilisateurs
Notre SDK offre une méthode unifiée pour vérifier et récupérer les informations de consentement, getUserStatus():
let status = CMPManager.shared.getUserStatus()
var message = "Status: (status.status)nn"
message += "Vendors:n"
for (vendorId, state) in status.vendors {
message += "- (vendorId): (state)n"
}
message += "nPurposes:n"
for (purposeId, state) in status.purposes {
message += "- (purposeId): (state)n"
}
message += "nTCF: (status.tcf)n"
message += "Additional Consent: (status.addtlConsent)n"
message += "Regulation: (status.regulation)"
print(message)
Pour plus d'informations sur les autres méthodes, veuillez consulter notre documentation API complète.
Réouverture de la fenêtre de consentement pour vérifier les choix des utilisateurs
Afin de permettre à l'utilisateur de vérifier ou de modifier ses choix, vous pouvez simplement appeler openConsentLayer()
cmpManager.forceOpen()
Cette méthode affichera la couche de consentement via la même instance WKWebView créée lors des étapes précédentes.
Importation/exportation des informations de consentement vers d'autres sources
Dans certains cas, une application native peut contenir des webviews afin d'afficher des informations, telles que des publicités ou du contenu. Afin de transmettre les informations de consentement du SDK vers la webview, vous pouvez récupérer la chaîne de consentement en utilisant :
consentData = cmpManager.exportCMPInfo()
Cela permettra d'exporter les informations de consentement et toutes les autres données requises par le CMP. Vous pouvez ensuite transmettre ces informations au CMP présent dans votre webview en les ajoutant à l'URL appelée dans la webview.
Si, par ailleurs, vous devez importer la chaîne de consentement à l'aide du SDK, vous pouvez utiliser l'exemple ci-dessous :
let consentStringToImport = "Q1FERkg3QVFERkg3QUFmR01CSVRCQkVnQUFBQUFBQUFBQWlnQUFBQUFBQUEjXzUxXzUyXzUzXzU0XzU1XzU2XyNfczI3ODlfczI3OTBfczI3OTFfczI2OTdfczk3MV9VXyMxLS0tIw"
cmpManager.importCMPInfo(consentStringToImport)
Intégration avec Apple Tracking Transparency (ATT)
Si vous utilisez des outils de suivi ou d'analyse dans votre application, nous vous recommandons de lire le guide sur la mise en œuvre de l'ATT ici.
Créer une mise en page personnalisée
Pour créer une vue personnalisée de WKWebView, par exemple en modifiant son positionnement ou son arrière-plan, vous pouvez modifier la configuration transmise à l'objet ConsentLayerUIConfig comme indiqué ci-dessous :
ConsentLayerUIConfig(
position: .halfScreenTop,
backgroundStyle: .dimmed(.grey, 0.75),
cornerRadius: 20,
respectsSafeArea: false,
allowsOrientationChanges: true)
Connexion
Lorsque vous utilisez notre SDK iOS, vous pouvez avoir besoin de déboguer ou d'analyser les informations de journal à diverses fins. Les journaux générés par notre SDK sont classés sous « CMP », ce qui vous permet de filtrer et d'afficher facilement uniquement les journaux pertinents. Pour plus d'informations, veuillez vous reporter à cette section de notre documentation.