ヘルプセンターの横串検索では、エンドユーザーのヘルプセンターの検索結果に、ヘルプセンター以外のコンテンツを含めることができます。つまり、エンドユーザーがヘルプセンターで検索した場合、検索結果にはヘルプセンターの記事やコミュニティの投稿だけではなく、外部のコンテンツも表示されます。横串検索では、外部のナレッジベース、学習管理ソフトウェア、ブログ、Webサイトのページなどにも検索対象を広げることができます。また、エンドユーザーは、ブログ記事などのタイプ別に検索を行うことができます。
ヘルプセンターに横串検索を実装するには、以下のいずれかの方法を使用します。
- 横串検索API：Zendeskの検索インデックスに外部コンテンツのレコードを取り込むことができるREST APIです。この方法では、外部コンテンツをホストするサイトとヘルプセンターを統合するために、開発者がミドルウェア層を構築し、維持する必要があります。
- 検索クローラー：Guideの検索設定で構成可能な検索クローラーを使用すると、開発者リソースを使わずにヘルプセンターに横串検索を実装できます。ヘルプセンターの検索設定で複数のクローラーを設定して、同一Webサイトまたは異なるWebサイトのさまざまなコンテンツをクロールし、インデックスを作成することができます。
APIとクローラーは同時に使用することができます。ただし、API経由でソースやタイプを削除した場合、削除されたソースまたはタイプのレコードを作成または更新しているクローラーは動作しなくなります。
この記事では、次のトピックについて説明します。
検索クローラーのしくみ
ヘルプセンターで検索したユーザーが利用できるようにするために、外部のコンテンツをクロールしてインデックスを作成する検索クローラーを1つまたは複数設定することができます。クロールする外部サイトには、検索クローラー用のページをリストアップしたサイトマップが必要です。さらに、クロールするページは、パブリック（非認証）である必要があります。認証済みコンテンツをヘルプセンターの検索に追加する場合は、外部コンテンツAPIを使用する必要があります。
クローラーが設定されると、12時間から24時間ごとに1回、設定時に指定されたサイトマップ内のページにアクセスし、ヘルプセンターの検索インデックスにコンテンツを取り込みます。検索クローラーは、アコーディオンなどのUI要素によって非表示になっている場合でも、最初のページ読み込み時にページソース内のコンテンツをインデックス化します。ただし、検索クローラーはJavaScriptを実行しないため、JavaScriptによってレンダリングされたコンテンツや、最初のページの読み込み後に動的にレンダリングされるコンテンツはクロールしません。検索クローラーは、訪問したページのリンクをクロールすることはなく、使用するように設定されたサイトマップ内のページのみを訪問します。
複数のクローラーを設定して、同じWebサイトまたは異なるWebサイトの異なるコンテンツをクロールおよびインデックス化することができます。詳しくは「検索クローラーの設定」を参照してください。
横串検索APIのしくみ
Zendeskが提供するREST APIを使用すると、開発者はカスタムインテグレーションを構築し、外部のコンテンツレコードをヘルプセンターの検索インデックスに取り込むことができます。外部コンテンツを検索結果に取り込むには、外部コンテンツをホストするアプリケーションと外部コンテンツAPIを開発者が統合する必要があります。
一度設定すると、APIは外部コンテンツのレコードを取り込み、ヘルプセンターの検索インデックスに追加します。インデックス化されたレコードは、ユーザーの検索クエリに応答するときに、ヘルプセンターの検索エンジンで利用できるようになります。
詳細については、「Zendesk横串検索APIの設定」を参照してください。
外部コンテンツのソースおよびタイプ
設定方法に関係なく、横串検索によって取り込まれた各コンテンツレコードは、コンテンツソースとコンテンツタイプに関連付けられ、エンドユーザーが検索結果をフィルター処理するために使用されます。詳しくは「検索フィルターの編集」を参照してください。
ソースとタイプの定義は、横串検索APIを使用するか、またはGuideで検索クローラーを設定するときに行うことができます。APIを使用してソースとタイプを定義すると、検索クローラーの設定時にソースやタイプを選択できるようになります。同様に、検索クローラーを設定するときにコンテンツソースとタイプを作成すると、external_content_type APIとexternal_content_source APIに反映されます。「Zendesk横串検索APIリファレンス」を参照してください。
検索結果に外部コンテンツソースを含めるかどうかを設定することができます。ヘルプセンターの検索に外部コンテンツが含まれる場合、検索フィルターによってコンテンツがソース名とタイプ名別にグループ化されて表示されるため、探している情報を見つけやすくなります。「ソース」は、コンテンツを作成元（ブログなど）でグループ化し、「タイプ」はコンテンツの種類（開発者向けドキュメントなど）でグループ化します。
外部コンテンツのソースとタイプを作成する際は、エンドユーザーがヘルプセンターの検索で目的のコンテンツを簡単に見つけられるようなグループ分けと名前を検討してください。詳しくは「検索フィルターの編集」を参照してください。
横串検索の既知の制限事項
現在のところ、横串検索には以下のような制限があります。
-
外部コンテンツの検索結果は、ヘルプセンターの検索、コンテキストパネルのナレッジベースセクション、および統合検索APIレスポンスに表示されます。瞬時に検索や記事検索APIなど、他のGuide検索を使用するインターフェイスには表示されません。
0 コメント
サインインしてコメントを残してください。