ドライブ内の driveItems のSearch
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
クエリと一致するアイテムを対象にアイテムの階層を検索します。 フォルダー階層内、ドライブ全体、現在のユーザーと共有されるファイル内で検索できます。
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | 特権の高いアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Files.Read | Files.Read.All、Files.ReadWrite、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | Files.Read | Files.Read.All、Files.ReadWrite、Files.ReadWrite.All |
アプリケーション | Files.Read.All | Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All |
注: このメソッドは Sites.Selected アプリケーションのアクセス許可をサポートしていません。
HTTP 要求
GET /drives/{drive-id}/root/search(q='{search-text}')
GET /groups/{group-id}/drive/root/search(q='{search-text}')
GET /me/drive/root/search(q='{search-text}')
GET /sites/{site-id}/drive/root/search(q='{search-text}')
GET /users/{user-id}/drive/root/search(q='{search-text}')
オプションのクエリ パラメーター
このメソッドは、応答を$expand
カスタマイズするために、$select
$skipToken
、$top
および $orderby
OData クエリ パラメーターをサポートします。
関数パラメーター
パラメーター | 型 | 説明 |
---|---|---|
q | string | アイテムの検索に使用するクエリ テキスト。 値は、ファイル名、メタデータ、およびファイルのコンテンツを含む複数のフィールドに渡って照合できます。 |
例
要求
次の例では、サインインしているユーザーのドライブ アイテム内の複数のフィールドで、「Contoso Project」の一致を検索します。
GET /me/drive/root/search(q='Contoso Project')
応答
このメソッドは、検索条件に一致する DriveItems のコレクション含んでいるオブジェクトを返します。 アイテムが見つからない場合は、空のコレクションが返されます。
一致する値が多すぎる場合、応答はページングされ、 @odata.nextLink プロパティには結果の次のページへの URL が含まれます。 クエリ パラメーターを使用すると、ページ内のアイテム数を指定できます。
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 /me/drive/search(q='Contoso Project')
応答
ドライブ リソースからの検索時の応答には、ドライブの外部のアイテム (現在のユーザーと共有されているアイテム) が含まれていることがあります。 こうしたアイテムには、それらが対象のドライブの外部に保存されていることを示す、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"
}
エラー応答
エラーがどのように返されるかの詳細については、「エラー応答」を参照してください。
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示