1. Sitecore Searchインターフェイス

API Explorerタブ

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

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

Sitecore SearchのDeveloper ResourcesページにあるAPI Explorerタブは、開発者がデータに対して要求を作成して実行する場所です。これは、search and recommendation APIをライブでインタラクティブに操作する方法です。このトピックでは、このツールを使用する多くの方法の一部について説明します。

API Explorerタブは、Builderペイン、Requestペイン、Responseペインの3つのペインに分かれています。

建てる

Buildペインで、API要求の値を入力または選択できます。

Sitecore Search実装は、各ページに要件を満たすウィジェットがあるページ用に構成されます。ページに設定されたURLまたはURLパターンによって、そのコンテンツが決まります。ページを選択すると、そのページを構成するURLまたはURLパターンがBuildペインのURL入力フィールドに設定されます。

メモ

API Explorerは、preview searchウィジェットによって行われたAPI要求がページに含まれていないため、作成できません。Buildは、ページに対するAPI要求のみを構築できます。

リクエストを表示するには、Buildをクリックします。要求がRequestペインに表示されます。

Request

このペインでは、リクエストがJSON形式で表示されます。このペインでJSONを直接編集できます。

次のコードは、要求の例です。

{
    "context": {
        "page": {
            "uri": "/search"
        },
        "user": {
            "user_id": "12145"
        }
    },
    "widget": {
        "rfkid": "rfkid_7"
    },
    "content": {
        "product": {}
    }
}
手記

エラーは、リクエストにクエリに関連する値が欠落している場合に設定または更新する必要がある値を示します。

ペインの右上にあるClick して、ペインのサイズを大きくします。

要求をエクスポートするには、Copy to Clipboardをクリックし、次のオプションから選択します。

  • Copy as cURL using Sitecore host

  • Copy as cURL using your subdomain

  • Copy as data objectコードで使用します。

リクエストをテストするには、Runをクリックします。応答がResponseペインに表示されます。

大事な

検索エクスペリエンスの中断を避けるために、APIは失敗しないように設計されています。利用可能な情報に基づいて、常に次善の結果セットが返されます。

応答

要求に対するJSON応答がこのペインに表示されます。JSONを折りたたんだり展開したりして、構造を表示し、応答を確認できます。応答をエクスポートするには、Copy to Clipboardをクリックし、Copy as data objectをクリックします。

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