资源:文件
文件的元数据。
某些资源方法(例如 files.update
)需要 fileId
。使用 files.list
方法检索文件的 ID。
JSON 表示法 |
---|
{ "kind": string, "driveId": string, "fileExtension": string, "copyRequiresWriterPermission": boolean, "md5Checksum": string, "contentHints": { "indexableText": string, "thumbnail": { "image": string, "mimeType": string } }, "writersCanShare": boolean, "viewedByMe": boolean, "mimeType": string, "exportLinks": { string: string, ... }, "parents": [ string ], "thumbnailLink": string, "iconLink": string, "shared": boolean, "lastModifyingUser": { object ( |
字段 | |
---|---|
kind |
仅限输出。表明这是哪类资源。值:固定字符串 |
drive |
仅限输出。文件所在的共享云端硬盘的 ID。仅针对共享云端硬盘中的内容进行填充。 |
file |
仅限输出。 |
copy |
是否应禁止读者和评论者复制、打印或下载此文件。 |
md5 |
仅限输出。文件内容的 MD5 校验和。这仅适用于 Google 云端硬盘中包含二进制内容的文件。 |
content |
有关文件内容的其他信息。这些字段绝不会在响应中填充。 |
content |
要为文件编入索引的文本,以改进全文查询。此值的长度不得超过 128KB,并且可以包含 HTML 元素。 |
content |
文件的缩略图。只有在 Google 云端硬盘无法生成标准缩略图时,才会使用此缩略图。 |
content |
使用可在网址中安全使用的 Base64 编码(RFC 4648 第 5 节)的缩略图数据。 使用 base64 编码的字符串。 |
content |
缩略图的 MIME 类型。 |
writers |
仅具有 |
viewed |
仅限输出。文件是否已被此用户查看。 |
mime |
文件的 MIME 类型。 如果未提供任何值,Google 云端硬盘会尝试从上传的内容中自动检测适当的值。除非上传新的修订版,否则无法更改此值。 如果文件是使用 Google 文档 MIME 类型创建的,系统会尽可能导入上传的内容。支持的导入格式已发布在“关于”资源中。 |
export |
仅限输出。用于将 Google 文档编辑器文件导出为特定格式的链接。 包含一系列 |
parents[] |
包含相应文件的父级文件夹的 ID。 文件只能有一个父级文件夹;不支持指定多个父级。 如果未在创建请求中指定,系统会将文件直接放入用户的“我的云端硬盘”文件夹中。如果未在复制请求中指定,则文件会继承源文件的任何可检测到的父级。files.update 请求必须使用 |
thumbnail |
仅限输出。指向文件缩略图的短时有效链接(如果有)。通常持续数小时。由于跨域资源共享 (CORS) 政策,不适合直接在 Web 应用中使用,请考虑使用代理服务器。仅当请求访问的应用可以访问文件内容时才会填充。如果文件未公开共享,则必须使用有凭据的请求提取 |
icon |
仅限输出。指向文件图标的静态非身份验证链接。 |
shared |
仅限输出。文件是否已共享。不会为共享云端硬盘中的内容填充。 |
last |
仅限输出。上次修改文件的用户。只有当上次修改由已登录的用户执行时,系统才会填充此字段。 |
owners[] |
仅限输出。此文件的所有者。只有某些旧版文件可能有多个所有者。系统不会为共享云端硬盘中的内容填充此字段。 |
head |
仅限输出。文件的头部修订版本的 ID。此功能目前仅适用于 Google 云端硬盘中的二进制内容文件。 |
sharing |
仅限输出。与请求方用户共享文件的用户(如果适用)。 |
web |
仅限输出。用于在浏览器中通过相关 Google 编辑器或查看器打开文件的链接。 |
web |
仅限输出。用于在浏览器中下载文件内容的链接。此功能仅适用于 Google 云端硬盘中的二进制内容文件。 |
size |
仅限输出。blob 和第一方编辑器文件的大小(以字节为单位)。系统不会针对没有大小的文件(例如快捷方式和文件夹)填充此字段。 |
viewersCanCopyContent |
已弃用:请改用 |
permissions[] |
仅限输出。文件的完整权限列表。只有在请求访问的用户可以共享文件时,此选项才可用。不会为共享云端硬盘中的内容填充。 |
has |
仅限输出。此文件是否有缩略图。这并不表示请求应用是否有权访问缩略图。如需检查访问权限,请查看是否存在 thumbnailLink 字段。 |
spaces[] |
仅限输出。包含文件的聊天室列表。目前支持的值为“drive”“appDataFolder”和“photos”。 |
folder |
文件夹或文件夹快捷方式的颜色,以 RGB 十六进制字符串表示。支持的颜色会发布在“关于”资源的 如果指定了不受支持的颜色,系统会改用调色板中相近的颜色。 |
id |
文件的 ID。 |
name |
文件的名称。此 ID 在文件夹中不一定是唯一的。请注意,对于不可变项(例如共享云端硬盘的顶级文件夹、“我的云端硬盘”根文件夹和“应用数据”文件夹),名称是固定的。 |
description |
文件的简短说明。 |
starred |
用户是否为文件加星标。 |
trashed |
文件是否已被移至回收站(无论是明确移至,还是从已移至回收站的父级文件夹移至)。只有文件所有者可以将文件移至回收站,其他用户无法看到所有者回收站中的文件。 |
explicitly |
仅限输出。文件是否已明确移至回收站,而不是从父级文件夹递归移至回收站。 |
created |
文件的创建时间(RFC 3339 日期时间)。 |
modified |
上次有人修改文件的时间(RFC 3339 日期时间)。 请注意,设置 |
modified |
仅限输出。用户上次修改文件的时间(RFC 3339 日期时间)。 |
viewed |
用户上次查看文件的时间(RFC 3339 日期时间)。 |
shared |
仅限输出。与用户共享文件的时间(如果适用)(RFC 3339 日期时间)。 |
quota |
仅限输出。文件使用的存储空间配额字节数。这包括头部修订版本以及启用了 |
version |
仅限输出。文件的单调递增版本号。这会体现对服务器上的文件所做的每项更改,即使用户看不到这些更改也是如此。 |
original |
上传内容的原始文件名(如果有),或者 |
owned |
仅限输出。用户是否为文件所有者。不会为共享云端硬盘中的内容填充。 |
full |
仅限输出。从 当 |
properties |
一组对所有应用都显示的任意键值对。 更新和复制请求中会清除包含 null 值的条目。 包含一系列 |
app |
一组仅供请求应用使用的任意键值对。 更新和复制请求中会清除包含 null 值的条目。 这些媒体资源只能使用经过身份验证的请求检索。经过身份验证的请求使用通过 OAuth 2 客户端 ID 获取的访问令牌。您无法使用 API 密钥检索私有媒体资源。 包含一系列 |
is |
仅限输出。文件是由请求应用创建或打开的。 |
teamDriveId |
已废弃:仅供输出。请改用 |
capabilities |
仅限输出。当前用户对此文件拥有的权限。每项 capability 都对应于用户可以执行的精细操作。 |
capabilities.canChangeViewersCanCopyContent |
已废弃:仅供输出。 |
capabilities. |
仅限输出。当前用户是否可以将此文件夹的子文件夹移出共享云端硬盘。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。 |
capabilities. |
仅限输出。当前用户能否读取此文件所属的共享云端硬盘。仅针对共享云端硬盘中的内容进行填充。 |
capabilities. |
仅限输出。当前用户是否可以修改此文件。其他因素可能会限制用户对文件可以进行的更改类型。例如,请参阅 |
capabilities. |
仅限输出。当前用户是否可以复制此文件。对于共享云端硬盘中的内容,当前用户能否复制此内容的非文件夹后代,或者如果此内容本身不是文件夹,则能否复制此内容本身。 |
capabilities. |
仅限输出。当前用户是否可以对此文件发表评论。 |
capabilities. |
仅限输出。当前用户是否可以向此文件夹添加子文件夹。如果内容不是文件夹,则此属性始终为 false。 |
capabilities. |
仅限输出。当前用户是否可以删除此文件。 |
capabilities. |
仅限输出。当前用户是否可以下载此文件。 |
capabilities. |
仅限输出。当前用户是否可以列出此文件夹的子文件夹。如果内容不是文件夹,则此属性始终为 false。 |
capabilities. |
仅限输出。当前用户是否可以从此文件夹中移除子文件夹。如果内容不是文件夹,则此属性始终为 false。对于共享云端硬盘中的文件夹,请改用 |
capabilities. |
仅限输出。当前用户是否可以重命名此文件。 |
capabilities. |
仅限输出。当前用户能否将此文件移至回收站。 |
capabilities. |
仅限输出。当前用户是否可以读取此文件的修订版本资源。对于共享云端硬盘项,可以读取此项的非文件夹后代项的修订版本,或者此项本身(如果它不是文件夹)。 |
capabilities.canReadTeamDrive |
已废弃:仅供输出。请改用 |
capabilities.canMoveTeamDriveItem |
已废弃:仅供输出。请改用 |
capabilities. |
仅限输出。当前用户是否可以更改此文件的 |
capabilities.canMoveItemIntoTeamDrive |
已废弃:仅供输出。请改用 |
capabilities. |
仅限输出。当前用户是否可以从回收站中恢复此文件。 |
capabilities. |
仅限输出。当前用户是否可以修改此文件的内容。 |
capabilities.canMoveItemWithinTeamDrive |
已废弃:仅供输出。请改用 |
capabilities.canMoveItemOutOfTeamDrive |
已废弃:仅供输出。请改用 |
capabilities. |
仅限输出。当前用户是否可以删除此文件夹的子文件夹。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。 |
capabilities.canMoveChildrenOutOfTeamDrive |
已废弃:仅供输出。请改用 |
capabilities.canMoveChildrenWithinTeamDrive |
已废弃:仅供输出。请改用 |
capabilities. |
仅限输出。当前用户能否将此文件夹的子文件夹移至回收站。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。 |
capabilities. |
仅限输出。当前用户能否通过更改其父级来将此内容移出此云端硬盘。请注意,更改项的父项的请求可能仍会失败,具体取决于要添加的新父项。 |
capabilities. |
仅限输出。当前用户是否可以在同一请求中为项添加父项,而无需移除现有父项。不会为共享云端硬盘文件填充。 |
capabilities. |
仅限输出。当前用户是否可以在不添加其他父级的情况下从项中移除父级。不会为共享云端硬盘文件填充。 |
capabilities. |
仅限输出。当前用户能否在此云端硬盘中移动此内容。请注意,更改项父级的请求可能仍会失败,具体取决于要添加的新父级和要移除的父级。 |
capabilities. |
仅限输出。当前用户是否可以修改此文件的共享设置。 |
capabilities. |
仅限输出。当前用户是否可以在此云端硬盘中移动此文件夹的子文件夹。如果内容不是文件夹,则此属性为 false。请注意,移动子文件夹的请求可能仍会失败,具体取决于当前用户对子文件夹和目标文件夹的访问权限。 |
capabilities.canModifyContentRestriction |
已废弃:仅供输出。使用 |
capabilities. |
仅限输出。当前用户能否将其他云端硬盘(其他共享云端硬盘或“我的云端硬盘”)中的文件夹添加到此文件夹。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。 |
capabilities. |
仅限输出。当前用户能否更改关联共享元数据中的 securityUpdateEnabled 字段。 |
capabilities. |
仅限输出。当前用户是否为文件的待处理所有者。不会为共享云端硬盘文件填充。 |
capabilities. |
仅限输出。当前用户是否可以读取文件上的标签。 |
capabilities. |
仅限输出。当前用户是否可以修改文件的标签。 |
capabilities. |
仅限输出。当前用户是否可以对受编辑者限制的文件添加或修改内容限制。 |
capabilities. |
仅限输出。当前用户是否可以添加或修改受所有者限制的内容限制。 |
capabilities. |
仅限输出。文件是否存在可由当前用户移除的内容限制。 |
capabilities. |
用户是否可以停用继承的权限。 |
capabilities. |
用户能否重新启用继承的权限。 |
has |
仅限输出。此文件是否具有直接权限。系统仅会为共享云端硬盘中的内容填充此字段。 |
trashing |
仅限输出。如果文件已被明确移至回收站,则为将其移至回收站的用户。仅针对共享云端硬盘中的内容进行填充。 |
thumbnail |
仅限输出。用于缩略图缓存失效的缩略图版本。 |
trashed |
仅限输出。内容被移至回收站的时间(RFC 3339 日期时间)。仅针对共享云端硬盘中的内容进行填充。 |
modified |
仅限输出。文件是否已被此用户修改。 |
permission |
仅输出。具有对此文件的访问权限的用户的权限 ID 的 files.list。 |
image |
仅限输出。有关图片媒体的其他元数据(如果有)。 |
image |
仅限输出。拍摄照片时是否使用了闪光灯。 |
image |
仅限输出。用于创建照片的测光模式。 |
image |
仅限输出。用于创建照片的传感器类型。 |
image |
仅限输出。用于创建照片的曝光模式。 |
image |
仅限输出。照片的色彩空间。 |
image |
仅限输出。用于创建照片的白平衡模式。 |
image |
仅限输出。图片的宽度(以像素为单位)。 |
image |
仅限输出。图片的高度(以像素为单位)。 |
image |
仅限输出。存储在图片中的位置信息。 |
image |
仅限输出。图片中存储的纬度。 |
image |
仅限输出。图片中存储的经度。 |
image |
仅限输出。图片中存储的海拔。 |
image |
仅限输出。从图片的原始方向应用的顺时针 90 度旋转次数。 |
image |
仅限输出。拍摄照片的日期和时间 (EXIF DateTime)。 |
image |
仅限输出。用于创建照片的相机品牌。 |
image |
仅限输出。用于创建照片的相机型号。 |
image |
仅限输出。曝光时长(以秒为单位)。 |
image |
仅限输出。用于创建照片的光圈(f 值)。 |
image |
仅限输出。用于创建照片的焦距(以毫米为单位)。 |
image |
仅限输出。用于创建照片的 ISO 感光度。 |
image |
仅限输出。照片的曝光偏差(APEX 值)。 |
image |
仅限输出。用于创建照片的焦距下镜头的最小 f 值(APEX 值)。 |
image |
仅限输出。与照片拍摄正文的距离(以米为单位)。 |
image |
仅限输出。用于拍摄照片的镜头。 |
video |
仅限输出。有关视频媒体的其他元数据。此功能可能无法在上传后立即可用。 |
video |
仅限输出。视频的宽度(以像素为单位)。 |
video |
仅限输出。视频的高度(以像素为单位)。 |
video |
仅限输出。视频的时长(以毫秒为单位)。 |
shortcut |
快捷方式文件详情。仅针对将 mimeType 字段设置为 |
shortcut |
此快捷方式指向的文件的 ID。只能在 |
shortcut |
仅限输出。此快捷方式指向的文件的 MIME 类型。此字段的值是目标的 MIME 类型的快照,是在创建快捷方式时捕获的。 |
shortcut |
仅限输出。目标文件的 ResourceKey。 |
content |
限制访问文件内容。仅当存在此类限制时才会填充。 |
resource |
仅限输出。通过共享链接访问内容所需的密钥。 |
link |
仅限输出。LinkShare 相关详细信息。包含客户端用于引用此项的链接网址的详细信息。 |
link |
仅限输出。文件是否符合安全更新条件。 |
link |
仅限输出。是否为此文件启用了安全更新。 |
label |
仅限输出。文件标签概览。 |
label |
仅限输出。文件上的一组标签,由 |
sha1 |
仅限输出。与此文件关联的 SHA1 校验和(如果有)。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。 |
sha256 |
仅限输出。与此文件关联的 SHA256 校验和(如果有)。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。 |
inherited |
此文件是否已停用继承的权限。继承的权限默认处于启用状态。 |
ContentRestriction
限制访问文件内容。
JSON 表示法 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
字段 | |
---|---|
read |
文件内容是否为只读。如果文件是只读的,则可能无法添加该文件的新修订版本,也无法添加或修改评论,更无法修改文件的标题。 |
reason |
文件内容受到限制的原因。只有在同时设置 |
type |
仅限输出。内容限制的类型。目前,唯一可能的值是 |
restricting |
仅限输出。设置内容限制的用户。仅当 |
restriction |
仅限输出。内容限制设置的时间(采用 RFC 3339 时间戳格式)。仅当 |
owner |
内容限制是否只能由文件所有者修改或移除。对于共享云端硬盘中的文件,任何具有 |
system |
仅限输出。内容限制是否由系统应用,例如因电子签名而应用。用户无法修改或移除系统限制的内容限制。 |
方法 |
|
---|---|
|
创建文件的副本,并应用任何请求的更新(具有补丁语义)。 |
|
创建新文件。 |
|
永久删除用户拥有的文件,而不将其移至回收站。 |
|
下载文件的内容。 |
|
永久删除用户的所有回收站文件。 |
|
将 Google Workspace 文档导出为请求的 MIME 类型,并返回导出的字节内容。 |
|
生成一组文件 ID,可在创建或复制请求中提供。 |
|
根据 ID 获取文件的元数据或内容。 |
|
列出用户的文件。 |
|
列出文件的标签。 |
|
修改应用于文件的一组标签。 |
|
更新文件的元数据和/或内容。 |
|
订阅文件的更改。 |