Flutter GDPR合规广告插件 gdpr_admob 的使用

本指南提供了如何在Flutter应用程序中使用gdpr_admob包的基本理解。

介绍

gdpr_admob包帮助你在欧洲经济区（EEA）内的用户显示GDPR同意表单，并根据用户的同意初始化Google Mobile Ads。本指南解释了如何在你的Flutter应用中设置它。

步骤指南

1. 添加依赖项

将以下依赖项添加到你的pubspec.yaml文件中：

dependencies:
  flutter:
    sdk: flutter
  google_mobile_ads: ^5.2.0
  gdpr_admob: ^1.0.3

2. 导入包

在你的Dart文件中导入所需的包：

import 'package:flutter/material.dart';
import 'package:gdpr_admob/gdpr_admob.dart';
import 'package:google_mobile_ads/google_mobile_ads.dart';

3. 初始化GDPR

在你的StatefulWidget中，创建一个GdprAdmob实例并定义一个方法来初始化它。此方法将为用户设置GDPR同意状态。

final GdprAdmob gdprAdmob = GdprAdmob();
bool _isLoading = false;
String? _errorMessage;
String? _consentStatus;

Future<void> _initializeGdpr() async {
  setState(() {
    _isLoading = true;
  });

  final error = await gdprAdmob.initialize(
    mode: DebugGeography.debugGeographyEea,
    testIdentifiers: ["WRITE_YOUR_TEST_DEVICE_IDENTIFIERS"],
  );

  if (error != null) {
    setState(() {
      _errorMessage = error.message;
    });
  }

  setState(() {
    getStatus();
    _isLoading = false;
  });
}

4. 获取同意状态

定义另一个方法来获取当前用户的同意状态。

getStatus() async {
  final status = await gdprAdmob.getConsentStatus();
  setState(() {
    _consentStatus = status;
  });
}

5. 显示GDPR对话框

现在你可以在你的小部件树中使用这些方法来显示GDPR对话框并获取同意状态。你也可以使用resetConsentStatus方法重置同意状态。

ElevatedButton(
  onPressed: _initializeGdpr,
  child: const Text("Show GDPR dialog"),
),
ElevatedButton(
  onPressed: () async {
    await gdprAdmob.resetConsentStatus();
    getStatus();
  },
  child: const Text("Reset the consent state"),
),
if (_consentStatus != null)
  Text('Consent Status: $_consentStatus'),
if (_errorMessage != null) Text('Error: $_errorMessage'),

完整示例代码

以下是完整的示例代码，展示了如何在Flutter应用中集成gdpr_admob包。

import 'package:flutter/material.dart';
import 'package:gdpr_admob/gdpr_admob.dart';
import 'package:google_mobile_ads/google_mobile_ads.dart';

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Flutter GDPR dialog',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final GdprAdmob gdprAdmob = GdprAdmob();
  bool _isLoading = false;
  String? _errorMessage;
  String? _consentStatus;

  Future<void> _initializeGdpr() async {
    setState(() {
      _isLoading = true;
    });

    final error = await gdprAdmob.initialize(
      mode: DebugGeography.debugGeographyEea,
      testIdentifiers: ["WRITE_YOUR_TEST_DEVICE_IDENTIFIERS"],
    );

    if (error != null) {
      setState(() {
        _errorMessage = error.message;
      });
    }

    setState(() {
      getStatus();
      _isLoading = false;
    });
  }

  getStatus() async {
    final status = await gdprAdmob.getConsentStatus();
    setState(() {
      _consentStatus = status;
    });
  }

  [@override](/user/override)
  void initState() {
    getStatus();
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text("Flutter GDPR dialog"),
      ),
      body: Center(
        child: _isLoading
            ? const CircularProgressIndicator()
            : Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  if (_consentStatus != "obtained")
                    ElevatedButton(
                      onPressed: _initializeGdpr,
                      child: const Text("Show GDPR dialog"),
                    ),
                  ElevatedButton(
                    onPressed: () async {
                      await gdprAdmob.resetConsentStatus();
                      getStatus();
                    },
                    child: const Text("Reset the consent state"),
                  ),
                  if (_consentStatus != null)
                    Text('Consent Status: $_consentStatus'),
                  if (_errorMessage != null) Text('Error: $_errorMessage'),
                ],
              ),
      ),
    );
  }
}