セッション変数は、Webサイト内のビジネスメッセンジャーの利用者の名前、メールアドレス、電話番号などのユーザー情報を取得し、セッションが有効な間、一時的に保存するための変数です。
ビジネスメッセンジャーのウィジェットに利用者の情報を保存し、利用者に対して個別の体験を提供するのに役立ちます。
セッション変数の仕組み
1. セッションの開始
利用者がWebアプリにアクセスすると、サーバーによって新しいセッションが作成され、重複しないセッションIDが割り当てられます。このIDは、利用者のブラウザーに送信されます。
2. データの保管
利用者がアプリでメッセージをやりとりする際、特定の情報(例:ユーザー名、各種設定など)は、利用者のセッションIDと関連付けられ、サーバー上でセッション変数に保存されます。
3. データの取得
以後、サーバーではセッションIDをもとにセッション変数の値を取得します。
4. セッションの終了
セッションは、利用者がサインアウトしたり、セッションが時間切れになったり、ブラウザーが終了されたりすると終了します。セッションが終了すると、サーバーではセッション変数が破棄されます。
セッション変数のサンプル
[
{
name: 'UserName',
value: '川根太郎'
},
{
name: 'id',
value: '6320834868293'
}
]
セッション変数の利用例
1. 初回表示時におけるセッション変数の設定
ウィジェットの初回表示時に、widgetProps内でセッション変数を設定します。
ZOHOIM.widgetProps = {
sessionVariableValues:sessionVariable
};
2. 初回表示後のセッション変数の更新
やりとりの中でセッション変数の値を更新する必要が生じた場合、triggerEventメソッドを使ってセッション変数を更新できます。
const { triggerEvent } = window.ZOHOIM || {};
const args = {
sessionVariableValues: sessionVariable
};
triggerEvent('setVariable',args);