[Flottement] 1. consentmanager Intégration SDK
Pose
Exécutez cette commande:
Avec Flutter :
flutter pub add cmp_sdkCela ajoutera une ligne comme celle-ci au pubspec.yaml de votre package (et exécutera un implicite flutter pub get):
dependencies:
cmp_sdk: ^0.1.0Alternativement, votre éditeur peut prendre en charge flutter pub get. Consultez la documentation de votre éditeur pour en savoir plus.
Importer
Maintenant, dans votre code Dart, vous pouvez utiliser :
import 'package:cmp_sdk/cmp_sdk.dart';Utilisation de la bibliothèque
Pour créer une instance de CmpSdk avec une configuration de base :
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",
);
}Ouvrir la couche de consentement
Rappels d'événements
Le SDK permet de configurer des rappels pour divers événements de couche de consentement tels que l'ouverture, la fermeture, les erreurs et les clics sur les boutons. Ceci est utile à des fins de journalisation ou pour exécuter une logique supplémentaire basée sur les interactions de l'utilisateur.
_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'),
);
Gestion du consentement
Le SDK fournit des méthodes pour accepter ou rejeter le consentement globalement, réinitialiser les données de consentement et ouvrir la couche de consentement pour l'interaction de l'utilisateur.
-
Tout Accepter:
await _cmpSdkPlugin.acceptAll(); -
Tout rejeter:
await _cmpSdkPlugin.rejectAll(); -
En cliquant:
await _cmpSdkPlugin.check(); -
Réinitialiser le consentement:
await _cmpSdkPlugin.reset(); -
Ouvrir la couche de consentement:
await _cmpSdkPlugin.open();
Exportation et importation de chaîne CMP
Chaîne CMP représentant les préférences de consentement de l'utilisateur. Vous pouvez l'importer dans le SDK CMP pour appliquer ces préférences. Cela peut être utile pour transférer les préférences de consentement entre différentes parties de votre application ou pour les stocker en externe.
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");
}
}Statut et informations du consentement
Vous pouvez récupérer diverses informations relatives au consentement à l'aide des méthodes du SDK, telles que vérifier si le consentement est requis, récupérer l'état actuel du consentement et obtenir le consentement pour des fournisseurs ou des objectifs spécifiques.
-
Vérifier l'exigence de consentement:
await _cmpSdkPlugin.check(); -
Obtenir le statut de consentement : Implémentez une méthode pour récupérer et compiler le statut de consentement à partir de diverses méthodes du SDK telles que
exportCmpString,hasConsent,getAllVendors, etc.
Création d'une mise en page personnalisée
L'interface utilisateur de la couche de consentement peut être personnalisée à l'aide de l'objet « CmpUiConfig ». Vous pouvez spécifier la configuration de l'écran (par exemple, plein écran, demi-écran) en fonction des besoins de votre application.
await _cmpSdkPlugin.configureConsentLayer(CmpUiConfig(screenConfig: ScreenConfig.fullScreen));Dispositions disponibles
- plein écran
- demi-écran en bas
- demi-écranHaut
- écran central
- petitÉcranCentre
- grandécran supérieur
- grand écran inférieur
Florales
Documentation de l'API: Documentation
Bibliothèque: pub.dev
