列出用户的文件。
此方法接受 q
参数,该参数是组合一个或多个搜索字词的搜索查询。有关详情,请参阅搜索文件和文件夹指南。
HTTP 请求
GET https://www.googleapis.com/drive/v3/files
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
corpora |
查询所适用的项(文件/文档)的正文。支持的正文为“user”“domain”“drive”和“allDrives”。优先使用“user”或“drive”而非“allDrives”,以提高效率。默认情况下,语料库设置为“用户”。不过,这可能会因通过“q”参数设置的过滤器而发生变化。 |
corpus |
已弃用:要列出的文件的来源。请改用“corpora”。 |
driveId |
要搜索的共享云端硬盘的 ID。 |
includeItemsFromAllDrives |
“我的云端硬盘”和共享云端硬盘内容是否应该包含在结果中。 |
includeTeamDriveItems |
已废弃:请改用 |
orderBy |
以英文逗号分隔的排序键列表。有效键包括“ createdTime”“folder”“modifyByMeTime”“modifyTime”“name”“name_natural”“quotaBytesUsed”“recency”“sharedWithMeTime”“starred”“viewedByMeTime”。默认情况下,每个键都会按升序排序,但可以使用“desc”修饰符进行反转。用法示例:?orderBy=folder,editingTime desc,name。 |
pageSize |
每页返回的文件数量上限。即使在文件列表结束之前,也可能会显示部分结果页或空白结果。 |
pageToken |
用于继续下一页面中的上一个列表请求的令牌。此值应设为上一个响应中的“nextPageToken”的值。 |
q |
用于过滤文件结果的查询。请参阅“搜索文件和文件夹”指南,了解受支持的语法。 |
spaces |
要在语料库内查询的空格的逗号分隔列表。支持的值包括“drive”和“appDataFolder”。 |
supportsAllDrives |
发出请求的应用是否同时支持“我的云端硬盘”和共享云端硬盘。 |
supportsTeamDrives |
已废弃:请改用 |
teamDriveId |
已废弃:请改用 |
includePermissionsForView |
指定要包含在响应中的其他视图权限。仅支持“已发布”属性。 |
includeLabels |
以英文逗号分隔的 |
请求正文
请求正文必须为空。
响应正文
文件列表。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
字段 | |
---|---|
nextPageToken |
下一页文件的页面令牌。如果已达到文件列表末尾,将不会显示此属性。如果令牌因任何原因被拒,应将其舍弃,并且应从结果的第一页重新开始分页。页面令牌的有效期通常为几小时。不过,如果您添加或移除了新内容,预期结果可能会有所不同。 |
kind |
标识这是哪类资源。值:固定字符串 |
incompleteSearch |
搜索过程是否不完整。如果为 true,则可能会因没有搜索所有文档而缺少某些搜索结果。使用“allDrives”语料库搜索多个云端硬盘时,可能会发生这种情况,但系统无法搜索所有语料库。发生这种情况时,建议客户端通过选择其他语料库(例如“user”或“drive”)来缩小查询范围。 |
files[] |
文件列表。如果填充了 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.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 |
共享到用户网域中的文件。 |