Google: Updates the metadata for a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives)

Google driveDrives.driveDrivesUpdate: arguments, response, policy and SDK examples.

Operation google.drive_drives_update

Provider route: PATCH /drive/v3/drives/{driveId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["driveDrives"]["driveDrivesUpdate"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.driveDrives.driveDrivesUpdate(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.drive_drives.drive_drives_update(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.driveId`	string	Required within parent	The ID of the shared drive.
`query`	Model	Optional	Expand 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
`body`	Model	Required within parent	Expand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — request body — body

Referenced models: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — request body — body, 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

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body

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

Schemas

2 more schemas are linked from the tables above, on the schema pages.

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) — 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`.

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

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.

Policy, approvals and errors

SDK function policy ID: google.drive_drives_update. Catalog operation: drive.drives.update. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/drive"]

Official provider source

Report an issue with this page