コンテンツにスキップ

カスタムイベント

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

アプリ内の意味のある瞬間(レベルの開始、フォームのステップの完了、チェックアウトの表示)をセッションの タイムラインに記します。カスタムイベントはセッションに注釈を付けるものです。スコアを変えることは決して ないため、セッションをより人間らしく見せるために使うことはできません。

使いどころ

  • フローのステップを記すとき: checkout_open、payment_submit
  • ゲームやタスクの区切りを記すとき: level_start、round_end

注: カスタムイベントは入力を報告する手段ではありません。キー入力や Web ビュー内のタッチを報告 するには、SDK が見えない入力を報告するを参照してください。

注: カスタムイベントは、SDK がスコアリングするセッションの中で端末上に留まります。SDK はそれらを DEA に送信しません。

前提条件

  • SDK がインストールされ、初期化されている。クイックスタートを参照してください。
  • ユーザーが同意している。同意前のイベントは記録されません。

使い方

イベントを記録する

import 'package:dea_sdk/dea_sdk.dart';

DeaSdk.instance?.captureEvent('level_start');

データ付きでイベントを記録する

DeaSdk.instance?.captureEvent('level_start', {'level': 3, 'mode': 'hard'});

上限

上限 超えた場合
名前 64 文字 名前は先頭 64 文字に切り詰められる
データ JSON として 1024 バイト イベント全体が破棄される

JSON に変換できないデータも破棄されます。破棄されたイベントは黙って破棄されます。captureEvent は例外を 投げず、何も報告しません。取得の一時停止中、同意前、 dispose() 後もイベントは無視されます。

名前やデータに個人情報を入れないでください。

例

ゲームのラウンドを記す

import 'package:dea_sdk/dea_sdk.dart';

class GameController {
  int _round = 0;

  void startRound() {
    _round++;
    DeaSdk.instance?.captureEvent('round_start', {'round': _round});
  }

  void endRound({required bool won}) {
    DeaSdk.instance?.captureEvent('round_end', {'round': _round, 'won': won});
  }
}

API

メンバー 戻り値 説明
captureEvent(name, [data]) void セッションのタイムラインにイベントを記録する