此页面由 Cloud Translation API 翻译。

REST Resource: drives

资源：云端硬盘
- JSON 表示法
方法

资源：云端硬盘

表示共享云端硬盘。

某些资源方法（例如 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 }, "createdTime": string, "hidden": boolean, "restrictions": { "copyRequiresWriterPermission": boolean, "domainUsersOnly": boolean, "driveMembersOnly": boolean, "adminManagedRestrictions": boolean, "sharingFoldersRequiresOrganizerPermission": boolean }, "orgUnitId": string }

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
  },
  "createdTime": 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"`。
`backgroundImageLink`	`string` 仅供输出。指向此共享云端硬盘背景图片的短期链接。
`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，系统将根据此 ID 设置背景图片和颜色。可以从 `drive.about.get` 响应中检索可能的 `driveThemes` 集。如果 `drive.drives.create` 请求中未指定该主题，则系统会选择随机主题，并根据该主题设置背景图片和颜色。此字段是只写字段，只能针对未设置 `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 像素。
`createdTime`	`string` 仅供输出。共享云端硬盘的创建时间（RFC 3339 日期时间）。
`hidden`	`boolean` 相应共享云端硬盘是否在默认视图中处于隐藏状态。
`restrictions`	`object` 应用于此共享云端硬盘或此共享云端硬盘中的内容的一组限制。请注意，创建共享云端硬盘时无法设置限制。如需添加限制，请先创建一个共享云端硬盘，然后使用 `drives.update` 添加限制。
`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` 响应中填充此字段。

方法
`create`	创建共享云端硬盘。
`delete`	永久删除用户是 `organizer` 的共享云端硬盘。
`get`	按 ID 获取共享云端硬盘的元数据。
`hide`	从默认视图中隐藏共享云端硬盘。
`list`	列出用户的共享云端硬盘。
`unhide`	将共享云端硬盘恢复为默认视图。
`update`	更新共享云端硬盘的元数据。

REST Resource: drives

资源：云端硬盘

方法

`create`

`delete`

`get`

`hide`

`list`

`unhide`

`update`