Method: files.list

列出用户的文件。

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

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
corpora

string

查询所适用的项(文件/文档)的正文。支持的正文为 defaultdomaindriveallDrives。优先使用 defaultdrive,而不是 allDrives,这样可以提高效率。

corpus
(deprecated)

enum (Corpus)

已弃用:要应用查询的项目(文件/文档)正文。请改用 corpora

driveId

string

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

includeItemsFromAllDrives

boolean

“我的云端硬盘”和共享云端硬盘内容是否应该包含在结果中。

includeTeamDriveItems
(deprecated)

boolean

已废弃:请改用 includeItemsFromAllDrives

maxResults

integer

每页返回的文件数量上限。即使在文件列表结束之前,也可能会显示部分结果页或空白结果。

orderBy

string

以英文逗号分隔的排序键列表。有效键包括 createdDatefolderlastViewedByMeDatemodifiedByMeDatemodifiedDatequotaBytesUsedrecencysharedWithMeDatestarredtitletitle_natural。默认情况下,每个键都会按升序排序,但可以使用 desc 修饰符进行反转。用法示例:?orderBy=folder,modifyDate desc,title。请注意,目前存在大约 100 万个文件的用户限制,系统会忽略请求的排序顺序。

pageToken

string

文件的页面令牌。

projection
(deprecated)

enum (Projection)

已弃用:此参数没有函数。

q

string

用于搜索文件的查询字符串。

spaces

string

要查询的空格的逗号分隔列表。支持的值包括 driveappDataFolder

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)

文件列表。如果填充了 nextPageToken,则此列表可能不完整,应提取其他结果页。

授权范围

需要以下 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 在用户网域中共享的内容。