コンテンツにスキップ

カスタムイベント

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

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

注: カスタムイベントは端末内に留まります。本番 SDK はそれをどこにも送信しません。 debug を有効にすると、各イベントが Logcat に CustomObject の行として表示されます。

使いどころ

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

前提条件

  • SDK がインストールされ、初期化されている。クイックスタートを参照してください。
  • ユーザーが同意している。同意前のイベントは記録されません。
  • events に CaptureEvent.CUSTOM が含まれている。デフォルトでは 含まれています。

使い方

イベントを記録する

import ai.dea.sdk.DeaSdk

DeaSdk.instance?.captureEvent("level_start")

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

DeaSdk.instance?.captureEvent("level_start", mapOf("level" to 3, "mode" to "hard"))

captureEvent はイベントが記録されたとき true を、記録されなかったとき false を返します。

制限

制限 超えた場合
名前 1〜64 文字 イベント全体が破棄されます
データ JSON として 1024 バイト イベント全体が破棄されます

Android は長い名前を切り詰めず、イベントを破棄します。取得が一時停止中、 同意前、dispose() 後もイベントは無視され、captureEvent は false を返します。

JSON で表現できる値を使ってください: 文字列、数値、真偽値、null、およびそれらのリストとマップ。 その他の値は null として記録されます。

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

例

ゲームのラウンドを記録する

import ai.dea.sdk.DeaSdk

class GameController {
    private var round = 0

    fun startRound() {
        round++
        DeaSdk.instance?.captureEvent("round_start", mapOf("round" to round))
    }

    fun endRound(won: Boolean) {
        DeaSdk.instance?.captureEvent("round_end", mapOf("round" to round, "won" to won))
    }
}

API

メンバー 戻り値 説明
captureEvent(name, data = null) Boolean セッションのタイムラインにイベントを記録します。破棄または無視された場合は false