この記事では、ガイド表示の問題や設定エラーなどのアプリのトラブルシューティングを行うために、Pendoエージェントデバッガーにアクセスして使用する方法を説明します。また、ガイドを強制的に複数回表示したいなどの場合は、デバッガーを使用してテストすることもできます。
エージェントデバッガーにアクセスする
デバッガーへのアクセス方法は、実装によって異なります。
- インストールスクリプトを通じてアプリケーションにPendoを直接実装している場合は、この記事のインストールスクリプトへのアクセスの手順に従ってください。
- Pendo Launcherブラウザ拡張機能を使用してPendoをデプロイしている場合は、この記事のブラウザ拡張機能へのアクセスの手順に従ってください。
インストールスクリプトへのアクセス
- [設定(Settings)]>[サブスクリプション設定(Subscription Settings)]の順に進みます。
- [アプリケーション]タブを開きます。
- [アプリケーション]リストから該当するアプリを見つけて開きます。
-
[エージェント設定(Agent Settings)]より、[ステージング(Staging)]環境または[本番(Production)]環境で[デバッグ(Debug)]を選択します。
- [Pendoエージェントデバッガーの起動(Launch Pendo agent debugger)]ウィンドウで、デバッガーを開きたいアプリのURLを入力して[デバッガーを起動(Launch debugger)]を選択します。
ブラウザ拡張機能へのアクセス
- ブラウザの右上にあるPendo Launcherのシェブロンアイコンを右クリックします。
- ドロップダウンメニューから[エージェントデバッガーを表示(Show Agent Debugger)]を選択します。
アラートタブ
[アラート(Alerts)]タブには、アプリケーションの健全性の概要が表示されます。これにより、ガイドやアプリケーションのインストールにエラーや問題があるかどうかがわかります。ただし、すべての問題に対処できるとは限りません。また、問題に対してアクションを起こさないと決めることもできます。
- さらに詳細な情報を表示するには、[詳細を表示(View Details)]を選択します。これにより、エラーまたは問題に関連するデバッガーのタブが開きます。タブには、[構成(Config)]、[イベント(Events)]、[ガイド(Guides)]、[リソースセンター(Resource Center)]などが含まれます。
- [ヘルプを利用する(Get help)]を選択して、エラーまたは問題に関連するドキュメントを表示します。
構成タブ
[構成]タブに表示される情報を使用して、アプリのセットアップと構成を検証します。サブスクリプション設定や現在の訪問者情報など、Pendoエージェントの構成に関する情報が表示されます。これは、ガイドのトラブルシューティングやインストールの検証に有効です。また、この情報はセットアップが想定どおりであるかどうかを検証するのにも役立ちます。
[構成]タブには以下のセクションがあり、見出し行の左端にあるプラス(+)アイコンを選択すると展開できます。
環境
環境は、本番環境またはステージング環境に設定できます。ガイドが本番環境にある場合は、ステージング環境にも表示されます。
APIキーが正しいことを確認します。APIキーは、お客様のPendoアプリに固有のものです。正しいAPIキーであることを確認するには、[設定]>[サブスクリプション設定]に移動し、[アプリケーション]タブを開いて該当するアプリケーションを開きます。デフォルトでは[アプリの詳細(App Details)]タブが開き、そこでAPIキーを確認できます。
APIキーが一致し、複数アプリのサブスクリプションがある場合は、Pendoの左側のメニューから[ガイド]を開き、[アプリ(App)]列でガイドを見つけます。先ほどAPIキーを確認したアプリに登録されていることを確認してください。
訪問者とアカウントのメタデータ
[訪問者メタデータ(Visitor metadata)]と[アカウントメタデータ(Account metadata)]のセクションがあります。現在の訪問者に対してアプリケーションがPendoに渡している訪問者とアカウントのメタデータを確認します。メタデータ値が、テストしているガイドに適用されているセグメント内に収まっていることを確認してください。
デバッガーを使用して現在の訪問者IDを見つけ、その訪問者IDにのみ適用されるセグメントを作成することもできます。これにより、他のユーザーに見られることなく本番環境でガイドをテストすることができます。
フレーム
アプリケーションが使用しているiframeに関する情報を確認します。複数のiframeがある場合は、それぞれを選択して情報を表示できます。
設定
技術管理者がアプリの構成について詳しく知るために、詳細情報を見ることができます。すべての構成の詳細については、agent.pendo.ioを参照してください。
プラグイン
この情報を使用して、テキストキャプチャ、ガイドのマークダウン、セッションリプレイなど、Pendoエージェントに想定される機能があるかどうかを確認します。
高度な設定
Pendoサポートが技術情報を表示し、トラブルシューティングできます。このセクションでは、アプリの組み込み機能をリセットできます。
イベントタブ
[イベント]タブを使用して、Pendoがリアルタイムでトラックイベントとクリック数を正しく登録していることを検証します。このタブでは、Pendoを最初にインストールする際の重要な情報も提供されます。デフォルトでは、タブは空の状態です。
[イベントログを有効にする(Enable event logging)]を選択すると、サイトのテスト中にイベントをリアルタイムで表示します。各イベントを展開すると、訪問者ID、アカウントID、ページのURLなど、イベントに関する情報が表示されます。
[ページのURL(Page URL)]は、表示されているページからPendoが認識している正規化されたURLです。ガイドが特定のページに設定されている場合は、デバッガーからURLをコピーしてPendoの[ページ(Pages)]に移動し、ガイドが設定されているページを選択します。
ページには少なくとも1件のルールがあります。各ページルールの右側にある[ルールをテスト(Test Rule)]を選択します。[テストURL(Test URL)]ボックスにデバッガーでコピーしたURLを貼り付けます。URLがどのページルールとも一致しない場合、デバッガーが読み込まれているページは、ガイドが設定されているページに一致しません。
URLとページのタグ付けの詳細については、ページのタグ付けを行うURLを参照してください。
ガイドタブ
ガイドタブを使用して、ガイドまたはガイド内のステップが表示されない問題のトラブルシューティングを行います。ガイドタブは、[スロットリング(Throttling)]、[最終表示(Last seen)]、[アクティブなガイド(Active guides)]、および[除外されたガイド(Excluded guides)]セクションで構成されます。
スロットリング
[スロットリング]セクションでは、スロットリングが設定されているかどうか、その設定、およびガイドの順序が表示されます。また、Pendoの左側のメニューから[ガイド]>[順序(Ordering)]に移動すると、スロットリングの設定とガイドの順序を確認できます。
スロットリングが「オン」かつガイドが「自動アクティベーション」に設定されている場合、そのスロットリング期間が完了するまでガイドは表示されません。
ガイドの順序リストの一番上にガイドが表示されておらず、自動アクティベーションに設定されている場合、順序が上の自動ガイドが最初に表示されるまで、ガイドは表示されません。詳細については、ガイドの順序設定とスロットリングを参照してください。
最終表示
[ガイドの最終表示(Guide Last Seen)]セクションには、訪問者IDが表示できるガイドに関する情報(ガイドID、ガイドステップID、ガイドの最終表示日時、ガイドのステータスなど)が表示されます。
訪問者IDは[最終表示]セクションの下部にあります。IDが匿名の場合は、「_PENDO_T_XXXX」の形式で表示されます。「XXXX」はランダムな文字列です。
注:セグメントが[全員(Everyone)]に設定され、訪問者IDが匿名の場合は、アプリケーション設定で[匿名の訪問者にガイドを表示(Show guide to anonymous visitors)]がオンになっていることを確認してください。この設定をオンにした後は、匿名の訪問者に表示する各ガイドのセグメントを再び保存する必要があります。
アクティブなガイド
アクティブなガイドとは、ページとセグメントに基づいて現在の訪問者が利用できるすべてのガイドのことです。読み込む予定のガイドがリストにある場合、訪問者はガイドのセグメントに適合し、URLもガイドが設定されているページと一致します。
ガイドの横にあるプラス(+)記号を選択すると、そのガイドの詳細が表示されます。ガイドの詳細には、以下の情報が含まれています。
- 名前(Name):ガイドのタイトル。
- ID:ガイドの一意の識別子。
- 状態(State):公開、ステージング、ドラフトなどのガイドのステータス。ガイドのステータスの詳細については、ガイドの作成を参照してください。
- 起動方法(Launch method):ガイドがアクティブ化される方法(バッジまたは自動)。ガイドのアクティベーションの詳細については、ガイドのアクティベーションオプションを参照してください。
- 最終更新日(Last updated):ガイドが最後に更新された日時。
- デバイス(Device):ガイドが起動するよう設定されているデバイス。
- 表示されたステップ数(Steps seen):総ステップ数のうち、表示されたステップ数。たとえば、1/2は、ガイドの2つのステップのうち1つが表示されたことを示します。
- 言語(Language):ガイドの言語。たとえば、en-USは、ガイドがアメリカ英語に設定されたことを示します。
- 共有サービスバージョン(Shared service version):Pendoガイドのバージョン。
ガイドの各ステップに関する情報は、ガイドの詳細の下にあるセクションに表示され、ステップ1、ステップ2などのラベルが付けられます。ガイド内の各ステップで利用可能な情報には、そのIDとタイプ、最後に表示および更新された日時、表示されたかどうかとその理由、ページターゲットの正規表現、「次を含む」ルール、およびそのステップのターゲットとトリガー要素が含まれます。
問題:アクティブなガイドが起動しない
[アクティブなガイドのリスト(Active Guides List)]にガイドが表示されない場合は、ガイドの[起動方法]を確認してください。
[起動方法]が、ガイドが自動的にアクティブ化されることを示す[自動(auto)]で、[表示されたステップ数]が0より大きい場合、ガイドは表示されません。これは、自動的にアクティブ化されたガイドは閉じられるまで一度しか表示されないためです。テスト用にこれを上書きするには、ガイドの詳細の上にある[ガイドの起動(Launch Guide)]ボタンを選択します。ガイドの自動起動の詳細については、ガイドのアクティベーションオプションを参照してください。
[起動方法]が[バッジ(badge)]または[DOM(dom)]で、ガイドがターゲット要素を通じてアクティブ化されることを示している場合は、ガイドの最初のステップの詳細を確認してください。[ターゲット要素(Target element)]の横に赤い十字(x)があり、[見つかりません(not found)]などの文言がある場合は、Pendoが現在のページでガイドが紐づけられている要素を見つけられなかったことを示します。ページ上に要素が表示されている場合は、以下のいずれかの方法でタグを付け直してみてください。
- ビジュアルデザインスタジオ(Visual Design Studio)を開き、そこから要素をターゲットとして再設定します。
- CSSとHTMLの知識がある場合、DOMで要素を見つけて、CSSセレクターに適合するかどうかを確認します。
- Chromeの[検証(Inspect)]ツールの知識がある場合、コンソールの関数
pendo.Sizzle(‘CSSselector’)
を使用して、CSSセレクターがページ上の要素に適合するかどうかを確認します。複数の要素に適合する場合、PendoはガイドをDOMの最初の要素に添付します。
起動の問題が引き続き発生する場合は、以下の点を確認してください。
- ガイド内の各ステップに問題がないか。
- ガイドの順序設定とスロットリング。
- [構成]タブのページ設定。[フレーム(Frame)] > [フレームhref(Frame href)]にリストされているURLが、想定されるURLと一致していることを確認します。
問題:ガイドのステップが表示されない
ガイドが想定どおりに起動しても、いずれかのステップが表示されない場合は、ガイドを再起動して、表示されないステップの前のステップに到達するまで進みます。次に、デバッガーでガイドの詳細と次のステップの詳細を調べます。ガイドの次のステップに進む前に、要素とページの設定が一致していることを確認してください。一致しない場合、デバッガーはステップの詳細の該当する行の横に赤い十字(x)と短いメッセージを表示します。
除外されたガイド
除外されたガイドは、現在の訪問者が対象外であるすべてのガイドです。リスト内の除外されたガイドには、それぞれ以下の情報が含まれています。
- ガイドにハイパーリンクされた一意の識別子。
- 除外された理由。たとえば、現在の訪問者がセグメントに適合しない場合や、現在のURLがガイドのステップの場所と一致しない場合などがあります。
リソースセンタータブ
[リソースセンター]タブを使用して、モジュールのアクティビティ(どのモジュールにもガイドが表示されないなど)を監視し、トラブルシューティングを行います。
最初のセクションはホームビューで、リソースセンターの最初の画面を指します。他の各セクションは、リソースセンター内のモジュールに対応しています。
リソースセンターでガイド表示の問題を解決するには、まずデバッガーの[リソースセンター]タブで[オンボーディング(Onboarding)]または[ガイドリスト(Guide List)]モジュールを確認します。
- [コンテンツ有り(Has Content)]設定が[いいえ(No)]に設定されていることを確認します。これは、そのモジュールには表示可能なガイドがないことを意味します。ガイドが子ヘッダーの下に表示されているかどうかを確認します。
- ガイドがリストにあり、ペイロードにあると表示されている場合は、モジュールに適用されているセグメントが[構成]タブの訪問者メタデータに適用されていることを確認します。
- ガイドがリストにない場合は、Pendoのリソースセンターに移動し、ガイドがそのモジュールに含まれていること、およびガイドが適切な環境(ステージングまたは本番)にプッシュされていることを確認します。
さらなるトラブルシューティング
トラブルシューティングについてさらにサポートが必要な場合は、テクニカルサポートにお問い合わせください。詳細については、テクニカルサポートチームにPendoに関する問い合わせをするを参照してください。