Google: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — request body — body
Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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