ガイド変数の使用方法

概要

ガイドにパーソナライズ機能を追加する場合は、ガイドのエージェントメタデータを利用して、ユーザーにコンテンツを動的に表示することができます。PendoのガイドではJavaScriptテンプレートの構文を使用します。

<%=root.metadata.visitor.id%>
 <%=root.metadata.account.id%>
personalizedWelcome.png

使用可能な変数

初期化時に(スニペットを介して)渡されるすべてのエージェントメタデータ変数は、ガイド変数として使用できます。

ガイドの種類に応じて、次の変数も利用できます:root.step.index- 0から始まるステップ番号。たとえば、ガイドに3つのステップがある場合、root.step.indexは0、1、もしくは2となります。

root.step.number- 1から始まるステップ番号。たとえば、ガイドに3つのステップがある場合、root.step.numberは1、2、もしくは3となります。

root.step.isFirst- 現在のステップが最初のステップかどうかを示します。

root.step.isLast- 現在のステップが最後のステップかどうかを示します。

root.guide.name- ガイドの名前

root.guide.publishedAt- ガイドの公開時期(タイムスタンプ)

root.guide.showsAfter- ガイドの表示開始予定時期(タイムスタンプ)

root.guide.stepCount- ガイドの総ステップ数

以下のコード例では、ガイド完了の進行状況をレポートし、アクティブなステップに基づいて要素の表示と非表示を切り替える方法を示します。

進捗状況の通知:

<p>Step <%= root.step.number%> of <%= root.guide.stepCount%></p>

最初のステップでない場合にBackボタンを表示:

<% if (!root.step.isFirst) { %>
  <button class="_pendo-guide-previous-button_">Back</button>
<% } %>

最後のステップでない場合はNextボタン、最後のステップの場合はDoneボタンを表示:

<% if (!root.step.isLast) { %>
  <button class="_pendo-guide-next-button_">Next</button>
<% } else { %>
  <button class="_pendo-dismiss-guide-button_">Done</button>
<% } %>