カスタムユーザー識別子¶
SDK は匿名ユーザーに対して識別子を生成します。ユーザーがログインした後、setUser() を呼び出して安定したビジネスユーザー情報を書き込むことで、複数の Session にまたがって同一ユーザーの View、Action、Resource、Error を検索できます。
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id |
String | いいえ | 安定しており、機密情報を直接公開しないビジネスユーザー ID を推奨 |
name |
String | いいえ | ユーザーのニックネームまたは表示名 |
email |
String | いいえ | ユーザーのメールアドレス |
| その他のフィールド | Unknown | いいえ | 会員ランクなど、ビジネスに必要なユーザー属性 |
少なくとも id を指定することを推奨します。頻繁に変化するニックネームやメールアドレスを安定したユーザー ID の代わりに使用しないでください。
ユーザー分析でビジネスユーザーを関連付ける場合、初回設定またはビジネスユーザーの切り替え時には、安定した空でない id を渡す必要があります。SDK の user.id はエクスプローラーの保存フィールド userid に対応します。SDK が自動生成した空でない識別子もユーザー統計に含めることができ、名前やメールアドレスを提供する必要はありません。
同一ワークスペース内の複数のアプリケーションをまたいで分析する場合は、一貫したビジネス ID ルールを使用し、同じ ID が異なるユーザーに対応しないようにしてください。
NPM の例¶
import { datafluxRum } from "@cloudcare/browser-rum"
datafluxRum.setUser({
id: "user-1234",
name: "John Doe",
email: "john@example.com",
membership_level: "gold"
})
CDN の例¶
ログアウトまたはユーザー切り替え¶
setUser() と clearUser() はユーザーコンテキストのみを更新し、Session を自動的に終了または新規作成しません。SDK 3.3.6 以降では、ログインまたはアカウント切り替え後、まず完全なビジネスユーザー情報を設定してから、startSession() を呼び出して新しい Session 境界を作成できます。
ログアウト時は、まずビジネスユーザー情報をクリアしてから新しい Session を作成し、後続のイベントが元のビジネスユーザーに紐付かないようにします。
CDN 導入では window.DATAFLUX_RUM 上の同名メソッドを使用します。非同期ロード時は onReady コールバック内で実行します。
同一ユーザーの名前やその他の属性のみを更新する場合は、setUserProperty() を使用して部分更新します。id を含まない setUser() で既存のユーザーコンテキストを上書きせず、そのために startSession() を呼び出す必要もありません。
ページリフレッシュとローカルストレージ¶
デフォルトでは、ユーザーコンテキストはタブのメモリ内に保持されます。リフレッシュ後は、アプリケーションがログイン状態を復元してからユーザー情報を設定する必要があります。storeContextsToLocal を有効にすると、ユーザーコンテキストはリフレッシュ後に復元できます。ログアウト時には、永続化されたビジネスユーザー情報をクリアするために clearUser() を呼び出す必要があります。
同一オリジンの複数のアプリケーションがローカルストレージを使用する場合、storeContextsKey によってワークスペース、アプリケーション、環境を区別する必要があります。同一オリジンで同じ Key を使用するタブ間ではユーザーコンテキストが同期される可能性があります。ビジネスコンテキストのストレージ分離は Session 分離を意味しないため、複数アカウントのシナリオでセッションの帰属を検証してください。パラメータの説明は Web アプリケーション導入 を参照してください。
注意事項¶
- パスワード、アクセストークン、身分証明書番号などの機密情報を書き込まないでください。
- ユーザー情報は設定後に生成されるイベントにのみ影響し、すでに送信済みのデータは変更されません。
- ユーザー切り替え後は、ユーザー情報と Session を同期して更新し、2 つのアカウントのデータが同じ Session に混在しないようにしてください。
ユーザー分析では、複数のユーザーを含む、または完全なユーザー帰属を確認できないセッションはリプレイを提供しません。後からユーザー情報を更新しても、過去のセッションの帰属は修正されません。
検証¶
ユーザー設定後にページ操作を 1 回トリガーし、View または Action エクスプローラーで userid が設定した user.id と一致することを確認します。ログイン、アカウント切り替え、またはログアウト後は、上記の順序でユーザーコンテキストを更新し、startSession() を呼び出して、新しいイベントの session_id が変更され、元のビジネスユーザーに紐付かないことを確認します。
setUserProperty() のみで同一ユーザーの属性を更新する場合は、userid と session_id がどちらも変更されないことを確認します。