- 资源:File
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ContentRestriction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 方法
资源:文件
文件的元数据。
某些资源方法(例如 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[] |
包含文件的父级文件夹的 ID。 一个文件只能有一个父级文件夹;不支持指定多个父级。 如果在插入请求中未指定相应文件,则该文件会直接放置在用户的“我的云端硬盘”文件夹中。如果未作为复制请求的一部分指定,该文件将继承源文件的任何可检测到的父级文件。files.update 请求必须使用 |
thumbnailLink |
仅限输出。指向文件缩略图(如果有)的短期链接。通常持续几个小时。由于跨域资源共享 (CORS) 的影响,不适合直接在 Web 应用中使用,请考虑使用代理服务器。仅在发出请求的应用可以访问文件内容时填充。如果文件未公开共享,则必须使用凭据请求来提取 |
appDataContents |
仅限输出。此文件是否在“Application Data”文件夹中。 |
webViewLink |
仅限输出。一个链接,仅在公共文件夹中提供,用于通过 Google 云端硬盘的网站托管查看静态 Web 资源(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 |
仅限输出。此文件是否有缩略图。这并不表示提出请求的应用是否有权访问缩略图。要检查访问权限,请查看是否有 minimumLink 字段。 |
spaces[] |
仅限输出。包含文件的聊天室的列表。支持的值包括 |
folderColorRgb |
如果文件是文件夹或文件夹快捷方式,则以 RGB 十六进制字符串表示文件夹颜色。“About”(关于)资源的 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 时间戳格式)。请注意,设置 modifyDate 也将为设置日期的用户更新 modifiedByMe 日期。 |
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 中列出了有权访问此文件的用户的权限 ID。 |
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 值)。 |
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 获取文件的元数据或内容。 |
|
插入新文件。 |
|
列出用户的文件。 |
|
列出文件的标签。 |
|
修改应用于文件的一组标签。 |
|
更新文件的元数据和/或内容。 |
|
将文件的更新时间设置为当前服务器时间。 |
|
将文件移至回收站。 |
|
从回收站中还原文件。 |
|
更新文件的元数据和/或内容。 |
|
订阅文件的更改。 |