Skip to content

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

Deprecated: Use `drives.get` instead.: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Deprecated: Use `drives get` instead — response body

FieldTypePresenceDescription and constraints
$objectRootDeprecated: use the drive collection instead. Next ID: 33
backgroundImageFileobjectOptionalThe background image file for a Team Drive.
backgroundImageFile.idstringOptionalThe ID of an image file in Drive to use for the background image.
backgroundImageFile.widthJSONOptional
backgroundImageFile.width (anyOf 1)numberAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageFile.xCoordinateJSONOptional
backgroundImageFile.xCoordinate (anyOf 1)numberAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageFile.yCoordinateJSONOptional
backgroundImageFile.yCoordinate (anyOf 1)numberAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageLinkstringOptionalA short-lived link to this Team Drive’s background image.
capabilitiesModelOptionalExpand Deprecated: Use `drives get` instead — response body — capabilities
colorRgbstringOptionalThe 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`.
createdTimestringOptionalThe time at which the Team Drive was created (RFC 3339 date-time).
Format: date-time
idstringOptionalThe ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
kindstringOptionalIdentifies what kind of resource this is. Value: the fixed string `“drive#teamDrive”`.
Default: drive#teamDrive
namestringOptionalThe name of this Team Drive.
orgUnitIdstringOptionalThe organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
restrictionsModelOptionalExpand Deprecated: Use `drives get` instead — response body — restrictions
themeIdstringOptionalThe 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.