Google: Drive drives schemas
6 Google schemas with complete fields and constraints.
← Drive drives operations · All schemas
Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive. |
backgroundImageFile | object | Optional | 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. |
backgroundImageFile.id | string | Optional | The ID of an image file in Google 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 | Output only. A short-lived link to this shared drive's background image. |
capabilities | Model | Optional | Expand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities |
colorRgb | string | Optional | 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`. |
createdTime | string | Optional | The time at which the shared drive was created (RFC 3339 date-time). Format: date-time |
hidden | boolean | Optional | Whether the shared drive is hidden from default view. |
id | string | Optional | Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. |
kind | string | Optional | Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`. Default: drive#drive |
name | string | Optional | The name of this shared drive. |
orgUnitId | string | Optional | Output only. 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 Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — 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 `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`. |
Referenced models: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities, Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — restrictions
Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive. |
backgroundImageFile | object | Optional | 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. |
backgroundImageFile.id | string | Optional | The ID of an image file in Google 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 | Output only. A short-lived link to this shared drive's background image. |
capabilities | Model | Optional | Expand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities |
colorRgb | string | Optional | 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`. |
createdTime | string | Optional | The time at which the shared drive was created (RFC 3339 date-time). Format: date-time |
hidden | boolean | Optional | Whether the shared drive is hidden from default view. |
id | string | Optional | Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. |
kind | string | Optional | Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`. Default: drive#drive |
name | string | Optional | The name of this shared drive. |
orgUnitId | string | Optional | Output only. 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 Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — 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 `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`. |
Referenced models: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities, Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — restrictions
Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Output only. Capabilities the current user has on this shared drive. |
canAddChildren | boolean | Optional | Output only. Whether the current user can add children to folders in this shared drive. |
canChangeCopyRequiresWriterPermissionRestriction | boolean | Optional | Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. |
canChangeDomainUsersOnlyRestriction | boolean | Optional | Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. |
canChangeDownloadRestriction | boolean | Optional | Output only. Whether the current user can change organizer-applied download restrictions of this shared drive. |
canChangeDriveBackground | boolean | Optional | Output only. Whether the current user can change the background of this shared drive. |
canChangeDriveMembersOnlyRestriction | boolean | Optional | Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. |
canChangeSharingFoldersRequiresOrganizerPermissionRestriction | boolean | Optional | Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. |
canComment | boolean | Optional | Output only. Whether the current user can comment on files in this shared drive. |
canCopy | boolean | Optional | Output only. Whether the current user can copy files in this shared drive. |
canDeleteChildren | boolean | Optional | Output only. Whether the current user can delete children from folders in this shared drive. |
canDeleteDrive | boolean | Optional | Output only. 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. |
canDownload | boolean | Optional | Output only. Whether the current user can download files in this shared drive. |
canEdit | boolean | Optional | Output only. Whether the current user can edit files in this shared drive |
canListChildren | boolean | Optional | Output only. Whether the current user can list the children of folders in this shared drive. |
canManageMembers | boolean | Optional | Output only. Whether the current user can add members to this shared drive or remove them or change their role. |
canReadRevisions | boolean | Optional | Output only. Whether the current user can read the revisions resource of files in this shared drive. |
canRename | boolean | Optional | Output only. Whether the current user can rename files or folders in this shared drive. |
canRenameDrive | boolean | Optional | Output only. Whether the current user can rename this shared drive. |
canResetDriveRestrictions | boolean | Optional | Output only. Whether the current user can reset the shared drive restrictions to defaults. |
canShare | boolean | Optional | Output only. Whether the current user can share files or folders in this shared drive. |
canTrashChildren | boolean | Optional | Output only. Whether the current user can trash children from folders in this shared drive. |
Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — restrictions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions. |
adminManagedRestrictions | boolean | Optional | Whether administrative privileges on this shared drive are required to modify restrictions. |
copyRequiresWriterPermission | boolean | Optional | 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. |
domainUsersOnly | boolean | Optional | 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. |
downloadRestriction | Model | Optional | Expand Deprecated: Use `drives get` instead — response body — restrictions download Restriction Download restrictions applied by shared drive managers. |
driveMembersOnly | boolean | Optional | Whether access to items inside this shared drive is restricted to its members. |
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. |
Referenced models: Deprecated: Use `drives get` instead — response body — restrictions download Restriction
Gets a shared drive's metadata by ID For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — 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 shared drive belongs. Default: false |
Lists the user's shared drives This method accepts the `q` parameter, which is a search query combining one or more search terms For more information, see the Search for shared drives (https: developers google com workspace drive api guides search-shareddrives) guide — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of shared drives. |
drives | array | Optional | The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
drives[] | Model | Each item | Expand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body |
kind | string | Optional | Identifies what kind of resource this is. Value: the fixed string `"drive#driveList"`. Default: drive#driveList |
nextPageToken | string | Optional | The page token for the next page of shared drives. This will be absent if the end of the 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. |
Referenced models: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body