列出用户的文件。
此方法接受 q
参数,该参数是组合了一个或多个搜索字词的搜索查询。有关详情,请参阅搜索文件和文件夹指南。
HTTP 请求
GET https://www.googleapis.com/drive/v3/files
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
corpora |
查询适用的项(文件/文档)的正文。受支持的正文包括“user”“domain”“drive”和“allDrives”。为了提高效率,请优先选择“user”或“drive”而不是“allDrives”。默认情况下,语料库设置为“用户”。不过,这可能会根据通过“q”参数设置的过滤器发生变化。 |
corpus |
已弃用:要列出的文件的来源。请改用“语料库”。 |
driveId |
要搜索的共享云端硬盘的 ID。 |
includeItemsFromAllDrives |
结果中是否应包含“我的云端硬盘”和共享云端硬盘内容。 |
includeTeamDriveItems |
已弃用:请改用 |
orderBy |
以英文逗号分隔的排序键列表。有效键包括“createdTime”“folder”“modifiedByMeTime”“modifiedTime”“name”“name_natural”“quotaBytesUsed”“recency”“sharedWithMeTime”“starred”和“viewedByMeTime”。默认情况下,每个键都会按升序排序,但也可以使用“desc”修饰符将其反转。用法示例:?orderBy=folder,modifyTime 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.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 |
与用户网域共享的文件。 |