Method: files.list

ユーザーのファイルを一覧表示します。

このメソッドには、1 つ以上の検索キーワードを組み合わせた検索クエリを q パラメータとして渡すことができます。詳しくは、ファイルとフォルダを検索するをご覧ください。

HTTP リクエスト

GET https://www.googleapis.com/drive/v2/files

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
corpora

string

クエリが適用されるアイテム（ファイル/ドキュメント）サポートされる本体は、default、domain、drive、allDrives です。効率性を重視するには、default または drive を allDrives よりも優先します。
corpus
(deprecated)

enum (Corpus)

非推奨: クエリが適用されるアイテム（ファイル/ドキュメント）の本文。corpora を代わりに使用してください。

driveId

string

検索する共有ドライブの ID。
includeItemsFromAllDrives

boolean

マイドライブと共有ドライブの両方のアイテムを検索結果に含めるかどうか。
includeTeamDriveItems
(deprecated)

boolean

非推奨: 代わりに includeItemsFromAllDrives を使用してください。
maxResults

integer

1 ページに対して返されるファイルの最大数。ファイルリストの末尾に到達する前でも、部分的なページや空の結果ページが表示されることがあります。
orderBy

string

カンマ区切りのキーのリスト。有効なキーは createdDate、folder、lastViewedByMeDate、modifiedByMeDate、modifiedDate、quotaBytesUsed、recency、sharedWithMeDate、starred、title、title_natural です。デフォルトでは、各キーは昇順で並べ替えられますが、desc 修飾子によって逆にすることができます。使用例: ?orderBy=folder,modifiedDate 降順、タイトル。現在のところ、約 100 万件のファイルがあるユーザーの場合、リクエストされた並べ替え順が無視される制限があります。
pageToken

string

ファイルのページトークン。
projection
(deprecated)

enum (Projection)

非推奨: このパラメータに機能はありません。
q

string

ファイルを検索するクエリ文字列。
spaces

string

クエリ対象のスペースのカンマ区切りリスト。指定できる値は drive および appDataFolder です。
supportsAllDrives

boolean

リクエスト元のアプリケーションがマイドライブと共有ドライブの両方をサポートしているかどうか。
supportsTeamDrives
(deprecated)

boolean

非推奨: 代わりに supportsAllDrives を使用してください。
teamDriveId
(deprecated)

string

非推奨: 代わりに driveId を使用してください。
includePermissionsForView

string

レスポンスに含める追加のビューの権限を指定します。published のみがサポートされています。
includeLabels

string

レスポンスの labelInfo 部分に含めるラベルの ID のカンマ区切りリスト。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ファイルのリスト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
フィールド
nextPageToken

string

ファイルの次のページのページトークン。ファイルリストの末尾にある場合、この行は存在しません。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページ分けを最初からやり直す必要があります。
kind

string

これは常に drive#fileList です。
etag

string

リストの ETag。
items[]

object (File)

ファイルのリスト。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.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

一部のスコープは制限されており、アプリで使用するにはセキュリティ評価が必要です。詳しくは、認可ガイドをご覧ください。

コーパス

列挙型
DEFAULT ユーザーがアクセスしたアイテム。
DOMAIN ユーザーのドメインに共有されているアイテム。