カスタムイベント¶
ヒューマンスコアリングユースケースの一部です。
アプリ内の意味のある瞬間(レベルの開始、フォームステップの完了、チェックアウトの開始)をセッションの タイムライン上にマークします。カスタムイベントはセッションに注釈を付けるものです。その名前やデータは スコアや分類には一切加わらないため、セッションをより人間らしく見せるために使うことはできません。
注: セッションのタイムラインは端末上に留まります。iOS SDK は取得した入力を DEA に送りません。 カスタムイベントも同様です。プライバシーとネットワークを 参照してください。
使いどころ¶
- フローのステップをマークする:
checkout_open、payment_submit - ゲームやタスクの境界をマークする:
level_start、round_end
前提条件¶
- SDK がインストールされ、開始されている。クイックスタートを参照してください。
- ユーザーが同意している。同意前のイベントは記録されません。
使い方¶
イベントを記録する¶
captureEvent はイベントが記録されたときに true を、拒否されたときに false を返します
(制限を参照)。結果が不要なときは _ に代入してください。
データ付きでイベントを記録する¶
import DeaBase
import DeaSDK
_ = Dea.sdk?.captureEvent("level_start", data: ["level": 3, "mode": "hard"])
data は [String: JSONValue] です。文字列、整数、浮動小数点数、Boolean のリテラルは自動的に変換
されます。それ以外は .array([...])、.object([...])、.null を使います。
import DeaBase
import DeaSDK
let data: [String: JSONValue] = [
"level": 3,
"speed": 1.5,
"assisted": false,
"items": .array(["sword", "shield"]),
"position": .object(["x": 10, "y": 20]),
]
_ = Dea.sdk?.captureEvent("checkpoint", data: data)
制限¶
| 制限 | 超えた場合 | |
|---|---|---|
| 名前 | 1 〜 64 文字 | イベント全体が拒否される |
| データ | JSON として 1024 バイト | イベント全体が拒否される |
拒否されたイベントは false を返し、何も記録されません。名前が切り詰められることはありません。
イベントは、取得の一時停止中、同意前、dispose() 後にも
拒否されます。
名前やデータに個人情報を入れないでください。
例¶
ゲームのラウンドをマークする¶
import DeaBase
import DeaSDK
final class GameController {
private var round = 0
func startRound() {
round += 1
_ = Dea.sdk?.captureEvent("round_start", data: ["round": .int(round)])
}
func endRound(won: Bool) {
_ = Dea.sdk?.captureEvent("round_end", data: ["round": .int(round), "won": .bool(won)])
}
}
変数に保持された値は明示的にラップします: .int(_:)、.double(_:)、.string(_:)、.bool(_:)。
API¶
| メンバー | 戻り値 | 説明 |
|---|---|---|
captureEvent(_:data:) |
Bool |
セッションのタイムラインにイベントを記録する。拒否された場合は false |