ヘルプセンターの横串検索の設定

Zendeskの横串検索を使用すると、エンドユーザーはヘルプセンターの検索結果に、ヘルプセンター以外のコンテンツを含めることができます。つまり、エンドユーザーがヘルプセンターで検索した場合、検索結果にはヘルプセンターの記事やコミュニティの投稿だけではなく、外部のコンテンツも表示されます。横串検索では、外部のナレッジベース、学習管理ソフトウェア、ブログ、Webサイトのページなどにも検索対象を広げることができます。また、エンドユーザーは、ブログ記事などのタイプ別に検索を行うことができます。

この記事では、次のトピックについて説明します。

横串検索の仕組み
外部レコードを横串検索に取り込む
横串検索を設定する
ヘルプセンターのテーマを横串検索用に設定する
横串検索の既知の制限事項

横串検索の仕組み

Zendeskの横串検索機能は、大きく分けて4つの部分から構成されています。

横串検索 - External Content Type API
ヘルプセンターの横串検索設定
テーマで検索結果をフィルタリングするための新しいCurlybarのヘルパー
Copenhagenテーマでの横串検索のサポート

ZendeskはREST APIを提供しており、検索コンテンツのレコードをZendesk検索インデックスに取り込むことができます（以下の図を参照）。これは、Zendesk REST APIを使った独自のカスタムインテグレーションを構築できるようにするためです（「複数のヘルプセンターをまたぐ検索の有効化」を参照）。

Zendes横串検索の説明図

外部レコードを横串検索に取り込む

最初のコンテンツを取り込むと、横串検索が表示されます。その後、ヘルプセンターの検索エンジンでインデックスを付けて、ランク付けしたいコンテンツレコードを取り込むことができます。これにより、ヘルプセンターのコンテンツと外部のコンテンツの両方を含む検索結果が、検索結果ページの統一された1つのランキングで表示されます。外部コンテンツを検索結果に取り込むには、外部コンテンツをホストするアプリケーションと外部コンテンツREST APIを統合する必要があります。エンドユーザーが外部コンテンツの検索結果をクリックすると、その外部コンテンツレコードのURLに移動します。

外部コンテンツレコードREST APIを使用すると、検索可能にしたいすべてのサードパーティコンテンツをヘルプセンター検索に取り込むことができます。詳細については、横串検索APIのリファレンスドキュメントで以下のトピックを参照してください。

Help Center APIに慣れている方なら、記事、投稿、トピックのプロパティの中に、外部コンテンツレコードと重なるものがいくつかあることに気づくでしょう。

各コンテンツレコードには、コンテンツソースオブジェクトとコンテンツタイプオブジェクトが関連付けられており、エンドユーザーによるフィルタリングを可能にするために使用されます。これは、記事や投稿をヘルプセンター別（複数のヘルプセンター検索を使用している場合）、タイプ別（articlesやcommunityなど）にフィルタリングできるのと同じ仕組みです。

Zendesk横串検索の外部オブジェクトAPIの図

外部コンテンツのレコード、タイプ、ソースにはそれぞれ固有のIDが与えられているので、ニーズに合わせて完全にカスタマイズすることができます。これにより、マルチプルヘルプセンター検索を使用する際にヘルプセンターで記事や投稿がグループ化されるのと同じように、外部レコードをグループ化することができます（「複数のヘルプセンターをまたぐ検索の有効化」を参照）。現在、既存の2つのタイプ（articlesとcommunity）のいずれか1つをフィルタリング用の外部レコードとして指定することはできません。

typesプロパティは、GuideとGatherの2つのタイプを拡張したもので、コンテンツ、記事、コミュニティの投稿を対象としています。

横串検索を設定する

検索結果に表示したいコンテンツを取り込むためには、Zendesk REST APIとのインテグレーションを独自に構築する必要があります。複数のヘルプセンターがある場合は、ヘルプセンターごとに利用可能なコンテンツソースを選択することもできます。

外部コンテンツをヘルプセンターで検索可能にするには

Guideで、サイドバーにある設定アイコン（）をクリックします。
「検索設定」>「横串検索」で「設定」をクリックします。
「横串検索の設定」の「外部コンテンツ」で、検索対象に含める外部コンテンツのチェックボックスを選択します。
「保存」をクリックします。
（オプション）同じ外部コンテンツを複数のヘルプセンターで検索できるようにしたい場合は、アカウントのドロップダウンメニューから、検索対象に追加したいヘルプセンターを選択します。ステップ1～4を繰り返します。

ヘルプセンターで外部コンテンツを検索できるようにした後、ナレッジベース結果を構成してナレッジベース検索に外部コンテンツが含まれるようにすることができます。「Zendeskエージェントワークスペースでのコンテキストパネルの設定」を参照してください。

ヘルプセンターのテーマを横串検索用に設定する

最初のコンテンツを取り込むと、横串検索のUIが表示され、ヘルプセンターで検索可能にするかどうかを管理できるようになります。複数のヘルプセンターがある場合は、どのコンテンツを検索可能にするか、どのヘルプセンターで検索するかを選択できます。

既存のガイドテーマをカスタマイズする

外部コンテンツがヘルプセンター検索の検索結果に表示されるようにするには、横串検索結果に対応したテーマが必要です。それには、最新バージョンのCopenhagenテーマを使うか、古い{{help_center_filters}}ヘルパーと{{filters}}ヘルパーを新しい{{source_filters}}ヘルパーと{{type_filters}}ヘルパーに置き換えてください（「ヘルプセンターのテンプレート言語のレシピ集」を参照）。

横串検索の既知の制限事項

現在のところ、横串検索には以下のような制限があります。

外部コンテンツの検索結果は、ヘルプセンターの検索とコンテキストパネルのナレッジベースでのみ表示され、瞬時に検索やArticle Search APIなどの他のGuide検索を利用したインターフェイスには表示されません。
既存の2つのタイプ（articlesとcommunity）のいずれか1つをフィルタリング用の外部レコードとして指定することはできません。