close()

Close httplib2 connections.

delete(driveId)

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.

Args:
  driveId: string, The ID of the shared drive. (required)

get(driveId, useDomainAdminAccess=None)

Gets a shared drive's metadata by ID.

Args:
driveId: string, The ID of the shared drive. (required)
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.

Returns:
An object of the form:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

hide(driveId)

Hides a shared drive from the default view.

Args:
driveId: string, The ID of the shared drive. (required)

Returns:
An object of the form:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

insert(requestId, body=None)

Creates a new shared drive.

Args:
requestId: string, An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. (required)
body: object, The request body.
The object takes the form of:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

Returns:
An object of the form:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)

Lists the user's shared drives.

Args:
maxResults: integer, Maximum number of shared drives to return per page.
pageToken: string, Page token for shared drives.
q: string, Query string for searching shared drives.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.

Returns:
An object of the form:

{ # A list of shared drives.
"items": [ # The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
},
],
"kind": "drive#driveList", # This is always drive#driveList
"nextPageToken": "A String", # The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

unhide(driveId)

Restores a shared drive to the default view.

Args:
driveId: string, The ID of the shared drive. (required)

Returns:
An object of the form:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

update(driveId, body=None, useDomainAdminAccess=None)

Updates the metadata for a shared drive.

Args:
driveId: string, The ID of the shared drive. (required)
body: object, The request body.
The object takes the form of:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

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.

Returns:
An object of the form:

{ # Representation of a shared drive.
"backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # 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.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A 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.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # This is always drive#drive
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A 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.insert 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.
}

Drive API . drives

Instance Methods

Method Details