この記事では、ステージング環境や本番環境でガイドが期待通りに表示されない原因を確認します。
この記事では、便利なデバッガーツールを起動し、ガイド表示の問題をトラブルシューティングする方法について説明します。
デバッガーの読み込み
1.ブラウザウィンドウでウェブアプリページを右クリックし、[検証(Inspect)]をクリックします。
2. ブラウザ開発者ツールが表示されます。[コンソール]タブを見つけて開き、pendo.enableDebugging()
と入力してEnterキーを押します。後でデバッガーを無効にするには、pendo.disableDebugging()
を使用します。
3. 画面の左上に小さな赤い虫が表示されます。それを選択すると、デバッガーが開きます。
4. デバッガーがブラウザーのサイドナビゲーションバーとして読み込まれます。7つのセクションで構成されています。この記事では、[エージェント(Agent)]、[ガイド], [スロットリング(Throttling)]、[リソースセンター]を取り上げます。
エージェント
[エージェント]セクションには、サブスクリプションの設定や現在の訪問者の情報など、ガイドのトラブルシューティングだけでなく、インストールの検証にも役立つさまざまなデータが表示されます。
1. 現在の訪問者に対してアプリケーションがPendoに渡している訪問者とアカウントのメタデータを確認します。
メタデータの値が、テストしているガイドに適用されているセグメント内に収まっていることを確認してください。
また、これを使って現在の訪問者IDを調べ、その訪問者IDだけに適用されるセグメントを作成すれば、他の人に見られることなく本番環境でガイドをテストすることができます。
2. ガイドが現在のテストに適した環境に設定されていることを確認します(本番環境またはステージング環境)。
ガイドが本番環境にある場合は、ステージング環境にも表示されます。
3. 正しいAPIキーがあることを確認します。
APIキーは、お客様のPendoアプリに固有のものになります。正しいキーであることを確認するには、[設定(Settings)] > [サブスクリプション設定(Subscription Settings)]>[アプリの詳細を表示(View App Details)]に移動し、[基本設定(Basic Settings)]でAPIキーを探して確認してください。
一致し、マルチアプリのサブスクリプションをお持ちの場合は、左側のナビゲーションから [ガイド(Guides)]ページに移動し、[アプリ(App)]の列でガイドを探し、先ほどAPIキーを確認したアプリの下に登録されていることを確認してください。
4. ページルールをテストします。
[現在のURL(Current URL)]は、表示されているページからPendoが認識している正規化されたURLです。
ガイドが特定のページに設定されている場合は、デバッグで現在のURLをコピーしてPendoの[ページ(Pages)]に移動し、ガイドが設定されているページをクリックします。そのページには少なくとも1つのルールがあるはずです。
各ページルールの右側にある[ルールのテスト(Test Rule)]を選択します。[テストURL(Test Url)]ボックスにデバッガーでコピーした現在のURLを貼り付けます。現在のURLがどのページルールとも一致しない場合、デバッガーが読み込まれているページは、ガイドが設定されているページに合致しません。
URLとページのタグ付けの詳細については、ページのタグ付けを行うURLについてを参照してください。
ガイド
[ガイド]セクションには、[アクティブなガイド(Active Guides)]と[除外されたガイド(Excluded Guides)]の2つのリストが表示されます。
[アクティブなガイド]は、ページとセグメントに基づいて現在の訪問者が利用できるすべてのガイドです。読み込む予定のガイドがこのリストにある場合は、現在の訪問者がガイドのセグメントに適合し、現在のURLがガイドが設定されているページと一致します。
[除外されたガイド]は、現在の訪問者が対象外であるすべてのガイドです。対象にならない理由は、以下のようにリストの各項目の下に表示されます。理由の例には、現在の訪問者がセグメントに適合しない場合や、現在のURLがそのガイドに設定されたステップの場所と一致しない場合などが挙げられます。
ガイドが[除外されたガイド(Excluded Guides)]リストになく、表示されない理由がわからない場合は、ガイドの横にあるプラス記号(+)をクリックして、ガイドの詳細を確認してください。
ガイドの詳細には、ガイドの各ステップに関連する情報が表示されます。ここでは、ガイドの詳細とステップセクションの両方で確認しておきたいことをご紹介します。
1.[起動(Launched)]フィールドが[自動(Automatic)]に設定され、[表示済み(Has Been Seen)]が[はい(True)]になっている。
この場合、自動アクティベーションではガイドが閉じられるまでに1回しか表示されないため、それ以降はガイドが表示されません。アクティベーション設定の詳細については、ガイドのアクティベーションオプション– ビジュアルデザインスタジオを参照してください。
2. [起動]にはバッジまたはDom(ターゲット要素のアクティベーション)のいずれかが含まれているが、ステップ1の詳細で、要素に赤で「表示されていません(not visible)」と表示される。
これは、Pendoが現在のページでガイドがタグ付けされている要素を見つけることができないことを意味します。ページに要素が表示されている場合は、Pendoデザイナー内で要素のタグを付け直してみてください。または、CSSとHTMLに精通している場合は、DOMで要素を見つけて、CSSセレクターに適合するかどうかを確認してください。
CSSセレクターがページ上の要素に適合するかどうかを確認するために、コンソールで使用できる関数pendo.Sizzle('CSSselector')
もあります。複数に適合する場合は、PendoはガイドをDOMの最初の要素に添付します。
4. 期待どおりにガイドが開始されても、ステップの1つが表示されない。
ガイドを再起動し、表示されないステップの直前まで進みます。デバッガーでガイドの詳細(特に次のステップの詳細)を調べて、要素またはページの設定が次のガイドステップと一致しているかどうかを確認します。一致しない場合は赤で表示されます。
要素の設定を確認するには、上記2の回答を参照してください。ページ設定を確認するには、上記のデバッガーの[エージェント]タブにある[現在のURL]情報のトラブルシューティングのヒントを参照してください。
5. 上記を行ってもガイドが表示されない問題が解決せず、ガイドが自動に設定されている場合は、スロットリングまたはガイドの順序が原因である可能性があります。
スロットリングとガイドの順序
スロットリングタブでは、スロットリングが設定されているかどうか、その設定、およびガイドの順序が表示されます。これらの情報は、[ガイド(Guides)]>[オーダー(Ordering)]でも確認できます。
スロットリングが有効で、ガイドが自動アクティベーションに設定されている場合、そのスロットリング期間が完了するまでガイドは表示されません。
2. ガイドの順序リストの一番上にガイドが表示されておらず、自動アクティベーションに設定されている場合、順序が上の自動ガイドが最初に表示されるまで、ガイドは表示されません。
詳細については、スロットリングと順序の設定を参照してください。
リソースセンター
リソースセンタータブは、ガイドタブと似ています。最初のブロックはホームビューで、リソースセンターを開いたときに最初に表示されるものです。以降の各ブロックは、リソースセンター内のモジュールに対応しています。
リソースセンターでのガイド表示の問題を解決するには、まずデバッガーのリソースセンタータブで、オンボーディングまたはガイドリストモジュールを確認します。
1. [コンテンツ有り(Has Content)]が[いいえ(False)]に設定されている
これは、そのモジュールには表示可能なガイドがないことを意味します。ガイドが子ヘッダーの下に表示されているかどうかを確認します。
ガイドがリストにあり、ペイロードにあると表示されている場合は、モジュールに適用されているセグメントが[エージェント]タブの訪問者メタデータに適用されていることを確認してください。
ガイドがリストにあり、ペイロードに含まれていないと表示されている場合は、[エージェント]タブに移動してさらにトラブルシューティングを行ってください。
ガイドがリストにない場合は、Pendo UIのリソースセンターに移動し、ガイドがそのモジュールに含まれていること、およびガイドが適切な環境(ステージングまたは本番)にプッシュされていることを確認してください。
さらなるトラブルシューティング
このチェックリストをご覧になっても問題が解決しない場合は、Pendoサポートまでご連絡ください。
デバッガーの無効化
完了したら、必ずデバッガーをオフにしてください。オフにするには、開発者ツールのコンソールでpendo.disableDebugging()
と入力します。