Search + K

Command Palette

Search for a command to run...

Sign In

drive.drives.update

PATCH /drives/{driveId}
Copy endpoint
https://www.googleapis.com/drive/v3

Updates the metadata for a shared drive. For more information, see Manage shared drives.

Parameters

path Path Parameters

Name Type
driveId required

The ID of the shared drive.

string

query Query Parameters

Name Type
useDomainAdminAccess

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.

boolean
access_token

OAuth access token.

string
alt

Data format for response.

"json" | "media" | "proto"
callback

JSONP

string
fields

Selector specifying which fields to include in a partial response.

string
key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

string
oauth_token

OAuth 2.0 token for the current user.

string
prettyPrint

Returns response with indentations and line breaks.

boolean
quotaUser

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.

string
upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

string
uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

string
$.xgafv

V1 error format.

"1" | "2"

Request Body

application/json
interface Drive {
backgroundImageFile?: {
id?: string;
width?: number;
xCoordinate?: number;
yCoordinate?: number;
}
;
backgroundImageLink?: string;
capabilities?: {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
canChangeDomainUsersOnlyRestriction?: boolean;
canChangeDownloadRestriction?: boolean;
canChangeDriveBackground?: boolean;
canChangeDriveMembersOnlyRestriction?: boolean;
canChangeSharingFoldersRequiresOrganizerPermissionRestriction?: boolean;
canComment?: boolean;
canCopy?: boolean;
canDeleteChildren?: boolean;
canDeleteDrive?: boolean;
canDownload?: boolean;
canEdit?: boolean;
canListChildren?: boolean;
canManageMembers?: boolean;
canReadRevisions?: boolean;
canRename?: boolean;
canRenameDrive?: boolean;
canResetDriveRestrictions?: boolean;
canShare?: boolean;
canTrashChildren?: boolean;
}
;
colorRgb?: string;
createdTime?: string;
hidden?: boolean;
id?: string;
kind?: string;
name?: string;
orgUnitId?: string;
restrictions?: {
adminManagedRestrictions?: boolean;
copyRequiresWriterPermission?: boolean;
domainUsersOnly?: boolean;
downloadRestriction?: DownloadRestriction

A restriction for copy and download of the file.

interface DownloadRestriction {
restrictedForReaders?: boolean;
restrictedForWriters?: boolean;
}
;
driveMembersOnly?: boolean;
sharingFoldersRequiresOrganizerPermission?: boolean;
}
;
themeId?: string;
}

Responses

200 */*

Successful response

interface Drive {
backgroundImageFile?: {
id?: string;
width?: number;
xCoordinate?: number;
yCoordinate?: number;
}
;
backgroundImageLink?: string;
capabilities?: {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
canChangeDomainUsersOnlyRestriction?: boolean;
canChangeDownloadRestriction?: boolean;
canChangeDriveBackground?: boolean;
canChangeDriveMembersOnlyRestriction?: boolean;
canChangeSharingFoldersRequiresOrganizerPermissionRestriction?: boolean;
canComment?: boolean;
canCopy?: boolean;
canDeleteChildren?: boolean;
canDeleteDrive?: boolean;
canDownload?: boolean;
canEdit?: boolean;
canListChildren?: boolean;
canManageMembers?: boolean;
canReadRevisions?: boolean;
canRename?: boolean;
canRenameDrive?: boolean;
canResetDriveRestrictions?: boolean;
canShare?: boolean;
canTrashChildren?: boolean;
}
;
colorRgb?: string;
createdTime?: string;
hidden?: boolean;
id?: string;
kind?: string;
name?: string;
orgUnitId?: string;
restrictions?: {
adminManagedRestrictions?: boolean;
copyRequiresWriterPermission?: boolean;
domainUsersOnly?: boolean;
downloadRestriction?: DownloadRestriction

A restriction for copy and download of the file.

interface DownloadRestriction {
restrictedForReaders?: boolean;
restrictedForWriters?: boolean;
}
;
driveMembersOnly?: boolean;
sharingFoldersRequiresOrganizerPermission?: boolean;
}
;
themeId?: string;
}