Method: files.list

列出用户的文件。

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

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
corpora

string

查询所适用的项目（文件/文档）的正文。支持的实体包括“user”“domain”“drive”和“allDrives”。为了提高效率，建议使用“user”或“drive”而非“allDrives”。默认情况下，语料库设置为“用户”。不过，此值可能会因通过“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

以英文逗号分隔的标签 ID 列表，用于在响应的 labelInfo 部分中包含这些标签。

请求正文

请求正文必须为空。

响应正文

文件列表。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
字段
files[]

object (File)

文件列表。如果 nextPageToken 已填充，则表示此列表可能不完整，应再提取一页结果。
nextPageToken

string

下一页文件的页面令牌。如果已到达文件列表的末尾，则此字段将不存在。如果令牌因任何原因被拒绝，则应将其舍弃，并从第一页结果重新开始分页。网页令牌通常在几个小时内有效。不过，如果添加或移除了新商品，您的预期结果可能会有所不同。
kind

string

表明这是哪类资源。值：固定字符串 "drive#fileList"。

授权范围

需要以下 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 与用户网域共享的文件。