検索 REST サービスを使用してクエリ候補を取得する
クライアントおよびモバイル アプリケーションから、検索 REST サービスを使用して、SharePoint の検索からクエリ候補を取得する方法を説明します。 検索候補とも呼ばれるクエリ候補は、ユーザーが既に検索していて、クエリを入力するときに表示される、つまり「候補」にされるフレーズです。 SharePoint の検索を使用して、クエリ前とクエリ後の候補を有効にすることができます。 これらの候補は、ユーザーがクエリを入力すると検索ボックスの下の一覧に表示されます。 クエリ候補とその有効化方法の詳細については、「 SharePoint でクエリ候補を管理する」を参照してください。
検索 REST サービスの Suggest エンドポイント
検索 REST サービスには、 Suggest エンドポイントが含まれ、これは REST Web 要求をサポートする任意のテクノロジで使用でき、クライアントまたはモバイル アプリケーションから、検索システムによってクエリに対して生成されるクエリ候補を取得できます。
検索 REST サービスの Suggest エンドポイントへの GET 要求の URI は次のとおりです。
/_api/search/suggest
クエリ候補パラメータは URL に指定します。 要求 URL は次の 2 つの方法で作成できます。
http://server/_api/search/suggest?parameter=value&parameter=value
http://server/_api/search/suggest(parameter=value&parameter=value)
注:
検索 REST サービスでは、Suggest エンドポイントへの匿名要求をサポートしていません。
クエリ候補パラメーター
次のセクションで、 Suggest エンドポイントに使用できるパラメーターについて説明します。
Querytext
検索クエリのテキストを含む文字列。
サンプル GET 要求
http:// server/_api/search/suggest?querytext='sharepoint'
iNumberOfQuerySuggestions
取得するクエリ候補の数。 ゼロ (0) より大きい必要があります。 既定値は 5 です。
サンプル GET 要求
http:// server/_api/search/suggest?querytext='sharepoint'&inumberofquerysuggestions=3
iNumberOfResultSuggestions
取得する個人用の結果の数。 ゼロ (0) より大きい必要があります。 既定値は 5 です。
サンプル GET 要求
http:// server/_api/search/suggest?querytext='sharepoint'&inumberofresultsuggestions=4
fPreQuerySuggestions
クエリ前候補を取得するか、クエリ後候補を取得するかを指定するブール値。 クエリ前候補を返す場合は true、それ以外は false です。 既定値は false です。
GET 要求の例
http:// server/_api/search/suggest?querytext='sharepoint'&fprequerysuggestions=true
fHitHighlighting
ヒットしたクエリ候補をハイライト表示するか、太字で書式設定するかを指定するブール値。 指定したクエリの用語に一致する、返されるクエリ候補の用語を太字で書式設定する場合は true、それ以外は false です。 既定値は true です。
GET 要求の例
http:// server/_api/search/suggest?querytext='sharepoint'&fhithighlighting=false
fCapitalizeFirstLetters
返されるクエリ候補の各用語の先頭の文字を大文字にするかどうかを指定するブール値。 各用語の先頭の文字を大文字にする場合は true、それ以外は false です。 既定値は false です。
GET 要求の例
http:// server/_api/search/suggest?querytext='sharepoint'&fcapitalizefirstletters=false
Culture
クエリのロケール ID (LCID) ( 「Microsoft によって割り当てられたロケール ID」を参照)。
サンプル GET 要求
http:// server/_api/search/suggest?querytext='sharepoint'&culture=1044
EnableStemming
ステミングを有効にするかどうかを指定するブール値。 ステミングを有効にする場合は true、それ以外は false。 既定値は true です。
GET 要求の例
http:// server/_api/search/suggest?querytext='sharepoint'&enablestemming=false
ShowPeopleNameSuggestions
返されるクエリ候補に人名を含めるかどうかを指定するブール値。 返されるクエリ候補に人名を含める場合は true、それ以外は false です。 既定値は true です。
GET 要求の例
http:// server/_api/search/suggest?querytext='sharepoint'&showpeoplenamesuggestions=false
EnableQueryRules
このクエリのクエリ ルールを有効にするかどうかを指定するブール値。 クエリ ルールを有効にする場合は true、それ以外は false です。 既定値は true です。
GET 要求の例
http:// server/_api/search/suggest?querytext='sharepoint'&enablequeryrules=false
fPrefixMatchAllTerms
前方一致のクエリ候補を返すかどうかを指定するブール値。 前方一致に基づいてクエリ候補を返す場合は true、クエリ候補がクエリ全文に一致する必要がある場合は false。
サンプル GET 要求
http:// server/_api/search/suggest?querytext='sharepoint'&fprefixmatchallterms=false