Flutter用户隐私同意管理插件usercentrics_sdk的使用

Flutter用户隐私同意管理插件usercentrics_sdk的使用

欢迎使用Usercentrics

您现在距离在您的应用程序中实现“隐私”核心功能更近了一步。我们很高兴您决定将此作为优先事项。我们在这里帮助您与用户建立信任。

Usercentrics Apps SDK

Usercentrics Apps SDK 是一个为移动应用、移动游戏和电视应用提供的本地同意管理平台解决方案，它能够收集、记录和管理用户的隐私选择，以确保全球法律合规性。

要求

• Dart 2.17.1 或更高版本
• Flutter 1.20.0 或更高版本
• Android 4.1（API 16）或更高版本，Kotlin 1.5 或更高版本
• iOS 11 或更高版本

Android Kotlin 版本低于 1.5

如果您的 Kotlin 版本不兼容，可能会看到以下错误：

e: Incompatible classes were found in dependencies. Remove them from the classpath or use '-Xskip-metadata-version-check' to suppress errors

解决方法是增加 android/build.gradle 文件中的 Kotlin 版本，例如：1.5.31。

Android 版本低于 5.0 (API 21)

如果您支持 Android 版本低于 5.0 (API 21) 并且没有启用多 Dex 支持，可能会看到以下错误：

D8: Cannot fit requested classes in a single dex file (# methods: 66055 > 65536)

您可以将最低版本设置为 5.0 (API 21)，或者启用多 Dex 支持：

implementation "androidx.multidex:multidex:2.0.1"
multiDexEnabled true
android:name="androidx.multidex.MultiDexApplication"

iOS 版本低于 11

如果您有 iOS 目标版本低于 11 或者没有任何版本（默认为版本 9），可能会看到以下错误：

[!] Automatically assigning platform `iOS` with version `9.0` on target `Runner` because no platform was specified. Please specify a platform for this target in your Podfile.

解决方法是将 ios/Podfile 中的版本设置为至少 11，并在 Xcode 中更改 Deployment Target。

开始使用

为了使用和测试 SDK，您需要一个 Usercentrics 帐户。请注册免费试用。

集成示例

以下是完整的 Flutter 示例代码：

import 'package:flutter/material.dart';
import 'package:usercentrics_sdk/usercentrics_sdk.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    _initializeUsercentrics();
  }

  // 初始化 Usercentrics
  void _initializeUsercentrics() {
    Usercentrics.initialize(
      settingsId: 'Yi9N3aXia', // 替换为您自己的 settingsId
      loggerLevel: UsercentricsLoggerLevel.debug,
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  HomePageState createState() => HomePageState();
}

class HomePageState extends State<HomePage> {
  [@override](/user/override)
  void initState() {
    super.initState();
    _showCMPIfNeeded();
  }

  // 显示 CMP 如果需要
  void _showCMPIfNeeded() async {
    try {
      final status = await Usercentrics.status;

      if (status.shouldCollectConsent) {
        _showFirstLayer();
      } else {
        applyConsent(status.consents);
      }
    } catch (error) {
      // 处理非本地化错误
    }
  }

  // 显示第一层
  void _showFirstLayer({
    BannerSettings? settings,
  }) async {
    try {
      final response = await Usercentrics.showFirstLayer(
        settings: settings,
      );

      _handleUserResponse(response);
    } catch (error) {
      // 处理错误
    }
  }

  // 显示第二层
  void _showSecondLayer() async {
    try {
      final response = await Usercentrics.showSecondLayer(
        settings: BannerSettings(
          secondLayer: SecondLayerStyleSettings(
            showCloseButton: true,
            buttonLayout: ButtonLayout.row(
              buttons: [
                const ButtonSettings(type: ButtonType.save),
                const ButtonSettings(type: ButtonType.acceptAll),
              ],
            ),
          ),
        ),
      );

      _handleUserResponse(response);
    } catch (error) {
      // 处理错误
    }
  }

  // 处理用户响应
  void _handleUserResponse(UsercentricsConsentUserResponse? response) {
    print("Consents -> ${response?.consents}");
    print("User Interaction -> ${response?.userInteraction}");
    print("Controller Id -> ${response?.controllerId}");

    applyConsent(response?.consents);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Usercentrics Flutter Sample'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(50.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.stretch,
          children: [
            ElevatedButton(
              onPressed: () => _showFirstLayer(),
              child: const Text("Show First Layer"),
            ),
            ElevatedButton(
              onPressed: () => _showSecondLayer(),
              child: const Text("Show Second Layer"),
            ),
          ],
        ),
      ),
    );
  }
}

// 应用同意
void applyConsent(List<UsercentricsServiceConsent>? consents) {
  // https://docs.usercentrics.com/cmp_in_app_sdk/latest/apply_consent/apply-consent/#apply-consent-to-each-service
}