Method: files.list

ユーザーのファイルの一覧を取得します。

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
corpora

string

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

enum (Corpus)

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

driveId

string

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

boolean

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

boolean

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

integer

ページごとに返されるファイルの最大数。ファイル リストの末尾に達する前でも、結果ページが部分的または空になることがあります。
orderBy

string

並べ替えキーのカンマ区切りのリスト。有効なキーは次のとおりです。

  • createdDate: ファイルが作成された日時。
  • folder: フォルダ ID。このフィールドはアルファベット順で並べ替えられます。
  • lastViewedByMeDate: ユーザーが最後にファイルを表示した日時。
  • modifiedByMeDate: ユーザーが最後にファイルを変更した日時。
  • modifiedDate: 誰かが最後にファイルを変更した日時。
  • quotaBytesUsed: ファイルによって使用された保存容量のバイト数。
  • recency: ファイルの日付 / 時刻フィールドの最新のタイムスタンプ。
  • sharedWithMeDate: ファイルがユーザーと共有された日時（該当する場合）。
  • starred: ユーザーがファイルにスターを付けたかどうか。
  • title: ファイルのタイトル。このフィールドはアルファベット順に並べ替えられるため、1、12、2、22 の順になります。
  • title_natural: ファイルのタイトル。このフィールドは自然な並べ替え順序で並べ替えられるため、1、2、12、22 の順になります。

各キーはデフォルトで昇順に並べ替えられますが、'desc' 修飾子で逆順に並べ替えることもできます。使用例: ?orderBy=folder,modifiedDate desc,title

現在、約 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 表現 
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
フィールド
items[]

object (File)

ファイルのリスト。nextPageToken が入力されている場合、このリストは不完全である可能性があり、結果の追加ページを取得する必要があります。
nextPageToken

string

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

string

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

string

リストの ETag。

認可スコープ

次の 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

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

コーパス

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