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

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

string

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

string

コーパス内でクエリするスペースのカンマ区切りのリスト。サポートされている値は「drive」と「appDataFolder」です。
supportsAllDrives

boolean

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

boolean

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

string

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

string

レスポンスに含める追加のビューの権限を指定します。「公開済み」のみがサポートされています。
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.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

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

Corpus

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