[Unité] 1. consentmanager Intégration SDK
Sur ce document, vous trouverez des informations générales sur la façon d'intégrer notre SDK à votre projet. Pour plus de détails, veuillez vous référer à notre Référence de l'API Documentation.
1. Installation
consentmanager Le SDK est une solution complète de 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 des publicités, ce SDK offre une intégration transparente pour les plateformes iOS et Android. De plus, il propose des plugins/ponts wrapper pour React Native, Flutter et Unity, ce qui le rend polyvalent dans divers environnements de développement.
Étapes – Description de haut niveau
-
Intégration et configuration:
- Intégrez le SDK dans votre application.
- Configurez les paramètres du SDK en fonction de vos besoins.
-
Créer une instance et afficher la couche de consentement:
- Au démarrage de l'application, créez une instance du
CMPManager
classe. 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 du
-
Traitement des données de consentement de l'utilisateur:
- Une fois les consentements recueillis, les informations sont stockées et peuvent être interrogées via différentes propriétés et méthodes exposées par notre SDK. Vous disposerez d'informations sur les consentements rejetés ou acceptés, les fournisseurs et les finalités.
En termes de compatibilité, nous avons :
- Unity 20XX.XX ou version ultérieure
- iOS (via DllImport)
- Android (via JNI)
1. Importation du package SDK
En seulement deux étapes, vous pouvez tout configurer.
-
- Téléchargez la dernière version du plugin.
- Importez le package dans votre projet Unity en utilisant Actifs > Importer un package > Package personnalisé.
Configurer JSON
Dans CmpSdkConfig.json, vous pouvez définir la version native du SDK pour iOS et Android qui sera utilisée pour le processus de construction :
Trouver les versions natives du SDK compatibles ici:
{
"displayName": "Consentmanager SDK",
"name": "CmpSdk",
"androidBasePath": "net.consentmanager.sdk",
"version": "3.0.0",
"androidLibraryVersion": "x.xx.x",
"iosLibraryVersion": "x.xx.x",
"description": "Unity plugin helps you to use native Consentmanager functionality on Android and iOS."
}
Paramètres de construction
Pour modifier les paramètres de construction, accédez à Window
-> CmpSdk
Paramètres de construction iOS
- Activer le script de build iOS : Activez cette option pour activer ou désactiver le script de build responsable de l'intégration du SDK iOS dans le projet Unity.
- Chemin xcFramework : Spécifiez le chemin d'accès au répertoire xcFramework. Ce chemin peut être modifié directement ou parcouru à l'aide du bouton associé.
- Inclure la balise de version : Lorsqu'il est activé, ajoute la version du SDK iOS au chemin xcFramework, permettant des configurations spécifiques à la version.
- Chemin du framework résultant : Affiche le chemin entièrement résolu vers xcFramework, y compris la version du SDK si la balise de version est incluse.
- Activer la transparence du suivi des applications : Activez cette option pour activer la fonctionnalité de transparence du suivi des applications pour iOS, qui est nécessaire au consentement de l'utilisateur conformément aux directives de confidentialité d'iOS.
- Message de consentement pour la transparence du suivi des applications : Un champ de texte pour saisir le message personnalisé affiché aux utilisateurs lors de la demande de consentement pour le suivi. Ce message doit être clair et concis, expliquant pourquoi le consentement est nécessaire.
Paramètres de construction Android
- Activer le script de build Android : Basculez pour activer ou désactiver le script de build pour intégrer le SDK Android dans le projet Unity.
-
Intégrer une mise en page personnalisée : Lorsqu'elle est activée, cela permet l'utilisation d'une mise en page personnalisée pour la couche de consentement pour le fragment UIView.
Si vous souhaitez utiliser une mise en page personnalisée avec des fragments, assurez-vous que votre projet Unity ajoute le
appcompat
dépendance. Ajouter un modèle principal personnalisé :
Actifs/Plugins/Android/mainTemplate.gradle
et ajoutez la dépendance :
implémentation 'androidx.appcompat:appcompat:1.xx'
2. Utilisation du SDK
Consultez l'exemple ci-dessous pour voir une illustration de l'utilisation de notre SDK. Pour plus d'informations, veuillez vous référer au document complet Référence de l'API.
Veuillez noter que les fonctionnalités liées à la détermination de la nécessité ou non du consentement, 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 nouvelle tentative ne parvient pas à atteindre notre serveur, l'événement didReceiveError renverra une erreur de dépassement de délai, 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 de script
private static void CheckConsentWithServer(){
CmpManager.Instance.CheckWithServerAndOpenIfNecessary();}
}
private static void SetCmpUrlConfig() {
const string id = "id";
const string domain = "domain";
const string language = "en";
const string appName = "AppName";
CmpManager.Instance.SetUrlConfig(id, domain, language, appName);
}
private void OpenConsentLayer() {
CmpManager.Instance.OpenConsentLayer();
}
private void JumpToSettings() {
CmpManager.Instance.JumpToSettings();
}
private void HasVendorConsent(string vendorId) {
var hasConsent = CmpManager.Instance.HasVendorConsent(vendorId);
Debug.Log($"Has vendor consent: {hasConsent}");
}
private void HasPurposeConsent(string purposeId) {
var hasConsent = CmpManager.Instance.HasPurposeConsent(purposeId);
Debug.Log($"Has purpose consent: {hasConsent}");
}
Journal
Lorsque vous utilisez notre SDK iOS, vous pouvez avoir besoin de déboguer ou d'analyser les informations des journaux à diverses fins. Les journaux générés par notre SDK sont étiquetés sous « CMP », ce qui vous permet de filtrer et d'afficher facilement uniquement les journaux pertinents. Pour plus d'informations, veuillez consulter cette section de notre documentation.