ガイドのロジック

最終更新日: 2023年09月21日 03:27

ガイドのロジックは、コードブロックを使用せずに、Pendoユーザーが基本的なマークダウン（Markdown）構文を使用して高度なガイドの動作を実装できるようにするEngageのガイドの機能です。次の動作が含まれます。

対象外のガイドステップのスキップ
条件に応じたガイドの分岐
必須の質問項目へのマーク
ガイドのパーソナライズ（メタデータの置換など）

ガイドのロジックの有効化

［設定（Settings）］>［サブスクリプション設定（Subscription Settings）］の順に進みます。
［アプリケーション（Applications）］タブを開き、関連するアプリケーションを見つけます。これにより、デフォルトで［アプリの詳細（App Details）］ タブが開きます。
［ガイドロジックのプラグインを有効にする（Enable Guide Logic Plugin）］というチェックボックスを選択します。

対象外のガイドステップのスキップ

ウォークスルーガイドでこの動作を使用すると、より大きなガイドフロー内でレンダリングに失敗する可能性のあるステップを回避できます。一般的な例としては、ユーザーの役割やアプリ内の構成によっては存在しない場合がある要素にターゲットを絞ったガイドステップが挙げられます。

ビジュアルデザインスタジオ（Visual Design Studio）で、確認が必要なステップの前のaria-label入力フィールドに次の構文を入力します。

注：この構文はガイドの最初のステップでは機能しないため、表示対象外のステップの前のステップに表示させてください。

構文説明

{skipStep: auto/}

次のステップあるいは前のステップのアクションによって、ガイドが対象外のステップに移動した場合、代わりに次のあるいは前の対象のステップに進みます。

現在のステップから移動する際に、特定の方向に対象のステップがない場合は、ガイドを閉じます。

{skipStep: [number]/}

次のステップあるいは前のステップのアクションによって、ガイドが対象外のステップに移動した場合、代わりにステップ番号によって示される特定の定められたステップに進みます。

たとえば、ガイドが適さないステップに遭遇した場合、構文{skipStep: 7/}によって、ガイドを強制的にステップ7に移動させることができます。

対象となるステップの確認は、{skipStep}構文のステップがあるページで行われます。この確認を別のページで行うには、移動後に訪問者に表示されるページにステップを追加します。{skipStep}は移動を実行しないため、この確認は移動前に実行されます。

ガイドのaria-labelにこの構文が設定されると、ガイドステップの右下に所定のアイコンが表示されます。ガイドがプレビューもしくは公開中になると、このアイコンは消えます。

条件に応じたガイドの分岐

この動作を使用して、複数選択式の投票とアンケート調査への回答に基づいて、同じガイド内のあるステップから別のステップにユーザーを誘導することができます。

ガイドステップで条件に応じたガイドの分岐を有効にするには、次の2つのマークダウンタグが必要です。

構文説明

{branching/}

このタグを使用すると、ガイドは対象外の手順をスキップして、次または前の対象手順に移動できます。特定の方向に対象となるステップがない場合、ガイドは終了します。

この構文を複数選択式の投票とアンケート調査の質問タイトルに追加して、特定の投票とアンケート調査の条件に応じた分岐を有効化することを示します。

投票とアンケート調査の質問の横に分岐アイコンが表示され、分岐が有効であることを示します。ガイドがプレビュー済みまたは公開中になると、このアイコンは消えます。

注：このタグは現在、ラジオボタンによる複数選択式の投票とアンケート調査にのみ対応しており、ドロップダウン式には対応していません。

{goto- [number]/}

このタグを使用して、対象外のステップに進んだ際にガイドが移動すべき正確なステップ番号を指定します。

たとえば、{goto-7/}を使用すると、対象外のステップに進んだ場合にガイドはステップ7に移動します。

条件に応じた分岐を実装する

ビジュアルデザインスタジオ（Visual Design Studio）で、ラジオボタンを使用した複数選択式の投票とアンケート調査を作成します。ドロップダウン式は現在、条件に応じた分岐ではサポートされていません。
条件に応じた分岐を実装したい各ガイドステップに対して、適切なマークダウンタグを追加します。
1. 条件に応じた分岐を実装したい各ガイドステップのテキストブロック内に{branching/}タグを配置します。
2. ラジオボタンの回答内に{goto- [number]/}タグを挿入して、その回答が選択された際に移動するステップを指定します。

条件に応じたガイドの投票とアンケート調査を設置できるのは、ガイドステップごとに1つの投票とアンケート調査に限られます。{branching/}タグで複数の投票とアンケート調査を追加した場合、デザイナーはこれがサポートされていないことを示します。

必須の質問項目

この動作では、自由記入式の投票とアンケート調査、多項選択式の投票とアンケート調査、もしくは数字による投票とアンケート調査が「必須」とマークされます。これにより、ユーザーは指定された質問を完了しなければ、Pendoガイドの投票とアンケート調査を送信できなくなります。

構文	説明
`{required/}`	ビジュアルデザインスタジオ内で自由記入式の投票とアンケート調査、多項選択式の投票とアンケート調査、もしくは数字による投票とアンケート調査にこれを追加すると、指定された質問が完了するまで送信やガイドを進めるボタンがすべて無効になります。

適切な構文が追加されると、デザイナーと公開中のガイドの両方で、それぞれの質問の横に小さな赤いアスタリスクが表示されます。これは、その問題が必須としてマークされたことを示します。

ガイドがプレビューでレンダリング中、もしくは公開中の場合、ガイドの投票とアンケート調査を送信するボタンは、表示されたすべての質問が完了するまで無効になります。

ガイドのパーソナライズ

ビジュアルデザインスタジオ内のいずれかのガイドでこの動作を使用すると、Pendoエージェントのメタデータ値をガイドのテキストに動的に挿入することができます。これは、ガイドのレンダリング時にユーザーに表示される訪問者もしくはアカウントオブジェクトのあらゆるメタデータをサポートします。

構文説明

{[visitor/account].[fieldName]|[optionalFallback]/}

たとえば...

{visitor.name|Gary/}

ガイドのパーソナライズ構文は、訪問者もしくはアカウントオブジェクトの指定の後に、そのメタデータオブジェクトに存在する任意のフィールド名を指定できます。たとえば、アカウントのメタデータオブジェクトにcountryというフィールドがある場合、{account.country/}を指定すると、メタデータからその値を動的に挿入することができます。

この構文では、オプションでフォールバックパラメータも使用できます。したがって、上記の例でガイドを閲覧している特定のアカウントに国名が定義されていない場合、そのアカウントの国名メタデータフィールドが空白であれば、{account.country|your country/}と入力すると、「あなたの国名」という単語が表示されます。

特に、この構文はXLIFFファイルやPendoのローカリゼーションと互換性があります。したがって、XLIFFファイルには次のように指定します。

英語（米国）：Please tell us about your experience in {account.country|your country/}
日本語：{account.country|su país/}での経験についてお聞かせください

パーソナライズがアクティブな場合、ガイドのパーソナライズアイコンが表示されます。パーソナライズ効果は、デザイナーとガイドのプレビュー時もしくは公開時の両方で発生するためです。