横串検索の外部コンテンツAPIは、Zendeskの検索インデックスに外部コンテンツのレコードを取り込むことができるREST APIです。この方法では、外部コンテンツをホストするサービスまたはサイトとヘルプセンターを統合するために、開発者がミドルウェア層を構築し、維持する必要があります。開発者の支援なしで横串検索を設定するには、外部コンテンツ検索クローラーを使用します。詳しくは「ヘルプセンターの横串検索について」を参照してください。
外部コンテンツAPIを使用して横串検索を設定する
外部コンテンツAPIを使用してヘルプセンターに横串検索を設定するには、以下のプロセスフローの手順を参考にしてください。
-
検索結果に表示したいコンテンツを取り込むためには、Zendesk REST APIとのインテグレーションを独自に構築します。詳しくは「Federated Search APIリファレンス」を参照してください。
-
ヘルプセンターの検索結果に含めるコンテンツと除外するコンテンツを選択します。詳しくは「ヘルプセンターの検索結果に外部コンテンツを含める方法」を参照してください。
-
ヘルプセンターのテーマを横串検索用に設定します。
外部コンテンツがヘルプセンター検索の検索結果に表示されるようにするには、横串検索結果に対応したテーマが必要です。それには、最新バージョンのCopenhagenテーマを使うか、古い{{help_center_filters}}と{{filters}}のヘルパーを新しい{{source_filters}}と{{type_filters}}のヘルパーに置き換えてください。詳しくは、テンプレート言語のリファレンスドキュメントの「検索結果」ページとヘルプセンターのテンプレート言語のレシピ集の「ヘルプセンターの検索に外部コンテンツを含めるために横串検索を追加する」を参照してください。
-
必要に応じて、ナレッジベース検索に外部コンテンツが含まれるようにナレッジベース結果を設定します。「コンテキストパネルでナレッジベースの設定を行う」を参照してください。