API Explorerを使用して検索要求をテストする
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore SearchのDeveloper Resourcesページの「API Explorer」タブを使用して、JSONリクエストを作成し、エンドポイントのSearchと推奨事項を使用してデータをフェッチAPIできます。
このチュートリアルでは、次の方法について説明します。
-
要求を作成します。
-
要求をViewします。
-
要求を実行し、応答をコピーします。
要求を作成する
このセクションでは、API Explorerの左側のペインを使用してリクエストを作成する方法について説明します。または、要求データオブジェクトをRequestペインに直接貼り付けて、Buildをクリックします。
要求ペインを作成するには:
-
メニューバーで、Developer Resourcesをクリックし、API Explorerタブをクリックします。
-
左側のペインのPageドロップダウンメニューで、テストするページを選択するには、そのページの名前をクリックします。
先端以前に作成したリクエストをクリアする場合は、左側のペインでResetをクリックします。
-
(オプション)応答を1つ以上のウィジェットに制限するには、Widgetフィールドをクリックし、表示されるドロップダウン リストでウィジェットを選択または選択解除します。選択したページに属するWidgetsは事前に選択されています。
-
Entityドロップダウンメニューで、エンティティをクリックします。
-
次の表に示すオプションのフィールドには、説明されている値を指定します。
畑
形容
Source
特定のソースからの結果を制限するには、それらを選択します。
Limit
結果の数を制限するには、値を入力します。
Offset
結果をスキップするには、スキップする数値を入力します。
-
次の表に示すオプションのセクションには、説明されている値を指定します。
Section
形容
Locale
ドメインで複数のロケールを使用している場合は、Country & Languageプルダウン メニューで国と言語をクリックします。
メモロケールを選択しない場合は、デフォルトのドメイン・ロケールが使用されます。
Query
Queryセクションでは、結果内の特定の単語を強調表示するように構成できます。HTMLタグを追加して、単語の書式を設定したり、動作 (インタラクティブ性など) を変更したりすることもできます。
結果でキーワードを強調表示するには、次のすべての操作を行います。
-
Keywordsフィールドにキーワードを入力します。
-
Highlight in attributeドロップダウンメニューで、属性をクリックします。
-
Highlight fragment sizeフィールドに、強調表示する最大文字数を入力します。
-
Highlight tagフィールドに、強調表示されたテキストの前後にHTMLタグを追加するには、タグを入力します。
Suggestion blocks
プレビュー検索ウィジェットは、訪問者が検索入力フィールドにキーワードを入力すると、候補を表示できます。
suggestion blockを追加するには、次のすべての操作を行います。
-
Click
Add Suggestion Blockブロックを選択します。 -
ブロックで、提案の数を制限するには、Maxフィールドに最大数を入力します。
Context/IDs
インデックス付き項目をクエリのコンテキストとして指定できます。たとえば、共同購入商品のrecommendationウィジェットのコンテキストとしてProduct Aを使用します。
エンティティを追加するには、次のすべてを実行します。
-
Click
Add Entity次に、エンティティを選択します。 -
エンティティの入力フィールドに、特定のインデックス付きアイテムを返すには、そのIDを入力します。
手記Content Collectionセクションでは、インデックス付きアイテムを参照してIDを確認できます。
Context/User
Personalizationと関連性は、Searchのコア機能です。 API Explorerでは、すべての要求には訪問者またはユーザーに関する情報が必要です。
訪問者またはユーザーをコンテキストとして提供するには、実装に応じて次のいずれかの操作を行います。
-
UUIDフィールドに、Sitecore別に訪問者またはユーザーに割り当てられたIDを入力します。
-
User IDフィールドに、訪問者またはユーザーに割り当てたIDを入力します。
手記Content Collectionセクションでは、訪問者のIDを参照できます。
オプションで、ユーザーグループをコンテキストとして提供するには、「 User groups 」フィールドに、訪問者またはユーザーに関連付けられているユーザーグループのIDを入力します。
Facet
facetsを指定するには、必要に応じて次のすべてを実行します。
-
すべてのファクトの結果を取得するには、Allチェック ボックスをオンにします。
-
Maxフィールドに、ファセット値の数を制限するには、最大数を入力します。デフォルトは100です。ただし、テストの目的で、この数をさらに制限することをお勧めします。
-
Sortドロップダウンメニューで、TextまたはCountをクリックします。
-
特定のファセットを含めるには、
Add Facetをクリックしてファセットを選択し、選択したファセットに対して必要に応じて次の操作を行います。-
UUIDフィールドに、Sitecore別に訪問者またはユーザーに割り当てられたIDを入力します。
-
Maxフィールドに、ファセット値の数を制限するには、最大数を入力します。デフォルトは100です。ただし、テストの目的で、この数をさらに制限することをお勧めします。
-
Sortドロップダウンメニューで、TextまたはCountをクリックします。
-
Sort
並べ替えオプションを指定するには、次の操作を行います。
-
Selectドロップダウンメニューで、並べ替えオプションをクリックします。
-
すべての並べ替えオプションのリストを取得するには、Return All Sort Choicesチェック ボックスをオンにします。
-
-
Click Build。要求がRequestパネルに表示されます。
要求のView
要求を作成したら、Requestペインで出力を調べてエラーを確認する必要があります。必要なキーが欠落している場合は、JSON出力の上に警告が表示されます。
要求を表示するには:
-
RequestウィンドウでJSON形式で要求を読み取ります。
先端生成された要求が正しくない場合は、Buildペインに別の値を入力し、もう一度Buildをクリックすることで修正できます。または、RequestペインでJSONを直接編集することもできます。
-
必要に応じて、リクエストをコピーするには、Copy to clipboard as...
をクリックし、希望する形式をクリックします。手記リクエストは、Sitecoreホストまたはサブドメインを使用して、データ オブジェクトまたはcURLオブジェクトとしてコピーできます。
要求を実行し、応答をコピーします
リクエストを作成したら、リクエストを実行して、正しく送信されていること、エラーがないことを確認します。
要求を実行して応答をコピーするには:
-
Requestペインで、Runをクリックします。
-
API ExplorerのResponseペインでJSON形式で応答を読み取ります。応答をスキャフォールディングしてスクロールできます。
-
Click Copy to clipboard as...
してCopy as data objectをクリックします。