Flutter广告管理插件 sourcepoint_unified_cmp 的使用

sourcepoint_unified_cmp 是一个用于集成 Sourcepoint 的统一 CMP（Consent Management Platform）SDK 到 Flutter 应用中的插件。以下是如何使用该插件的详细指南和示例代码。

主要概念

1. SourcepointController: 用于初始化账户配置，并提供加载同意的方法。
2. SourcepointUnifiedCMPBuilder: 一个 Widget，它接收控制器并加载子 Widget 一旦获得用户同意。

示例代码

初始化控制器

首先，我们需要初始化 SourcepointController 并传入账户配置：

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

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const SourcepointUnifiedCMPBuilderExample(),
    );
  }
}

使用 SourcepointUnifiedCMPBuilder

在 SourcepointUnifiedCMPBuilder 中，我们可以根据用户的同意状态来显示不同的 UI：

class SourcepointUnifiedCMPBuilderExample extends StatefulWidget {
  const SourcepointUnifiedCMPBuilderExample({super.key});

  @override
  State<SourcepointUnifiedCMPBuilderExample> createState() => _SourcepointUnifiedCMPBuilderExampleState();
}

class _SourcepointUnifiedCMPBuilderExampleState extends State<SourcepointUnifiedCMPBuilderExample> {
  late final SourcepointController _controller;

  @override
  void initState() {
    super.initState();

    final config = SPConfig(
      accountId: 22,
      propertyId: 7639,
      propertyName: 'tcfv2.mobile.webview',
      pmId: '122058',
      campaigns: [CampaignType.gdpr],
    );

    _controller = SourcepointController(config: config)
      ..setEventDelegate(
        SourcepointEventDelegate(
          onConsentReady: (SPConsent consent) {
            debugPrint('DELEGATE onConsentReady: Consent string: '
                '${consent.gdpr?.euconsent}');
          },
          onSpFinished: (SPConsent consent) {
            debugPrint(
              'DELEGATE SpFinished: Consent string: ${consent.gdpr?.euconsent}',
            );
          },
        ),
      )
      ..addListener(() {
        debugPrint('CONSENT CHANGE NOTIFIER: Consent string: '
            '${_controller.consent?.gdpr?.euconsent}');
      });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text('Consent Sample'),
      ),
      body: Center(
        child: SourcepointUnifiedCMPBuilder(
          controller: _controller,
          builder: (BuildContext context, AsyncSnapshot<SPConsent> snapshot) {
            List<Widget> children;
            if (snapshot.hasData) {
              final consent = snapshot.data;
              debugPrint('user consent has been loaded:');
              debugPrint('   grants: ${consent?.gdpr?.grants}');
              debugPrint('euconsent: ${consent?.gdpr?.euconsent}');
              children = <Widget>[
                const Icon(
                  Icons.check_circle_outline,
                  color: Colors.green,
                  size: 60,
                ),
                const Padding(
                  padding: EdgeInsets.only(top: 16),
                  child: Text('Result: We got initial consent'),
                ),
                Padding(
                  padding: const EdgeInsets.only(top: 16),
                  child: TextButton(
                    onPressed: () {
                      _controller.loadPrivacyManager(
                        pmId: '122058',
                        pmTab: PMTab.vendors,
                      );
                    },
                    child: const Text('Load Privacy Manager'),
                  ),
                ),
              ];
            } else if (snapshot.hasError) {
              children = <Widget>[
                const Icon(
                  Icons.error_outline,
                  color: Colors.red,
                  size: 60,
                ),
                Padding(
                  padding: const EdgeInsets.only(top: 16),
                  child: Text('Error: ${snapshot.error}'),
                ),
              ];
            } else {
              children = const <Widget>[
                SizedBox(
                  width: 60,
                  height: 60,
                  child: CircularProgressIndicator(),
                ),
                Padding(
                  padding: EdgeInsets.only(top: 16),
                  child: Text('Awaiting consent...'),
                ),
              ];
            }
            return SingleChildScrollView(
              child: Column(
                children: children,
              ),
            );
          },
        ),
      ),
    );
  }
}

处理同意变更

有两种方式可以监听同意变更：

1. 注册事件监听器：每当同意变更时会通知你当前的 SPConsent 对象：

_controller = SourcepointController(config: config)
  ..addListener(() {
    debugPrint('CONSENT CHANGE NOTIFIER: Consent string: '
        '${_controller.consent?.gdpr?.euconsent}');
  });

1. 使用事件委托：你可以获取更细粒度的事件，如 onUIReady, onError, onAction, onConsentReady, onConsentChanged, onSpFinished：

_controller = SourcepointController(config: config)
  ..setEventListener(
    SourcepointEventListener(
      onConsentReady: (SPConsent consent) {
        debugPrint('EVENT onConsentReady: Consent string: '
            '${consent.gdpr?.euconsent}');
      },
      onConsentChanged: (SPConsent consent) {
        debugPrint('EVENT onConsentChanged: Consent string: '
            '${consent.gdpr?.euconsent}');
      },
    ),
  );

加载隐私管理器

你还可以通过按钮动态加载隐私管理器对话框：

TextButton(
  onPressed: () {
    _controller.loadPrivacyManager(
      pmId: '122058',
    );
  },
  child: const Text('Load Privacy Manager'),
)