Method: files.list

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
corpora

string

クエリが適用されるアイテム（ファイル/ドキュメント）サポート対象の本文は、「user」、「domain」、「drive」、「allDrives」です。効率を高めるために「allDrive」よりも「user」または「drive」を優先してください。デフォルトでは、コーパスは「user」に設定されています。これは、「q」パラメータで設定されたフィルタによって変わる可能性があります。
corpus
(deprecated)

enum (Corpus)

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

string

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

boolean

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

boolean

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

string

カンマ区切りのキーのリスト。有効なキーは、「createdTime」、「folder」、「modifiedByMeTime」、「modifiedTime」、「name」、「name_Natural」、「quotaBytesUsed」、「recency」、「sharedWithMeTime」、「starred」、「viewedByMeTime」です。各キーはデフォルトでは昇順に並べ替えられますが、「降順」修飾子で逆にすることができます。使用例: ?orderBy=folder,modifiedTime 降順、名前。
pageSize

integer

1 ページに対して返されるファイルの最大数。ファイルリストの末尾に到達する前でも、部分的なページや空の結果ページが表示されることがあります。
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 表現 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
フィールド
nextPageToken

string

ファイルの次のページのページトークン。ファイルリストの末尾にある場合、この行は存在しません。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページ分けを最初からやり直す必要があります。ページトークンは通常、数時間有効です。ただし、アイテムを追加または削除した場合、期待した結果は異なることがあります。
kind

string

リソースの種類を示します。値: 固定文字列 "drive#fileList"。
files[]

object (File)

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

認可スコープ

次の 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.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 ユーザーのドメインと共有されるファイル。