[Einheit] 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.
1. Installation
consentmanager SDK ist eine umfassende Lösung für die Verwaltung der Benutzereinwilligung in mobilen Anwendungen. Dieses SDK wurde für die Einhaltung der DSGVO, die Berücksichtigung von Benutzerdatenschutzeinstellungen und die Transparenz der Anzeigenverfolgung entwickelt und bietet eine nahtlose Integration für iOS- und Android-Plattformen. Darüber hinaus bietet es Wrapper-Plugins/Bridges für React Native, Flutter und Unity, wodurch es in verschiedenen Entwicklungsumgebungen vielseitig einsetzbar ist.
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 und Anzeigen des Consent Layers:
- Erstellen Sie beim Start der App eine Instanz von
CMPManager
Klasse. Diese Instanz übernimmt den Einwilligungsprozess. - Das SDK zeigt bei Bedarf automatisch den Zustimmungsbildschirm an.
- Erstellen Sie beim Start der App eine Instanz von
-
Verarbeitung der Einwilligungsdaten des Benutzers:
- Sobald die Einwilligungen eingeholt wurden, werden die Informationen gespeichert und stehen für Abfragen über verschiedene Eigenschaften und Methoden zur Verfügung, die unser SDK bereitstellt. Sie erhalten Informationen über abgelehnte oder akzeptierte Einwilligungen, Anbieter und Zwecke.
In Bezug auf die Kompatibilität haben wir:
- Unity 20XX.XX oder höher
- iOS (über DllImport)
- Android (über JNI)
1. Importieren des SDK-Pakets
In nur zwei Schritten können Sie alles einrichten.
-
- Laden Sie die neueste Version herunter des Plugins.
- Importieren Sie das Paket in Ihr Unity-Projekt über Assets > Paket importieren > Benutzerdefiniertes Paket.
JSON konfigurieren
In CmpSdkConfig.json können Sie die native SDK-Version für iOS und Android festlegen, die für den Build-Prozess verwendet wird:
Finden Sie die kompatiblen nativen SDK-Versionen Hier :
{
"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."
}
Build-Einstellungen
Um die Build-Einstellungen zu ändern, gehen Sie zu Window
-> CmpSdk
iOS-Build-Einstellungen
- Aktivieren Sie das iOS-Build-Skript: Schalten Sie dies um, um das Build-Skript zu aktivieren oder zu deaktivieren, das für die Integration des iOS SDK in das Unity-Projekt verantwortlich ist.
- xcFramework-Pfad: Geben Sie den Pfad zum xcFramework-Verzeichnis an. Dieser Pfad kann direkt bearbeitet oder über die zugehörige Schaltfläche aufgerufen werden.
- Versions-Tag einschließen: Wenn diese Option aktiviert ist, hängt die iOS SDK-Version an den xcFramework-Pfad an und ermöglicht so versionenspezifische Konfigurationen.
- Resultierender Framework-Pfad: Zeigt den vollständig aufgelösten Pfad zum xcFramework an, einschließlich der SDK-Version, wenn das Versions-Tag enthalten ist.
- Aktivieren Sie die App-Tracking-Transparenz: Schalten Sie diese Option um, um die App-Tracking-Transparenzfunktion für iOS zu aktivieren, die für die Zustimmung des Benutzers gemäß den iOS-Datenschutzrichtlinien erforderlich ist.
- Einwilligungserklärung zur App-Tracking-Transparenz: Ein Textfeld zur Eingabe der benutzerdefinierten Nachricht, die Benutzern angezeigt wird, wenn sie ihre Zustimmung zur Nachverfolgung einholen. Diese Nachricht sollte klar und prägnant sein und erklären, warum die Einwilligung erforderlich ist.
Android-Build-Einstellungen
- Aktivieren Sie das Android-Build-Skript: Schalten Sie um, um das Build-Skript für die Integration des Android SDK in das Unity-Projekt zu aktivieren oder zu deaktivieren.
-
Benutzerdefiniertes Layout integrieren: Wenn diese Option aktiviert ist, ermöglicht dies die Verwendung eines benutzerdefinierten Layouts für die Zustimmungsebene für das Fragment UIView.
Wenn Sie ein benutzerdefiniertes Layout mit Fragmenten verwenden möchten, stellen Sie sicher, dass Ihr Unity-Projekt das
appcompat
Abhängigkeit. Fügen Sie eine benutzerdefinierte Hauptvorlage hinzu:
Assets/Plugins/Android/mainTemplate.gradle
und füge die Abhängigkeit hinzu:
Implementierung 'androidx.appcompat:appcompat:1.xx'
2. Verwendung des SDK
Sehen Sie sich das folgende Beispiel an, um eine Illustration der Verwendung unseres SDK zu sehen. Weitere Informationen finden Sie in der vollständigen API-Referenz.
Bitte beachten Sie, dass die Funktionen zur Bestimmung, ob eine Zustimmung erforderlich ist oder nicht, sowie die Anzeige der Zustimmungsebene von einer zuverlässigen Netzwerkverbindung abhängen. Wenn keine Verbindung verfügbar ist oder der Wiederholungsmechanismus unseren Server nicht erreichen kann, gibt das Ereignis didReceiveError einen Timeout-Fehler zurück. Das SDK kann daher überhaupt nicht feststellen, ob eine Zustimmung erforderlich ist, da es die Zustimmungsebene überhaupt nicht anzeigen kann. Bitte stellen Sie sicher, dass Ihre Logik dies berücksichtigt.
Beispielskript
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}");
}
Protokollierung
Wenn Sie unser iOS SDK verwenden, müssen Sie möglicherweise Protokollinformationen für verschiedene Zwecke debuggen oder analysieren. Die von unserem SDK generierten Protokolle sind unter „CMP“ gekennzeichnet, sodass Sie einfach nur die relevanten Protokolle filtern und anzeigen können. Weitere Informationen finden Sie unter In diesem Abschnitt unserer Dokumentation.