フィードバック 編集

searchRequest リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

JSON BLOB で書式設定された検索要求。

JSON BLOB には、応答に必要なリソースの種類、基になるソース、ページング パラメーター、並べ替えオプション、要求された集計とフィールド、および実際の検索クエリが含まれます。 さまざまなリソースに対する検索要求の 例 を参照してください。

注意

エンティティの種類の特定の組み合わせの検索や、検索結果の並べ替えまたは集計に関する 既知の制限事項 に注意してください。

プロパティ

プロパティ 種類 説明
aggregationFilters String collection 集計され、フィールドの特定の値にフィルター処理された検索結果を取得するための 1 つ以上のフィルターが含まれています。 省略可能。
同じフィールドによって集計される以前の検索に基づいて、このフィルターをビルドします。 前の検索の応答から、フィールドの特定の値に対して結果をフィルター処理する searchBucket を識別し、 その aggregationFilterToken プロパティで文字列を使用し、 "{field}:\"{aggregationFilterToken}\" という形式で集計フィルター文字列を作成します。
同じフィールドに複数の値を指定する必要がある場合は、 その aggregationFilterToken プロパティの文字列を使用し 、"{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\") という形式で集計フィルター 文字列を作成します。
たとえば、ドライブ項目をファイルの種類別に検索して集計すると、応答でファイルの種類docxの searchBucket が返されます。 この searchBucket に対して返される aggregationFilterToken は、後続の検索クエリで便利に使用でき、フィルターはファイルの種類のdocxドライブ アイテムに一致します。 例 1 と 例 2 は、実際の要求と応答を示しています。
集計 aggregationOption コレクション 検索結果と共に返される集計 (絞り込み条件とも呼ばれます) を指定します。 省略可能。
contentSources String collection 対象となる接続を含みます。
enableTopResults Boolean これにより、メッセージのハイブリッド並べ替えがトリガーされます。最初の 3 つのメッセージが最も関連性があります。 このプロパティは entityType=messageにのみ適用されます。 省略可能。
entityTypes entityType コレクション 応答で必要なリソースの 1 つ以上の種類。 可能な値は、list、site、listItem、message、event、drive、driveItem、externalItem です。 同じ検索要求でサポートされている 2 つ以上のエンティティの種類の組み合わせについては、 既知の制限事項 を参照してください。 必須です。
フィールド String collection entityTypes で指定されたリソース オブジェクトごとに返されるフィールドを格納し、既定で返されるフィールドをカスタマイズできます。それ以外の場合は、SharePointとOneDriveのカスタム 管理プロパティなどの追加フィールドや、Microsoft Graph コネクタが取り込むコンテンツの externalItem のカスタム フィールドを含めます。 fields プロパティでは、プロパティに適用される セマンティック ラベルを使用できます。 たとえば、プロパティにタイトルというラベルが付けられている場合は、次の構文 label_titleを使用してプロパティを取得できます。 省略可能。
from Int32 検索結果のオフセットを指定します。 オフセット 0 は、最初の結果を返します。 省略可能。
query SearchQuery クエリ用語を含みます。 必須です。
queryAlterationOptions searchAlterationOptions スペル修正に関連する 2 つのオプション フラグを含む JSON BLOB で書式設定されたクエリ変更オプション。 省略可能。
resultTemplateOptions resultTemplateOption コレクション コネクタから検索結果をレンダリングするための検索結果テンプレート オプションを提供します。
size Int32 取得するページのサイズ。最大値は 1000 です。 省略可能。
sortProperties sortProperty コレクション 結果を並べ替えるフィールドと方向の順序付けられたコレクションを格納します。 コレクションには最大で 5 つの並べ替えプロパティがあります。 省略可能。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "aggregationFilters": ["String"],
  "aggregations": {"@odata.type": "microsoft.graph.aggregationOption"},
  "enableTopResults": "Boolean",
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "fields": ["String"],
  "from": "Int32",
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": "Int32"
}

関連項目