Method: files.list

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

このメソッドは、1 つ以上の検索キーワードを組み合わせた検索クエリである q パラメータを受け入れます。詳しくは、ファイルやフォルダを検索するのガイドをご覧ください。

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」、「modifiedByMeTime」、「modifiedTime」、「name」、「name_natural」、「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 表現
{
  "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

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

Corpus

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