コンテンツにスキップ

オプション

オプションは DeaSdk.init に一度だけ渡します。SDK の起動時に読み取られます。後から init を呼んでも 実行中のインスタンスが返り、そのオプションが維持されます。別の appId を渡した場合も同様です。

DeaOptions は SDK が何を取得するかを保持します。いくつかの設定は、DeaOptions と並ぶ DeaSdk.init 自身の名前付き引数です。

以下のサンプルでは modelDirectory に path_provider を使っています。先にアプリに追加してください:

flutter pub add path_provider
import 'dart:io' show Platform;

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

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final support = await getApplicationSupportDirectory();

  DeaSdk.init(
    DeaOptions(
      appId: Platform.isIOS ? 'YOUR_IOS_APP_ID' : 'YOUR_ANDROID_APP_ID',
      requireConsent: true,
      events: const [
        EventKind.down,
        EventKind.move,
        EventKind.up,
        EventKind.cancel,
        EventKind.scroll,
        EventKind.hover,
        EventKind.keyDown,
      ],
      motionRate: 50,
      idleMotionMs: 3000,
      touchMarginMs: 200,
    ),
    appKey: Platform.isIOS ? 'YOUR_IOS_APP_KEY' : 'YOUR_ANDROID_APP_KEY',
    modelDirectory: support,
  );
  runApp(const MyApp());
}

テレメトリ(SDK のログと取得した入力)は、ステージングとテストのパッケージでアプリに届きます。 テレメトリを参照してください。

コアオプション

appId

型 デフォルト 必須
String — はい

このプラットフォームのアプリに対して DEA が発行したアプリ ID。DEA は Android アプリと iOS アプリを別々に 登録するため、Android では Android の ID を、iOS では iOS の ID を渡します。 アカウントとキーを参照してください。

SDK はこの ID を読み取って、本番アプリとして動作していることを認識します。DEA には送信しません。

requireConsent

型 デフォルト 必須
bool true いいえ

true の場合、ユーザーが同意するまで何も記録されません。 ユーザー同意を参照してください。

SDK の外側で同意がすでに成立している場合に限り false にします。たとえば、アプリがオンボーディング中に 同意を求め、ユーザーが同意した後にのみ DeaSdk.init を呼ぶ場合です。

debug

型 デフォルト 必須
bool false いいえ

テストパッケージでは、取得したオブジェクトごとにログへ書き出します。本番とステージングのパッケージは 無視します。リリースするビルドでは false のままにしてください。

onLog

型 デフォルト 必須
void Function(LogEntry entry)? null いいえ

ステージングとテストのパッケージで、SDK のログエントリごとに呼び出されます。 テレメトリを参照してください。本番パッケージにはログが含まれていないため、 そこでは決して呼び出されません。SDK 自身がログエントリをどこかに送信することはありません。

取得オプション

events

型 デフォルト 必須
List<EventKind> 6 種類のポインター種別(pointerKinds) いいえ

取得する入力の種類。種類を減らすと処理は軽くなりますが、スコアの根拠となる証拠も減ります。

値 取得する内容
EventKind.down 指、スタイラス、またはマウスボタンが押される
EventKind.move 押された状態でポインターが動く
EventKind.up ポインターが離される
EventKind.cancel システムがポインターをキャンセルする
EventKind.scroll マウスホイールとトラックパッドのスクロール
EventKind.hover マウスまたはスタイラスが触れずに動く
EventKind.keyDown アプリが captureKey で報告するキーの押下
EventKind.keyUp アプリが captureKey で報告するキーの解放

キー種別はデフォルトのリストに含まれず、自動的に取得されることはありません。アプリがキー入力を報告する 場合にのみ追加してください。キー入力を報告するを 参照してください。含めない場合、captureKey は何もしません。

同じリストは、アプリが capturePointer で転送する内容もフィルタリングします。リストにない種別は 破棄されます。

motionRate

型 デフォルト 必須
int(Hz) 50 いいえ

要求する加速度センサーとジャイロスコープのレート。25 未満の値は 25 に引き上げられます。端末が モーションデータを配信し始めると、getSessionInfo().device.sensorRate がこのレートを報告します。 モーションデータがまだ届いていない間、および setMotion(false) でモーションがオフになっている間は 0 を返します。

idleMotionMs

型 デフォルト 必須
int(ms) 3000 いいえ

この時間だけ誰も画面に触れていない場合、次のタッチまでモーションデータは低いレート(idleMotionMs ごとに 1 件)で記録されます。0 にするとすべての読み取り値を記録します。

touchMarginMs

型 デフォルト 必須
int(ms) 200 いいえ

アイドル中であっても、各タッチの前後この時間は、モーションデータが常にフルレートで保持されます。

注: idleMotionMs と touchMarginMs は、スコアの計算元となるモーションデータの形を決めます。 各タッチは、その直前に取得されたモーションの読み取り値とともにスコアリングされます。デフォルトのまま にしてください。

アテステーションオプション

これらは DeaOptions のフィールドではなく、DeaSdk.init の引数です。DEA はアプリを登録する際に、 プラットフォームごとに 1 セットの値を発行します:

値 iOS Android
appId(DeaOptions 内) 必須 必須
appKey 必須 必須
playIntegrityProject 無視 必須

appKey

型 デフォルト 必須
String? null はい(アテステーションに必要)

このプラットフォームの appId とともに DEA が発行したアプリキー。Android では Android アプリのキー、 iOS では iOS アプリのキーです。キーは公開情報であり(アプリを識別するもので、アプリの中に同梱されます)、 SDK は端末キーを登録する際に X-App-Key ヘッダーとして DEA に送信します。 アカウントとキーを参照してください。

これがないと、attest() は DEA に接続せずに Verdict.unsupported(supported は false)を返し、 detail に appKey が渡されなかったことが記されます。取得と分類には必要ありません。

DeaSdk.init(
  const DeaOptions(appId: 'YOUR_APP_ID'),
  appKey: 'YOUR_APP_KEY',
);

registryAppId

型 デフォルト 必須
String? null いいえ

DeaSdk.init の引数です。

非推奨。 0.20.8 以降は無視されます。証明は appId を含みません。DEA は証明に署名した端末キーから アプリを取得し、それが appKey のアプリであることを確認します。既存のアプリがコンパイルできるよう、 このオプションは残してあります。次に更新するときに削除してください。

playIntegrityProject

型 デフォルト 必須
int? null Android ではアテステーションに必須。iOS では無視

Android アプリに対して DEA が appId と appKey とともに発行した Google Cloud プロジェクト番号。 iOS では無視されます。アテステーションを参照してください。

DeaSdk.init(
  const DeaOptions(appId: 'YOUR_APP_ID'),
  appKey: 'YOUR_APP_KEY',
  playIntegrityProject: 123456789012,
);

モデルオプション

SDK はパッケージに組み込まれたモデルでスコアリングします。DEA が公開した新しいモデルをダウンロードして 端末に保持することもできます。これらは DeaSdk.init の引数です。

modelDirectory

型 デフォルト 必須
Directory?(dart:io) null いいえ

ダウンロードしたモデルを保持する場所。SDK はその中に dea/models を作成します。アプリの application-support ディレクトリを渡してください。たとえば path_provider の getApplicationSupportDirectory() から 取得できます。

これがないとモデルを保持する場所がなく、更新チェックは実行されず、SDK は常に組み込みモデルで スコアリングします。ディレクトリがある場合:

  • 起動時、以前の実行で保持したモデルが、最初の入力がスコアリングされる前に読み込まれます。
  • SDK は、起動ごと、前回応答のあったチェックから 1 日が経過した後にアプリがフォアグラウンドに戻ったとき、 および checkForModel() を呼び出したときに、DEA のモデルホストに 新しいモデルが公開されているかを問い合わせます。変更がない応答では何もダウンロードしません。
  • 新しいモデルはダウンロードされ、検証され、すぐにスコアリングを開始します。以降の実行のために保持 されます。使用中のものより古い、または同じモデルは決して読み込まれません。

チェックはバックグラウンドで実行されます。スコアリングをブロックすることも、例外を投げることも ありません。本番アプリは DEA の本番モデルチャネルを読み取ります。

modelUpdates

型 デフォルト 必須
bool true いいえ

更新チェックを止めるには false にします。保持されていたモデルは削除され、SDK は組み込みモデルで スコアリングします。modelDirectory がない場合は効果がありません。

modelTimeout

型 デフォルト 必須
Duration 30 秒 いいえ

1 回のモデル要求が打ち切られるまでに許される時間。