Method: files.list

ユーザーのファイルの一覧を取得します。詳しくは、ファイルとフォルダを検索するをご覧ください。

このメソッドは、1 つ以上の検索語句を組み合わせた検索クエリである q パラメータを受け取ります。

このメソッドは、デフォルトですべてのファイル（ゴミ箱内のファイルを含む）を返します。 ゴミ箱内のファイルをリストに表示しない場合は、trashed=false クエリ パラメータを使用して、結果からゴミ箱内のファイルを削除します。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
corpora

string

クエリを適用するアイテム（ファイルまたはドキュメント）のコレクションを指定します。サポートされているアイテムは次のとおりです。

  • user
  • domain
  • drive
  • allDrives

効率を高めるには、allDrives ではなく user または drive を使用してください。デフォルトでは、corpora は user に設定されています。ただし、これは q パラメータで設定されたフィルタによって変更される可能性があります。詳しくは、ファイルの構成をご覧ください。
corpus
(deprecated)

enum (Corpus)

非推奨: 一覧表示するファイルのソース。代わりに corpora を使用してください。
driveId

string

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

boolean

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

boolean

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

string

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

  • createdTime: ファイルが作成された日時。このキーを大きなアイテム コレクションに対するクエリに使用すると、タイムアウトなどの問題が発生する可能性があるため、使用しないでください。大きなアイテム コレクションで時間に関連する並べ替えを行う場合は、代わりに modifiedTime desc を使用してください。
  • folder: フォルダ ID。このフィールドはアルファベット順に並べ替えられます。
  • modifiedByMeTime: ユーザーが最後にファイルを変更した日時。
  • modifiedTime: 誰かが最後にファイルを変更した日時。
  • name: ファイルの名前。このフィールドはアルファベット順に並べ替えられるため、1、12、2、22 の順になります。
  • name_natural: ファイルの名前。このフィールドは自然順に並べ替えられるため、1、2、12、22 の順になります。
  • quotaBytesUsed: ファイルで使用されている保存容量のバイト数。
  • recency: ファイルの日付 / 時刻フィールドの最新のタイムスタンプ。
  • sharedWithMeTime: ファイルがユーザーと共有された日時（該当する場合）。
  • starred: ユーザーがファイルにスターを付けたかどうか。
  • viewedByMeTime: ユーザーが最後にファイルを表示した日時。

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

integer

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

指定しない場合、共有ドライブの場合は最大 100 個のファイルが返され、非共有ドライブの場合はファイルのリスト全体が返されます。

最大値は 100 です。100 を超える値は 100 に変更されます。
pageToken

string

次のページで前のリスト リクエストを続行するためのトークン。これは、前のレスポンスの nextPageToken の値に設定する必要があります。
q

string

ファイル結果をフィルタリングするためのクエリ。サポートされている構文については、ファイルとフォルダを検索するをご覧ください。
spaces

string

コーパス内でクエリするスペースのカンマ区切りのリスト。サポートされる値は、drive と appDataFolder です。詳しくは、ファイルの構成をご覧ください。
supportsAllDrives

boolean

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

boolean

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

string

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

string

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

string

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

リクエストの本文

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

レスポンスの本文

ファイルのリスト。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (File)

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

string

ファイルの次のページのページトークン。ファイルのリストの末尾に達すると、この項目は表示されなくなります。トークンが何らかの理由で拒否された場合は、破棄して、結果の最初のページからページ分割を再開する必要があります。通常、ページトークンは数時間有効です。ただし、新しいアイテムが追加または削除されると、期待される結果が異なる場合があります。
kind

string

リソースの種類を示します。値は固定文字列 "drive#fileList" です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • 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

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

コーパス

列挙型
user ユーザーが所有しているファイルまたはユーザーと共有されているファイル。
domain ユーザーのドメインと共有されているファイル。