Teamdrives

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

Resource representations

Representation of a Team Drive.

{
  "kind": "drive#teamDrive",
  "id": string,
  "name": string,
  "themeId": string,
  "colorRgb": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": float,
    "yCoordinate": float,
    "width": float
  },
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canChangeTeamDriveBackground": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteTeamDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRemoveChildren": boolean,
    "canRename": boolean,
    "canRenameTeamDrive": boolean,
    "canShare": boolean
  },
  "createdDate": datetime
}
Property name Value Description Notes
kind string This is always drive#teamDrive
id string The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
name string The name of this Team Drive.
capabilities object Capabilities the current user has on this Team Drive.
capabilities.canAddChildren boolean Whether the current user can add children to folders in this Team Drive.
capabilities.canComment boolean Whether the current user can comment on files in this Team Drive.
capabilities.canCopy boolean Whether the current user can copy files in this Team Drive.
capabilities.canDeleteTeamDrive boolean Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
capabilities.canDownload boolean Whether the current user can download files in this Team Drive.
capabilities.canEdit boolean Whether the current user can edit files in this Team Drive
capabilities.canListChildren boolean Whether the current user can list the children of folders in this Team Drive.
capabilities.canManageMembers boolean Whether the current user can add members to this Team Drive or remove them or change their role.
capabilities.canReadRevisions boolean Whether the current user can read the revisions resource of files in this Team Drive.
capabilities.canRemoveChildren boolean Whether the current user can remove children from folders in this Team Drive.
capabilities.canRename boolean Whether the current user can rename files or folders in this Team Drive.
capabilities.canRenameTeamDrive boolean Whether the current user can rename this Team Drive.
capabilities.canShare boolean Whether the current user can share files or folders in this Team Drive.
themeId string The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.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 Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. writable
backgroundImageFile object An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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.canChangeTeamDriveBackground boolean Whether the current user can change the background of this Team Drive.
createdDate datetime The time at which the Team Drive was created (RFC 3339 date-time).

Methods

delete
Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.
get
Gets a Team Drive's metadata by ID.
insert
Creates a new Team Drive.
list
Lists the user's Team Drives.
update
Updates a Team Drive's metadata

Send feedback about...

Drive REST API v2
Drive REST API v2