REST Resource: files

资源:文件

文件的元数据。

某些资源方法(例如 files.update)需要 fileId。使用 files.list 方法检索文件的 ID。

JSON 表示法
{
  "kind": string,
  "userPermission": {
    object (Permission)
  },
  "fileExtension": string,
  "md5Checksum": string,
  "selfLink": string,
  "ownerNames": [
    string
  ],
  "lastModifyingUserName": string,
  "editable": boolean,
  "writersCanShare": boolean,
  "downloadUrl": string,
  "mimeType": string,
  "exportLinks": {
    string: string,
    ...
  },
  "driveId": string,
  "parents": [
    {
      object (ParentReference)
    }
  ],
  "thumbnailLink": string,
  "appDataContents": boolean,
  "webViewLink": string,
  "iconLink": string,
  "shared": boolean,
  "lastModifyingUser": {
    object (User)
  },
  "owners": [
    {
      object (User)
    }
  ],
  "openWithLinks": {
    string: string,
    ...
  },
  "defaultOpenWithLink": string,
  "headRevisionId": string,
  "properties": [
    {
      object (Property)
    }
  ],
  "copyable": boolean,
  "etag": string,
  "sharingUser": {
    object (User)
  },
  "alternateLink": string,
  "embedLink": string,
  "webContentLink": string,
  "fileSize": string,
  "copyRequiresWriterPermission": boolean,
  "permissions": [
    {
      object (Permission)
    }
  ],
  "hasThumbnail": boolean,
  "spaces": [
    string
  ],
  "folderColorRgb": string,
  "id": string,
  "title": string,
  "description": string,
  "labels": {
    "viewed": boolean,
    "restricted": boolean,
    "starred": boolean,
    "hidden": boolean,
    "trashed": boolean,
    "modified": boolean
  },
  "explicitlyTrashed": boolean,
  "createdDate": string,
  "modifiedDate": string,
  "modifiedByMeDate": string,
  "lastViewedByMeDate": string,
  "markedViewedByMeDate": string,
  "sharedWithMeDate": string,
  "quotaBytesUsed": string,
  "version": string,
  "indexableText": {
    "text": string
  },
  "originalFilename": string,
  "ownedByMe": boolean,
  "canComment": boolean,
  "shareable": boolean,
  "fullFileExtension": string,
  "isAppAuthorized": boolean,
  "teamDriveId": string,
  "capabilities": {
    "canChangeRestrictedDownload": boolean,
    "canMoveChildrenOutOfDrive": boolean,
    "canReadDrive": boolean,
    "canEdit": boolean,
    "canCopy": boolean,
    "canComment": boolean,
    "canAddChildren": boolean,
    "canDelete": boolean,
    "canDownload": boolean,
    "canListChildren": boolean,
    "canRemoveChildren": boolean,
    "canRename": boolean,
    "canTrash": boolean,
    "canReadRevisions": boolean,
    "canReadTeamDrive": boolean,
    "canMoveTeamDriveItem": boolean,
    "canChangeCopyRequiresWriterPermission": boolean,
    "canMoveItemIntoTeamDrive": boolean,
    "canUntrash": boolean,
    "canModifyContent": boolean,
    "canMoveItemWithinTeamDrive": boolean,
    "canMoveItemOutOfTeamDrive": boolean,
    "canDeleteChildren": boolean,
    "canMoveChildrenOutOfTeamDrive": boolean,
    "canMoveChildrenWithinTeamDrive": boolean,
    "canTrashChildren": boolean,
    "canMoveItemOutOfDrive": boolean,
    "canAddMyDriveParent": boolean,
    "canRemoveMyDriveParent": boolean,
    "canMoveItemWithinDrive": boolean,
    "canShare": boolean,
    "canMoveChildrenWithinDrive": boolean,
    "canModifyContentRestriction": boolean,
    "canAddFolderFromAnotherDrive": boolean,
    "canChangeSecurityUpdateEnabled": boolean,
    "canAcceptOwnership": boolean,
    "canReadLabels": boolean,
    "canModifyLabels": boolean,
    "canModifyEditorContentRestriction": boolean,
    "canModifyOwnerContentRestriction": boolean,
    "canRemoveContentRestriction": boolean,
    "canDisableInheritedPermissions": boolean,
    "canEnableInheritedPermissions": boolean
  },
  "hasAugmentedPermissions": boolean,
  "trashingUser": {
    object (User)
  },
  "canReadRevisions": boolean,
  "thumbnailVersion": string,
  "trashedDate": string,
  "permissionIds": [
    string
  ],
  "thumbnail": {
    "image": string,
    "mimeType": string
  },
  "imageMediaMetadata": {
    "flashUsed": boolean,
    "meteringMode": string,
    "sensor": string,
    "exposureMode": string,
    "colorSpace": string,
    "whiteBalance": string,
    "width": integer,
    "height": integer,
    "location": {
      "latitude": number,
      "longitude": number,
      "altitude": number
    },
    "rotation": integer,
    "date": string,
    "cameraMake": string,
    "cameraModel": string,
    "exposureTime": number,
    "aperture": number,
    "focalLength": number,
    "isoSpeed": integer,
    "exposureBias": number,
    "maxApertureValue": number,
    "subjectDistance": integer,
    "lens": string
  },
  "videoMediaMetadata": {
    "width": integer,
    "height": integer,
    "durationMillis": string
  },
  "shortcutDetails": {
    "targetId": string,
    "targetMimeType": string,
    "targetResourceKey": string
  },
  "contentRestrictions": [
    {
      object (ContentRestriction)
    }
  ],
  "resourceKey": string,
  "linkShareMetadata": {
    "securityUpdateEligible": boolean,
    "securityUpdateEnabled": boolean
  },
  "labelInfo": {
    "labels": [
      {
        object (Label)
      }
    ]
  },
  "sha1Checksum": string,
  "sha256Checksum": string,
  "inheritedPermissionsDisabled": boolean
}
字段
kind

string

仅限输出。文件的类型。此值始终为 drive#file

userPermission

object (Permission)

仅限输出。经过身份验证的用户对此文件的权限。

fileExtension

string

仅限输出。fullFileExtension 的最后一个组成部分,其中移除了似乎不是扩展程序一部分的尾随文本。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。

md5Checksum

string

仅限输出。此文件内容的 MD5 校验和。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。

ownerNames[]

string

仅限输出。此文件的所有者的姓名。不会为共享云端硬盘中的内容填充。

lastModifyingUserName

string

仅限输出。上次修改此文件的用户的姓名。

editable
(deprecated)

boolean

仅限输出。已弃用:请改用 capabilities/canEdit

writersCanShare

boolean

作者是否可以与其他用户共享文档。不会为共享云端硬盘中的内容填充。

downloadUrl

string

仅限输出。文件的短时效下载网址。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;Google 文档或快捷方式文件不会填充此字段。

mimeType

string

文件的 MIME 类型。只有在上传新内容时,此字段才可在更新时更改。此字段可以留空,系统会根据上传内容的 MIME 类型确定 mimetype。

driveId

string

仅限输出。文件所在的共享云端硬盘的 ID。仅针对共享云端硬盘中的内容进行填充。

parents[]

object (ParentReference)

包含相应文件的父级文件夹的 ID。

文件只能有一个父级文件夹;不支持指定多个父级。

如果未在插入请求中指定,系统会将文件直接放入用户的“我的云端硬盘”文件夹中。如果未在复制请求中指定,则文件会继承源文件的任何可检测到的父级。files.update 请求必须使用 addParentsremoveParents 参数来修改父级列表。

appDataContents

boolean

仅限输出。此文件是否位于“应用数据”文件夹中。

shared

boolean

仅限输出。文件是否已共享。不会为共享云端硬盘中的内容填充。

lastModifyingUser

object (User)

仅限输出。上次修改此文件的用户。只有当上次修改由已登录的用户执行时,系统才会填充此字段。

owners[]

object (User)

仅限输出。此文件的所有者。只有某些旧版文件可以有多个所有者。系统不会为共享云端硬盘中的内容填充此字段。

headRevisionId

string

仅限输出。文件的头部修订版本的 ID。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。

properties[]

object (Property)

属性列表。

copyable
(deprecated)

boolean

仅限输出。已弃用:请改用 capabilities/canCopy

etag

string

仅限输出。文件的 ETag。

sharingUser

object (User)

仅限输出。与当前用户共享内容的用户(如果有)。

fileSize

string (int64 format)

仅限输出。blob 和第一方编辑器文件的大小(以字节为单位)。系统不会针对没有大小的文件(例如快捷方式和文件夹)填充此字段。

copyRequiresWriterPermission

boolean

是否应禁止读者和评论者复制、打印或下载此文件。

permissions[]

object (Permission)

仅限输出。拥有对此文件访问权限的用户的权限列表。不会为共享云端硬盘中的内容填充。

hasThumbnail

boolean

仅限输出。此文件是否有缩略图。这并不表示请求应用是否有权访问缩略图。如需检查访问权限,请查看是否存在 thumbnailLink 字段。

spaces[]

string

仅限输出。包含文件的聊天室列表。支持的值包括 driveappDataFolderphotos

folderColorRgb

string

如果文件是文件夹或文件夹的快捷方式,则文件夹颜色为 RGB 十六进制字符串。支持的颜色列表可在“关于”资源的 folderColorPalette 字段中找到。如果指定了不受支持的颜色,系统会将其更改为调色板中相近的颜色。

id

string

文件的 ID。

title

string

此文件的标题。请注意,对于不可变项(例如共享云端硬盘的顶级文件夹、“我的云端硬盘”根文件夹和“应用数据”文件夹),标题是固定的。

description

string

文件的简短说明。

labels

object

文件的一组标签。

labels.viewed

boolean

此用户是否已查看此文件。

labels.restricted
(deprecated)

boolean

仅限输出。已弃用:请改用 copyRequiresWriterPermission

labels.starred

boolean

此文件是否已被用户收藏。

labels.hidden
(deprecated)

boolean

仅限输出。已弃用。

labels.trashed

boolean

此文件是否已被移至回收站。此标签适用于访问文件的所有用户;不过,只有所有者可以查看文件和将文件从回收站中移出。

labels.modified

boolean

仅限输出。文件是否已被此用户修改。

explicitlyTrashed

boolean

仅限输出。此文件是否已被明确移至回收站,而不是递归移至回收站。

createdDate

string

仅限输出。此文件的创建时间(采用 RFC 3339 格式的时间戳)。

modifiedDate

string

上次有人修改此文件的时间(采用 RFC 3339 时间戳格式)。只有在设置了 setModifiedDate 参数时,此属性在更新时才可变。

modifiedByMeDate

string

仅限输出。用户上次修改此文件的时间(采用 RFC 3339 时间戳格式)。请注意,设置 modifiedDate 还会更新设置日期的用户的 modifiedByMe 日期。

lastViewedByMeDate

string

用户上次查看此文件的时间(采用 RFC 3339 时间戳格式)。

markedViewedByMeDate
(deprecated)

string

仅限输出。已弃用。

sharedWithMeDate

string

仅限输出。与用户共享此文件的时间(采用 RFC 3339 时间戳格式)。

quotaBytesUsed

string (int64 format)

仅限输出。此文件使用的配额字节数。

version

string (int64 format)

仅限输出。文件的单调递增版本号。这会体现对服务器上的文件所做的每项更改,即使请求用户看不到这些更改也是如此。

indexableText

object

文件的可编入索引文本属性(只能写入)

indexableText.text

string

要为此文件编入索引的文本。

originalFilename

string

上传内容的原始文件名(如果有),或者 title 字段的原始值。此功能仅适用于 Google 云端硬盘中的二进制内容文件。

ownedByMe

boolean

仅限输出。文件是否归当前用户所有。不会为共享云端硬盘中的内容填充。

canComment
(deprecated)

boolean

仅限输出。已弃用:请改用 capabilities/canComment

shareable
(deprecated)

boolean

仅限输出。已弃用:请改用 capabilities/canShare

fullFileExtension

string

仅限输出。完整文件扩展名;从标题中提取。可以包含多个串联的扩展名,例如“tar.gz”。从影视内容中移除扩展程序不会清除此字段;但是,更改影视内容的扩展程序会更新此字段。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。

isAppAuthorized

boolean

仅限输出。文件是由请求应用创建或打开的。

teamDriveId
(deprecated)

string

仅限输出。已弃用:请改用 driveId

capabilities

object

仅限输出。当前用户对此文件拥有的权限。每项 capability 都对应于用户可以执行的精细操作。

capabilities.canChangeRestrictedDownload
(deprecated)

boolean

仅限输出。已弃用。

capabilities.canMoveChildrenOutOfDrive

boolean

仅限输出。当前用户是否可以将此文件夹的子文件夹移出共享云端硬盘。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。

capabilities.canReadDrive

boolean

仅限输出。当前用户是否可以读取此文件所属的共享云端硬盘。仅针对共享云端硬盘中的内容进行填充。

capabilities.canEdit

boolean

仅限输出。当前用户是否可以修改此文件。其他因素可能会限制用户对文件可以进行的更改类型。例如,请参阅 canChangeCopyRequiresWriterPermissioncanModifyContent

capabilities.canCopy

boolean

仅限输出。当前用户是否可以复制此文件。对于共享云端硬盘中的内容,当前用户能否复制此内容的非文件夹后代,或者如果此内容本身不是文件夹,则能否复制此内容本身。

capabilities.canComment

boolean

仅限输出。当前用户是否可以对此文件发表评论。

capabilities.canAddChildren

boolean

仅限输出。当前用户是否可以向此文件夹添加子文件夹。如果内容不是文件夹,则此属性始终为 false。

capabilities.canDelete

boolean

仅限输出。当前用户是否可以删除此文件。

capabilities.canDownload

boolean

仅限输出。当前用户是否可以下载此文件。

capabilities.canListChildren

boolean

仅限输出。当前用户是否可以列出此文件夹的子文件夹。如果内容不是文件夹,则此属性始终为 false。

capabilities.canRemoveChildren

boolean

仅限输出。当前用户是否可以从此文件夹中移除子文件夹。如果内容不是文件夹,则此属性始终为 false。对于共享云端硬盘中的文件夹,请改用 canDeleteChildrencanTrashChildren

capabilities.canRename

boolean

仅限输出。当前用户是否可以重命名此文件。

capabilities.canTrash

boolean

仅限输出。当前用户能否将此文件移至回收站。

capabilities.canReadRevisions

boolean

仅限输出。当前用户是否可以读取此文件的修订版本资源。对于共享云端硬盘内容,可以读取此内容的非文件夹后代内容的修订版本,或者此内容本身(如果它不是文件夹)。

capabilities.canReadTeamDrive
(deprecated)

boolean

仅限输出。已弃用:请改用 canReadDrive

capabilities.canMoveTeamDriveItem
(deprecated)

boolean

仅限输出。已废弃:请改用 canMoveItemWithinDrivecanMoveItemOutOfDrive

capabilities.canChangeCopyRequiresWriterPermission

boolean

仅限输出。当前用户是否可以更改此文件的 copyRequiresWriterPermission 限制。

capabilities.canMoveItemIntoTeamDrive
(deprecated)

boolean

仅限输出。已弃用:请改用 canMoveItemOutOfDrive

capabilities.canUntrash

boolean

仅限输出。当前用户是否可以从回收站中恢复此文件。

capabilities.canModifyContent

boolean

仅限输出。当前用户是否可以修改此文件的内容。

capabilities.canMoveItemWithinTeamDrive
(deprecated)

boolean

仅限输出。已弃用:请改用 canMoveItemWithinDrive

capabilities.canMoveItemOutOfTeamDrive
(deprecated)

boolean

仅限输出。已弃用:请改用 canMoveItemOutOfDrive

capabilities.canDeleteChildren

boolean

仅限输出。当前用户是否可以删除此文件夹的子文件夹。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。

capabilities.canMoveChildrenOutOfTeamDrive
(deprecated)

boolean

仅限输出。已弃用:请改用 canMoveChildrenOutOfDrive

capabilities.canMoveChildrenWithinTeamDrive
(deprecated)

boolean

仅限输出。已弃用:请改用 canMoveChildrenWithinDrive

capabilities.canTrashChildren

boolean

仅限输出。当前用户能否将此文件夹的子文件夹移至回收站。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。

capabilities.canMoveItemOutOfDrive

boolean

仅限输出。当前用户能否通过更改其父级来将此项内容移出此云端硬盘。请注意,更改项的父项的请求可能仍会失败,具体取决于要添加的新父项。

capabilities.canAddMyDriveParent

boolean

仅限输出。当前用户是否可以在同一请求中为项添加父项,而无需移除现有父项。不会为共享云端硬盘文件填充。

capabilities.canRemoveMyDriveParent

boolean

仅限输出。当前用户是否可以在不添加其他父级的情况下从项中移除父级。不会为共享云端硬盘文件填充。

capabilities.canMoveItemWithinDrive

boolean

仅限输出。当前用户能否在此云端硬盘中移动此内容。请注意,更改项父级的请求可能仍会失败,具体取决于要添加的新父级和要移除的父级。

capabilities.canShare

boolean

仅限输出。当前用户是否可以修改此文件的共享设置。

capabilities.canMoveChildrenWithinDrive

boolean

仅限输出。当前用户是否可以在此云端硬盘中移动此文件夹的子文件夹。如果内容不是文件夹,则此属性为 false。请注意,移动子文件夹的请求可能仍会失败,具体取决于当前用户对子文件夹和目标文件夹的访问权限。

capabilities.canModifyContentRestriction
(deprecated)

boolean

已废弃:仅限输出。使用 canModifyEditorContentRestrictioncanModifyOwnerContentRestrictioncanRemoveContentRestriction 之一。

capabilities.canAddFolderFromAnotherDrive

boolean

仅限输出。当前用户能否将其他云端硬盘(其他共享云端硬盘或“我的云端硬盘”)中的文件夹添加到此文件夹。如果内容不是文件夹,则此属性为 false。仅针对共享云端硬盘中的内容进行填充。

capabilities.canChangeSecurityUpdateEnabled

boolean

仅限输出。当前用户能否更改关联分享元数据中的 securityUpdateEnabled 字段。

capabilities.canAcceptOwnership

boolean

仅限输出。当前用户是否为文件的待处理所有者。不会为共享云端硬盘文件填充。

capabilities.canReadLabels

boolean

仅限输出。当前用户是否可以读取文件上的标签。

capabilities.canModifyLabels

boolean

仅限输出。当前用户是否可以修改文件的标签。

capabilities.canModifyEditorContentRestriction

boolean

仅限输出。当前用户是否可以对受编辑者限制的文件添加或修改内容限制。

capabilities.canModifyOwnerContentRestriction

boolean

仅限输出。当前用户是否可以添加或修改受所有者限制的内容限制。

capabilities.canRemoveContentRestriction

boolean

仅限输出。文件是否存在可由当前用户移除的内容限制。

capabilities.canDisableInheritedPermissions

boolean

仅限输出。用户是否可以停用继承的权限。

capabilities.canEnableInheritedPermissions

boolean

仅限输出。用户能否重新启用继承的权限。

hasAugmentedPermissions

boolean

仅限输出。此文件是否具有直接权限。系统仅会为共享云端硬盘中的内容填充此字段。

trashingUser

object (User)

仅限输出。如果文件已被明确移至回收站,则为将其移至回收站的用户。仅针对共享云端硬盘中的内容进行填充。

canReadRevisions
(deprecated)

boolean

仅限输出。已弃用:请改用 capabilities/canReadRevisions

thumbnailVersion

string (int64 format)

仅限输出。用于缩略图缓存失效的缩略图版本。

trashedDate

string

仅限输出。内容被移至回收站的时间(采用 RFC 3339 时间戳格式)。仅针对共享云端硬盘中的内容进行填充。

permissionIds[]

string

仅输出。具有对此文件的访问权限的用户的权限 ID 的 files.list。

thumbnail

object

文件的缩略图。只有在无法生成标准缩略图时,系统才会使用此缩略图。

thumbnail.image

string (bytes format)

缩略图的 Base64 编码字节(可在网址中安全使用)。应符合 RFC 4648 第 5 节。

使用 base64 编码的字符串。

thumbnail.mimeType

string

缩略图的 MIME 类型。

imageMediaMetadata

object

仅限输出。与图片媒体相关的元数据。只有图片类型才会显示此属性,其内容将取决于可从图片内容解析的内容。

imageMediaMetadata.flashUsed

boolean

仅限输出。拍摄照片时是否使用了闪光灯。

imageMediaMetadata.meteringMode

string

仅限输出。用于创建照片的测光模式。

imageMediaMetadata.sensor

string

仅限输出。用于创建照片的传感器的类型。

imageMediaMetadata.exposureMode

string

仅限输出。用于创建照片的曝光模式。

imageMediaMetadata.colorSpace

string

仅限输出。照片的色彩空间。

imageMediaMetadata.whiteBalance

string

仅限输出。用于创建照片的白平衡模式。

imageMediaMetadata.width

integer

仅限输出。图片的宽度(以像素为单位)。

imageMediaMetadata.height

integer

仅限输出。图片的高度(以像素为单位)。

imageMediaMetadata.location

object

仅限输出。存储在图片中的位置信息。

imageMediaMetadata.location.latitude

number

仅限输出。图片中存储的纬度。

imageMediaMetadata.location.longitude

number

仅限输出。图片中存储的经度。

imageMediaMetadata.location.altitude

number

仅限输出。图片中存储的海拔。

imageMediaMetadata.rotation

integer

仅限输出。从图片的原始方向应用的顺时针 90 度旋转次数。

imageMediaMetadata.date

string

仅限输出。拍摄照片的日期和时间(EXIF 格式时间戳)。

imageMediaMetadata.cameraMake

string

仅限输出。用于创建照片的相机品牌。

imageMediaMetadata.cameraModel

string

仅限输出。用于创建照片的相机型号。

imageMediaMetadata.exposureTime

number

仅限输出。曝光时长(以秒为单位)。

imageMediaMetadata.aperture

number

仅限输出。用于创建照片的光圈(f 值)。

imageMediaMetadata.focalLength

number

仅限输出。用于创建照片的焦距(以毫米为单位)。

imageMediaMetadata.isoSpeed

integer

仅限输出。用于创建照片的 ISO 感光度。

imageMediaMetadata.exposureBias

number

仅限输出。照片的曝光偏差(APEX 值)。

imageMediaMetadata.maxApertureValue

number

仅限输出。用于创建照片的焦距下镜头的最小 f 值(APEX 值)。

imageMediaMetadata.subjectDistance

integer

仅限输出。与照片拍摄正文的距离(以米为单位)。

imageMediaMetadata.lens

string

仅限输出。用于拍摄照片的镜头。

videoMediaMetadata

object

仅限输出。与视频媒体相关的元数据。此字段仅适用于视频类型。

videoMediaMetadata.width

integer

仅限输出。视频的宽度(以像素为单位)。

videoMediaMetadata.height

integer

仅限输出。视频的高度(以像素为单位)。

videoMediaMetadata.durationMillis

string (int64 format)

仅限输出。视频的时长(以毫秒为单位)。

shortcutDetails

object

快捷方式文件详情。仅当快捷方式文件的 mimeType 字段设置为 application/vnd.google-apps.shortcut 时,此字段才会填充。只能在 files.insert 请求中设置。

shortcutDetails.targetId

string

此快捷方式指向的文件的 ID。只能在 files.insert 请求中设置。

shortcutDetails.targetMimeType

string

仅限输出。此快捷方式指向的文件的 MIME 类型。此字段的值是创建快捷方式时捕获的目标 MIME 类型的快照。

shortcutDetails.targetResourceKey

string

仅限输出。目标文件的 ResourceKey。

contentRestrictions[]

object (ContentRestriction)

限制访问文件内容。仅当存在此类限制时才会填充。

resourceKey

string

仅限输出。通过共享链接访问内容所需的密钥。

linkShareMetadata.securityUpdateEligible

boolean

仅限输出。文件是否符合安全更新条件。

linkShareMetadata.securityUpdateEnabled

boolean

仅限输出。是否为此文件启用了安全更新。

labelInfo

object

仅限输出。文件标签概览。

labelInfo.labels[]

object (Label)

仅限输出。文件上的一组标签,由 includeLabels 参数中的标签 ID 指定。默认情况下,系统不会返回任何标签。

sha1Checksum

string

仅限输出。与此文件关联的 SHA1 校验和(如果有)。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。

sha256Checksum

string

仅限输出。与此文件关联的 SHA256 校验和(如果有)。只有内容存储在 Google 云端硬盘中的文件才会填充此字段;文档编辑器或快捷方式文件不会填充此字段。

inheritedPermissionsDisabled

boolean

此文件是否已停用继承的权限。继承的权限默认处于启用状态。

ContentRestriction

限制访问文件内容。

JSON 表示法
{
  "readOnly": boolean,
  "reason": string,
  "type": string,
  "restrictingUser": {
    object (User)
  },
  "restrictionDate": string,
  "ownerRestricted": boolean,
  "systemRestricted": boolean
}
字段
readOnly

boolean

文件内容是否为只读。如果文件是只读的,则可能无法添加该文件的新修订版本,也无法添加或修改评论,更无法修改文件的标题。

reason

string

文件内容受到限制的原因。只有在同时设置 readOnly=true 的请求中,此值才可变。

type

string

仅限输出。内容限制的类型。目前,唯一可能的值是 globalContentRestriction

restrictingUser

object (User)

仅限输出。设置内容限制的用户。仅当 readOnly 为 true 时填充。

restrictionDate

string

仅限输出。内容限制设置的时间(采用 RFC 3339 时间戳格式)。仅当 readOnly 为 true 时填充。

ownerRestricted

boolean

内容限制是否只能由文件所有者修改或移除。对于共享云端硬盘中的文件,任何具有 organizer 权限的用户都可以修改或移除此内容限制。

systemRestricted

boolean

仅限输出。内容限制是否由系统应用,例如因电子签名而应用。用户无法修改或移除系统限制的内容限制。

方法

copy

创建指定文件的副本。

delete

永久删除用户拥有的文件,而不将其移至回收站。

emptyTrash

永久删除用户的所有回收站文件。

export

将 Google Workspace 文档导出为请求的 MIME 类型,并返回导出的字节内容。

generateIds

生成一组文件 ID,可在插入或复制请求中提供。

get

根据 ID 获取文件的元数据或内容。

insert

插入新文件。

list

列出用户的文件。

listLabels

列出文件的标签。

modifyLabels

修改应用于文件的一组标签。

patch

更新文件的元数据和/或内容。

touch

将文件的更新时间设置为当前服务器时间。

trash

将文件移至回收站。

untrash

从回收站中恢复文件。

update

更新文件的元数据和/或内容。

watch

订阅文件的更改。