[RéagirNative] 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. Pour notre application de démonstration présentant les cas d'utilisation et une implémentation qui pourrait servir de point de départ, veuillez consulter notre dépôt.
1. Installation
Votre consentmanager Le SDK pour les applications iOS implémente et fournit des fonctionnalités pour informer l'utilisateur sur la protection des données et demander et recueillir le consentement de l'utilisateur. Il permet aux développeurs d'applications d'intégrer facilement le consentmanager service dans leur application.
É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éation d'une instance:
- Au démarrage de l'application, créez une instance du
CMPConsentToolclasse. Cette instance gérera le processus de consentement.
- Au démarrage de l'application, créez une instance du
-
Initialisation du SDK:
- Une fois l'instance prête, le SDK récupère automatiquement les informations nécessaires du consentmanager serveurs pour préparer son fonctionnement.
-
Affichage de l'écran de consentement:
- Le SDK affichera automatiquement l'écran de consentement si nécessaire lorsque le
CMPConsentTooll'instance est créée.
- Le SDK affichera automatiquement l'écran de consentement si nécessaire lorsque le
-
Traitement des données personnelles:
- Une fois les consentements collectés, les informations sont stockées et sont disponibles pour interrogation via différentes propriétés et méthodes exposées par notre SDK. Vous aurez des informations sur les consentements rejetés ou acceptés, les fournisseurs, les objectifs, etc.
En suivant ces étapes, vous vous assurez que votre application est conforme aux exigences de consentement et que le consentement de l'utilisateur est correctement géré et stocké.
Consent Manager Diagramme de séquence du SDK du fournisseur
Pour illustrer les étapes ci-dessus, vérifions dans le diagramme ci-dessous trois flux de séquence SDK possibles.
1. Lors de la création d'une instance à l'aide de initialiser fonction, il y a deux résultats possibles. La première est lorsque l'API Consentmanger informe le SDK que la CMP ne s'ouvrira pas, ce qui déclenche le OnCmpNotOpenedCallbackOnCmpNotOpenedCallback. Le deuxième résultat est lorsque la couche de consentement s'ouvre, permettant à l'utilisateur d'interagir avec elle, et cela déclenche le SurOpenCallback. Une fois que l'utilisateur a donné son consentement et que celui-ci a été traité, le OnCmpCloseCallbackOnCmpCloseCallback est appelé.
S'il vous plaît noter que le SurErreurRappel est représenté par les flèches rouges en pointillés pour fournir des exemples d'erreurs pouvant survenir au cours du processus.
2. Créer une instance et appeler le ouvrirAndCheckConsent les fonctions conduiront à un processus similaire. La différence est qu'en dissociant la création de l'instance et la vérification de l'API consentementmanger, vous obtenez la possibilité d'ajouter une logique métier et d'interagir avec l'API des bibliothèques.
3. Créer une instance et appeler le couche ouverte fonction ouvrira le calque sans vérifier le consentmanager, si c'est nécessaire. Si le consentement a déjà été donné, les options et les paramètres seront affichés à l'utilisateur. Le flux de processus ressemblera à ceci :
Pour plus d'informations sur la présentation de la version du SDK et le journal des modifications, veuillez vous référer à ce lien.
Installation via NPM
npm install cmp-sdkLiaison (React Native 0.59 et versions antérieures)
Si vous utilisez React Native 0.59 ou une version antérieure, vous devez lier les modules natifs manuellement :
react-native link cmp-sdkImporter le Consentmanager du cmp-sdk package dans votre code :
import { Consentmanager } from 'cmp-sdk';2. Initialisation du SDK
Vous pouvez initialiser le SDK CMP à l'aide de la configuration directe ou d'un objet de configuration :
Initialisation directe :
Consentmanager.createInstance('Code-ID from consentmanager, e.g. bfa712361a....',
'Server-Domain from consentmanager, e.g. delivery.consentmanager.net',
'App Name, e.g. MyReactApp',
'Language, e.g. FR');Initialisation à l'aide de l'objet Config :
Consentmanager.createInstanceByConfig(yourConfigObject);3. Utilisation du SDK
Pour gérer la couche de consentement :
Ouvrir la couche de consentement :
Consentmanager.openConsentlayer();Gestion des événements
Ajoutez des écouteurs d'événements pour gérer divers événements liés au consentement :
const removeListeners = Consentmanager.addEventListeners({
onOpen: () => console.log('Consent layer opened'),
onClose: () => console.log('Consent layer closed'),
// Add other event handlers as needed
});
N'oubliez pas de supprimer les écouteurs d'événements lorsqu'ils ne sont plus nécessaires :
removeListeners();Requêtes de consentement
Vous pouvez vérifier les consentements du fournisseur et de l'objectif :
Vérifiez le consentement du fournisseur :
Consentmanager.hasVendor('vendorID').then((hasConsent) => {
console.log('Has vendor consent: ', hasConsent);
});Vérifier le consentement à l'objectif :
Consentmanager.hasPurpose('purposeID').then((hasConsent) => {
console.log('Has purpose consent: ', hasConsent);
});Réinitialisation du consentement
Consentmanager.reset();Exportation de la chaîne de consentement
Consentmanager.exportCmpString().then((cmpString) => {
console.log('CMP String: ', cmpString);
});Méthodes supplémentaires
Le SDK CMP fournit diverses méthodes pour récupérer ou gérer les données de consentement, telles que :
getAllVendors()getAllPurposes()getEnabledVendors()getEnabledPurposes()getDisabledVendors()getDisabledPurposes()getUSPrivacyString()getGoogleACString()
Reportez-vous à la documentation du SDK pour obtenir des informations détaillées sur ces méthodes.
