Method: files.list

• HTTP リクエスト
• クエリ パラメータ
• リクエストの本文
• レスポンスの本文
  • JSON 表現
• 認可スコープ
• コーパス
• 試してみる

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

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

注: このメソッドは、ゴミ箱に移動されたファイルを含む、デフォルトですべてのファイルを返します。ゴミ箱に移動したファイルをリストに表示しない場合は、trashed=false クエリ パラメータを使用して、ゴミ箱に移動したファイルを結果から除外します。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
corpora	string クエリが適用されるアイテム（ファイルまたはドキュメント）の本文。サポートされているボディは「user」、「domain」、「drive」、「allDrives」です。「ユーザー」を優先するまたは「drive」「allDrives」に移動考えてみましょうデフォルトでは、コーパスは「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 次のページで前の 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"。
incompleteSearch	boolean 検索プロセスが完了していないかどうか。true の場合、すべてのドキュメントが検索されたわけではないため、一部の検索結果が表示されない可能性があります。これは、「allDrives」コーパスを使用して複数のドライブを検索する際に発生することがあります。この場合、すべてのコーパスを検索することはできません。この場合は、クライアントが「user」や「drive」などの別のコーパスを選択してクエリを絞り込むことをおすすめします。
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	ユーザーのドメインと共有されているファイル。