ユーザーのファイルを一覧表示します。
このメソッドには、1 つ以上の検索語句を組み合わせた検索クエリを q
パラメータとして渡すことができます。詳しくは、ファイルとフォルダを検索するガイドをご覧ください。
HTTP リクエスト
GET https://www.googleapis.com/drive/v2/files
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
corpora |
クエリを適用するアイテム(ファイル/ドキュメント)の本文。サポートされているボディは |
corpus |
非推奨: クエリが適用されるアイテム(ファイル/ドキュメント)の本文。 |
driveId |
検索する共有ドライブの ID。 |
includeItemsFromAllDrives |
検索結果にマイドライブと共有ドライブの両方のアイテムを含めるかどうか。 |
includeTeamDriveItems |
非推奨: 代わりに、 |
maxResults |
ページごとに返されるファイルの最大数。ファイルリストの最後まで到達する前に、結果ページが部分的に表示される、または空になることがあります。 |
orderBy |
並べ替えキーのカンマ区切りのリスト。有効なキーは次のとおりです。
各キーはデフォルトで昇順に並べ替えられますが、「desc」修飾子を使用して降順に並べ替えることもできます。使用例: なお、現在、約 100 万個のファイルがあるユーザーについては、リクエストされた並べ替え順序が無視されるという制限があります。 |
pageToken |
ファイルのページトークン。 |
projection |
非推奨: このパラメータには機能がありません。 |
q |
ファイルを検索するためのクエリ文字列。 |
spaces |
クエリするスペースのカンマ区切りのリスト。サポートされる値は |
supportsAllDrives |
リクエスト元のアプリケーションがマイドライブと共有ドライブの両方をサポートしているかどうか。 |
supportsTeamDrives |
非推奨: 代わりに、 |
teamDriveId |
非推奨: 代わりに、 |
includePermissionsForView |
レスポンスに含める追加ビューの権限を指定します。 |
includeLabels |
レスポンスの |
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
ファイルのリスト。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"nextPageToken": string,
"kind": string,
"etag": string,
"selfLink": string,
"incompleteSearch": boolean,
"nextLink": string,
"items": [
{
object ( |
フィールド | |
---|---|
nextPageToken |
次のページのファイルのページトークン。ファイルリストの最後まで到達した場合は、この値は表示されません。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページネーションを再開する必要があります。 |
kind |
これは常に |
etag |
リストの ETag。 |
selfLink |
このリストへのリンク。 |
incompleteSearch |
検索プロセスが完了したかどうか。true の場合、すべてのドキュメントが検索されていないため、一部の検索結果が表示されないことがあります。これは、「allDrives」コーパスを使用して複数のドライブを検索する際に、すべてのコーパスを検索できなかった場合に発生することがあります。この場合は、クライアントが「default」や「drive」などの別のコーパスを選択してクエリを絞り込むことをおすすめします。 |
nextLink |
次のページのファイルへのリンク。 |
items[] |
ファイルのリスト。nextPageToken が入力されている場合、このリストは不完全な可能性があるため、結果の追加ページを取得する必要があります。 |
認可スコープ
以下のいずれかの OAuth スコープが必要です。
https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.apps.readonly
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.meet.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive.readonly
一部のスコープは制限されており、アプリで使用するにはセキュリティ評価が必要です。詳しくは、認可ガイドをご覧ください。
Corpus
列挙型 | |
---|---|
DEFAULT |
ユーザーがアクセスしたアイテム。 |
DOMAIN |
ユーザーのドメインと共有されているアイテム。 |