1. Search開発者

REST APIを使用した統合

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

WebサイトまたはアプリケーションをSitecore Searchと統合するために利用できる方法の1つは、REST APIを使用することです。

メモ

組織にJSS Next.jsまたはJSS AngularアプリケーションがSitecore XM Cloudに接続されている場合は、Sitecore Cloudを使用してXM CloudサイトにSitecore Search関連の機能を実装します。 SDKです。 Cloud SDKとSitecore Search REST APIの比較も参照してください。

Searchには、統合用に次のAPIが用意されています。

  • Search and Recommendation - Search and Recommendation APIを使用して、顧客向けの検索エクスペリエンスを作成します。検索結果の取得、フィルタリング、並べ替え、パーソナライズ、コンテンツの提案などを行うことができます。

    Search and Recommendation APIを使用する場合は、詳細なデータモデルとオブジェクトとキーの説明については、APIリファレンス を参照してください。

  • イベント - イベントAPIを使用して、ウェブサイトやモバイルアプリでの訪問者のアクションやその他のイベントをキャプチャしてレポートします。イベントは、SearchのAIコアで使用される重要なシグナルの1つです。

    イベントAPIを使用する場合は、すべてのオブジェクトとキーの詳細なデータモデルと説明については、APIリファレンス を参照してください。

  • 認証 - 認証APIを使用して、Searchへの要求の認証に使用できるキーまたはトークンを取得します。これは、サブドメインがない場合にのみ適用されます。

一般的なAPI統合フロー

APIを使用してSearchと統合するときに実行する一般的なワークフローを次に示します。

  1. サブドメインがない場合は、APIキーまたはアクセス トークンを取得します。サブドメインがある場合は、認証は必要ありません。

  2. 各訪問者の 匿名の一意の識別子 を作成する方法を計画します。

    これは厳密に必須ではありませんが、複数のセッションにまたがる訪問者にリクエストを結び付けるために、各訪問者の匿名識別子を作成して送信することを強くお勧めします。これにより、パーソナライズされた検索結果を提供し、分析を生成できます。

  3. 管理者から次の情報を収集します。

    • 目的の検索エクスペリエンスを作成するために必要なウィジェットとページ。たとえば、ビジネス要件は、会社のホーム ページには全ページ検索を表示し、各業種のページにはpreview searchのみを表示することです。

    • 検索エクスペリエンスごとに使用できるようにする必要があるコンテンツ。ドメインの インデックスに登録されたコンテンツ のすべてを、すべての検索エクスペリエンスで使用できるとは限りません。たとえば、会社のホーム ページでのページ全体検索では、使用可能なすべてのコンテンツを検索する必要がある場合があります。ただし、業種のページでのpreview searchでは、その業種に関連するコンテンツのみを検索する必要がある場合があります。

    • 各検索エクスペリエンスに必要な機能 (facets、並べ替えなど)、およびこれらの機能の構成方法。

      手記

      管理者はSearchで多くの機能を構成しますが、実行時に一部の設定を渡す必要がある場合があります。

  4. Search and Recommendation APIへのテスト要求を作成します。この時点で、応答も調査し、検索エクスペリエンスの作成に使用する部分を特定します。

  5. アプリケーションで、Search and Recommendation APIへの要求を作成するコードを追加します。また、検索エクスペリエンスを作成するために必要な応答の部分を取得するコードを追加します。

    ユースケースを検討し、APIリファレンスのデータモデルを調べてリクエストを作成します。

  6. イベントAPIにリクエストを送信するコードを追加します。訪問者が実行するアクションに基づいて可能なイベントは数多くあります。

    ユースケースを検討し、APIリファレンスのデータモデルを調べてリクエストを作成します。

  7. WebサイトまたはアプリをDeployします。

    ウェブサイトまたはアプリがデプロイされたら、イベントを監視 し、イベントAPIに送信するリクエストを調整できます。

    手記

    アプリケーションに含まれる可能性のある他の検索も無効にすることをお勧めします。これは、多くのクローラーがコンテンツをクロールするストレスを軽減するためです。

訪問者が検索ページにアクセスし、検索、ファセットの選択、フィルター処理、content itemをクリックするユース ケースを処理するための サンプル要求を含むチュートリアル を作成しました。

この記事を改善するための提案がある場合は、 お知らせください!