[ReactNative] 1. consentmanager SDK-Integration
In diesem Dokument finden Sie allgemeine Informationen zur Integration unseres SDK in Ihr Projekt. Weitere Einzelheiten entnehmen Sie bitte unserer API-Referenz Dokumentation. Unsere Demo-App, die die Anwendungsfälle und eine Implementierung zeigt, die als Ausgangspunkt dienen könnte, finden Sie unter unser Repo.
1. Installation
Die consentmanager SDK für iOS-Apps implementiert und bietet Funktionen, um den Benutzer über den Datenschutz zu informieren und die Zustimmung des Benutzers einzuholen und einzuholen. Es ermöglicht App-Entwicklern, das einfach zu integrieren consentmanager Service in ihre App.
Schritte – Beschreibung auf hoher Ebene
-
Integration und Konfiguration:
- Integrieren Sie das SDK in Ihre App.
- Konfigurieren Sie die SDK-Einstellungen entsprechend Ihren Anforderungen.
-
Erstellen einer Instanz:
- Erstellen Sie beim Start der App eine Instanz von
CMPConsentToolKlasse. Diese Instanz übernimmt den Einwilligungsprozess.
- Erstellen Sie beim Start der App eine Instanz von
-
SDK-Initialisierung:
- Sobald die Instanz bereit ist, ruft das SDK automatisch die erforderlichen Informationen von der Instanz ab consentmanager Server, um sich auf den Betrieb vorzubereiten.
-
Anzeigen des Einwilligungsbildschirms:
- Das SDK zeigt bei Bedarf automatisch den Einwilligungsbildschirm an
CMPConsentToolInstanz wird erstellt.
- Das SDK zeigt bei Bedarf automatisch den Einwilligungsbildschirm an
-
Verarbeitung personenbezogener Daten:
- Sobald die Einwilligungen eingeholt wurden, werden die Informationen gespeichert und stehen für Abfragen über verschiedene Eigenschaften und Methoden zur Verfügung, die von unserem SDK bereitgestellt werden. Sie erhalten Informationen über abgelehnte oder akzeptierte Einwilligungen, Anbieter, Zwecke usw.
Indem Sie diese Schritte befolgen, stellen Sie sicher, dass Ihre App den Einwilligungsanforderungen entspricht und dass die Nutzereinwilligung ordnungsgemäß verwaltet und gespeichert wird.
Consent Manager Anbieter-SDK-Sequenzdiagramm
Um die oben genannten Schritte zu veranschaulichen, sehen wir uns im Diagramm unten drei mögliche SDK-Sequenzabläufe an.
1. Beim Erstellen einer Instanz mit dem initialisieren Funktion gibt es zwei mögliche Ergebnisse. Der erste Fall besteht darin, dass die Consentmanger-API das SDK darüber informiert, dass das CMP nicht geöffnet wird, was das auslöst OnCmpNotOpenedCallback. Das zweite Ergebnis ist, wenn die Zustimmungsebene geöffnet wird, sodass der Benutzer damit interagieren kann, und dies löst die aus OnOpenCallback. Sobald der Benutzer seine Zustimmung erteilt und die Zustimmung verarbeitet wird, wird die OnCmpCloseCallback wird genannt.
Bitte beachten Sie, dass die OnErrorCallback wird durch die rot gestrichelten Pfeillinien dargestellt, um Beispiele dafür zu liefern, wann während des Prozesses Fehler auftreten können.
2. Erstellen einer Instanz und Aufrufen der openAndCheckConsent Funktionen führen zu einem ähnlichen Prozess. Der Unterschied besteht darin, dass Sie durch die Entkopplung der Erstellung der Instanz und der Prüfung für die Consentmanger-API die Möglichkeit erhalten, Geschäftslogik hinzuzufügen und mit der Bibliotheks-API zu interagieren.
3. Erstellen einer Instanz und Aufrufen der offeneSchicht Die Funktion öffnet die Ebene, ohne die zu überprüfen consentmanager, wenn es nötig ist. Bei bereits erteilter Einwilligung werden dem Nutzer die Optionen und Einstellungen aufgezeigt. Der Prozessablauf wird wie folgt aussehen:
Weitere Informationen zu unserer SDK-Versionsübersicht und dem Änderungsprotokoll finden Sie unter diesen Link.
Installation über NPM
npm install cmp-sdkVerlinkung (React Native 0.59 und niedriger)
Wenn Sie React Native 0.59 oder niedriger verwenden, müssen Sie die nativen Module manuell verknüpfen:
react-native link cmp-sdkImportieren Sie die Consentmanager von dem cmp-sdk Paket in Ihrem Code:
import { Consentmanager } from 'cmp-sdk';2. Initialisieren des SDK
Sie können das CMP SDK entweder über die direkte Konfiguration oder ein Konfigurationsobjekt initialisieren:
Direkte Initialisierung:
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');Initialisierung mit Config Object:
Consentmanager.createInstanceByConfig(yourConfigObject);3. Verwendung des SDK
So verwalten Sie die Einwilligungsebene:
Offene Einwilligungsebene:
Consentmanager.openConsentlayer();Handhabung des Events
Fügen Sie Ereignis-Listener hinzu, um verschiedene zustimmungsbezogene Ereignisse zu verarbeiten:
const removeListeners = Consentmanager.addEventListeners({
onOpen: () => console.log('Consent layer opened'),
onClose: () => console.log('Consent layer closed'),
// Add other event handlers as needed
});
Denken Sie daran, die Ereignis-Listener zu entfernen, wenn sie nicht mehr benötigt werden:
removeListeners();Einwilligungsanfragen
Sie können die Einwilligungen des Anbieters und des Verwendungszwecks überprüfen:
Überprüfen Sie die Zustimmung des Anbieters:
Consentmanager.hasVendor('vendorID').then((hasConsent) => {
console.log('Has vendor consent: ', hasConsent);
});Überprüfen Sie die Zweckeinwilligung:
Consentmanager.hasPurpose('purposeID').then((hasConsent) => {
console.log('Has purpose consent: ', hasConsent);
});Einwilligung zurücksetzen
Consentmanager.reset();Einwilligungszeichenfolge exportieren
Consentmanager.exportCmpString().then((cmpString) => {
console.log('CMP String: ', cmpString);
});Zusätzliche Methoden
Das CMP SDK bietet verschiedene Methoden zum Abrufen oder Verwalten von Einwilligungsdaten, wie zum Beispiel:
getAllVendors()getAllPurposes()getEnabledVendors()getEnabledPurposes()getDisabledVendors()getDisabledPurposes()getUSPrivacyString()getGoogleACString()
Ausführliche Informationen zu diesen Methoden finden Sie in der SDK-Dokumentation.
