searchRequest リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

重要

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

注意

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

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

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

注:

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

プロパティ

プロパティ 型 説明
集計 aggregationOption コレクション 検索結果と共に返される集計 (絞り込み条件とも呼ばれます) を指定します。 省略可能です。
aggregationFilters String collection 集計され、フィールドの特定の値にフィルター処理された検索結果を取得するための 1 つ以上のフィルターが含まれます。 省略可能です。
同じフィールドで集計する以前の検索に基づいて、このフィルターを構築します。 以前の検索の応答から、結果をフィールドの特定の値にフィルター処理する searchBucket を特定し、 その aggregationFilterToken プロパティで文字列を使用し、 "{field}:\"{aggregationFilterToken}\" という形式で集計フィルター文字列を作成します。
同じフィールドに複数の値を指定する必要がある場合は、 aggregationFilterToken プロパティの文字列を使用し 、"{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\") の形式で集計フィルター文字列を作成します。
たとえば、ドライブ項目をファイルの種類別に検索して集計すると、応答内のファイルの種類docxの searchBucket が返されます。 この searchBucket に返された aggregationFilterToken を後続の検索クエリで使用し、フィルターの一致をダウンしてファイルの種類の項目をdocx駆動できます。 例 1 と 例 2 は、実際の要求と応答を示しています。
collapseProperties collapseProperty コレクション フィールドの順序付きコレクションと、結果を折りたたむ制限を格納します。 省略可能です。
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、acronym、bookmark、chatMessage です。 同じ検索要求でサポートされている 2 つ以上のエンティティ型の組み合わせの詳細については、「 既知の制限事項」を参照してください。 必須です。
フィールド String collection entityTypes で指定された各リソース オブジェクトに対して返されるフィールドが含まれます。既定では、SharePoint と OneDrive からのカスタム 管理プロパティなどの追加フィールドや、Microsoft Graph コネクタが持ち込むコンテンツからの externalItem のカスタム フィールドなど、既定で返されるフィールドのカスタマイズが可能になります。
fields プロパティは、プロパティに適用される セマンティック ラベル を使用できます。 たとえば、プロパティが title としてラベルである場合は、次の構文を使用して取得できます: label_title。
オプション。
from Int32 検索結果のオフセットを指定します。 オフセット 0 は、最初の結果を返します。 オプション。
query SearchQuery クエリ用語が含まれます。 必須です。
queryAlterationOptions searchAlterationOptions スペル修正に関連する 2 つの省略可能なフラグを含む JSON BLOB として書式設定されたクエリ変更オプションを提供します。 オプション。
地域 string アプリケーションのアクセス許可を使用する検索に必要です。 検索の地理的な場所を表します。 詳細については、「 リージョンの値を取得する」を参照してください。
resultTemplateOptions resultTemplateOption コレクション コネクタの検索結果をレンダリングするための検索結果テンプレート オプションを提供します。
sharePointOneDriveOptions sharePointOneDriveOptions アプリケーションのアクセス許可を使用して検索を実行するときに検索するコンテンツの種類を示します。 省略可能です。
size Int32 取得するページのサイズ。 最大値は 500 です。 オプション。
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"},
  "region": "63128164-cbbf-4db4-896c-a7038417019c",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "trimDuplicates": false
}

関連コンテンツ