Drives

For a list of methods for this resource, see the end of this page.

Resource representations

Representation of a shared drive.

{
  "kind": "drive#drive",
  "id": string,
  "name": string,
  "themeId": string,
  "colorRgb": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": float,
    "yCoordinate": float,
    "width": float
  },
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveBackground": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteChildren": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canShare": boolean,
    "canTrashChildren": boolean
  },
  "createdDate": datetime,
  "hidden": boolean,
  "restrictions": {
    "adminManagedRestrictions": boolean,
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean
  }
}
Property name Value Description Notes
kind string This is always drive#drive
id string The ID of this shared drive which is also the ID of the top level folder of this shared drive.
name string The name of this shared drive. writable
themeId string The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. writable
colorRgb string The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. writable
backgroundImageFile object An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. writable
backgroundImageFile.id string The ID of an image file in Google Drive to use for the background image.
backgroundImageFile.xCoordinate float The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
backgroundImageFile.yCoordinate float The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
backgroundImageFile.width float The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
capabilities object Capabilities the current user has on this shared drive.
capabilities.canAddChildren boolean Whether the current user can add children to folders in this shared drive.
capabilities.canChangeCopyRequiresWriterPermissionRestriction boolean Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
capabilities.canChangeDomainUsersOnlyRestriction boolean Whether the current user can change the domainUsersOnly restriction of this shared drive.
capabilities.canChangeDriveBackground boolean Whether the current user can change the background of this shared drive.
capabilities.canChangeDriveMembersOnlyRestriction boolean Whether the current user can change the driveMembersOnly restriction of this shared drive.
capabilities.canComment boolean Whether the current user can comment on files in this shared drive.
capabilities.canCopy boolean Whether the current user can copy files in this shared drive.
capabilities.canDeleteChildren boolean Whether the current user can delete children from folders in this shared drive.
capabilities.canDeleteDrive boolean Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
capabilities.canDownload boolean Whether the current user can download files in this shared drive.
capabilities.canEdit boolean Whether the current user can edit files in this shared drive
capabilities.canListChildren boolean Whether the current user can list the children of folders in this shared drive.
capabilities.canManageMembers boolean Whether the current user can add members to this shared drive or remove them or change their role.
capabilities.canReadRevisions boolean Whether the current user can read the revisions resource of files in this shared drive.
capabilities.canRename boolean Whether the current user can rename files or folders in this shared drive.
capabilities.canRenameDrive boolean Whether the current user can rename this shared drive.
capabilities.canShare boolean Whether the current user can share files or folders in this shared drive.
capabilities.canTrashChildren boolean Whether the current user can trash children from folders in this shared drive.
createdDate datetime The time at which the shared drive was created (RFC 3339 date-time).
hidden boolean Whether the shared drive is hidden from default view. writable
restrictions object A set of restrictions that apply to this shared drive or items inside this shared drive. writable
restrictions.adminManagedRestrictions boolean Whether administrative privileges on this shared drive are required to modify restrictions.
restrictions.copyRequiresWriterPermission boolean Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.
restrictions.domainUsersOnly boolean Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
restrictions.driveMembersOnly boolean Whether access to items inside this shared drive is restricted to its members.

Methods

delete
Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
get
Gets a shared drive's metadata by ID.
hide
Hides a shared drive from the default view.
insert
Creates a new shared drive.
list
Lists the user's shared drives.
unhide
Restores a shared drive to the default view.
update
Updates the metadata for a shared drive.