Update
|
|||||
|
|
||||
Updates the metadate for a shared drive
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, create, and delete all of your Google Drive files
Input
This building block consumes 39 input parameters
| Name | Format | Description |
|---|---|---|
driveId Required |
STRING |
The ID of the shared drive |
useDomainAdminAccess |
BOOLEAN |
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 |
backgroundImageFile |
OBJECT |
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 |
The ID of an image file in Google Drive to use for the background image |
backgroundImageFile.width |
FLOAT |
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 |
backgroundImageFile.xCoordinate |
FLOAT |
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 |
backgroundImageFile.yCoordinate |
FLOAT |
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 |
backgroundImageLink |
STRING |
A short-lived link to this shared drive's background image |
capabilities |
OBJECT |
Capabilities the current user has on this shared drive |
capabilities.canAddChildren |
BOOLEAN |
Whether the current user can add children to folders in this shared drive |
capabilities.canChangeCopyRequiresWriterPermissionRestriction |
BOOLEAN |
Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive |
capabilities.canChangeDomainUsersOnlyRestriction |
BOOLEAN |
Whether the current user can change the domainUsersOnly restriction of this shared drive |
capabilities.canChangeDriveBackground |
BOOLEAN |
Whether the current user can change the background of this shared drive |
capabilities.canChangeDriveMembersOnlyRestriction |
BOOLEAN |
Whether the current user can change the driveMembersOnly restriction of this shared drive |
capabilities.canComment |
BOOLEAN |
Whether the current user can comment on files in this shared drive |
capabilities.canCopy |
BOOLEAN |
Whether the current user can copy files in this shared drive |
capabilities.canDeleteChildren |
BOOLEAN |
Whether the current user can delete children from folders in this shared drive |
capabilities.canDeleteDrive |
BOOLEAN |
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 |
capabilities.canDownload |
BOOLEAN |
Whether the current user can download files in this shared drive |
capabilities.canEdit |
BOOLEAN |
Whether the current user can edit files in this shared drive |
capabilities.canListChildren |
BOOLEAN |
Whether the current user can list the children of folders in this shared drive |
capabilities.canManageMembers |
BOOLEAN |
Whether the current user can add members to this shared drive or remove them or change their role |
capabilities.canReadRevisions |
BOOLEAN |
Whether the current user can read the revisions resource of files in this shared drive |
capabilities.canRename |
BOOLEAN |
Whether the current user can rename files or folders in this shared drive |
capabilities.canRenameDrive |
BOOLEAN |
Whether the current user can rename this shared drive |
capabilities.canShare |
BOOLEAN |
Whether the current user can share files or folders in this shared drive |
capabilities.canTrashChildren |
BOOLEAN |
Whether the current user can trash children from folders in this shared drive |
colorRgb |
STRING |
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 |
DATE_TIME |
The time at which the shared drive was created (RFC 3339 date-time) |
hidden |
BOOLEAN |
Whether the shared drive is hidden from default view |
id |
STRING |
The ID of this shared drive which is also the ID of the top level folder of this shared drive |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#drive" |
name |
STRING |
The name of this shared drive |
restrictions |
OBJECT |
A set of restrictions that apply to this shared drive or items inside this shared drive |
restrictions.adminManagedRestrictions |
BOOLEAN |
Whether administrative privileges on this shared drive are required to modify restrictions |
restrictions.copyRequiresWriterPermission |
BOOLEAN |
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 |
restrictions.domainUsersOnly |
BOOLEAN |
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 |
restrictions.driveMembersOnly |
BOOLEAN |
Whether access to items inside this shared drive is restricted to its members |
themeId |
STRING |
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 |
= Parameter name
= Format
|
driveId STRING Required The ID of the shared drive |
|
useDomainAdminAccess BOOLEAN 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 |
|
backgroundImageFile OBJECT 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 The ID of an image file in Google Drive to use for the background image |
|
backgroundImageFile.width FLOAT 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 |
|
backgroundImageFile.xCoordinate FLOAT 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 |
|
backgroundImageFile.yCoordinate FLOAT 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 |
|
backgroundImageLink STRING A short-lived link to this shared drive's background image |
|
capabilities OBJECT Capabilities the current user has on this shared drive |
|
capabilities.canAddChildren BOOLEAN Whether the current user can add children to folders in this shared drive |
|
capabilities.canChangeCopyRequiresWriterPermissionRestriction BOOLEAN Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive |
|
capabilities.canChangeDomainUsersOnlyRestriction BOOLEAN Whether the current user can change the domainUsersOnly restriction of this shared drive |
|
capabilities.canChangeDriveBackground BOOLEAN Whether the current user can change the background of this shared drive |
|
capabilities.canChangeDriveMembersOnlyRestriction BOOLEAN Whether the current user can change the driveMembersOnly restriction of this shared drive |
|
capabilities.canComment BOOLEAN Whether the current user can comment on files in this shared drive |
|
capabilities.canCopy BOOLEAN Whether the current user can copy files in this shared drive |
|
capabilities.canDeleteChildren BOOLEAN Whether the current user can delete children from folders in this shared drive |
|
capabilities.canDeleteDrive BOOLEAN 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 |
|
capabilities.canDownload BOOLEAN Whether the current user can download files in this shared drive |
|
capabilities.canEdit BOOLEAN Whether the current user can edit files in this shared drive |
|
capabilities.canListChildren BOOLEAN Whether the current user can list the children of folders in this shared drive |
|
capabilities.canManageMembers BOOLEAN Whether the current user can add members to this shared drive or remove them or change their role |
|
capabilities.canReadRevisions BOOLEAN Whether the current user can read the revisions resource of files in this shared drive |
|
capabilities.canRename BOOLEAN Whether the current user can rename files or folders in this shared drive |
|
capabilities.canRenameDrive BOOLEAN Whether the current user can rename this shared drive |
|
capabilities.canShare BOOLEAN Whether the current user can share files or folders in this shared drive |
|
capabilities.canTrashChildren BOOLEAN Whether the current user can trash children from folders in this shared drive |
|
colorRgb STRING 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 DATE_TIME The time at which the shared drive was created (RFC 3339 date-time) |
|
hidden BOOLEAN Whether the shared drive is hidden from default view |
|
id STRING The ID of this shared drive which is also the ID of the top level folder of this shared drive |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#drive" |
|
name STRING The name of this shared drive |
|
restrictions OBJECT A set of restrictions that apply to this shared drive or items inside this shared drive |
|
restrictions.adminManagedRestrictions BOOLEAN Whether administrative privileges on this shared drive are required to modify restrictions |
|
restrictions.copyRequiresWriterPermission BOOLEAN 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 |
|
restrictions.domainUsersOnly BOOLEAN 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 |
|
restrictions.driveMembersOnly BOOLEAN Whether access to items inside this shared drive is restricted to its members |
|
themeId STRING 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 |
Output
This building block provides 37 output parameters
| Name | Format | Description |
|---|---|---|
backgroundImageFile |
OBJECT |
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 |
The ID of an image file in Google Drive to use for the background image |
backgroundImageFile.width |
FLOAT |
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 |
backgroundImageFile.xCoordinate |
FLOAT |
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 |
backgroundImageFile.yCoordinate |
FLOAT |
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 |
backgroundImageLink |
STRING |
A short-lived link to this shared drive's background image |
capabilities |
OBJECT |
Capabilities the current user has on this shared drive |
capabilities.canAddChildren |
BOOLEAN |
Whether the current user can add children to folders in this shared drive |
capabilities.canChangeCopyRequiresWriterPermissionRestriction |
BOOLEAN |
Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive |
capabilities.canChangeDomainUsersOnlyRestriction |
BOOLEAN |
Whether the current user can change the domainUsersOnly restriction of this shared drive |
capabilities.canChangeDriveBackground |
BOOLEAN |
Whether the current user can change the background of this shared drive |
capabilities.canChangeDriveMembersOnlyRestriction |
BOOLEAN |
Whether the current user can change the driveMembersOnly restriction of this shared drive |
capabilities.canComment |
BOOLEAN |
Whether the current user can comment on files in this shared drive |
capabilities.canCopy |
BOOLEAN |
Whether the current user can copy files in this shared drive |
capabilities.canDeleteChildren |
BOOLEAN |
Whether the current user can delete children from folders in this shared drive |
capabilities.canDeleteDrive |
BOOLEAN |
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 |
capabilities.canDownload |
BOOLEAN |
Whether the current user can download files in this shared drive |
capabilities.canEdit |
BOOLEAN |
Whether the current user can edit files in this shared drive |
capabilities.canListChildren |
BOOLEAN |
Whether the current user can list the children of folders in this shared drive |
capabilities.canManageMembers |
BOOLEAN |
Whether the current user can add members to this shared drive or remove them or change their role |
capabilities.canReadRevisions |
BOOLEAN |
Whether the current user can read the revisions resource of files in this shared drive |
capabilities.canRename |
BOOLEAN |
Whether the current user can rename files or folders in this shared drive |
capabilities.canRenameDrive |
BOOLEAN |
Whether the current user can rename this shared drive |
capabilities.canShare |
BOOLEAN |
Whether the current user can share files or folders in this shared drive |
capabilities.canTrashChildren |
BOOLEAN |
Whether the current user can trash children from folders in this shared drive |
colorRgb |
STRING |
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 |
DATE_TIME |
The time at which the shared drive was created (RFC 3339 date-time) |
hidden |
BOOLEAN |
Whether the shared drive is hidden from default view |
id |
STRING |
The ID of this shared drive which is also the ID of the top level folder of this shared drive |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#drive" |
name |
STRING |
The name of this shared drive |
restrictions |
OBJECT |
A set of restrictions that apply to this shared drive or items inside this shared drive |
restrictions.adminManagedRestrictions |
BOOLEAN |
Whether administrative privileges on this shared drive are required to modify restrictions |
restrictions.copyRequiresWriterPermission |
BOOLEAN |
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 |
restrictions.domainUsersOnly |
BOOLEAN |
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 |
restrictions.driveMembersOnly |
BOOLEAN |
Whether access to items inside this shared drive is restricted to its members |
themeId |
STRING |
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 |
= Parameter name
= Format
|
backgroundImageFile OBJECT 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 The ID of an image file in Google Drive to use for the background image |
|
backgroundImageFile.width FLOAT 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 |
|
backgroundImageFile.xCoordinate FLOAT 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 |
|
backgroundImageFile.yCoordinate FLOAT 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 |
|
backgroundImageLink STRING A short-lived link to this shared drive's background image |
|
capabilities OBJECT Capabilities the current user has on this shared drive |
|
capabilities.canAddChildren BOOLEAN Whether the current user can add children to folders in this shared drive |
|
capabilities.canChangeCopyRequiresWriterPermissionRestriction BOOLEAN Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive |
|
capabilities.canChangeDomainUsersOnlyRestriction BOOLEAN Whether the current user can change the domainUsersOnly restriction of this shared drive |
|
capabilities.canChangeDriveBackground BOOLEAN Whether the current user can change the background of this shared drive |
|
capabilities.canChangeDriveMembersOnlyRestriction BOOLEAN Whether the current user can change the driveMembersOnly restriction of this shared drive |
|
capabilities.canComment BOOLEAN Whether the current user can comment on files in this shared drive |
|
capabilities.canCopy BOOLEAN Whether the current user can copy files in this shared drive |
|
capabilities.canDeleteChildren BOOLEAN Whether the current user can delete children from folders in this shared drive |
|
capabilities.canDeleteDrive BOOLEAN 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 |
|
capabilities.canDownload BOOLEAN Whether the current user can download files in this shared drive |
|
capabilities.canEdit BOOLEAN Whether the current user can edit files in this shared drive |
|
capabilities.canListChildren BOOLEAN Whether the current user can list the children of folders in this shared drive |
|
capabilities.canManageMembers BOOLEAN Whether the current user can add members to this shared drive or remove them or change their role |
|
capabilities.canReadRevisions BOOLEAN Whether the current user can read the revisions resource of files in this shared drive |
|
capabilities.canRename BOOLEAN Whether the current user can rename files or folders in this shared drive |
|
capabilities.canRenameDrive BOOLEAN Whether the current user can rename this shared drive |
|
capabilities.canShare BOOLEAN Whether the current user can share files or folders in this shared drive |
|
capabilities.canTrashChildren BOOLEAN Whether the current user can trash children from folders in this shared drive |
|
colorRgb STRING 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 DATE_TIME The time at which the shared drive was created (RFC 3339 date-time) |
|
hidden BOOLEAN Whether the shared drive is hidden from default view |
|
id STRING The ID of this shared drive which is also the ID of the top level folder of this shared drive |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#drive" |
|
name STRING The name of this shared drive |
|
restrictions OBJECT A set of restrictions that apply to this shared drive or items inside this shared drive |
|
restrictions.adminManagedRestrictions BOOLEAN Whether administrative privileges on this shared drive are required to modify restrictions |
|
restrictions.copyRequiresWriterPermission BOOLEAN 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 |
|
restrictions.domainUsersOnly BOOLEAN 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 |
|
restrictions.driveMembersOnly BOOLEAN Whether access to items inside this shared drive is restricted to its members |
|
themeId STRING 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 |