カスタムイベント¶
ヒューマンスコアリングユースケースの一部です。
アプリ内の意味のある瞬間(レベルの開始、フォームステップの完了、チェックアウトの開始)をセッションのタイムライン上 に記録します。カスタムイベントはそれ自体では証拠を追加しないため、セッションをより人間らしく見せるために使う ことはできません。
注: 本番環境の
appIdでは、カスタムイベントは端末上に留まります。SDK はそれらを DEA に一切送信しないため、 セッションについて問い合わせても DEA はカスタムイベントを確認できません。
使いどころ¶
- フローのステップを記録する:
checkout_open、payment_submit - ゲームやタスクの区切りを記録する:
level_start、round_end
前提条件¶
- SDK がインストールされ、初期化されている。クイックスタートを参照してください。
- ユーザーが同意している。同意前はイベントは記録されません。
使い方¶
イベントを記録する¶
データ付きでイベントを記録する¶
captureEvent はイベントが記録された場合に true、記録されなかった場合に false を返します。
制限¶
| 制限 | 超過した場合 | |
|---|---|---|
| 名前 | 1〜64 文字 | イベント全体が破棄される |
| データ | JSON として 1024 バイト | イベント全体が破棄される |
データの値は文字列、数値、真偽値、または null にしてください。取得が一時停止している間と
同意の前も、イベントは破棄され、false が返ります。
名前やデータに個人情報を含めないでください。
例¶
ゲームのラウンドを記録する¶
import {useRef} from 'react';
import * as Dea from '@dea/react-native';
export function useRounds() {
const round = useRef(0);
const startRound = () => {
round.current += 1;
Dea.captureEvent('round_start', {round: round.current}).catch(() => {});
};
const endRound = (won: boolean) => {
Dea.captureEvent('round_end', {round: round.current, won}).catch(() => {});
};
return {startRound, endRound};
}
API¶
| メンバー | 戻り値 | 説明 |
|---|---|---|
captureEvent(name, data?) |
Promise<boolean> |
セッションのタイムライン上にイベントを記録する。破棄された場合は false |