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 を優先します。デフォルトでは、コーパスは user に設定されています。ただし、q パラメータで設定されたフィルタによって、この値は変更される可能性があります。詳細については、ファイルの構成をご覧ください。
corpus
(deprecated)

enum (Corpus)

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

driveId

string

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

boolean

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

boolean

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

string

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

  • createdTime: ファイルが作成された日時。
  • 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

ページごとに返されるファイルの最大数。ファイル リストの末尾に達する前でも、結果ページが部分的または空になることがあります。
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 ユーザーのドメインと共有されているファイル。