REST Resource: drives

资源：Drive

共享云端硬盘的表示形式。

某些资源方法（例如 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,
    "canChangeDownloadRestriction": 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,
    "downloadRestriction": {
      object (DownloadRestriction)
    }
  },
  "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

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

boolean

仅限输出。当前用户是否可以更改此共享云端硬盘的组织者设置的下载限制。
themeId

string

将从中设置背景图片和颜色的主题的 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，则拥有组织者角色或文件组织者角色的用户可以共享文件夹。
restrictions.downloadRestriction

object (DownloadRestriction)

共享云端硬盘管理员应用的下载限制。
orgUnitId

string

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

方法

create

 创建共享云端硬盘。

delete

 永久删除用户是 organizer 的共享云端硬盘。

get

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

hide

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

list

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

unhide

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

update

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