ヘルプセンターの横串検索では、エンドユーザーのヘルプセンターの検索結果に、ヘルプセンター以外のコンテンツを含めることができます。つまり、エンドユーザーがヘルプセンターで検索した場合、検索結果にはヘルプセンターの記事やコミュニティの投稿だけではなく、外部のコンテンツも表示されます。横串検索では、外部のナレッジベース、学習管理ソフトウェア、ブログ、Webサイトのページなどにも検索対象を広げることができます。また、エンドユーザーは、ブログ記事などのタイプ別に検索を行うことができます。
外部コンテンツの検索結果は、ヘルプセンターの検索、コンテキストパネルのナレッジベースセクション、および統合検索APIレスポンスに表示されます。瞬時に検索や記事検索APIなど、他の検索を使用するインターフェイスには表示されません。
ヘルプセンターに横串検索を実装するには、以下のいずれかの方法を使用します。
- Webクローラー：Webクローラーを使えば、開発者の手を借りずに、ヘルプセンターに横串検索を実装することができます。ヘルプセンターの検索設定で複数のクローラーを設定して、同一Webサイトまたは異なるWebサイトのさまざまなコンテンツをクロールし、インデックスを作成することができます。
- 横串検索API：このREST APIを使えば、Zendeskの検索インデックスに外部コンテンツのレコードを取り込むことができます。この方法では、外部コンテンツをホストするサイトとヘルプセンターを統合するために、開発者がミドルウェア層を構築し、維持する必要があります。
APIとクローラーは同時に使用することができます。ただし、API経由でソースやタイプを削除した場合、削除されたソースまたはタイプのレコードを作成または更新しているクローラーは動作しなくなります。
この記事では、次のトピックについて説明します。
Webクローラーのしくみ
ヘルプセンターで検索するユーザーが利用できるように、同じWebサイトや様々なWebサイトから外部のコンテンツをクロールし、インデックスを作成するWebクローラーを1つまたは複数設定できます。
横串検索用のWebクローラーを設定するには、「外部コンテンツをインデックス化するためのWebクローラーの活用」を参照してください。
横串検索APIメソッドのしくみ
Zendeskが提供するREST APIを使用すると、開発者はカスタムインテグレーションを構築し、外部のコンテンツレコードをヘルプセンターの検索インデックスに取り込むことができます。外部コンテンツを検索結果に取り込むには、外部コンテンツをホストするアプリケーションと外部コンテンツAPIを開発者が統合する必要があります。
APIを使用して横串検索を設定するには、Zendesk REST APIと連携する独自のインテグレーションを構築し、検索結果に表示したいコンテンツを取り込む必要があります。詳しくは「Federated Search APIリファレンス」を参照してください。
横串検索を設定したら、ヘルプセンターの検索結果に含めるコンテンツと除外するコンテンツを選択する必要があります。詳しくは「ヘルプセンターの検索結果に外部コンテンツを含める方法」を参照してください。
エージェントのコンテキストパネルのナレッジベースセクションでは、外部コンテンツを検索結果に含めることもできます。詳しくは「コンテキストパネルのナレッジベースセクションの設定」を参照してください。
外部コンテンツのソースおよびタイプ
設定方法に関係なく、横串検索によって取り込まれた各コンテンツレコードは、コンテンツソースとコンテンツタイプに関連付けられ、エンドユーザーが検索結果をフィルター処理するために使用されます。ソースとは、フォーラム、問題のトラッカー、学習管理システムなどの外部コンテンツのソースを指します。タイプとは、ブログ投稿、テクニカルノート、バグレポートなど、コンテンツの種類を示します。詳しくは「ヘルプセンターにおける外部コンテンツのソースとタイプのフィルター管理」を参照してください。
ソースとタイプの定義は、横串検索APIを使用するか、またはWebクローラーを設定するときに行うことができます。APIを使用してソースとタイプを定義すると、Webクローラーの設定時にソースやタイプを選択できるようになります。同様に、Webクローラーを設定するときにコンテンツソースとタイプを作成すると、External Content Types APIとExternal Content Sources APIに反映されます。
検索結果に外部コンテンツソースを含めるかどうかを設定することができます。ヘルプセンターの検索に外部コンテンツが含まれる場合、検索フィルターによってコンテンツがソース名とタイプ名別にグループ化されて表示されるため、探している情報を見つけやすくなります。「ソース」は、コンテンツを作成元（ブログなど）でグループ化し、「タイプ」はコンテンツの種類（開発者向けドキュメントなど）でグループ化します。
外部コンテンツのソースとタイプを作成する際は、エンドユーザーがヘルプセンターの検索で目的のコンテンツを簡単に見つけられるようなグループ分けと名前を検討してください。