- 资源: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, "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 |
仅限输出。指明资源的类型。值:固定字符串 |
driveId |
仅限输出。文件所在共享云端硬盘的 ID。系统只会为共享云端硬盘中的内容填充内容。 |
fileExtension |
仅限输出。 |
copyRequiresWriterPermission |
无论是复制、打印还是下载此文件的选项,都应为读者和评论者停用。 |
md5Checksum |
仅限输出。文件内容的 MD5 校验和。这仅适用于 Google 云端硬盘中含有二进制内容的文件。 |
contentHints |
有关文件内容的更多信息。响应中绝不会填充这些字段。 |
contentHints.indexableText |
要针对文件编入索引的文本,以改进 FullText 查询。此字段不得超过 128KB,且可以包含 HTML 元素。 |
contentHints.thumbnail |
文件的缩略图。仅当 Google 云端硬盘无法生成标准缩略图时,才会使用此方法。 |
contentHints.thumbnail.image |
使用可在网址中安全使用的 Base64(RFC 4648 第 5 节)编码的缩略图数据。 使用 base64 编码的字符串。 |
contentHints.thumbnail.mimeType |
缩略图的 MIME 类型。 |
writersCanShare |
是否仅拥有 |
viewedByMe |
仅限输出。此用户是否已查看过文件。 |
mimeType |
文件的 MIME 类型。 如果未提供任何值,Google 云端硬盘会尝试从上传的内容中自动检测适当的值。除非上传新的修订版本,否则该值无法更改。 如果文件创建时采用了 Google 文档 MIME 类型,系统会尽可能导入上传的内容。支持的导入格式在“About”资源中发布。 |
exportLinks |
仅限输出。用于将文档编辑器文件导出为特定格式的链接。 包含一系列 |
parents[] |
包含文件的父级文件夹的 ID。 一个文件只能有一个父级文件夹;不支持指定多个父级。 如果您未在创建请求中指定此文件,则系统会直接将文件存放在用户的“我的云端硬盘”文件夹中。如果未作为复制请求的一部分指定,该文件将继承源文件的任何可检测到的父级文件。files.update 请求必须使用 |
thumbnailLink |
仅限输出。指向文件缩略图(如果有)的短期链接。通常持续几个小时。由于跨域资源共享 (CORS) 政策限制,不适合直接在 Web 应用中使用,请考虑使用代理服务器。仅在发出请求的应用可以访问文件内容时填充。如果文件未公开共享,则必须使用凭据请求来提取 |
iconLink |
仅限输出。指向文件图标的未经身份验证的静态链接。 |
shared |
仅限输出。文件是否已共享。对于共享云端硬盘中的内容,系统不会填充此项。 |
lastModifyingUser |
仅限输出。修改文件的最后一位用户。仅当上次修改是由已登录的用户执行时,系统才会填充此字段。 |
owners[] |
仅限输出。此文件的所有者。只有某些旧版文件可以有多个所有者。对于共享云端硬盘中的内容,系统不会填充此字段。 |
headRevisionId |
仅限输出。文件头修订版本的 ID。此功能目前仅适用于 Google 云端硬盘中含有二进制内容的文件。 |
sharingUser |
仅限输出。与发出请求的用户共享文件的用户(如果有)。 |
webViewLink |
仅限输出。一个链接,用于在相关的 Google 编辑器或浏览器中打开文件。 |
webContentLink |
仅限输出。用于在浏览器中下载文件内容的链接。这仅适用于 Google 云端硬盘中含有二进制内容的文件。 |
size |
仅限输出。blob 和第一方编辑器文件的大小(以字节为单位)。对于没有大小的文件(例如快捷方式和文件夹),不会填充数据。 |
viewersCanCopyContent |
已弃用:请改用 |
permissions[] |
仅限输出。文件权限的完整列表。只有当发出请求的用户可以共享文件时,此字段才可用。对于共享云端硬盘中的内容,系统不会填充此项。 |
hasThumbnail |
仅限输出。此文件是否有缩略图。这并不表示提出请求的应用是否有权访问缩略图。要检查访问权限,请查看是否有 minimumLink 字段。 |
spaces[] |
仅限输出。包含文件的聊天室的列表。目前支持的值为“drive”“appDataFolder”和“照片” |
folderColorRgb |
文件夹或文件夹快捷方式的颜色,以 RGB 十六进制字符串表示。受支持的颜色发布在“About”资源的 如果指定了不受支持的颜色,系统会改用调色板中最接近的颜色。 |
id |
文件的 ID。 |
name |
文件的名称。该名称在文件夹中不一定是唯一的。请注意,对于不可变内容(例如共享云端硬盘的顶级文件夹、“我的云端硬盘”根文件夹、应用数据文件夹),名称是不变的。 |
description |
文件的简短说明。 |
starred |
用户是否为文件加星标。 |
trashed |
文件是否已移至回收站(明确移至回收站,或是从父级文件夹移至回收站)。只有所有者可以将文件移至回收站,其他用户无法查看所有者回收站中的文件。 |
explicitlyTrashed |
仅限输出。文件是否已明确移至回收站,而不是从父级文件夹递归移至回收站。 |
createdTime |
文件的创建时间(RFC 3339 日期时间)。 |
modifiedTime |
任何人上次修改该文件的时间(RFC 3339 日期时间)。 请注意,设置 |
modifiedByMeTime |
仅限输出。用户上次修改文件的时间(RFC 3339 日期时间)。 |
viewedByMeTime |
用户最后一次查看文件的时间(RFC 3339 日期时间)。 |
sharedWithMeTime |
仅限输出。与用户共享文件的时间(如果适用,RFC 3339 日期时间)。 |
quotaBytesUsed |
仅限输出。文件使用的存储空间配额字节数。这包括主要修订版本以及启用了 |
version |
仅限输出。文件单调递增的版本号。这反映了对服务器上文件所做的每一个更改,甚至包括对用户不可见的更改。 |
originalFilename |
已上传内容的原始文件名(如果有),或 |
ownedByMe |
仅限输出。用户是否拥有文件。对于共享云端硬盘中的内容,系统不会填充此项。 |
fullFileExtension |
仅限输出。从 当 |
properties |
对所有应用可见的任意键值对的集合。 在更新和复制请求中会清除值为 null 的条目。 包含一系列 |
appProperties |
发出请求的应用所专有的任意键值对的集合。 在更新和复制请求中会清除值为 null 的条目。 只能使用经过身份验证的请求检索这些属性。经过身份验证的请求使用通过 OAuth 2 客户端 ID 获取的访问令牌。您无法使用 API 密钥检索私有属性。 包含一系列 |
isAppAuthorized |
仅限输出。文件是由请求方应用创建还是打开的。 |
teamDriveId |
已弃用:仅限输出。请改用 |
capabilities |
仅限输出。当前用户对此文件的权限。每项功能都对应于用户可能执行的精细操作。 |
capabilities.canChangeViewersCanCopyContent |
已弃用:仅限输出。 |
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 |
仅限输出。如果文件已被明确移入回收站,则删除该文件的用户。系统只会为共享云端硬盘中的内容填充内容。 |
thumbnailVersion |
仅限输出。供缩略图缓存失效使用的缩略图版本。 |
trashedTime |
仅限输出。内容移至回收站的时间(RFC 3339 日期时间)。系统只会为共享云端硬盘中的内容填充内容。 |
modifiedByMe |
仅限输出。此用户是否修改过该文件。 |
permissionIds[] |
仅限输出。files.list 中列出了有权访问此文件的用户的权限 ID。 |
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.time |
仅限输出。照片拍摄日期和时间(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 |
仅限输出。设置内容限制的用户。仅当 |
restrictionTime |
仅限输出。设置内容限制的时间(采用 RFC 3339 时间戳格式)。仅当 |
ownerRestricted |
内容限制是否只能由文件所有者修改或移除。对于共享云端硬盘中的文件,任何拥有 |
systemRestricted |
仅限输出。内容限制是否由系统应用,例如因电子签名而应用。用户无法修改或移除系统限制内容限制。 |
方法 |
|
---|---|
|
创建文件的副本,并以补丁语义应用所有请求的更新。 |
|
创建新文件。 |
|
永久删除该用户拥有的文件,而不将其移至回收站。 |
|
永久删除用户移至回收站的所有文件。 |
|
将 Google Workspace 文档导出为请求的 MIME 类型,并返回导出的字节内容。 |
|
生成一组可在创建或复制请求中提供的文件 ID。 |
|
根据 ID 获取文件的元数据或内容。 |
|
列出用户的文件。 |
|
列出文件的标签。 |
|
修改应用于文件的一组标签。 |
|
更新文件的元数据和/或内容。 |
|
订阅文件的更改。 |