インサイトのセッションプレイバックを手動で記録する

Last Updated 12月 5, 2024

Download as PDF

概要

セッションプレイバックを有効にすると、インサイトはプラットフォームにおけるすべてのユーザーインタラクションの収集を開始し、それらを変換してセッションプレイバックと呼ばれる再生可能なセッションを再構築します。

制限されたセッションプレイバックの多くにおいて、ユーザーセッションの表示したくない部分を記録している場合、API呼び出しを使用して、いつ セッションプレイバックを開始するかを制御できます。 これにより、特定のセッションをセッションプレイバックを使用して収集するかどうかに関わらず制御できるため、セッションプレイバックの割り当て制限としてカウントされます。

一旦、 セッションプレイバックの記録方法を手動設定に切り替えると、すべてのセッションにおけるデフォルトの収集モードが、 セッションプレイバックからDigital Experience Analytics（DXA）に変わります（この時点ではインタラクションが収集されますが、セッションはセッションプレイバック用に再作成されないためセッション制限にはカウントされません）。そして、WalkMe PlayerはAPI呼び出しを待ってから、現在のセッションの記録モードを Digital Experience Analytics（DXA）から セッションプレイバックに変更します.

セッションプレイバックの記録方法を手動で設定

1. insights.walkme.comに移動します。
2. 要求された環境に移動し、［Environment Settings（環境設定）］をクリックします。
3. ［Session Playback Settings（セッションプレイバック設定）］タブに移動します。
4. ［Start Session Playback Recording Manually（セッションプレイバックの記録方法を手動で開始する）］のトグルをONに切り替えます。
5. 収集モードをセッションプレイバックに設定するには、クライアント側で「WalkMeInsightsAPI.startPlaybackRecording()」への呼び出しを追加します。

クライアント側の実装

現在のセッションのセッションプレイバックのキャプチャを開始するには、以下を呼び出します。

• WalkMeInsightsAPI.startPlaybackRecording()

インサイトが正常にロードされた後にのみAPI呼び出しが行われるようにするには、以下のウィンドウプロパティにコールバック関数を設定します。

• window.onWalkMeInsightsAPIReady

インサイトがサイトに読み込まれると、この属性に保存されている関数が呼び出されます。

手動で記録を停止するには、以下を呼び出しします。

• WalkMeInsightsAPI.stopRecording()

Code 例 (jQuery)

• ユーザーがターゲットボタンをクリックしたら、記録を開始します。

  $( "#target" ).click(function() {
  WalkMeInsightsAPI.startPlaybackRecording()
  });

• ユーザーが特定のURLにアクセスしたら、記録を開始します。

  // IMPORTANT NOTE: this code must appear before the WalkMe snippet.
  window.onWalkMeInsightsAPIReady = function() {
  if(window.location.href === "http://example.com/home"){
  WalkMeInsightsAPI.startPlaybackRecording()
  }
  }

• 管理者ユーザーのみ記録します。

  // IMPORTANT NOTE: this code must appear before the WalkMe snippet.
  window.onWalkMeInsightsAPIReady = function() {
  if(myUser.role.toLowerCase() === "admin"){
  WalkMeInsightsAPI.startPlaybackRecording()
  }
  }

重要な注意事項

• クライアント側APIが呼び出されると、現在のセッションはセッションプレイバックのセッションとしてカウントされます。
• 1つのセッションでクライアント側のAPIを複数回呼び出しても、セッションは引き続き単一のセッションプレイバックのセッションとしてカウントされます。
• 現在のところ、セッションがセッションプレイバックの収集モードで記録されると、Digital Experience Analytics（DXA）モードに戻す方法はありません。
• Digital Experience Analytics（DXA）モードで記録されたセッションのセクションはセッションプレイバックをサポートしませんが、これらのセッションのイベントは引き続き収集されます。
• 一旦、API呼び出し（WalkMeInsightsAPI.startPlaybackRecording）が行われると、セッションの残りは再生可能になります（つまり、セッションプレイバックの収集モードで記録されます）。