JavaScript SDK - event メソッド

OpenReplay の SDK の event メソッドの詳細

JavaScript SDK ⁠-⁠ event メソッド

このメソッドを使用すると、「機能イベント」を報告できます。機能イベントを使うことで、機能面で重要であるものの、トラッカーがデフォルトでは自動的に検出してフラグを付けられない、ユーザーのセッション内の瞬間を知らせることができます。機能イベントの例としては、ユーザーがショッピングカートに商品を追加する操作が挙げられます。トラッカーはその操作を記録できますが、セッションのタイムライン上で重要なイベントとしてフラグを付けるべきかどうかは判断できません。しかし、このメソッドを使えば、手動でフラグを付けられます。

詳細については、カスタムイベントを参照してください。

event(key: string, payload?: any, issue?: boolean): void
  • key: string: 情報が保存されるキーの名前。このキーは、OpenReplay プラットフォーム内でのフィルタリングや検索に使用できます。
  • payload: any: イベントの内容。シリアライズ可能な任意のデータを指定できます。
  • issue: boolean : これが機能イベント(false に設定した場合)なのか、「テクニカルイベント」(true に設定した場合)なのかを示します。デフォルト値は false です。