コンテンツにスキップ

カスタムイベント

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

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

注: 本番 SDK では、カスタムイベントはブラウザーの外に出ません。DEA に送信されず、スコアもそれを 読み取りません。

使いどころ

  • フローのステップを記録する: checkout_open、payment_submit
  • ゲームやタスクの境界を記録する: level_start、round_end

前提条件

  • SDK がインストールされ、初期化されていること。クイックスタートを参照してください。

使い方

イベントを記録する

import { DeaSdk } from '@dea/sdk';

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

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

import { DeaSdk } from '@dea/sdk';

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

制限

制限 超えた場合
名前 1〜64 文字 イベントは破棄され、captureEvent は false を返す
データ JSON で 1024 バイト イベントはデータなしで保持される

JSON に変換できないデータ(循環参照、BigInt)は制限超過として扱われます。captureEvent は、取得が 一時停止している間、同意ゲートが閉じている間、および dispose() の後も false を返します。

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

例

チェックアウトのステップを記録する

import { DeaSdk } from '@dea/sdk';

const dea = DeaSdk.current;

dea?.captureEvent('checkout_open', { items: cart.length });
// …
dea?.captureEvent('checkout_submit', { method: 'card' });

cart はアプリ側のコードを表します。

API

メンバー 戻り値 説明
captureEvent(name, data?) boolean イベントが記録されたとき true