[Flattern] 1. consentmanager SDK-Integration
Montage von
Führe diesen Befehl aus:
Mit Flutter:
flutter pub add cmp_sdkDadurch wird eine Zeile wie diese zur pubspec.yaml Ihres Pakets hinzugefügt (und eine implizite ausgeführt flutter pub get):
dependencies:
cmp_sdk: ^0.1.0Alternativ könnte Ihr Herausgeber Sie unterstützen flutter pub get. Weitere Informationen finden Sie in den Dokumenten Ihres Redakteurs.
Import
Jetzt können Sie in Ihrem Dart-Code Folgendes verwenden:
import 'package:cmp_sdk/cmp_sdk.dart';Verwenden der Bibliothek
Um eine Instanz von zu erstellen CmpSdk mit einer Grundkonfiguration:
import 'package:cmp_sdk/cmp_sdk.dart';
import 'package:cmp_sdk/cmp_config.dart';
void main() {
runApp(MyApp());
// Initialize CMP SDK with basic configuration
final cmpSdk = CmpSdk.createInstance(
id: "Code-ID from consentmanager, e.g. bf816dab123...",
domain: "Server-Domain from consentmanager, e.g. delivery.consentmanager.net",
appName: "App name, e.g. MyFlutterApp",
language: "Language, e.g. FR",
);
}Einwilligungsebene öffnen
Ereignisrückrufe
Das SDK ermöglicht das Einrichten von Rückrufen für verschiedene Ereignisse der Zustimmungsebene wie Öffnen, Schließen, Fehler und Schaltflächenklicks. Dies ist für Protokollierungszwecke oder die Ausführung zusätzlicher Logik basierend auf Benutzerinteraktionen nützlich.
_cmpSdkPlugin.setCallbacks(
onOpen: () => logCallback('Consent layer opened'),
onClose: () => logCallback('Consent layer closed'),
onError: (type, message) => logCallback('Error: $type - $message'),
onButtonClicked: (buttonType) => logCallback('Button clicked: $buttonType'),
);
Einwilligung verwalten
Das SDK bietet Methoden zum globalen Akzeptieren oder Ablehnen von Einwilligungen, zum Zurücksetzen von Einwilligungsdaten und zum Öffnen der Einwilligungsebene für die Benutzerinteraktion.
-
Akzeptieren:
await _cmpSdkPlugin.acceptAll(); -
Ablehnen:
await _cmpSdkPlugin.rejectAll(); -
Shau:
await _cmpSdkPlugin.check(); -
Einwilligung zurücksetzen:
await _cmpSdkPlugin.reset(); -
Öffnen Sie die Einwilligungsebene:
await _cmpSdkPlugin.open();
CMP-String exportieren und importieren
Die CMP-Zeichenfolge, die die Einwilligungspräferenzen des Benutzers darstellt. Sie können es in das CMP SDK importieren, um diese Einstellungen anzuwenden. Dies kann nützlich sein, um Einwilligungspräferenzen zwischen verschiedenen Teilen Ihrer Anwendung zu übertragen oder diese extern zu speichern.
Future<void> importUserConsent(String cmpString) async {
try {
final bool success = await CmpSdkPlatform.instance.importCmpString(cmpString);
if (success) {
// CMP string was successfully imported
print("CMP String successfully imported.");
// The user's consent preferences are now updated according to the imported string
} else {
// Handle the case where the import was unsuccessful
print("Failed to import CMP String.");
}
} catch (error) {
// Handle any errors that occur during import
print("Error importing CMP String: $error");
}
}
Future<void> exportUserConsent() async {
try {
final String? cmpString = await CmpSdkPlatform.instance.exportCmpString();
if (cmpString != null) {
// CMP string successfully retrieved
print("CMP String: $cmpString");
// You can now store this string or share it as needed
} else {
// Handle the case where CMP string is null
print("No CMP String available.");
}
} catch (error) {
// Handle any errors that occur during export
print("Error exporting CMP String: $error");
}
}Einwilligungsstatus und Informationen
Mithilfe der SDK-Methoden können Sie verschiedene einwilligungsbezogene Informationen abrufen, z. B. prüfen, ob eine Einwilligung erforderlich ist, den aktuellen Einwilligungsstatus abrufen und Einwilligungen für bestimmte Anbieter oder Zwecke einholen.
-
Überprüfen Sie die Einwilligungsvoraussetzung:
await _cmpSdkPlugin.check(); -
Einwilligungsstatus abrufen: Implementieren Sie eine Methode zum Abrufen und Kompilieren des Einwilligungsstatus aus verschiedenen SDK-Methoden wie
exportCmpString,hasConsent,getAllVendors, usw.
Erstellen eines benutzerdefinierten Layouts
Die Benutzeroberfläche der Einwilligungsschicht kann mithilfe des Objekts „CmpUiConfig“ angepasst werden. Sie können die Bildschirmkonfiguration (z. B. Vollbild, Halbbild) entsprechend den Anforderungen Ihrer Anwendung festlegen.
await _cmpSdkPlugin.configureConsentLayer(CmpUiConfig(screenConfig: ScreenConfig.fullScreen));Verfügbare Layouts
- ganzer Bildschirm
- halfScreenBottom
- halfScreenTop
- centerScreen
- smallCenterScreen
- großer TopScreen
- großerBottomScreen
Notizen
API-Dokumentation: Dokumentation
Bibliothek: pub.dev
