Method: files.list

列出用户的文件。

此方法接受 q 参数，该参数是包含一个或多个搜索字词的搜索查询。有关详情，请参阅搜索文件和文件夹指南。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
corpora

string

查询适用的内容（文件/文档）的正文。支持的正文包括：default、domain、drive 和 allDrives。为了提高效率，首选 default 或 drive，而不是 allDrives。
corpus
(deprecated)

enum (Corpus)

已弃用：要应用查询的项目正文（文件/文档）。请改用 corpora。
driveId

string

要搜索的共享云端硬盘的 ID。
includeItemsFromAllDrives

boolean

结果中是否包含“我的云端硬盘”和共享云端硬盘内容。
includeTeamDriveItems
(deprecated)

boolean

已弃用：请改用 includeItemsFromAllDrives。
maxResults

integer

每页返回的文件数量上限。即使文件列表没有到达终点，也有可能是部分结果页或空结果页。
orderBy

string

以英文逗号分隔的排序键列表。有效键包括 createdDate、folder、lastViewedByMeDate、modifiedByMeDate、modifiedDate、quotaBytesUsed、recency、sharedWithMeDate、starred、title 和 title_natural。默认情况下，每个键都按升序排序，但可以使用 desc 修饰符反转。用法示例：?orderBy=folder,modifyDate desc,title. 请注意，如果用户目前有约 100 万个文件，所请求的排序顺序会被忽略，
pageToken

string

文件的网页令牌。
projection
(deprecated)

enum (Projection)

已弃用：此参数没有函数。
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,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
字段
nextPageToken

string

下一页的文件的页面令牌。如果到达文件列表的末尾，此字段将不会显示。如果令牌因任何原因被拒绝，应舍弃，并应从搜索结果的第一页重新开始分页。
kind

string

始终为 drive#fileList。
etag

string

列表的 ETag。
items[]

object (File)

文件列表。如果填充了 pagePageToken，则此列表可能不完整，应提取另一个结果页。

授权范围

需要以下 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

某些范围是受限的，需要对应用进行安全性评估才能使用它们。如需了解详情，请参阅授权指南。

分类

枚举
DEFAULT 用户访问过的内容。
DOMAIN 共享到用户网域的内容。