资源:文件
文件的元数据。
某些资源方法(例如 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 |
要为文件编入索引的文本,用于改进全文查询。该标题不得超过 128KB,并且可能包含 HTML 元素。 |
contentHints.thumbnail |
文件的缩略图。这仅适用于 Google 云端硬盘无法生成标准缩略图的情况。 |
contentHints.thumbnail.image |
使用可在网址中安全使用的 Base64 编码的缩略图数据(RFC 4648 第 5 节)。 使用 base64 编码的字符串。 |
contentHints.thumbnail.mimeType |
缩略图的 MIME 类型。 |
writersCanShare |
仅具有 |
viewedByMe |
仅供输出。相应用户是否已查看文件。 |
mimeType |
文件的 MIME 类型。 如果未提供任何值,Google 云端硬盘会尝试自动检测上传的内容中的相应值。除非上传新的修订版本,否则无法更改该值。 如果文件是使用 Google 文档 MIME 类型创建的,系统会尽可能导入上传的内容。“简介”资源中发布了支持的导入格式。 |
exportLinks |
仅供输出。用于将文档编辑器文件导出为特定格式的链接。 包含一系列 |
parents[] |
包含文件的父级文件夹的 ID。 如果未在创建请求中指定,则文件会直接放在用户的“我的云端硬盘”文件夹中。如果未作为复制请求的一部分指定,则该文件将继承源文件的所有可检测到的父级。files.update 请求必须使用 |
thumbnailLink |
仅供输出。指向文件缩略图的短期链接(如果有)。通常持续数小时。仅当请求的应用可以访问文件的内容时,系统才会填充相应值。如果文件未公开共享,必须使用基于凭据的请求提取 |
iconLink |
仅供输出。指向文件图标的未经身份验证的静态链接。 |
shared |
仅供输出。文件是否已共享。对于共享云端硬盘中的内容,系统不会填充此信息。 |
lastModifyingUser |
仅供输出。最后修改文件的用户。 |
owners[] |
仅供输出。此文件的所有者。只有某些旧版文件可以有多个所有者。对于共享云端硬盘中的内容,系统不会填充此字段。 |
headRevisionId |
仅供输出。文件头修订版本的 ID。此功能目前仅适用于 Google 云端硬盘中含有二进制内容的文件。 |
sharingUser |
仅供输出。与发出请求的用户共享文件的用户(如果适用)。 |
webViewLink |
仅供输出。用于通过浏览器中的相关 Google 编辑器或查看器打开文件的链接。 |
webContentLink |
仅供输出。用于在浏览器中下载文件内容的链接。此操作仅适用于 Google 云端硬盘中含有二进制内容的文件。 |
size |
仅供输出。blob 和第一方编辑器文件的大小(以字节为单位)。对于没有大小的文件(例如快捷方式和文件夹),系统不会填充此字段。 |
viewersCanCopyContent |
已废弃:请改用 |
permissions[] |
仅供输出。文件权限的完整列表。只有在发出请求的用户可以共享文件时,才可以使用该选项。对于共享云端硬盘中的内容,系统不会填充此信息。 |
hasThumbnail |
仅供输出。此文件是否有缩略图。这不会指示发出请求的应用是否有权访问缩略图。要检查访问权限,请查找缩略图链接字段是否存在。 |
spaces[] |
仅供输出。包含该文件的聊天室列表。目前支持的值包括“drive”“appDataFolder”和“photos”。 |
folderColorRgb |
文件夹或文件夹快捷方式的颜色,以 RGB 十六进制字符串表示。支持的颜色会发布在“关于”资源的 如果指定了不受支持的颜色,系统会改用调色板中最接近的颜色。 |
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 权限。 |
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 DateTime)。 |
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 |
仅供输出。设置内容限制的用户。仅当 |
restrictionTime |
仅供输出。设置内容限制的时间(带格式的 RFC 3339 时间戳)。仅当 |
ownerRestricted |
内容限制是否只能由文件所有者修改或移除。对于共享云端硬盘中的文件,任何具有 |
方法 |
|
---|---|
|
创建文件的副本,并通过补丁语义应用任何请求的更新。 |
|
创建新文件。 |
|
系统会永久删除该用户拥有的文件,而不会将其移至回收站。 |
|
永久删除该用户在回收站中的所有文件。 |
|
将 Google Workspace 文档导出为请求的 MIME 类型,并返回导出的字节内容。 |
|
生成一组文件 ID,这些 ID 可在创建或复制请求中提供。 |
|
按 ID 获取文件的元数据或内容。 |
|
列出用户的文件。 |
|
列出文件的标签。 |
|
修改应用于文件的标签集。 |
|
更新文件的元数据和/或内容。 |
|
订阅对文件的更改。 |