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: フォルダ 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

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

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

コーパス

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