如需了解此资源的方法列表,请参阅本页结尾部分。
资源表示形式
文件的元数据。
{ "kind": "drive#file", "id": string, "name": string, "mimeType": string, "description": string, "starred": boolean, "trashed": boolean, "explicitlyTrashed": boolean, "trashingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "trashedTime": datetime, "parents": [ string ], "properties": { (key): string }, "appProperties": { (key): string }, "spaces": [ string ], "version": long, "webContentLink": string, "webViewLink": string, "iconLink": string, "hasThumbnail": boolean, "thumbnailLink": string, "thumbnailVersion": long, "viewedByMe": boolean, "viewedByMeTime": datetime, "createdTime": datetime, "modifiedTime": datetime, "modifiedByMeTime": datetime, "modifiedByMe": boolean, "sharedWithMeTime": datetime, "sharingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "owners": [ { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string } ], "teamDriveId": string, "driveId": string, "lastModifyingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "shared": boolean, "ownedByMe": boolean, "capabilities": { "canAcceptOwnership": boolean, "canAddChildren": boolean, "canAddFolderFromAnotherDrive": boolean, "canAddMyDriveParent": boolean, "canChangeCopyRequiresWriterPermission": boolean, "canChangeSecurityUpdateEnabled": boolean, "canChangeViewersCanCopyContent": boolean, "canComment": boolean, "canCopy": boolean, "canDelete": boolean, "canDeleteChildren": boolean, "canDownload": boolean, "canEdit": boolean, "canListChildren": boolean, "canModifyContent": boolean, "canModifyContentRestriction": boolean, "canModifyLabels": boolean, "canMoveChildrenOutOfTeamDrive": boolean, "canMoveChildrenOutOfDrive": boolean, "canMoveChildrenWithinTeamDrive": boolean, "canMoveChildrenWithinDrive": boolean, "canMoveItemIntoTeamDrive": boolean, "canMoveItemOutOfTeamDrive": boolean, "canMoveItemOutOfDrive": boolean, "canMoveItemWithinTeamDrive": boolean, "canMoveItemWithinDrive": boolean, "canMoveTeamDriveItem": boolean, "canReadLabels": boolean, "canReadRevisions": boolean, "canReadTeamDrive": boolean, "canReadDrive": boolean, "canRemoveChildren": boolean, "canRemoveMyDriveParent": boolean, "canRename": boolean, "canShare": boolean, "canTrash": boolean, "canTrashChildren": boolean, "canUntrash": boolean }, "viewersCanCopyContent": boolean, "copyRequiresWriterPermission": boolean, "writersCanShare": boolean, "permissions": [ permissions Resource ], "permissionIds": [ string ], "hasAugmentedPermissions": boolean, "folderColorRgb": string, "originalFilename": string, "fullFileExtension": string, "fileExtension": string, "md5Checksum": string, "sha1Checksum": string, "sha256Checksum": string, "size": long, "quotaBytesUsed": long, "headRevisionId": string, "contentHints": { "thumbnail": { "image": bytes, "mimeType": string }, "indexableText": string }, "imageMediaMetadata": { "width": integer, "height": integer, "rotation": integer, "location": { "latitude": double, "longitude": double, "altitude": double }, "time": string, "cameraMake": string, "cameraModel": string, "exposureTime": float, "aperture": float, "flashUsed": boolean, "focalLength": float, "isoSpeed": integer, "meteringMode": string, "sensor": string, "exposureMode": string, "colorSpace": string, "whiteBalance": string, "exposureBias": float, "maxApertureValue": float, "subjectDistance": integer, "lens": string }, "videoMediaMetadata": { "width": integer, "height": integer, "durationMillis": long }, "isAppAuthorized": boolean, "exportLinks": { (key): string }, "shortcutDetails": { "targetId": string, "targetMimeType": string, "targetResourceKey": string }, "contentRestrictions": [ { "readOnly": boolean, "reason": string, "restrictingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "restrictionTime": datetime, "type": string } ], "labelInfo": { "labels": [ { "kind": "drive#label", "id": string, "revisionId": string, "fields": { (key): { "kind": "drive#labelField", "id": string, "valueType": string, "dateString": [ date ], "integer": [ long ], "selection": [ string ], "text": [ string ], "user": [ { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string } ] } } } ] }, "resourceKey": string, "linkShareMetadata": { "securityUpdateEligible": boolean, "securityUpdateEnabled": boolean } }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
kind |
string |
用于标识资源的类型。值:固定字符串 "drive#file" 。 |
|
id |
string |
文件的 ID。 | 可写入 |
name |
string |
文件的名称。文件夹名称不必相同。请注意,对于不可变内容(例如共享云端硬盘的顶级文件夹、“我的云端硬盘”根文件夹和应用数据文件夹),其名称保持不变。 | 可写入 |
mimeType |
string |
文件的 MIME 类型。 如果未提供任何值,Google 云端硬盘将尝试根据上传的内容自动检测出适当的值。除非上传新的修订版本,否则该值无法更改。 如果创建的文件是 Google 文档 MIME 类型的文件,系统会尽可能导入上传内容。支持的导入格式在“关于”资源中发布。 |
可写入 |
description |
string |
文件的简短说明。 | 可写入 |
starred |
boolean |
用户是否已为文件加星标。 | 可写入 |
trashed |
boolean |
文件是否已被移至回收站(无论是明确删除还是从已删除的父级文件夹删除)。只有所有者可以将文件移至回收站。凡是不归文件所有者所有的用户,都会从系统返回的所有 files.list 响应中排除回收站。不过,有权访问该文件的所有用户都可以在 API 响应中查看回收站中的元数据。拥有访问权限的所有用户都可以复制、下载、导出和共享文件。 | 可写入 |
explicitlyTrashed |
boolean |
文件是否已被明确移至回收站,而不是从父文件夹中以递归方式移至回收站。 | |
parents[] |
list |
包含文件的父文件夹的 ID。 如果您未在创建请求中指定该文件,则系统会直接将文件放在用户的“我的云端硬盘”文件夹中。如果未在复制请求中指定,则文件将沿用源文件的所有可发现父级。更新请求必须使用 |
可写入 |
properties |
object |
对所有应用可见的任意键值对的集合。 具有 null 值的条目会在更新和复制请求中清除。 |
可写入 |
properties.(key) |
string |
||
appProperties |
object |
请求应用的专用键值对集合。 具有 null 值的条目会在更新和复制请求中清除。只能使用经过身份验证的请求检索这些属性。经过身份验证的请求会使用通过 OAuth 2 客户端 ID 获取的访问令牌。您无法使用 API 密钥检索私有属性。 |
可写入 |
appProperties.(key) |
string |
||
spaces[] |
list |
包含该文件的聊天室列表。目前支持的值为“drive”、“appDataFolder”和“photos”。 | |
version |
long |
文件的单调递增版本号。这类更改反映了对服务器上的文件所做的所有更改,甚至包括用户看不到的更改。 | |
webContentLink |
string |
用于在浏览器中下载文件的链接。此选项仅适用于 Google 云端硬盘中具有二进制内容的文件。 | |
webViewLink |
string |
用于在浏览器的相关 Google 编辑器或查看器中打开文件的链接。 | |
iconLink |
string |
指向相应文件图标的未经身份验证的静态链接。 | |
thumbnailLink |
string |
指向文件缩略图的短期链接(如果有)。通常持续数小时。仅在请求应用可以访问文件内容时填充。如果相应文件未公开共享,则 Files.thumbnailLink 中必须使用通过凭据的请求获取的网址。 |
|
viewedByMe |
boolean |
用户是否查看过该文件。 | |
viewedByMeTime |
datetime |
用户最后一次查看文件的时间(RFC 3339 日期时间)。 | 可写入 |
createdTime |
datetime |
文件的创建时间(RFC 3339 日期时间)。 | 可写入 |
modifiedTime |
datetime |
任何人上次修改文件的时间(RFC 3339 日期时间)。 请注意,设置 modifiedTime 也会为用户更新 modifiedByMeTime。 |
可写入 |
modifiedByMeTime |
datetime |
用户上次修改文件的时间(RFC 3339 日期时间)。 | |
sharedWithMeTime |
datetime |
文件的传输时间(如适用,以 RFC 3339 日期时间为准)。 | |
sharingUser |
nested object |
与发出请求的用户共享文件的用户(如果适用)。 | |
sharingUser.kind |
string |
用于标识资源的类型。值:固定字符串 "drive#user" 。 |
|
sharingUser.displayName |
string |
该用户的纯文本显示名称。 | |
sharingUser.photoLink |
string |
指向用户个人资料照片的链接(如果有)。 | |
sharingUser.me |
boolean |
此用户是否为发出请求的用户。 | |
sharingUser.permissionId |
string |
Permission 资源中显示的用户 ID。 | |
sharingUser.emailAddress |
string |
用户的电子邮件地址。如果用户未向请求者显示其电子邮件地址,则在某些情况下可能不会显示此信息。 | |
owners[] |
list |
此文件的所有者。只有某些旧版文件可以有多个所有者。对于此字段,系统不会为共享云端硬盘中的内容填充此字段。 | |
owners[].kind |
string |
用于标识资源的类型。值:固定字符串 "drive#user" 。 |
|
owners[].displayName |
string |
该用户的纯文本显示名称。 | |
owners[].photoLink |
string |
指向用户个人资料照片的链接(如果有)。 | |
owners[].me |
boolean |
此用户是否为发出请求的用户。 | |
owners[].permissionId |
string |
Permission 资源中显示的用户 ID。 | |
owners[].emailAddress |
string |
用户的电子邮件地址。如果用户未向请求者显示其电子邮件地址,则在某些情况下可能不会显示此信息。 | |
lastModifyingUser |
nested object |
修改文件的最后一位用户。 | |
lastModifyingUser.kind |
string |
用于标识资源的类型。值:固定字符串 "drive#user" 。 |
|
lastModifyingUser.displayName |
string |
该用户的纯文本显示名称。 | |
lastModifyingUser.photoLink |
string |
指向用户个人资料照片的链接(如果有)。 | |
lastModifyingUser.me |
boolean |
此用户是否为发出请求的用户。 | |
lastModifyingUser.permissionId |
string |
Permission 资源中显示的用户 ID。 | |
lastModifyingUser.emailAddress |
string |
用户的电子邮件地址。如果用户未向请求者显示其电子邮件地址,则在某些情况下可能不会显示此信息。 | |
shared |
boolean |
文件是否已共享。对于共享云端硬盘中的内容,系统不会填充内容。 | |
ownedByMe |
boolean |
用户是否为文件的所有者。对于共享云端硬盘中的内容,系统不会填充内容。 | |
viewersCanCopyContent |
boolean |
已弃用 - 请改用 copyRequiresWriterPermission 。 |
|
writersCanShare |
boolean |
仅具有 writer 权限的用户能否修改文件的权限。对于共享云端硬盘中的内容,系统不会填充内容。 |
可写入 |
permissions[] |
list |
文件的完整权限列表。仅当发出请求的用户能够共享文件时,此设置才可用。对于共享云端硬盘中的内容,系统不会填充内容。 | |
folderColorRgb |
string |
文件夹的颜色或指向文件夹的快捷方式,采用 RGB 十六进制字符串形式。受支持的颜色在“关于”资源中的 folderColorPalette 字段中发布。如果指定了不受支持的颜色,系统会改用调色板中最接近的颜色。 |
可写入 |
originalFilename |
string |
所上传内容的原始文件名(如果有),否则为 name 字段的原始值。此选项仅适用于 Google 云端硬盘中具有二进制内容的文件。 |
可写入 |
fullFileExtension |
string |
从 name 字段提取的完整文件扩展名。可能包含多个串联的扩展名,例如“tar.gz”。此选项仅适用于 Google 云端硬盘中具有二进制内容的文件。当 |
|
fileExtension |
string |
fullFileExtension 的最后一个组件。此选项仅适用于 Google 云端硬盘中具有二进制内容的文件。 |
|
md5Checksum |
string |
文件内容的 MD5 校验和。这仅适用于 Google 云端硬盘中具有二进制内容的文件。 | |
size |
long |
文件内容的大小(以字节为单位)。对于在 Google 云端硬盘中存储二进制内容的文件和文档编辑器文件,系统将填充此字段;对于快捷方式或文件夹,系统不会填充此字段。 | |
quotaBytesUsed |
long |
文件使用的存储空间配额字节数。包括头部修订版本以及启用了 keepForever 的先前修订版本。 |
|
headRevisionId |
string |
文件头修订的 ID。目前仅适用于 Google 云端硬盘中具有二进制内容的文件。 | |
contentHints |
object |
有关文件内容的其他信息。这些字段绝不会在响应中填充。 | |
contentHints.thumbnail |
object |
文件的缩略图。仅在 Google 云端硬盘无法生成标准缩略图时使用。 | |
contentHints.thumbnail.image |
bytes |
采用可在网址中安全使用的 Base64 编码的缩略图数据(RFC 4648 第 5 节)。 | 可写入 |
contentHints.thumbnail.mimeType |
string |
缩略图的 MIME 类型。 | 可写入 |
contentHints.indexableText |
string |
要编入索引的文件,以改进全文查询。其长度上限为 128 KB,且可能包含 HTML 元素。有关详情,请参阅管理文件元数据。 | 可写入 |
imageMediaMetadata |
object |
关于图片媒体的其他元数据(如果有)。 | |
imageMediaMetadata.width |
integer |
图片的宽度,以像素为单位。 | |
imageMediaMetadata.height |
integer |
图片的高度,以像素为单位。 | |
imageMediaMetadata.rotation |
integer |
从图片的原始方向应用的顺时针旋转 90 度的次数。 | |
imageMediaMetadata.location |
object |
图片中存储的地理位置信息。 | |
imageMediaMetadata.location.latitude |
double |
图片中存储的纬度。 | |
imageMediaMetadata.location.longitude |
double |
图片中存储的经度。 | |
imageMediaMetadata.location.altitude |
double |
图片中存储的海拔高度。 | |
imageMediaMetadata.time |
string |
照片拍摄的日期和时间(EXIF 日期时间)。 | |
imageMediaMetadata.cameraMake |
string |
用于创建照片的相机品牌。 | |
imageMediaMetadata.cameraModel |
string |
用于创建照片的相机型号。 | |
imageMediaMetadata.exposureTime |
float |
曝光时长(以秒为单位)。 | |
imageMediaMetadata.aperture |
float |
照片的光圈(光圈值)。 | |
imageMediaMetadata.flashUsed |
boolean |
是否使用闪光灯创建照片。 | |
imageMediaMetadata.focalLength |
float |
用于创建照片的焦距,以毫米为单位。 | |
imageMediaMetadata.isoSpeed |
integer |
照片的 ISO 速度。 | |
imageMediaMetadata.meteringMode |
string |
用于创建照片的测光模式。 | |
imageMediaMetadata.sensor |
string |
用于创建照片的传感器。 | |
imageMediaMetadata.exposureMode |
string |
用于创建照片的曝光模式。 | |
imageMediaMetadata.colorSpace |
string |
照片的颜色空间。 | |
imageMediaMetadata.whiteBalance |
string |
用于创建照片的白平衡模式。 | |
imageMediaMetadata.exposureBias |
float |
照片的曝光偏差(APEX 值)。 | |
imageMediaMetadata.maxApertureValue |
float |
用于制作照片的焦距的最小 f 数(APEX 值)。 | |
imageMediaMetadata.subjectDistance |
integer |
与照片正文的距离(以米为单位)。 | |
imageMediaMetadata.lens |
string |
用于创建照片的镜头。 | |
videoMediaMetadata |
object |
关于视频媒体的其他元数据。但上传后可能无法立即显示。 | |
videoMediaMetadata.width |
integer |
视频的宽度(以像素为单位)。 | |
videoMediaMetadata.height |
integer |
视频的高度(以像素为单位)。 | |
videoMediaMetadata.durationMillis |
long |
视频的时长(以毫秒为单位)。 | |
capabilities |
object |
当前用户对此文件的权限。每项功能都对应于用户可能会执行的精细操作。 | |
capabilities.canEdit |
boolean |
当前用户是否可以编辑此文件。其他因素可能限制用户对文件的更改类型。例如,请参阅 canChangeCopyRequiresWriterPermission 或 canModifyContent 。 |
|
capabilities.canComment |
boolean |
当前用户是否可以对此文件发表评论。 | |
capabilities.canShare |
boolean |
当前用户是否可以修改此文件的共享设置。 | |
capabilities.canCopy |
boolean |
当前用户是否可以复制此文件。对于共享云端硬盘中的内容,当前用户能否复制此内容的非文件夹后代,如果该内容不是文件夹,则复制此内容本身。 | |
capabilities.canReadRevisions |
boolean |
当前用户是否可以读取此文件的修订版本资源。对于共享云端硬盘内容,无论该内容是文件夹的非子文件夹的修订版本,还是此项目本身(如果不是文件夹)的修订版本,都可以读取。 | |
isAppAuthorized |
boolean |
文件是由请求应用创建还是打开。 | |
hasThumbnail |
boolean |
此文件是否有缩略图。这并不表示发出请求的应用是否有权访问缩略图。要检查访问权限,请看看缩略图链接字段是否存在。 | |
thumbnailVersion |
long |
用于缩略图缓存失效操作的缩略图版本。 | |
modifiedByMe |
boolean |
文件是否由此用户修改。 | |
trashingUser |
nested object |
如果文件已被明确移至回收站,则会被移至回收站的用户。仅填充共享云端硬盘中的内容。 | |
trashingUser.kind |
string |
用于标识资源的类型。值:固定字符串 "drive#user" 。 |
|
trashingUser.displayName |
string |
该用户的纯文本显示名称。 | |
trashingUser.photoLink |
string |
指向用户个人资料照片的链接(如果有)。 | |
trashingUser.me |
boolean |
此用户是否为发出请求的用户。 | |
trashingUser.permissionId |
string |
Permission 资源中显示的用户 ID。 | |
trashingUser.emailAddress |
string |
用户的电子邮件地址。如果用户未向请求者显示其电子邮件地址,则在某些情况下可能不会显示此信息。 | |
trashedTime |
datetime |
内容移至回收站的时间(RFC 3339 日期时间)。仅填充共享云端硬盘中的内容。 | |
teamDriveId |
string |
已弃用 - 请改用 driveId 。 |
|
capabilities.canAddChildren |
boolean |
当前用户是否可以添加文件夹至此文件夹。如果内容不是文件夹,则此值始终为 false。 | |
capabilities.canDelete |
boolean |
当前用户是否可以删除此文件。 | |
capabilities.canDownload |
boolean |
当前用户是否可以下载此文件。 | |
capabilities.canListChildren |
boolean |
当前用户是否可以列出此文件夹的子文件夹。如果内容不是文件夹,则此值始终为 false。 | |
capabilities.canMoveTeamDriveItem |
boolean |
已弃用 - 请改用 canMoveItemWithinDrive 或 canMoveItemOutOfDrive 。 |
|
capabilities.canMoveItemIntoTeamDrive |
boolean |
已弃用 - 请改用 canMoveItemOutOfDrive 。 |
|
capabilities.canReadTeamDrive |
boolean |
已弃用 - 请改用 canReadDrive 。 |
|
capabilities.canRemoveChildren |
boolean |
当前用户是否可以从此文件夹中移除儿童。如果内容不是文件夹,则此值始终为 false。对于共享云端硬盘中的文件夹,请改用 canDeleteChildren 或 canTrashChildren 。 |
|
capabilities.canRename |
boolean |
当前用户是否可以重命名此文件。 | |
capabilities.canTrash |
boolean |
当前用户是否可以将此文件移至回收站。 | |
capabilities.canUntrash |
boolean |
当前用户是否可以从回收站中恢复此文件。 | |
hasAugmentedPermissions |
boolean |
是否有直接拥有此文件的权限。此字段只会填充共享云端硬盘中的内容。 | |
capabilities.canChangeViewersCanCopyContent |
boolean |
已弃用 | |
permissionIds[] |
list |
拥有此文件访问权限的用户的权限 ID 列表。 | |
capabilities.canChangeCopyRequiresWriterPermission |
boolean |
当前用户是否可以更改此文件的 copyRequiresWriterPermission 限制。 |
|
copyRequiresWriterPermission |
boolean |
是否应为读者和评论者停用复制、打印或下载此文件的选项。 | 可写入 |
capabilities.canDeleteChildren |
boolean |
当前用户是否可以删除此文件夹的子级。如果内容不是文件夹,则该值为 false。仅填充共享云端硬盘中的内容。 | |
capabilities.canMoveChildrenOutOfTeamDrive |
boolean |
已弃用 - 请改用 canMoveChildrenOutOfDrive 。 |
|
capabilities.canMoveChildrenWithinTeamDrive |
boolean |
已弃用 - 请改用 canMoveChildrenWithinDrive 。 |
|
capabilities.canMoveItemOutOfTeamDrive |
boolean |
已弃用 - 请改用 canMoveItemOutOfDrive 。 |
|
capabilities.canMoveItemWithinTeamDrive |
boolean |
已弃用 - 请改用 canMoveItemWithinDrive 。 |
|
capabilities.canTrashChildren |
boolean |
当前用户是否可以将此文件夹的子级移至回收站。如果内容不是文件夹,则该值为 false。仅填充共享云端硬盘中的内容。 | |
exportLinks |
object |
用于将文档编辑器文件导出为特定格式的链接。 | |
exportLinks.(key) |
string |
从导出格式到网址的映射 | |
driveId |
string |
文件所在的共享云端硬盘的 ID。仅填充共享云端硬盘中的内容。 | |
capabilities.canMoveChildrenOutOfDrive |
boolean |
当前用户是否可以将此文件夹的子文件夹移出共享云端硬盘。如果内容不是文件夹,则该值为 false。仅填充共享云端硬盘中的内容。 | |
capabilities.canMoveChildrenWithinDrive |
boolean |
当前用户是否可以在此云端硬盘中移动此文件夹的子级。如果内容不是文件夹,则该值为 false。请注意,移动子项的请求可能仍会失败,具体取决于当前用户对子项和目标文件夹的访问权限。 | |
capabilities.canMoveItemOutOfDrive |
boolean |
当前用户是否可以通过更改其父级内容将此内容移出此云端硬盘。请注意,更改项的父级的请求可能仍会失败,具体取决于要添加的新父级。 | |
capabilities.canMoveItemWithinDrive |
boolean |
当前用户是否可以在此云端硬盘中移动此内容。请注意,更改项的父级的请求可能仍会失败,具体取决于要添加的新父级和要移除的父级。 | |
capabilities.canReadDrive |
boolean |
当前用户是否可以读取此文件所属的共享云端硬盘。仅填充共享云端硬盘中的内容。 | |
capabilities.canModifyContent |
boolean |
当前用户是否可以修改此文件的内容。 | |
capabilities.canAddMyDriveParent |
boolean |
当前用户是否可以为相应项添加父级,而无需在同一请求中移除现有父级。系统不会填充共享云端硬盘文件。 | |
capabilities.canRemoveMyDriveParent |
boolean |
当前用户是否可以从内容中移除父级,而无需在同一请求中添加其他父级。系统不会填充共享云端硬盘文件。 | |
shortcutDetails |
object |
快捷方式文件详细信息。仅为 mimeType 字段设置为 application/vnd.google-apps.shortcut 的快捷方式文件填充。 |
|
shortcutDetails.targetId |
string |
此快捷方式指向的文件的 ID。 | 可写入 |
shortcutDetails.targetMimeType |
string |
此快捷方式指向的文件的 MIME 类型。此字段的值是创建快捷方式时捕获的目标 MIME 类型的快照。 | |
capabilities.canAddFolderFromAnotherDrive |
boolean |
当前用户是否可以将其他共享云端硬盘(其他共享云端硬盘或“我的云端硬盘”)中的文件夹添加到此文件夹中。如果内容不是文件夹,则该值为 false。仅填充共享云端硬盘中的内容。 | |
capabilities.canModifyContentRestriction |
boolean |
当前用户是否可以修改此文件内容的限制。 | |
contentRestrictions[] |
list |
对文件内容访问的限制。仅当存在此类限制时填充。 | |
contentRestrictions[].readOnly |
boolean |
文件的内容是否为只读。如果某个文件是只读文件,则不可添加新的该文件修订版本、不可添加或修改注释,也不得修改文件标题。 | 可写入 |
contentRestrictions[].reason |
string |
文件内容受限的原因。这仅对同时设置 readOnly=true 的请求是可变的。 |
可写入 |
contentRestrictions[].restrictingUser |
nested object |
设置内容限制的用户。仅当 readOnly 为 true 时填充。 |
|
contentRestrictions[].restrictingUser.kind |
string |
用于标识资源的类型。值:固定字符串 "drive#user" 。 |
|
contentRestrictions[].restrictingUser.displayName |
string |
该用户的纯文本显示名称。 | |
contentRestrictions[].restrictingUser.photoLink |
string |
指向用户个人资料照片的链接(如果有)。 | |
contentRestrictions[].restrictingUser.me |
boolean |
此用户是否为发出请求的用户。 | |
contentRestrictions[].restrictingUser.permissionId |
string |
Permission 资源中显示的用户 ID。 | |
contentRestrictions[].restrictingUser.emailAddress |
string |
用户的电子邮件地址。如果用户未向请求者显示其电子邮件地址,则在某些情况下可能不会显示此信息。 | |
contentRestrictions[].restrictionTime |
datetime |
设置内容限制的时间(采用格式的 RFC 3339 时间戳)。仅当 readOnly 为 true 时填充。 |
|
contentRestrictions[].type |
string |
内容限制的类型。目前唯一可能的值是 globalContentRestriction 。 |
|
capabilities.canChangeSecurityUpdateEnabled |
boolean |
当前用户是否可以更改链接共享元数据中的 securityUpdateEnabled 字段。 | |
shortcutDetails.targetResourceKey |
string |
目标文件的 ResourceKey。 | |
resourceKey |
string |
通过共享链接访问该项所需的密钥。 | |
linkShareMetadata |
object |
包含客户端用于引用此项目的链接网址的详细信息。 | |
linkShareMetadata.securityUpdateEligible |
boolean |
文件是否符合安全更新的条件。 | |
linkShareMetadata.securityUpdateEnabled |
boolean |
此文件是否已启用安全更新。 | |
capabilities.canAcceptOwnership |
boolean |
当前用户是否为文件的受让所有者。系统不会填充共享云端硬盘文件。 | |
capabilities.canModifyLabels |
boolean |
当前用户是否可以修改此文件中的标签。 | |
capabilities.canReadLabels |
boolean |
当前用户是否可以读取此文件中的标签。 | |
labelInfo |
object |
文件的标签概览。 | |
labelInfo.labels[] |
list |
文件上的标签集,由 includeLabels 参数中的标签 ID 请求。默认情况下,系统不会返回任何标签。 |
|
labelInfo.labels[].kind |
string |
始终为 drive#label | |
labelInfo.labels[].id |
string |
标签的 ID。 | |
labelInfo.labels[].revisionId |
string |
标签的修订版本 ID。 | |
labelInfo.labels[].fields |
object |
由字段 ID 键控的标签字段映射。 | |
labelInfo.labels[].fields.(key) |
nested object |
||
labelInfo.labels[].fields.(key).kind |
string |
始终为 drive#labelField。 | |
labelInfo.labels[].fields.(key).id |
string |
此字段的标识符。 | |
labelInfo.labels[].fields.(key).valueType |
string |
字段类型。虽然未来可能支持新值,但目前允许使用以下值:
|
|
labelInfo.labels[].fields.(key).dateString[] |
list |
仅当 valueType 为 dateString 时才存在。RFC 3339 格式的日期:YYYY-MM-DD。 |
|
labelInfo.labels[].fields.(key).integer[] |
list |
仅当 valueType 为 integer 时才存在。 |
|
labelInfo.labels[].fields.(key).selection[] |
list |
仅当 valueType 为 selection 时才存在。 |
|
labelInfo.labels[].fields.(key).text[] |
list |
仅当 valueType 为 text 时才存在。 |
|
labelInfo.labels[].fields.(key).user[] |
list |
仅当 valueType 为 user 时才存在。 |
|
labelInfo.labels[].fields.(key).user[].kind |
string |
用于标识资源的类型。值:固定字符串 "drive#user" 。 |
|
labelInfo.labels[].fields.(key).user[].displayName |
string |
该用户的纯文本显示名称。 | |
labelInfo.labels[].fields.(key).user[].photoLink |
string |
指向用户个人资料照片的链接(如果有)。 | |
labelInfo.labels[].fields.(key).user[].me |
boolean |
此用户是否为发出请求的用户。 | |
labelInfo.labels[].fields.(key).user[].permissionId |
string |
Permission 资源中显示的用户 ID。 | |
labelInfo.labels[].fields.(key).user[].emailAddress |
string |
用户的电子邮件地址。如果用户未向请求者显示其电子邮件地址,则在某些情况下可能不会显示此信息。 | |
sha1Checksum |
string |
与此文件关联的 SHA1 校验和(如果有)。此字段仅适用于在其中存储了 Google 云端硬盘的文件,而不适用于文档编辑器或快捷方式文件。 | |
sha256Checksum |
string |
与此文件关联的 SHA256 校验和(如果有)。此字段仅适用于在其中存储了 Google 云端硬盘的文件,而不适用于文档编辑器或快捷方式文件。 |
方法
- 复制
- 创建文件的副本,并使用补丁语义应用任何请求的更新。无法复制文件夹。
- create
- 创建文件。
- delete
- 永久删除用户拥有的文件,而不将文件移至回收站。如果该文件属于某个共享云端硬盘,则此用户必须是其父级的组织者。如果目标是文件夹,则系统会删除用户拥有的所有后代。
- 进入“已删除邮件”文件夹
- 永久删除用户的所有已移至回收站的文件。
- 导出
- 将 Google Workspace 文档导出到请求的 MIME 类型,并返回导出的字节内容。请注意,所导出的内容不得超过 10MB。
- generateIds
- 生成一组可在创建或复制请求中提供的文件 ID。
- get
- 根据 ID 获取文件的元数据或内容。
- list
- 列表或搜索文件。
- update
- 更新文件的元数据和/或内容。调用此方法时,请只填充您要修改的请求中的字段。更新字段时,某些字段可能会自动更改,例如修改后的日期。此方法支持补丁程序语义。
- 手表
- 订阅对文件的更改。虽然您可以为共享云端硬盘中的文件更改建立渠道,但更改共享云端硬盘文件不会创建通知。
- listLabels
- 列出文件的标签。
- modifyLabels
- 修改文件上的标签集。