| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.teamdrives.html">teamdrives</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(requestId, body=None)</a></code></p> |
| <p class="firstline">Deprecated use drives.create instead.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(teamDriveId)</a></code></p> |
| <p class="firstline">Deprecated use drives.delete instead.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(teamDriveId, useDomainAdminAccess=None)</a></code></p> |
| <p class="firstline">Deprecated use drives.get instead.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(pageSize=None, pageToken=None, q=None, useDomainAdminAccess=None)</a></code></p> |
| <p class="firstline">Deprecated use drives.list instead.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(teamDriveId, body=None, useDomainAdminAccess=None)</a></code></p> |
| <p class="firstline">Deprecated use drives.update instead</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(requestId, body=None)</code> |
| <pre>Deprecated use drives.create instead. |
| |
| Args: |
| requestId: string, An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Deprecated: use the drive collection instead. |
| "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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 Team Drive's background image. |
| "capabilities": { # Capabilities the current user has on this Team Drive. |
| "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| "canManageMembers": True or False, # Whether the current user can add members to this Team 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 Team Drive. |
| "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| }, |
| "colorRgb": "A String", # The 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. |
| "createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". |
| "name": "A String", # The name of this Team Drive. |
| "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive. |
| "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| }, |
| "themeId": "A String", # The 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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # Deprecated: use the drive collection instead. |
| "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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 Team Drive's background image. |
| "capabilities": { # Capabilities the current user has on this Team Drive. |
| "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| "canManageMembers": True or False, # Whether the current user can add members to this Team 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 Team Drive. |
| "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| }, |
| "colorRgb": "A String", # The 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. |
| "createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". |
| "name": "A String", # The name of this Team Drive. |
| "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive. |
| "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| }, |
| "themeId": "A String", # The 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(teamDriveId)</code> |
| <pre>Deprecated use drives.delete instead. |
| |
| Args: |
| teamDriveId: string, The ID of the Team Drive (required) |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(teamDriveId, useDomainAdminAccess=None)</code> |
| <pre>Deprecated use drives.get instead. |
| |
| Args: |
| teamDriveId: string, The ID of the Team 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 Team Drive belongs. |
| |
| Returns: |
| An object of the form: |
| |
| { # Deprecated: use the drive collection instead. |
| "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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 Team Drive's background image. |
| "capabilities": { # Capabilities the current user has on this Team Drive. |
| "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| "canManageMembers": True or False, # Whether the current user can add members to this Team 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 Team Drive. |
| "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| }, |
| "colorRgb": "A String", # The 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. |
| "createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". |
| "name": "A String", # The name of this Team Drive. |
| "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive. |
| "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| }, |
| "themeId": "A String", # The 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(pageSize=None, pageToken=None, q=None, useDomainAdminAccess=None)</code> |
| <pre>Deprecated use drives.list instead. |
| |
| Args: |
| pageSize: integer, Maximum number of Team Drives to return. |
| pageToken: string, Page token for Team Drives. |
| q: string, Query string for searching Team Drives. |
| useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of Team Drives. |
| "kind": "drive#teamDriveList", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList". |
| "nextPageToken": "A String", # The page token for the next page of Team Drives. This will be absent if the end of the Team Drives 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. |
| "teamDrives": [ # The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
| { # Deprecated: use the drive collection instead. |
| "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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 Team Drive's background image. |
| "capabilities": { # Capabilities the current user has on this Team Drive. |
| "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| "canManageMembers": True or False, # Whether the current user can add members to this Team 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 Team Drive. |
| "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| }, |
| "colorRgb": "A String", # The 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. |
| "createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". |
| "name": "A String", # The name of this Team Drive. |
| "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive. |
| "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| }, |
| "themeId": "A String", # The 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. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(teamDriveId, body=None, useDomainAdminAccess=None)</code> |
| <pre>Deprecated use drives.update instead |
| |
| Args: |
| teamDriveId: string, The ID of the Team Drive (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Deprecated: use the drive collection instead. |
| "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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 Team Drive's background image. |
| "capabilities": { # Capabilities the current user has on this Team Drive. |
| "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| "canManageMembers": True or False, # Whether the current user can add members to this Team 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 Team Drive. |
| "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| }, |
| "colorRgb": "A String", # The 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. |
| "createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". |
| "name": "A String", # The name of this Team Drive. |
| "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive. |
| "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| }, |
| "themeId": "A String", # The 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. |
| } |
| |
| 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 Team Drive belongs. |
| |
| Returns: |
| An object of the form: |
| |
| { # Deprecated: use the drive collection instead. |
| "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.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 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 Team Drive's background image. |
| "capabilities": { # Capabilities the current user has on this Team Drive. |
| "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| "canManageMembers": True or False, # Whether the current user can add members to this Team 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 Team Drive. |
| "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| }, |
| "colorRgb": "A String", # The 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. |
| "createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". |
| "name": "A String", # The name of this Team Drive. |
| "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive. |
| "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| }, |
| "themeId": "A String", # The 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. |
| }</pre> |
| </div> |
| |
| </body></html> |