セッション¶
ヒューマンスコアリングユースケースの一部です。
セッションは、分類の対象となる一連の操作の区間です。SDK は
init の時点で 1 つ開始します。アプリだけが知る形でセッションが終わるとき(ログアウトやアカウントの
切り替え)は SDK に伝えてください。あるユーザーの操作が次のユーザーの分類に数えられることがなくなります。
これは、広告ユースケースで DEA が 1 つの広告ごとに開く
広告セッションとは別のものです。
使いどころ¶
- ユーザーがログアウトする
- ユーザーがアカウントを切り替える
- 現在のセッション ID が必要(たとえばサポートへの問い合わせに含めるため)
前提条件¶
- SDK がインストールされ、初期化されていること。クイックスタートを参照してください。
使い方¶
新しいセッションを開始する¶
reset() は現在のセッションを終了し、新しい ID で新しいセッションを開始します。リセット前に収集された
証拠は新しいセッションの分類に数えられません。スコアリング
モデル、同意の回答、ブラウザーのキーは保持されます。
現在のセッションを読み取る¶
import { DeaSdk } from '@dea/sdk';
const info = DeaSdk.current?.getSessionInfo();
console.log(info?.session); // current session id
console.log(info?.sdk.version); // SDK version
console.log(info?.device.surface); // current viewport size
getSessionInfo() は軽量な読み取りです。端末情報は、ウィンドウのサイズ変更、ズーム、回転の際にも
最新に保たれます。
SDK を停止する¶
dispose() は取得を停止し、SDK を解放します。まだ処理または送信されていないものは、再試行を待っている
広告の証明を含めて破棄されます。dispose() の後、
DeaSdk.current は null になり、init で新しいインスタンスを開始できます。
例¶
ログアウト時にリセットする¶
import { DeaSdk } from '@dea/sdk';
async function logout() {
await fetch('/api/logout', { method: 'POST' });
DeaSdk.current?.reset();
location.assign('/login');
}
API¶
| メンバー | 戻り値 | 説明 |
|---|---|---|
reset() |
void |
セッションを終了し、新しいセッションを開始する |
getSessionInfo() |
SessionInfo |
セッション ID、端末、SDK バージョン |
dispose() |
void |
取得を停止し、SDK を解放する |