资源:文件
文件的元数据。
某些资源方法(例如 files.update
)需要 fileId
。使用 files.list
方法检索文件的 ID。
JSON 表示法 |
---|
{ "kind": string, "userPermission": { object ( |
字段 | |
---|---|
kind |
仅供输出。文件类型。始终为 |
userPermission |
仅供输出。经过身份验证的用户对此文件的权限。 |
fileExtension |
仅供输出。移除了似乎不包含在扩展元素内的 |
md5Checksum |
仅供输出。此文件内容的 MD5 校验和。只有内容存储在 Google 云端硬盘的文件中,系统才会填充此字段;对于文档编辑器或快捷方式文件,系统不会填充此字段。 |
selfLink |
仅供输出。指向此文件的链接。 |
ownerNames[] |
仅供输出。此文件的所有者的姓名。对于共享云端硬盘中的内容,系统不会填充此信息。 |
lastModifyingUserName |
仅供输出。最后修改此文件的用户的名称。 |
editable |
仅供输出。已废弃:请改用 |
writersCanShare |
撰写者是否可以与其他用户共享文档。对于共享云端硬盘中的内容,系统不会填充此信息。 |
downloadUrl |
仅供输出。文件的短期有效下载网址。只有内容存储在 Google 云端硬盘的文件中,系统才会填充此字段;对于 Google 文档或快捷方式文件,不会填充此字段。 |
mimeType |
文件的 MIME 类型。只有在上传新内容时,此设置才是可变的。此字段可以留空,并且 mimetype 将根据上传内容的 MIME 类型确定。 |
exportLinks |
仅供输出。用于将文档编辑器文件导出为特定格式的链接。 包含一系列 |
driveId |
仅供输出。文件所在共享云端硬盘的 ID。系统只会为共享云端硬盘中的内容填充此字段。 |
parents[] |
包含此文件的父文件夹的集合。 如果未包含在插入请求中,系统会将该文件直接放入用户的“我的云端硬盘”文件夹中。如果未作为复制请求的一部分指定,则该文件将继承源文件的任何可检测到的父级。file.update 请求还可以使用 |
thumbnailLink |
仅供输出。指向文件缩略图的短期链接(如果有)。通常持续数小时。仅当请求的应用可以访问文件的内容时,系统才会填充相应值。如果文件未公开共享,必须使用基于凭据的请求提取 |
appDataContents |
仅供输出。此文件是否位于 Application Data 文件夹中。 |
webViewLink |
仅供输出。指向通过 Google 云端硬盘的网站托管功能查看静态网络资源(HTML、CSS、JS 等)的公共文件夹中的链接。 |
iconLink |
仅供输出。指向文件图标的链接。 |
shared |
仅供输出。文件是否已共享。对于共享云端硬盘中的内容,系统不会填充此信息。 |
lastModifyingUser |
仅供输出。最后修改此文件的用户。 |
owners[] |
仅供输出。此文件的所有者。只有某些旧版文件可以有多个所有者。对于共享云端硬盘中的内容,系统不会填充此字段。 |
openWithLinks |
仅供输出。用户的每款应用的 ID 到通过该应用打开此文件的链接的映射。仅在使用 drive.apps.readonly 范围时填充。 包含一系列 |
defaultOpenWithLink |
仅供输出。用于通过用户的默认应用打开此文件的链接。仅在使用 drive.apps.readonly 范围时填充。 |
headRevisionId |
仅供输出。文件头修订版本的 ID。只有内容存储在 Google 云端硬盘的文件中,系统才会填充此字段;对于文档编辑器或快捷方式文件,系统不会填充此字段。 |
properties[] |
属性列表。 |
copyable |
仅供输出。已废弃:请改用 |
etag |
仅供输出。文件的 ETag。 |
sharingUser |
仅供输出。与当前用户共享了内容的用户(如果有)。 |
alternateLink |
仅供输出。用于在相关 Google 编辑器或查看器中打开文件的链接。 |
embedLink |
仅供输出。用于嵌入文件的链接。 |
webContentLink |
仅供输出。用于在浏览器中使用基于 Cookie 的身份验证下载文件内容的链接。如果内容是公开分享的,那么无需任何凭据即可下载。 |
fileSize |
仅供输出。blob 和第一方编辑器文件的大小(以字节为单位)。对于没有大小的文件(例如快捷方式和文件夹),系统不会填充此字段。 |
copyRequiresWriterPermission |
是否应为读者和评论者停用复制、打印或下载此文件的选项。 |
permissions[] |
仅供输出。有权访问此文件的用户的权限列表。对于共享云端硬盘中的内容,系统不会填充此信息。 |
hasThumbnail |
仅供输出。此文件是否有缩略图。这不会指示发出请求的应用是否有权访问缩略图。要检查访问权限,请查找缩略图链接字段是否存在。 |
spaces[] |
仅供输出。包含该文件的聊天室列表。支持的值包括 |
folderColorRgb |
如果文件是文件夹或文件夹的快捷方式,则文件夹颜色以 RGB 十六进制字符串表示。“关于”资源的“folderColorPalette”字段中提供了支持的颜色列表。如果指定了不受支持的颜色,系统会将其更改为调色板中最接近的颜色。 |
id |
文件的 ID。 |
title |
此文件的标题。请注意,对于不可变内容(例如共享云端硬盘的顶层文件夹、“我的云端硬盘”根文件夹和应用数据文件夹),标题保持不变。 |
description |
文件的简短说明。 |
labels |
文件的一组标签。 |
labels.viewed |
相应用户是否已查看此文件。 |
labels.restricted |
仅供输出。已废弃:请改用 |
labels.starred |
用户是否为此文件添加了星标。 |
labels.hidden |
仅供输出。已弃用。 |
labels.trashed |
此文件是否已放入回收站。此标签适用于所有访问文件的用户;但是,只有所有者才能查看和移出文件。 |
labels.modified |
仅供输出。相应文件是否已被该用户修改。 |
explicitlyTrashed |
仅供输出。此文件是否已显式移至回收站,而不是以递归方式移至回收站。 |
createdDate |
仅供输出。此文件的创建时间(带格式的 RFC 3339 时间戳)。 |
modifiedDate |
任何人上次修改此文件的时间(采用 RFC 3339 格式的时间戳)。此字段仅在设置了 setModifiedDate 参数的情况下在更新时可变。 |
modifiedByMeDate |
仅供输出。用户上次修改此文件的时间(带格式的 RFC 3339 时间戳)。请注意,设置 modifiedDate 时,系统还会为设置日期的用户更新 modifyByMe 日期。 |
lastViewedByMeDate |
用户上次查看此文件的时间(带格式的 RFC 3339 时间戳)。 |
markedViewedByMeDate |
仅供输出。已弃用。 |
sharedWithMeDate |
仅供输出。与用户共享此文件的时间(带格式的 RFC 3339 时间戳)。 |
quotaBytesUsed |
仅供输出。此文件使用的配额字节数。 |
version |
仅供输出。文件单调递增的版本号。这会反映对服务器上的文件所做的每次更改,即便是请求用户看不到的更改也是如此。 |
indexableText |
文件的可编入索引的文本属性(只能写入) |
indexableText.text |
要为此文件编入索引的文本。 |
originalFilename |
已上传内容的原始文件名(如果有),或其他 |
ownedByMe |
仅供输出。文件是否归当前用户所有。对于共享云端硬盘中的内容,系统不会填充此信息。 |
canComment |
仅供输出。已废弃:请改用 |
shareable |
仅供输出。已废弃:请改用 |
fullFileExtension |
仅供输出。完整的文件扩展名;从标题中提取。可包含多个串联的扩展名,例如“tar.gz”。从影视内容中移除附加信息不会清除此字段;但是,更改影视内容中的扩展名会更新此字段。只有内容存储在 Google 云端硬盘的文件中,系统才会填充此字段;对于文档编辑器或快捷方式文件,系统不会填充此字段。 |
isAppAuthorized |
仅供输出。文件是由发出请求的应用创建还是打开的。 |
teamDriveId |
仅供输出。已废弃:请改用 |
capabilities |
仅供输出。当前用户对此文件的权限。每项功能都对应一项用户可以执行的精细操作。 |
capabilities.canChangeRestrictedDownload |
仅供输出。已弃用。 |
capabilities.canMoveChildrenOutOfDrive |
仅供输出。当前用户是否可以将此文件夹的子级移出共享云端硬盘。如果项不是文件夹,则此值为 false。系统只会为共享云端硬盘中的内容填充此字段。 |
capabilities.canReadDrive |
仅供输出。当前用户是否能够读取此文件所属的共享云端硬盘。系统只会为共享云端硬盘中的内容填充此字段。 |
capabilities.canEdit |
仅供输出。当前用户是否能够编辑此文件。其他因素可能会限制用户可以对文件做出的更改类型。有关示例,请参阅 |
capabilities.canCopy |
仅供输出。当前用户是否能够复制此文件。对于共享云端硬盘中的内容,当前用户是否可以复制此内容的非文件夹后代内容,或此内容本身(如果内容不是文件夹)。 |
capabilities.canComment |
仅供输出。当前用户是否可评论此文件。 |
capabilities.canAddChildren |
仅供输出。当前用户是否可以向此文件夹添加子级。如果项不是文件夹,则此值始终为 false。 |
capabilities.canDelete |
仅供输出。当前用户是否可以删除此文件。 |
capabilities.canDownload |
仅供输出。当前用户是否可下载此文件。 |
capabilities.canListChildren |
仅供输出。当前用户是否可列出此文件夹的子级。如果项不是文件夹,则此值始终为 false。 |
capabilities.canRemoveChildren |
仅供输出。当前用户是否可以从此文件夹中移除子级。如果项不是文件夹,则此值始终为 false。对于共享云端硬盘中的文件夹,请改用 |
capabilities.canRename |
仅供输出。当前用户是否可重命名此文件。 |
capabilities.canTrash |
仅供输出。当前用户是否可以将此文件移至回收站。 |
capabilities.canReadRevisions |
仅供输出。当前用户是否能够读取此文件的修订版本资源。对于共享云端硬盘内容,是否可以读取此内容的非文件夹后代的修订版本,以及此内容本身(如果不是文件夹)。 |
capabilities.canReadTeamDrive |
仅供输出。已废弃:请改用 |
capabilities.canMoveTeamDriveItem |
仅供输出。已废弃:请改用 |
capabilities.canChangeCopyRequiresWriterPermission |
仅供输出。当前用户是否可以更改此文件的 |
capabilities.canMoveItemIntoTeamDrive |
仅供输出。已废弃:请改用 |
capabilities.canUntrash |
仅供输出。当前用户是否可以从回收站恢复此文件。 |
capabilities.canModifyContent |
仅供输出。当前用户是否可以修改此文件的内容。 |
capabilities.canMoveItemWithinTeamDrive |
仅供输出。已废弃:请改用 |
capabilities.canMoveItemOutOfTeamDrive |
仅供输出。已废弃:请改用 |
capabilities.canDeleteChildren |
仅供输出。当前用户是否可以删除此文件夹的子级。如果项不是文件夹,则此值为 false。系统只会为共享云端硬盘中的内容填充此字段。 |
capabilities.canMoveChildrenOutOfTeamDrive |
仅供输出。已废弃:请改用 |
capabilities.canMoveChildrenWithinTeamDrive |
仅供输出。已废弃:请改用 |
capabilities.canTrashChildren |
仅供输出。当前用户是否可以将此文件夹的子级移至回收站。如果项不是文件夹,则此值为 false。系统只会为共享云端硬盘中的内容填充此字段。 |
capabilities.canMoveItemOutOfDrive |
仅供输出。当前用户是否可以通过更改其父级来将此内容移出此云端硬盘。请注意,更改项的父级的请求可能仍会失败,具体取决于要添加的新父级。 |
capabilities.canAddMyDriveParent |
仅供输出。指定当前用户是否可以为相应项添加父级,而无需在同一请求中移除现有的父级。对于共享云端硬盘文件,系统不会填充此信息。 |
capabilities.canRemoveMyDriveParent |
仅供输出。指定当前用户是否可以从项中移除父级,而无需在同一请求中添加其他父级。对于共享云端硬盘文件,系统不会填充此信息。 |
capabilities.canMoveItemWithinDrive |
仅供输出。当前用户是否可以在此云端硬盘内移动此内容。请注意,更改项的父级的请求可能仍会失败,具体取决于要添加的新父级和要移除的父级。 |
capabilities.canShare |
仅供输出。当前用户是否可以修改此文件的共享设置。 |
capabilities.canMoveChildrenWithinDrive |
仅供输出。当前用户是否可以在此云端硬盘内移动此文件夹的子级。如果项不是文件夹,则此值为 false。请注意,移动子级的请求可能仍会失败,具体取决于当前用户对子级和目标文件夹的访问权限。 |
capabilities.canModifyContentRestriction |
已弃用:仅限输出。请使用 |
capabilities.canAddFolderFromAnotherDrive |
仅供输出。当前用户是否可以将其他云端硬盘(其他共享云端硬盘或“我的云端硬盘”)中的文件夹添加到此文件夹。如果项不是文件夹,则此值为 false。系统只会为共享云端硬盘中的内容填充此字段。 |
capabilities.canChangeSecurityUpdateEnabled |
仅供输出。当前用户是否可以更改链接共享元数据中的 securityUpdateEnabled 字段。 |
capabilities.canAcceptOwnership |
仅供输出。当前用户是否是文件的受让所有者。对于共享云端硬盘文件,系统不会填充此信息。 |
capabilities.canReadLabels |
仅供输出。当前用户是否能够读取文件上的标签。 |
capabilities.canModifyLabels |
仅供输出。当前用户是否可以修改文件的标签。 |
capabilities.canModifyEditorContentRestriction |
仅供输出。指定当前用户是否可以为编辑限制的文件添加或修改内容限制。 |
capabilities.canModifyOwnerContentRestriction |
仅供输出。指定当前用户是否可以添加或修改所有者受限的内容限制。 |
capabilities.canRemoveContentRestriction |
仅供输出。当前用户是否可移除针对相应文件的内容限制。 |
hasAugmentedPermissions |
仅供输出。是否存在直接对此文件的权限。系统只会为共享云端硬盘中的内容填充此字段。 |
trashingUser |
仅供输出。如果文件已被明确移至回收站,则显示将文件移至回收站的用户。系统只会为共享云端硬盘中的内容填充此字段。 |
canReadRevisions |
仅供输出。已废弃:请改用 |
thumbnailVersion |
仅供输出。用于缩略图缓存失效操作的缩略图版本。 |
trashedDate |
仅供输出。内容移至回收站的时间(带格式的 RFC 3339 时间戳)。系统只会为共享云端硬盘中的内容填充此字段。 |
permissionIds[] |
仅限输出。有权访问此文件的用户的 files.list 权限。 |
thumbnail |
文件的缩略图。仅当无法生成标准缩略图时,才会用到此参数。 |
thumbnail.image |
缩略图图片可在网址中安全使用的 Base64 编码字节。应符合 RFC 4648 第 5 节的规定。 使用 base64 编码的字符串。 |
thumbnail.mimeType |
缩略图的 MIME 类型。 |
imageMediaMetadata |
仅供输出。有关图片媒体的元数据。这仅会针对图片类型显示,其内容取决于可以从图片内容中解析出的内容。 |
imageMediaMetadata.flashUsed |
仅供输出。创建照片时是否使用了闪光灯。 |
imageMediaMetadata.meteringMode |
仅供输出。用于创建照片的测光模式。 |
imageMediaMetadata.sensor |
仅供输出。用于创建照片的传感器类型。 |
imageMediaMetadata.exposureMode |
仅供输出。用于创建照片的曝光模式。 |
imageMediaMetadata.colorSpace |
仅供输出。照片的颜色空间。 |
imageMediaMetadata.whiteBalance |
仅供输出。用于创建照片的白平衡模式。 |
imageMediaMetadata.width |
仅供输出。图片的宽度(以像素为单位)。 |
imageMediaMetadata.height |
仅供输出。图片的高度(以像素为单位)。 |
imageMediaMetadata.location |
仅供输出。图片中存储的地理位置信息。 |
imageMediaMetadata.location.latitude |
仅供输出。图片中存储的纬度。 |
imageMediaMetadata.location.longitude |
仅供输出。图片中存储的经度。 |
imageMediaMetadata.location.altitude |
仅供输出。图片中存储的海拔高度。 |
imageMediaMetadata.rotation |
仅供输出。从图片的原始方向顺时针旋转 90 度的次数。 |
imageMediaMetadata.date |
仅供输出。照片拍摄的日期和时间(EXIF 格式的时间戳)。 |
imageMediaMetadata.cameraMake |
仅供输出。用于创建照片的相机品牌。 |
imageMediaMetadata.cameraModel |
仅供输出。用于创建照片的相机型号。 |
imageMediaMetadata.exposureTime |
仅供输出。曝光时长(以秒为单位)。 |
imageMediaMetadata.aperture |
仅供输出。用于创建照片的光圈 (f-number)。 |
imageMediaMetadata.focalLength |
仅供输出。用于创建照片的焦距(以毫米为单位)。 |
imageMediaMetadata.isoSpeed |
仅供输出。用于创建照片的 ISO 速度。 |
imageMediaMetadata.exposureBias |
仅供输出。照片的曝光偏差(APEX 值)。 |
imageMediaMetadata.maxApertureValue |
仅供输出。用于制作照片的镜头的最小 f 数(焦距为 APEX 值)。 |
imageMediaMetadata.subjectDistance |
仅供输出。与照片拍摄正文的距离(以米为单位)。 |
imageMediaMetadata.lens |
仅供输出。用于创建照片的镜头。 |
videoMediaMetadata |
仅供输出。关于视频媒体的元数据。此字段仅会针对视频类型显示。 |
videoMediaMetadata.width |
仅供输出。视频的宽度(以像素为单位)。 |
videoMediaMetadata.height |
仅供输出。视频的高度(以像素为单位)。 |
videoMediaMetadata.durationMillis |
仅供输出。视频的时长(以毫秒为单位)。 |
shortcutDetails |
快捷方式文件详细信息。仅针对 mimeType 字段设置为 |
shortcutDetails.targetId |
此快捷方式指向的文件的 ID。 |
shortcutDetails.targetMimeType |
仅供输出。此快捷方式指向的文件的 MIME 类型。此字段的值是创建快捷方式时捕获的目标 MIME 类型的快照。 |
shortcutDetails.targetResourceKey |
仅供输出。目标文件的 ResourceKey。 |
contentRestrictions[] |
对访问文件内容的限制。仅当存在此类限制时填充。 |
resourceKey |
仅供输出。通过共享链接访问该项所需的密钥。 |
linkShareMetadata |
仅供输出。LinkShare 的相关详情。包含有关客户端用于引用此商品的链接网址的详情。 |
linkShareMetadata.securityUpdateEligible |
仅供输出。文件是否符合安全更新条件。 |
linkShareMetadata.securityUpdateEnabled |
仅供输出。用于指明此文件是否启用了安全更新。 |
labelInfo |
仅供输出。文件标签的概览。 |
labelInfo.labels[] |
仅供输出。根据 |
sha1Checksum |
仅供输出。与此文件关联的 SHA1 校验和(如果有)。只有内容存储在 Google 云端硬盘的文件中,系统才会填充此字段;对于文档编辑器或快捷方式文件,系统不会填充此字段。 |
sha256Checksum |
仅供输出。与此文件关联的 SHA256 校验和(如果有)。只有内容存储在 Google 云端硬盘的文件中,系统才会填充此字段;对于文档编辑器或快捷方式文件,系统不会填充此字段。 |
ContentRestriction
对访问文件内容的限制。
JSON 表示法 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
字段 | |
---|---|
readOnly |
文件内容是否为只读内容。如果文件是只读的,就不能添加新的修订版本,不能添加或修改评论,也不能修改文件标题。 |
reason |
文件内容受限的原因。此字段仅在同样设置了 |
type |
仅供输出。内容限制的类型。目前唯一可能的值为 |
restrictingUser |
仅供输出。设置内容限制的用户。仅当 |
restrictionDate |
仅供输出。设置内容限制的时间(带格式的 RFC 3339 时间戳)。仅当 |
ownerRestricted |
内容限制是否只能由文件所有者修改或移除。对于共享云端硬盘中的文件,任何具有 |
systemRestricted |
仅供输出。系统是否应用了内容限制,例如由于电子签名。用户无法修改或移除系统受限内容限制。 |
方法 |
|
---|---|
|
创建指定文件的副本。 |
|
系统会永久删除该用户拥有的文件,而不会将其移至回收站。 |
|
永久删除该用户在回收站中的所有文件。 |
|
将 Google Workspace 文档导出为请求的 MIME 类型,并返回导出的字节内容。 |
|
生成一组可在插入或复制请求中提供的文件 ID。 |
|
按 ID 获取文件的元数据或内容。 |
|
插入新文件。 |
|
列出用户的文件。 |
|
列出文件的标签。 |
|
修改应用于文件的标签集。 |
|
更新文件的元数据和/或内容。 |
|
将文件的更新时间设置为当前的服务器时间。 |
|
将文件移到回收站。 |
|
从回收站中恢复文件。 |
|
更新文件的元数据和/或内容。 |
|
订阅对文件的更改。 |