[fladderen] 1. consentmanager SDK-integratie
Installatie van het
Voer deze opdracht uit:
Met flutter:
flutter pub add cmp_sdkDit zal een regel als deze toevoegen aan de pubspec.yaml van uw pakket (en een impliciete flutter pub get):
dependencies:
cmp_sdk: ^0.1.0Als alternatief kan uw redacteur dit mogelijk ondersteunen flutter pub get. Bekijk de documenten van uw redacteur voor meer informatie.
import
In uw Dart-code kunt u nu het volgende gebruiken:
import 'package:cmp_sdk/cmp_sdk.dart';Met behulp van de bibliotheek
Om een exemplaar van te maken CmpSdk met een basisconfiguratie:
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",
);
}Open toestemmingslaag
Terugbelverzoeken voor evenementen
Met de SDK kunt u callbacks instellen voor verschillende gebeurtenissen op de toestemmingslaag, zoals openen, sluiten, fouten en klikken op knoppen. Dit is handig voor logboekdoeleinden of voor het uitvoeren van aanvullende logica op basis van gebruikersinteracties.
_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'),
);
Toestemming beheren
De SDK biedt methoden om toestemming wereldwijd te accepteren of af te wijzen, toestemmingsgegevens opnieuw in te stellen en de toestemmingslaag te openen voor gebruikersinteractie.
-
Accepteer Cookies:
await _cmpSdkPlugin.acceptAll(); -
Alles afwijzen:
await _cmpSdkPlugin.rejectAll(); -
Check:
await _cmpSdkPlugin.check(); -
Toestemming opnieuw instellen:
await _cmpSdkPlugin.reset(); -
Open toestemmingslaag:
await _cmpSdkPlugin.open();
CMP-tekenreeks exporteren en importeren
De CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt. U kunt het importeren in de CMP SDK om deze voorkeuren toe te passen. Dit kan handig zijn voor het overbrengen van toestemmingsvoorkeuren tussen verschillende delen van uw applicatie of voor het extern opslaan ervan.
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");
}
}Toestemmingsstatus en informatie
U kunt verschillende toestemmingsgerelateerde informatie ophalen met behulp van de methoden van de SDK, zoals controleren of toestemming vereist is, de huidige toestemmingsstatus ophalen en toestemming verkrijgen voor specifieke leveranciers of doeleinden.
-
Controleer toestemmingsvereiste:
await _cmpSdkPlugin.check(); -
Krijg toestemmingsstatus: Implementeer een methode om de toestemmingsstatus op te halen en te compileren van verschillende SDK-methoden, zoals
exportCmpString,hasConsent,getAllVendors, Etc.
Een aangepaste lay-out maken
De gebruikersinterface van de toestemmingslaag kan worden aangepast met behulp van het `CmpUiConfig`-object. U kunt de schermconfiguratie (bijvoorbeeld volledig scherm, half scherm) specificeren volgens de behoeften van uw toepassing.
await _cmpSdkPlugin.configureConsentLayer(CmpUiConfig(screenConfig: ScreenConfig.fullScreen));Beschikbare lay-outs
- volledig scherm
- halfSchermBottom
- halfSchermTop
- middenScherm
- klein middenscherm
- grootTopScreen
- groot onderste scherm
Opmerkingen
API-documentatie: documentatie
Bibliotheek: pub.dev
