REST Resource: drives

资源：云端硬盘

表示共享云端硬盘。

某些资源方法（例如 drives.update）需要 driveId。使用 drives.list 方法检索共享云端硬盘的 ID。

JSON 表示法 
{
  "id": string,
  "name": string,
  "colorRgb": string,
  "kind": string,
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canChangeDriveBackground": boolean,
    "canShare": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": boolean,
    "canResetDriveRestrictions": boolean,
    "canDeleteChildren": boolean,
    "canTrashChildren": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdDate": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
字段
id

string

仅限输出。此共享云端硬盘的 ID，也是此共享云端硬盘顶级文件夹的 ID。
name

string

此共享云端硬盘的名称。
colorRgb

string

此共享云端硬盘的颜色，以 RGB 十六进制字符串表示。它只能针对未设置 themeId 的 drive.drives.update 请求进行设置。
kind

string

仅限输出。始终为 drive#drive
capabilities

object

仅限输出。当前用户对此共享云端硬盘的权限。
capabilities.canAddChildren

boolean

仅限输出。当前用户是否可以将孩子添加到此共享云端硬盘中的文件夹。
capabilities.canComment

boolean

仅限输出。当前用户是否能够对此共享云端硬盘中的文件发表评论。
capabilities.canCopy

boolean

仅限输出。当前用户是否能够复制此共享云端硬盘中的文件。
capabilities.canDeleteDrive

boolean

仅限输出。当前用户是否可以删除此共享云端硬盘。如果共享云端硬盘中有未移至回收站的内容，尝试删除共享云端硬盘的操作可能仍会失败。
capabilities.canDownload

boolean

仅限输出。当前用户是否能够下载此共享云端硬盘中的文件。
capabilities.canEdit

boolean

仅限输出。当前用户是否可以修改此共享云端硬盘中的文件
capabilities.canListChildren

boolean

仅限输出。当前用户是否可以列出此共享云端硬盘中文件夹的子级。
capabilities.canManageMembers

boolean

仅限输出。当前用户是否可以向此共享云端硬盘添加成员、移除成员或更改角色。
capabilities.canReadRevisions

boolean

仅限输出。当前用户是否能够读取此共享云端硬盘中文件的修订版本资源。
capabilities.canRename

boolean

仅限输出。当前用户是否可以重命名此共享云端硬盘中的文件或文件夹。
capabilities.canRenameDrive

boolean

仅限输出。当前用户是否可以重命名此共享云端硬盘。
capabilities.canChangeDriveBackground

boolean

仅限输出。当前用户是否能够更改此共享云端硬盘的背景。
capabilities.canShare

boolean

仅限输出。当前用户是否可以共享此共享云端硬盘中的文件或文件夹。
capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

仅限输出。当前用户是否能够更改此共享云端硬盘的 copyRequiresWriterPermission 限制。
capabilities.canChangeDomainUsersOnlyRestriction

boolean

仅限输出。当前用户是否能够更改此共享云端硬盘的 domainUsersOnly 限制。
capabilities.canChangeDriveMembersOnlyRestriction

boolean

仅限输出。当前用户是否能够更改此共享云端硬盘的 driveMembersOnly 限制。
capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

仅限输出。当前用户是否能够更改此共享云端硬盘的 sharingFoldersRequiresOrganizerPermission 限制。
capabilities.canResetDriveRestrictions

boolean

仅限输出。当前用户是否可以将共享云端硬盘限制重置为默认值。
capabilities.canDeleteChildren

boolean

仅限输出。当前用户是否可以从此共享云端硬盘的文件夹中删除孩子。
capabilities.canTrashChildren

boolean

仅限输出。当前用户是否可以从此共享云端硬盘的文件夹中将孩子移至回收站。
themeId

string

要设置背景图片和颜色的主题的 ID。可以从 drive.about.get 响应中检索到可能的 driveThemes 集。如果未在 drive.drives.insert 请求中指定，系统会选择随机主题，用于设置背景图片和颜色。此字段是只写字段；只能针对未设置 colorRgb 或 backgroundImageFile 的请求进行设置。
backgroundImageFile

object

用于为此共享云端硬盘设置背景图片的图片文件和剪裁参数。这是一个只写字段；它只能针对未设置 themeId 的 drive.drives.update 请求进行设置。指定这些标记时，必须设置 backgroundImageFile 的所有字段。
backgroundImageFile.id

string

Google 云端硬盘中要用作背景图片的图片文件的 ID。
backgroundImageFile.xCoordinate

number

背景图片中剪裁区域左上角的 X 坐标。这是一个 0 到 1 的闭区间值。此值表示从整张图片左侧到剪裁区域左侧的水平距离除以整张图片的宽度。
backgroundImageFile.yCoordinate

number

背景图片中剪裁区域左上角的 Y 坐标。这是一个 0 到 1 的闭区间值。此值表示从整张图片的顶部到剪裁区域顶部的垂直距离除以整张图片的高度。
backgroundImageFile.width

number

剪裁后的图片的宽度，介于 0 到 1 的闭合范围内。此值表示剪裁后图片的宽度除以整张图片的宽度。高度是通过应用 80:9 的宽高比宽高比计算的。生成的图片必须至少宽 1280 像素，高 144 像素。
createdDate

string

仅限输出。共享云端硬盘的创建时间（RFC 3339 日期时间）。
hidden

boolean

相应共享云端硬盘是否在默认视图中处于隐藏状态。
restrictions

object

应用于此共享云端硬盘或此共享云端硬盘中的内容的一组限制。
restrictions.copyRequiresWriterPermission

boolean

是否应为读者和评论者停用复制、打印或下载此共享云端硬盘中文件的选项。当此限制设为 true 时，对于此共享云端硬盘中的任何文件，系统会将名称相似的字段替换为 true。
restrictions.domainUsersOnly

boolean

是否仅限该共享云端硬盘所属网域中的用户访问此共享云端硬盘以及其中的内容。此限制可能会被由不受此共享云端硬盘控制的其他共享政策覆盖。
restrictions.driveMembersOnly

boolean

是否仅限该共享云端硬盘的成员访问其中的内容。
restrictions.adminManagedRestrictions

boolean

修改限制条件时是否需要拥有此共享云端硬盘的管理员权限。
restrictions.sharingFoldersRequiresOrganizerPermission

boolean

如果为 true，则只有拥有“组织者”角色的用户才能共享文件夹。如果为 false，则拥有“组织者”角色或“文件管理者”角色的用户可以共享文件夹。
orgUnitId

string

仅限输出。此共享云端硬盘的组织部门。当 useDomainAdminAccess 参数设置为 true 时，只有在 drives.list 响应中才会填充此字段。

方法

delete

 永久删除用户拥有“organizer”权限的共享云端硬盘。

get

 根据 ID 获取共享云端硬盘的元数据。

hide

 在默认视图中隐藏共享云端硬盘。

insert

 创建新的共享云端硬盘。

list

列出用户的共享云端硬盘。

unhide

 将共享云端硬盘恢复到默认视图。

update

 更新共享云端硬盘的元数据。