资源:File
文件的元数据。
某些资源方法(例如 files.update)需要 fileId。使用 files.list 方法检索文件的 ID。
| JSON 表示法 | 
|---|
| { "exportLinks": { string: string, ... }, "parents": [ string ], "owners": [ { object ( | 
| 字段 | |
|---|---|
| exportLinks | 
 仅限输出。用于将 Google 文档编辑器文件导出为特定格式的链接。 包含一系列  | 
| parents[] | 
 包含相应文件的父文件夹的 ID。 一个文件只能有一个父文件夹;不支持指定多个父文件夹。 如果未在创建请求中指定,则文件会直接放置在用户的“我的云端硬盘”文件夹中。如果未在复制请求中指定,则文件会继承源文件的任何可发现的父级。更新请求必须使用  | 
| owners[] | 
 仅限输出。相应文件的所有者。只有某些旧版文件可能拥有多个所有者。系统不会为共享云端硬盘中的内容填充此字段。 | 
| permissions[] | 
 仅限输出。文件的完整权限列表。仅当请求用户可以共享文件时,此字段才可用。系统不会为共享云端硬盘中的内容填充此字段。 | 
| spaces[] | 
 仅限输出。包含相应文件的空间列表。目前支持的值包括  | 
| properties | 
 可供所有应用查看的任意键值对的集合。 在更新和复制请求中,系统会清除具有 null 值的条目。 包含一系列  | 
| appProperties | 
 任意键值对的集合,仅供请求应用使用。 在更新和复制请求中,系统会清除具有 null 值的条目。 这些属性只能通过经过身份验证的请求进行检索。经过身份验证的请求使用通过 OAuth 2.0 客户端 ID 获取的访问令牌。您无法使用 API 密钥检索私有媒体资源。 包含一系列  | 
| permissionIds[] | 
 仅限输出。有权访问相应文件的用户的权限 ID 列表。 | 
| contentRestrictions[] | 
 对访问文件内容的限制。仅当存在此类限制时填充。 | 
| kind | 
 仅限输出。表明这是哪类资源。值:固定字符串  | 
| driveId | 
 仅限输出。文件所在的共享云端硬盘的 ID。仅针对共享云端硬盘中的内容填充。 | 
| fileExtension | 
 仅限输出。 | 
| copyRequiresWriterPermission | 
 是否应禁止读者和评论者复制、打印或下载此文件。 | 
| md5Checksum | 
 仅限输出。文件内容的 MD5 校验和。此架构仅适用于 Google 云端硬盘中的二进制内容文件。 | 
| contentHints | 
 有关文件内容的其他信息。这些字段永远不会在响应中填充。 | 
| contentHints.indexableText | 
 要为文件编制索引的文本,以改进 fullText 查询。长度不得超过 128 KB,并且可以包含 HTML 元素。 | 
| contentHints.thumbnail | 
 文件的缩略图。仅当 Google 云端硬盘无法生成标准缩略图时,才会使用此缩略图。 | 
| contentHints.thumbnail.image | 
 使用可在网址中安全使用的 Base64 (RFC 4648 第 5 节) 编码的缩略图数据。 使用 base64 编码的字符串。 | 
| contentHints.thumbnail.mimeType | 
 缩略图的 MIME 类型。 | 
| writersCanShare | 
 仅拥有  | 
| viewedByMe | 
 仅限输出。相应文件是否已被相应用户查看。 | 
| mimeType | 
 文件的 MIME 类型。 如果未提供任何值,Google 云端硬盘会尝试从上传的内容中自动检测合适的值。除非上传新修订版本,否则无法更改此值。 如果使用 Google 文档 MIME 类型创建文件,系统会尽可能导入上传的内容。支持的导入格式已发布在  | 
| thumbnailLink | 
 仅限输出。指向文件缩略图的短期链接(如有)。通常持续数小时。由于存在跨域资源共享 (CORS) 政策,因此不适合在 Web 应用中直接使用。考虑使用代理服务器。仅当请求的应用可以访问文件内容时填充。如果文件未公开共享,则必须使用经过身份验证的请求来获取  | 
| iconLink | 
 仅限输出。指向文件图标的静态、未经身份验证的链接。 | 
| shared | 
 仅限输出。文件是否已共享。系统不会为共享云端硬盘中的内容填充此字段。 | 
| lastModifyingUser | 
 仅限输出。上次修改文件的用户。只有在上次修改是由已登录的用户执行的情况下,系统才会填充此字段。 | 
| headRevisionId | 
 仅限输出。文件最新修订版本的 ID。此架构目前仅适用于 Google 云端硬盘中的二进制内容文件。 | 
| sharingUser | 
 仅限输出。与请求用户共享文件的用户(如有)。 | 
| webViewLink | 
 仅限输出。用于在浏览器中打开相关 Google 编辑器或查看器中的文件的链接。 | 
| webContentLink | 
 仅限输出。用于在浏览器中下载文件内容的链接。此架构仅适用于 Google 云端硬盘中的二进制内容文件。 | 
| size | 
 仅限输出。blob 和 Google Workspace 编辑器文件的大小(以字节为单位)。不会针对没有大小的文件(例如快捷方式和文件夹)填充此字段。 | 
| viewersCanCopyContent | 
 已弃用:请改用  | 
| hasThumbnail | 
 仅限输出。相应文件是否有缩略图。这并不表示请求的应用是否有权访问缩略图。如需检查访问权限,请查看是否存在 thumbnailLink 字段。 | 
| 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 | 
 仅限输出。从  当  | 
| isAppAuthorized | 
 仅限输出。文件是否由请求的应用创建或打开。 | 
| teamDriveId | 
 已弃用:仅限输出。请改用  | 
| capabilities | 
 仅限输出。当前用户对相应文件拥有的功能。每项功能都对应于用户可能采取的精细操作。如需了解详情,请参阅了解文件功能。 | 
| capabilities.canChangeViewersCanCopyContent | 
 已弃用:仅限输出。 | 
| capabilities.canMoveChildrenOutOfDrive | 
 仅限输出。当前用户是否可以将相应文件夹的子项移出共享云端硬盘。如果相应内容不是文件夹,则为  | 
| capabilities.canReadDrive | 
 仅限输出。当前用户是否可以读取相应文件所属的共享云端硬盘。仅针对共享云端硬盘中的内容填充。 | 
| capabilities.canEdit | 
 仅限输出。当前用户是否可以修改相应文件。其他因素可能会限制用户可以对文件进行的更改类型。例如,请参阅  | 
| capabilities.canCopy | 
 仅限输出。当前用户是否可以复制相应文件。对于共享云端硬盘中的内容,当前用户是否可以复制相应内容的非文件夹后代,或者复制相应内容(如果该内容不是文件夹)。 | 
| capabilities.canComment | 
 仅限输出。当前用户是否可以对此文件发表评论。 | 
| capabilities.canAddChildren | 
 仅限输出。当前用户是否可以向相应文件夹添加子项。如果相应项不是文件夹,则此值始终为  | 
| capabilities.canDelete | 
 仅限输出。当前用户是否可以删除相应文件。 | 
| capabilities.canDownload | 
 仅限输出。当前用户是否可以下载相应文件。 | 
| capabilities.canListChildren | 
 仅限输出。当前用户是否可以列出相应文件夹的子项。如果相应项不是文件夹,则此值始终为  | 
| capabilities.canRemoveChildren | 
 仅限输出。当前用户是否可以从相应文件夹中移除子项。如果相应内容不是文件夹,则此值始终为  | 
| capabilities.canRename | 
 仅限输出。当前用户是否可以重命名相应文件。 | 
| capabilities.canTrash | 
 仅限输出。当前用户是否可以将相应文件移至回收站。 | 
| capabilities.canReadRevisions | 
 仅限输出。当前用户是否可以读取相应文件的修订版本资源。对于共享云端硬盘内容,是否可以读取相应内容的非文件夹后代的修订版本,或者相应内容(如果不是文件夹)的修订版本。 | 
| capabilities.canReadTeamDrive | 
 已弃用:仅限输出。请改用  | 
| capabilities.canMoveTeamDriveItem | 
 已弃用:仅限输出。请改用  | 
| capabilities.canChangeCopyRequiresWriterPermission | 
 仅限输出。当前用户是否可以更改相应文件的  | 
| capabilities.canMoveItemIntoTeamDrive | 
 已弃用:仅限输出。请改用  | 
| capabilities.canUntrash | 
 仅限输出。当前用户是否可以从回收站中恢复相应文件。 | 
| capabilities.canModifyContent | 
 仅限输出。当前用户是否可以修改相应文件的内容。 | 
| capabilities.canMoveItemWithinTeamDrive | 
 已弃用:仅限输出。请改用  | 
| capabilities.canMoveItemOutOfTeamDrive | 
 已弃用:仅限输出。请改用  | 
| capabilities.canDeleteChildren | 
 仅限输出。当前用户是否可以删除相应文件夹的子项。如果相应内容不是文件夹,则为  | 
| capabilities.canMoveChildrenOutOfTeamDrive | 
 已弃用:仅限输出。请改用  | 
| capabilities.canMoveChildrenWithinTeamDrive | 
 已弃用:仅限输出。请改用  | 
| capabilities.canTrashChildren | 
 仅限输出。当前用户是否可以删除相应文件夹的子项。如果相应内容不是文件夹,则为  | 
| capabilities.canMoveItemOutOfDrive | 
 仅限输出。当前用户是否可以通过更改相应项的父级来将其移出此云端硬盘。请注意,即使您请求更改商品的父级,该请求仍可能会失败,具体取决于要添加的新父级。 | 
| capabilities.canAddMyDriveParent | 
 仅限输出。当前用户是否可以在同一请求中添加商品的父项,而无需移除现有父项。对于共享云端硬盘文件,此字段不会填充。 | 
| capabilities.canRemoveMyDriveParent | 
 仅限输出。当前用户是否可以在同一请求中移除商品的父级,而不添加其他父级。对于共享云端硬盘文件,此字段不会填充。 | 
| capabilities.canMoveItemWithinDrive | 
 仅限输出。当前用户是否可以在相应云端硬盘中移动相应内容。请注意,即使您请求更改商品的父级,该请求仍可能会失败,具体取决于要添加的新父级和要移除的父级。 | 
| capabilities.canShare | 
 仅限输出。当前用户是否可以修改相应文件的共享设置。 | 
| capabilities.canMoveChildrenWithinDrive | 
 仅限输出。当前用户是否可以在相应云端硬盘中移动相应文件夹的子项。如果相应内容不是文件夹,则为  | 
| capabilities.canModifyContentRestriction | 
 已弃用:仅限输出。请使用  | 
| capabilities.canAddFolderFromAnotherDrive | 
 仅限输出。当前用户是否可以将其他云端硬盘(不同的共享云端硬盘或“我的云端硬盘”)中的文件夹添加到此文件夹。如果相应内容不是文件夹,则为  | 
| capabilities.canChangeSecurityUpdateEnabled | 
 仅限输出。当前用户是否可以更改链接分享元数据中的  | 
| capabilities.canAcceptOwnership | 
 仅限输出。当前用户是否为文件的待定所有者。对于共享云端硬盘文件,此字段不会填充。 | 
| capabilities.canReadLabels | 
 仅限输出。当前用户是否可以读取文件上的标签。 | 
| capabilities.canModifyLabels | 
 仅限输出。当前用户是否可以修改文件上的标签。 | 
| capabilities.canModifyEditorContentRestriction | 
 仅限输出。当前用户是否可以添加或修改文件上受编辑器限制的内容限制。 | 
| capabilities.canModifyOwnerContentRestriction | 
 仅限输出。当前用户是否可以添加或修改所有者限制的内容限制。 | 
| capabilities.canRemoveContentRestriction | 
 仅限输出。当前用户是否可以移除文件上的内容限制。 | 
| capabilities.canDisableInheritedPermissions | 
 用户是否可以停用继承的权限。 | 
| capabilities.canEnableInheritedPermissions | 
 用户是否可以重新启用继承的权限。 | 
| capabilities.canChangeItemDownloadRestriction | 
 仅限输出。当前用户是否可以更改文件的所有者或组织者设置的下载限制。 | 
| hasAugmentedPermissions | 
 仅限输出。相应文件是否具有直接权限。系统仅会为共享云端硬盘中的内容填充此字段。 | 
| trashingUser | 
 仅限输出。如果文件已被明确放入回收站,则为将其放入回收站的用户。仅针对共享云端硬盘中的内容填充。 | 
| thumbnailVersion | 
 仅限输出。用于缩略图缓存失效的缩略图版本。 | 
| trashedTime | 
 仅限输出。相应项目被放入回收站的时间(RFC 3339 日期时间)。仅针对共享云端硬盘中的内容填充。 | 
| modifiedByMe | 
 仅限输出。相应文件是否已由相应用户修改。 | 
| 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 值)。 | 
| 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 | 
 仅限输出。通过共享链接访问相应内容所需的密钥。 | 
| linkShareMetadata | 
 仅限输出。LinkShare 相关详细信息。包含有关客户端用于引用相应媒体资源的链接网址的详细信息。 | 
| linkShareMetadata.securityUpdateEligible | 
 仅限输出。相应文件是否符合安全更新条件。 | 
| linkShareMetadata.securityUpdateEnabled | 
 仅限输出。相应文件是否已启用安全更新。 | 
| labelInfo | 
 仅限输出。文件上标签的概览。 | 
| labelInfo.labels[] | 
 仅限输出。文件上的一组标签,由  | 
| sha1Checksum | 
 仅限输出。与此文件关联的 SHA1 校验和(如果有)。此字段仅针对内容存储在 Google 云端硬盘中的文件填充;对于文档编辑器文件或快捷方式文件,此字段不会填充。 | 
| sha256Checksum | 
 仅限输出。与相应文件关联的 SHA256 校验和(如果有)。此字段仅针对内容存储在 Google 云端硬盘中的文件填充;对于文档编辑器文件或快捷方式文件,此字段不会填充。 | 
| inheritedPermissionsDisabled | 
 相应文件是否已停用继承的权限。默认情况下,系统会启用继承的权限。 | 
| downloadRestrictions | 
 对文件应用了下载限制。 | 
ContentRestriction
用于限制对文件内容的访问。
| JSON 表示法 | 
|---|
| {
  "readOnly": boolean,
  "reason": string,
  "type": string,
  "restrictingUser": {
    object ( | 
| 字段 | |
|---|---|
| readOnly | 
 文件内容是否为只读。如果文件为只读文件,则可能无法添加文件的新修订版本,也无法添加或修改评论,并且无法修改文件标题。 | 
| reason | 
 文件内容受到限制的原因。只有在请求中同时设置了  | 
| type | 
 仅限输出。内容限制的类型。目前,唯一可能的值是  | 
| restrictingUser | 
 仅限输出。设置内容限制的用户。仅当  | 
| restrictionTime | 
 仅限输出。设置内容限制的时间(采用 RFC 3339 日期时间格式)。仅当  | 
| ownerRestricted | 
 内容限制是否只能由文件所有者修改或移除。对于共享云端硬盘中的文件,任何具有  | 
| systemRestricted | 
 仅限输出。内容限制是否由系统应用,例如因电子签名而应用。用户无法修改或移除系统受限内容限制。 | 
DownloadRestrictionsMetadata
对文件应用了下载限制。
| JSON 表示法 | 
|---|
| { "itemDownloadRestriction": { object ( | 
| 字段 | |
|---|---|
| itemDownloadRestriction | 
 文件所有者或组织者直接应用了文件下载限制。此设置不会考虑共享云端硬盘设置或 DLP 规则。 | 
| effectiveDownloadRestrictionWithContext | 
 仅限输出。应用于此文件的有效下载限制。此设置会考虑所有限制设置和数据泄露防护规则。 | 
DownloadRestriction
对文件复制和下载的限制。
| JSON 表示法 | 
|---|
| { "restrictedForReaders": boolean, "restrictedForWriters": boolean } | 
| 字段 | |
|---|---|
| restrictedForReaders | 
 是否限制读者下载和复制。 | 
| restrictedForWriters | 
 是否限制了作者的下载和复制权限。如果为  | 
| 方法 | |
|---|---|
| 
 | 创建文件的副本,并应用具有补丁语义的任何请求的更新。 | 
| 
 | 创建文件。 | 
| 
 | 永久删除用户拥有的文件,而不将其移至回收站。 | 
| 
 | 下载文件内容。 | 
| 
 | 永久删除用户回收站中的所有文件。 | 
| 
 | 将 Google Workspace 文档导出为所请求的 MIME 类型,并返回导出的字节内容。 | 
| 
 | 生成一组可在创建或复制请求中提供的文件 ID。 | 
| 
 | 根据 ID 获取文件的元数据或内容。 | 
| 
 | 列出用户的文件。 | 
| 
 | 列出文件上的标签。 | 
| 
 | 修改应用于文件的标签集。 | 
| 
 | 更新文件的元数据、内容或两者。 | 
| 
 | 订阅文件的更改。 |