drives

Overview

Name	drives
Type	Resource
Id	googleworkspace.drive.drives

Fields

Name	Datatype	Description
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.
createdTime	string	The time at which the shared drive was created (RFC 3339 date-time).
orgUnitId	string	The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.
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.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.
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.
hidden	boolean	Whether the shared drive is hidden from default view.
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.
capabilities	object	Capabilities the current user has on this shared drive.
backgroundImageLink	string	A short-lived link to this shared drive's background image.
kind	string	Identifies what kind of resource this is. Value: the fixed string "drive#drive".
restrictions	object	A set of restrictions that apply to this shared drive or items inside this shared drive.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	driveId	Gets a shared drive's metadata by ID.
list	SELECT		Lists the user's shared drives.
create	INSERT	requestId	Creates a shared drive.
delete	DELETE	driveId	Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
hide	EXEC	driveId	Hides a shared drive from the default view.
unhide	EXEC	driveId	Restores a shared drive to the default view.
update	EXEC	driveId	Updates the metadate for a shared drive.