---
title: "API Explorerを使って検索リクエストをテストします"
slug: "test-a-search-request-using-the-api-explorer"
abstract: "Sitecore SearchのAPI Explorerを使ってSearchおよび推奨事項APIリクエストをテストする方法を説明しています。"
---
# API Explorerを使って検索リクエストをテストします

Sitecore Searchの**Developer Resources**ページの**API Explorer**タブを使って、SearchとRecommendation APIエンドポイントを使ってJSONリクエストを作成し、データを取得することができます。

このウォークスルーでは、以下の方法を説明します:

-   リクエストを作成しましょう。
-   View the Request。
-   リクエストを実行し、レスポンスをコピーします。

## リクエストを作成する

このセクションでは、API Explorerの左側ペインを使ってリクエストを作成する方法を説明します。または、リクエストデータオブジェクトを直接**Request**ペインに貼り付けて「 **ビルド**」をクリックすることもできます。

リクエストペインを作成するには:

1.  メニューバーで**Developer Resources**をクリックし、その後**API Explorer**タブをクリックしてください。
    
2.  左側のペインの **「ページ」** ドロップダウンメニューで、テストしたいページを選択して、そのページ名をクリックします。
    
    > !ヒント以前に作成したリクエストをクリアしたい場合は、左側のペインで**リセットをクリックします。**
    
3.  (任意)回答を1つ以上のウィジェットに限定するには、**Widget**フィールドをクリックし、表示されたドロップダウンリストでウィジェットを選択しまたは解除してください。選択したページに属するWidgetsは事前選択済みです。
    
4.  **エンティティ**のドロップダウンメニューでエンティティをクリックします。
    
5.  以下の表に記載されているオプションフィールドについては、説明した値を記載してください。
    
    フィールド
    
    概要
    
    **出典**
    
    特定の情報源からの結果を制限するには、それらを選択してください。
    
    **Limit**
    
    結果数を制限するには、値を入力してください。
    
    **Offset**
    
    結果をスキップするには、スキップする番号を入力してください。
    
6.  以下の表に記載されている任意のセクションについては、説明した値を記載してください。
    

Section

概要

Locale

ドメインが複数のロケージを使用している場合は、国&言語のドロップダウンメニューで国と言語をクリックしてください。注意ロケージを選択しない場合は、デフォルトのドメインローカが使用されます。

クエリ

クエリセクションでは、結果の特定の単語をハイライトするように設定できます。さらに、HTMLタグを追加して単語のフォーマットや挙動(例えばインタラクティビティ)を修正することもできます。結果でキーワードをハイライトするには、以下すべてを行ってください。キーワードフィールドでキーワードを入力します。属性のハイライトドロップダウンメニューで、属性をクリックします。ハイライトフラグメントサイズフィールドで、ハイライトする最大文字数を入力してください。ハイライトタグフィールドでは、ハイライトされたテキストの前後にHTMLタグを追加するには、タグを入力してください。

suggestion blocks

プレビュー検索ウィジェットは、訪問者が検索入力欄にキーワードを入力すると提案を表示できます。suggestion blockを追加するには、以下をすべて行ってください:Click Add Suggestion Blockを選び、ブロックを選択します。ブロック内で、提案数を制限するためにMaxフィールドで最大数を入力してください。

コンテキスト/ID

クエリのコンテキストとしてインデックスアイテムを指定することができます。例えば、共同購入商品のrecommendationウィジェットでProduct Aをコンテキストとして使うことができます。エンティティを追加するには、以下をすべて行ってください:Click Add Entity からエンティティを選択します。エンティティの入力欄で、特定のインデックスアイテムを返すには、その ID を入力します。注:Content Collection セクションでは、インデックスされたアイテムのIDを閲覧できます。

コンテキスト/ユーザー

Personalizationと関連性はSearchのコア機能です。API Explorerでは、すべてのリクエストにビジターまたはユーザーに関する情報が必要です。ビジターまたはユーザーをコンテキストとして提供するには、実装によって以下のいずれかを行います:UUIDフィールドにSitecoreからビジターまたはユーザーに割り当てられたIDを入力します。User IDフィールドに、ビジターまたはユーザーに割り当てたIDを入力します。注:Content Collectionセクションでは、訪問者のIDを閲覧できます。オプションでユーザーグループをコンテキストとして提供するには、ユーザーグループ欄にビジターまたはユーザーに関連付けられたユーザーグループのIDを入力してください。

ファセット

facetsを指定するには、必要に応じて以下をすべて行ってください:すべての事実の結果を取得するには、「すべて」チェックボックスを選択してください。最大フィールドでファセット値の数を制限するには、最大数を入力します。デフォルトは100です。ただし、テスト目的ではこの数をさらに制限することを推奨します。ソートドロップダウンメニューで「テキスト」または特定のファセットを含める Count.To をクリックし、「ファセットを追加」をクリックしてからファセットを選択し、選択したファセットについては必要に応じて以下を行います:UUIDフィールドで訪問者またはユーザーに割り当てられたIDをSitecore入力してください。最大フィールドではファセット値の数を制限するために最大数を入力します。デフォルトは100です。ただし、テスト目的ではこの数をさらに制限することを推奨します。「ソート」ドロップダウンメニューで「テキスト」または「カウント」をクリックします。

ソート

ソートオプションを指定するには、以下を行います。選択ドロップダウンメニューで、ソートオプションをクリックします。すべてのソートオプションのリストを取得するには、「すべてのソート選択肢を返す」チェックボックスを選択してください。

7.  **Click Build**。リクエストは**Request**パネルに表示されます。

## View the request(リクエストを閲覧)

リクエストを作成した後は、**Request**ペインの出力を確認してエラーをチェックしてください。必要なキーが欠けている場合は、JSON出力の上に警告が表示されます。

リクエストの閲覧方法:

1.  リクエストは**Request**ペインでJSON形式で読みます。
    
    > !ヒント生成されたリクエストが間違っている場合は、**ビルド** ペインで異なる値を入力してから再度 **ビルド** をクリックすることで修正できます。あるいは、**Request**ペインのJSONを直接編集することもできます。
    
2.  リクエストをコピーするには、クリップ **ボードにコピー**をクリックしてください... ![file\_copy\_icon.png](https://doc.sitecore.com/api/markdown-image/search/ja/developers/search-developer-guide/images/file_copy_icon.png) そしてお好みのフォーマットをクリックしてください。
    
    > !注リクエストはSitecoreホストやサブドメインを使ってデータオブジェクトまたはcURLオブジェクトとしてコピーできます。
    

## リクエストを実行し、レスポンスをコピーします

リクエストを作成した後、正しく送信されているか、エラーがないか実行してください。

リクエストを実行してレスポンスをコピーするには:

1.  **Request**ペインで「**実行**」をクリックします。
2.  API Explorerの **Response** ペインでJSON形式のレスポンスを読みます。レスポンスをスキャフォールドしてスクロールできます。
3.  Click **クリップボードにコピー...![file\_copy\_icon.png](https://doc.sitecore.com/api/markdown-image/search/ja/developers/search-developer-guide/images/file_copy_icon.png)**そして**「データオブジェクトとしてコピー**」をクリックします。

> !重要ソースを指定するリクエストは以下のステータスコードを返します:
> 
> ステータスコードが戻りました
> 
> 概要
> 
> 200
> 
> ソースが初期化されたり、インデックス実行が成功した場合に。ソースがアイテムをインデックスする必要はない。
> 
> 500
> 
> ソースが初期化されていない場合。