フィードバック 編集

searchRequest リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

注意事項

Microsoft Search API の要求および応答で使用されたリソースの名前が変更されたか、削除された、または廃止されています。 廃止についての詳細は、 「詳細情報」でご確認ください。 検索 API クエリは、以前のいずれかのアプリで適宜更新します。

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

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

注意

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

プロパティ

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

JSON 表記

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

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "contentSources": ["String"],
  "enableTopResults": true,
  "entityTypes": ["String"],
  "fields": ["String"],
  "from": 1024,
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "trimDuplicates": false
}

関連項目