ドライブ内の DriveItem を検索する

クエリと一致するアイテムを対象にアイテムの階層を検索します。フォルダー階層内、ドライブ全体、または現在のユーザーと共有されるファイル内で検索できます。

前提条件

この API を実行するには、以下のいずれかのスコープが必要です。

  • Files.Read
  • Files.ReadWrite

HTTP 要求

GET /me/drive/root/search(q='{search-text}')
GET /me/drive/items/{item-id}/search(q='{search-text}')
GET /me/drive/root:/{item-path}:/search(q='{search-text}')
GET /drives/{drive-id}/root/search(q='{search-text}')
GET /groups/{group-id}/drive/root/search(q='{search-text}')

オプションのクエリ パラメーター

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。

要求本文

このメソッドには、要求本文を指定しません。

関数パラメーター

名前 説明
q string アイテムの検索に使用するクエリ テキスト。値は、ファイル名、メタデータ、およびファイルのコンテンツを含む複数のフィールドに渡って照合できます。

要求

ここでは、現在のユーザーの OneDrive を検索する要求の例を示します。

GET https://graph.microsoft.com/v1.0/me/drive/root/search(q='{search-query}')
応答

このメソッドは、検索条件に一致する DriveItems のコレクション含んでいるオブジェクトを返します。アイテムが見つからない場合は、空のコレクションが返されます。

一致が多すぎる場合は、応答はページ化され、@odata.nextLink プロパティには、後続の結果ページへの URL が含まれます。$top クエリ パラメーターを使用すると、ページ内のアイテム数を指定できます。

HTTP/1.1 200 OK
Content-type: application/json

{
    "value": [
      {
        "id": "0123456789abc!123",
        "name": "Contoso Project",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!123" }
      },
      {
        "id": "0123456789abc!456",
        "name": "Contoso Project 2016",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!456" }
      }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd"
}

ユーザーがアクセスできるアイテムの検索

ドライブ内のアイテムの検索に加えて、アプリでは現在のユーザーと共有されるアイテムを含めるように、検索範囲を広げることができます。検索範囲を広げるには、Drive リソースの search メソッドを使用します。

要求
GET https://graph.microsoft.com/v1.0/me/drive/search(q='{search-query}')
応答

ドライブ リソースからの検索時の応答には、ドライブの外部のアイテム (現在のユーザーと共有されているアイテム) が含まれていることがあります。こうしたアイテムには、それらが対象のドライブの外部に保存されていることを示す、remoteItem ファセットが含まれます。

HTTP/1.1 200 OK
Content-type: application/json

{
    "value": [
      {
        "id": "0123456789abc!123",
        "name": "Contoso Project",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!123" },
        "remoteItem": { "id": "!23141901", "driveId": "s!1020101jlkjl12lx" }
      },
      {
        "id": "0123456789abc!456",
        "name": "Contoso Project 2016",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!456" }
      }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd"
}