Google: Drive teamdrives schemas

← Drive teamdrives operations · All schemas

Deprecated: Use `drives create` instead — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Deprecated: use the drive collection instead. Next ID: 33
backgroundImageFile	object	Optional	The background image file for a Team Drive.
backgroundImageFile.id	string	Optional	The ID of an image file in Drive to use for the background image.
backgroundImageFile.width	number	Optional	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. Format: float
backgroundImageFile.xCoordinate	number	Optional	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. Format: float
backgroundImageFile.yCoordinate	number	Optional	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. Format: float
backgroundImageLink	string	Optional	A short-lived link to this Team Drive's background image.
capabilities	Model	Optional	Expand Deprecated: Use `drives get` instead — response body — capabilities
colorRgb	string	Optional	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`.
createdTime	string	Optional	The time at which the Team Drive was created (RFC 3339 date-time). Format: date-time
id	string	Optional	The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
kind	string	Optional	Identifies what kind of resource this is. Value: the fixed string `"drive#teamDrive"`. Default: drive#teamDrive
name	string	Optional	The name of this Team Drive.
orgUnitId	string	Optional	The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
restrictions	Model	Optional	Expand Deprecated: Use `drives get` instead — response body — restrictions
themeId	string	Optional	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.create` 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`.

Referenced models: Deprecated: Use `drives get` instead — response body — capabilities, Deprecated: Use `drives get` instead — response body — restrictions

Deprecated: Use `drives get` instead — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
useDomainAdminAccess	boolean	Optional	Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. Default: false

Deprecated: Use `drives get` instead — response body

Field	Type	Presence	Description and constraints
$	object	Root	Deprecated: use the drive collection instead. Next ID: 33
backgroundImageFile	object	Optional	The background image file for a Team Drive.
backgroundImageFile.id	string	Optional	The ID of an image file in Drive to use for the background image.
backgroundImageFile.width	JSON	Optional
backgroundImageFile.width (anyOf 1)	number	Alternative	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. Format: float
backgroundImageFile.width (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageFile.xCoordinate	JSON	Optional
backgroundImageFile.xCoordinate (anyOf 1)	number	Alternative	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. Format: float
backgroundImageFile.xCoordinate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageFile.yCoordinate	JSON	Optional
backgroundImageFile.yCoordinate (anyOf 1)	number	Alternative	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. Format: float
backgroundImageFile.yCoordinate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageLink	string	Optional	A short-lived link to this Team Drive's background image.
capabilities	Model	Optional	Expand Deprecated: Use `drives get` instead — response body — capabilities
colorRgb	string	Optional	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`.
createdTime	string	Optional	The time at which the Team Drive was created (RFC 3339 date-time). Format: date-time
id	string	Optional	The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
kind	string	Optional	Identifies what kind of resource this is. Value: the fixed string `"drive#teamDrive"`. Default: drive#teamDrive
name	string	Optional	The name of this Team Drive.
orgUnitId	string	Optional	The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
restrictions	Model	Optional	Expand Deprecated: Use `drives get` instead — response body — restrictions
themeId	string	Optional	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.create` 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`.

Referenced models: Deprecated: Use `drives get` instead — response body — capabilities, Deprecated: Use `drives get` instead — response body — restrictions

Deprecated: Use `drives get` instead — response body — capabilities

Field	Type	Presence	Description and constraints
$	object	Root	Capabilities the current user has on this Team Drive.
canAddChildren	boolean	Optional	Whether the current user can add children to folders in this Team Drive.
canChangeCopyRequiresWriterPermissionRestriction	boolean	Optional	Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
canChangeDomainUsersOnlyRestriction	boolean	Optional	Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
canChangeDownloadRestriction	boolean	Optional	Output only. Whether the current user can change organizer-applied download restrictions of this shared drive. Read only: true
canChangeSharingFoldersRequiresOrganizerPermissionRestriction	boolean	Optional	Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
canChangeTeamDriveBackground	boolean	Optional	Whether the current user can change the background of this Team Drive.
canChangeTeamMembersOnlyRestriction	boolean	Optional	Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
canComment	boolean	Optional	Whether the current user can comment on files in this Team Drive.
canCopy	boolean	Optional	Whether the current user can copy files in this Team Drive.
canDeleteChildren	boolean	Optional	Whether the current user can delete children from folders in this Team Drive.
canDeleteTeamDrive	boolean	Optional	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.
canDownload	boolean	Optional	Whether the current user can download files in this Team Drive.
canEdit	boolean	Optional	Whether the current user can edit files in this Team Drive
canListChildren	boolean	Optional	Whether the current user can list the children of folders in this Team Drive.
canManageMembers	boolean	Optional	Whether the current user can add members to this Team Drive or remove them or change their role.
canReadRevisions	boolean	Optional	Whether the current user can read the revisions resource of files in this Team Drive.
canRemoveChildren	boolean	Optional	Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
canRename	boolean	Optional	Whether the current user can rename files or folders in this Team Drive.
canRenameTeamDrive	boolean	Optional	Whether the current user can rename this Team Drive.
canResetTeamDriveRestrictions	boolean	Optional	Whether the current user can reset the Team Drive restrictions to defaults.
canShare	boolean	Optional	Whether the current user can share files or folders in this Team Drive.
canTrashChildren	boolean	Optional	Whether the current user can trash children from folders in this Team Drive.

Deprecated: Use `drives get` instead — response body — restrictions

Field	Type	Presence	Description and constraints
$	object	Root	A set of restrictions that apply to this Team Drive or items inside this Team Drive.
adminManagedRestrictions	boolean	Optional	Whether administrative privileges on this Team Drive are required to modify restrictions.
copyRequiresWriterPermission	boolean	Optional	Whether the options to copy, print, or download files inside this Team 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 Team Drive.
domainUsersOnly	boolean	Optional	Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
downloadRestriction	Model	Optional	Expand Deprecated: Use `drives get` instead — response body — restrictions download Restriction Download restrictions applied by shared drive managers.
sharingFoldersRequiresOrganizerPermission	boolean	Optional	If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
teamMembersOnly	boolean	Optional	Whether access to items inside this Team Drive is restricted to members of this Team Drive.

Referenced models: Deprecated: Use `drives get` instead — response body — restrictions download Restriction

Deprecated: Use `drives get` instead — response body — restrictions download Restriction

Field	Type	Presence	Description and constraints
$	object	Root	A restriction for copy and download of the file.
restrictedForReaders	boolean	Optional	Whether download and copy is restricted for readers.
restrictedForWriters	boolean	Optional	Whether download and copy is restricted for writers. If true, download is also restricted for readers.

Deprecated: Use `drives list` instead — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of Team Drives.
kind	string	Optional	Identifies what kind of resource this is. Value: the fixed string `"drive#teamDriveList"`. Default: drive#teamDriveList
nextPageToken	string	Optional	The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
teamDrives	array	Optional	The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
teamDrives[]	Model	Each item	Expand Deprecated: Use `drives get` instead — response body

Referenced models: Deprecated: Use `drives get` instead — response body