Method: files.list

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
corpora

string

クエリが適用されるアイテム(ファイルまたはドキュメント)の本文。サポートされている本文は defaultdomaindriveallDrives です。効率を高めるために、allDrives よりも default または drive を優先します。

corpus
(deprecated)

enum (Corpus)

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

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

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

maxResults

integer

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

orderBy

string

並べ替えキーのカンマ区切りリスト。有効なキーは createdDatefolderlastViewedByMeDatemodifiedByMeDatemodifiedDatequotaBytesUsedrecencysharedWithMeDatestarredtitletitle_natural です。デフォルトでは、各キーが昇順で並べ替えられますが、desc 修飾子を使用すると元に戻すことができます。使用例: ?orderBy=folder,modifiedDate desc,title. 現在のところ、約 100 万ファイルの場合、リクエストした並べ替えが無視されるユーザーの制限があります。

pageToken

string

ファイルのページトークン。

projection
(deprecated)

enum (Projection)

非推奨: このパラメータに関数はありません。

q

string

ファイル検索用のクエリ文字列。

spaces

string

クエリ対象のスペースのカンマ区切りのリスト。サポートされる値は driveappDataFolder です。

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

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

includeLabels

string

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

リクエスト本文

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

レスポンスの本文

ファイルのリスト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

string

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

kind

string

これは常に drive#fileList です。

etag

string

リストの ETag。

items[]

object (File)

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

認可スコープ

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

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