Method: files.list

列出用户的文件。

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

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
corpora

string

要查询的项（文件/文档）的正文。支持的主体包括“用户”“网域”“云端硬盘”和“所有云端硬盘”。为了提高效率，请优先使用“用户”或“云端硬盘”，而不是“所有云端硬盘”。默认情况下，corpora 设置为“user”。不过，这可能会因“q”中设置的过滤器而异参数。
corpus
(deprecated)

enum (Corpus)

已弃用：要列出的文件的来源。使用“语料库”。
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 共享到用户网域的文件。