コンテンツにスキップ

ユーザー同意

ヒューマンスコアリングユースケースの一部です。

SDK はユーザーがアプリをどのように操作するかを記録するため、デフォルトではユーザーが同意するまで 何も記録しません。SDK には既製の同意ダイアログが用意されており、この保証を失うことなく独自の UI に 置き換えることもできます。

使いどころ

  • 常に。ただし、アプリが DeaSdk.init を呼ぶ前にすでに同意を得ている場合は、 requireConsent: false を設定してください
  • ダイアログの文言を変える、または翻訳するとき
  • 設定画面からユーザーが同意を撤回できるようにするとき

前提条件

使い方

組み込みダイアログを表示する

import 'package:dea_sdk/dea_sdk.dart';

final agreed = await showDeaConsentDialog(context);
  • 回答は端末に保存されます。ユーザーが一度回答すると、以降の呼び出しは何も表示せずに保存された回答を 返すため、起動ごとに呼んでも安全です。
  • ダイアログはアプリのテーマのプラットフォームに従います。デフォルトでは Android では Material ダイアログ、iOS では Cupertino アラートです。
  • 外側をタップしても閉じられません。それ以外の方法(たとえば戻るボタン)で閉じられた場合は false を 返しますが何も記録しないため、次回ユーザーに再度尋ねます。

文言を変える

await showDeaConsentDialog(
  context,
  copy: const ConsentCopy(
    title: 'Help us keep bots out',
    body: 'We measure how you interact with the app to tell people apart from bots.',
    recorded: ['Where you touch, and how hard', 'How the phone moves in your hand'],
    notRecorded: ['What you type', "What's on your screen"],
    closing: 'You can change this at any time in Settings.',
    accept: 'Allow',
    decline: 'Not now',
  ),
);

recorded または notRecorded に空のリストを渡すと、そのセクションは非表示になります。リストの内容が アプリにとって正しいままであることを確認してください。

ダイアログのスタイルを選ぶ

await showDeaConsentDialog(context, style: ConsentDialogStyle.material); // or .cupertino, .adaptive

独自の UI を使う

独自のダイアログやオンボーディングのステップを描画し、回答を記録します:

await DeaSdk.instance?.setConsent(true);  // the user agreed
await DeaSdk.instance?.setConsent(false); // the user declined

記録は setConsent が呼ばれた時点ですぐに開始または停止します。await は回答が保存されるのを待つ だけです。

現在の回答を読み取る

final consent = DeaSdk.instance!.consent;

consent.isAnswered; // false until the user has answered
consent.isGranted;  // true only if the user agreed
consent.decision;   // ConsentDecision.unknown, .granted or .denied
await DeaSdk.instance?.setConsent(false);

記録はすぐに停止し、SDK がまだ保留していた入力は破棄されます。セッションは維持されるため、ユーザーが 再度同意すると、同じセッションで記録が続きます。撤回前にスコアリングされた内容はセッションの分類に 残ります。ゼロからやり直すには、あわせて reset() を呼び出して ください。

再度尋ねる

await DeaSdk.instance?.consent.forget();

forget() は保存された回答を消去するため、次の showDeaConsentDialog 呼び出しで再度尋ねます。たとえば、 同じ端末で別のアカウントがサインインしたときに使います。拒否とは異なり、これは回答ではありません。 requireConsent がオン(デフォルト)の場合、ユーザーが再度回答するまで何も記録されません。

共用端末

セッションごとに別の人が端末を使う可能性がある場合(キオスク、テスト端末)は、回答を保存しないように します:

await showDeaConsentDialog(context, remember: false);

remember: false を指定すると、まず保存されている回答が消去され、呼び出しごとにダイアログが表示され、 新しい回答は保存されません。

例

最初の画面で尋ねる

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

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

  @override
  State<HomeScreen> createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  @override
  void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((_) {
      if (mounted) showDeaConsentDialog(context);
    });
  }

  @override
  Widget build(BuildContext context) => const Scaffold(body: Center(child: Text('Home')));
}

設定のスイッチ

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

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

  @override
  State<DeaConsentTile> createState() => _DeaConsentTileState();
}

class _DeaConsentTileState extends State<DeaConsentTile> {
  @override
  Widget build(BuildContext context) {
    final dea = DeaSdk.instance;
    return SwitchListTile(
      title: const Text('Bot protection'),
      subtitle: const Text('Measure how I interact with the app'),
      value: dea?.consent.isGranted ?? false,
      onChanged: dea == null
          ? null
          : (value) async {
              await dea.setConsent(value);
              setState(() {});
            },
    );
  }
}

API

メンバー 戻り値 説明
showDeaConsentDialog(context, {copy, style, remember, ask}) Future<bool> 必要であればダイアログを表示し、回答を返す。ask: false は保存された回答を読み取るだけ
DeaSdk.setConsent(granted, {remember}) Future<void> 回答を記録する
DeaSdk.consent Consent 現在の回答
Consent.isAnswered bool ユーザーが回答したかどうか
Consent.isGranted bool ユーザーが同意したかどうか
Consent.decision ConsentDecision unknown、granted、または denied
Consent.forget() Future<void> 保存された回答を消去する
Consent.addListener(listener) / removeListener(listener) void 回答が変わったときに通知を受ける