1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.drives.html">drives</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(requestId, body=None)</a></code></p> 82<p class="firstline">Creates a new shared drive.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(driveId)</a></code></p> 85<p class="firstline">Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(driveId, useDomainAdminAccess=None)</a></code></p> 88<p class="firstline">Gets a shared drive's metadata by ID.</p> 89<p class="toc_element"> 90 <code><a href="#hide">hide(driveId)</a></code></p> 91<p class="firstline">Hides a shared drive from the default view.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(pageSize=None, pageToken=None, q=None, useDomainAdminAccess=None)</a></code></p> 94<p class="firstline">Lists the user's shared drives.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#unhide">unhide(driveId)</a></code></p> 100<p class="firstline">Restores a shared drive to the default view.</p> 101<p class="toc_element"> 102 <code><a href="#update">update(driveId, body=None, useDomainAdminAccess=None)</a></code></p> 103<p class="firstline">Updates the metadate for a shared drive.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="create">create(requestId, body=None)</code> 112 <pre>Creates a new shared drive. 113 114Args: 115 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) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # Representation of a shared drive. 120 "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. 121 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 122 "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. 123 "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. 124 "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. 125 }, 126 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 127 "capabilities": { # Capabilities the current user has on this shared drive. 128 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 129 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 130 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 131 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 132 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 133 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 134 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 135 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 136 "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. 137 "canDownload": True or False, # Whether the current user can download files in this shared drive. 138 "canEdit": True or False, # Whether the current user can edit files in this shared drive 139 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 140 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 141 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 142 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 143 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 144 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 145 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 146 }, 147 "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. 148 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 149 "hidden": True or False, # Whether the shared drive is hidden from default view. 150 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 151 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 152 "name": "A String", # The name of this shared drive. 153 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 154 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 155 "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. 156 "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. 157 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 158 }, 159 "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.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. 160} 161 162 163Returns: 164 An object of the form: 165 166 { # Representation of a shared drive. 167 "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. 168 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 169 "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. 170 "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. 171 "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. 172 }, 173 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 174 "capabilities": { # Capabilities the current user has on this shared drive. 175 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 176 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 177 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 178 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 179 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 180 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 181 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 182 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 183 "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. 184 "canDownload": True or False, # Whether the current user can download files in this shared drive. 185 "canEdit": True or False, # Whether the current user can edit files in this shared drive 186 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 187 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 188 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 189 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 190 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 191 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 192 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 193 }, 194 "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. 195 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 196 "hidden": True or False, # Whether the shared drive is hidden from default view. 197 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 198 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 199 "name": "A String", # The name of this shared drive. 200 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 201 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 202 "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. 203 "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. 204 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 205 }, 206 "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.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. 207}</pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="delete">delete(driveId)</code> 212 <pre>Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. 213 214Args: 215 driveId: string, The ID of the shared drive. (required) 216</pre> 217</div> 218 219<div class="method"> 220 <code class="details" id="get">get(driveId, useDomainAdminAccess=None)</code> 221 <pre>Gets a shared drive's metadata by ID. 222 223Args: 224 driveId: string, The ID of the shared drive. (required) 225 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. 226 227Returns: 228 An object of the form: 229 230 { # Representation of a shared drive. 231 "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. 232 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 233 "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. 234 "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. 235 "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. 236 }, 237 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 238 "capabilities": { # Capabilities the current user has on this shared drive. 239 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 240 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 241 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 242 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 243 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 244 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 245 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 246 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 247 "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. 248 "canDownload": True or False, # Whether the current user can download files in this shared drive. 249 "canEdit": True or False, # Whether the current user can edit files in this shared drive 250 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 251 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 252 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 253 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 254 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 255 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 256 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 257 }, 258 "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. 259 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 260 "hidden": True or False, # Whether the shared drive is hidden from default view. 261 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 262 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 263 "name": "A String", # The name of this shared drive. 264 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 265 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 266 "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. 267 "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. 268 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 269 }, 270 "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.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. 271}</pre> 272</div> 273 274<div class="method"> 275 <code class="details" id="hide">hide(driveId)</code> 276 <pre>Hides a shared drive from the default view. 277 278Args: 279 driveId: string, The ID of the shared drive. (required) 280 281Returns: 282 An object of the form: 283 284 { # Representation of a shared drive. 285 "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. 286 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 287 "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. 288 "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. 289 "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. 290 }, 291 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 292 "capabilities": { # Capabilities the current user has on this shared drive. 293 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 294 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 295 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 296 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 297 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 298 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 299 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 300 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 301 "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. 302 "canDownload": True or False, # Whether the current user can download files in this shared drive. 303 "canEdit": True or False, # Whether the current user can edit files in this shared drive 304 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 305 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 306 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 307 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 308 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 309 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 310 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 311 }, 312 "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. 313 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 314 "hidden": True or False, # Whether the shared drive is hidden from default view. 315 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 316 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 317 "name": "A String", # The name of this shared drive. 318 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 319 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 320 "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. 321 "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. 322 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 323 }, 324 "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.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. 325}</pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="list">list(pageSize=None, pageToken=None, q=None, useDomainAdminAccess=None)</code> 330 <pre>Lists the user's shared drives. 331 332Args: 333 pageSize: integer, Maximum number of shared drives to return per page. 334 pageToken: string, Page token for shared drives. 335 q: string, Query string for searching shared drives. 336 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. 337 338Returns: 339 An object of the form: 340 341 { # A list of shared drives. 342 "drives": [ # The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. 343 { # Representation of a shared drive. 344 "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. 345 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 346 "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. 347 "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. 348 "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. 349 }, 350 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 351 "capabilities": { # Capabilities the current user has on this shared drive. 352 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 353 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 354 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 355 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 356 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 357 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 358 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 359 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 360 "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. 361 "canDownload": True or False, # Whether the current user can download files in this shared drive. 362 "canEdit": True or False, # Whether the current user can edit files in this shared drive 363 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 364 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 365 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 366 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 367 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 368 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 369 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 370 }, 371 "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. 372 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 373 "hidden": True or False, # Whether the shared drive is hidden from default view. 374 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 375 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 376 "name": "A String", # The name of this shared drive. 377 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 378 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 379 "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. 380 "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. 381 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 382 }, 383 "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.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. 384 }, 385 ], 386 "kind": "drive#driveList", # Identifies what kind of resource this is. Value: the fixed string "drive#driveList". 387 "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. 388}</pre> 389</div> 390 391<div class="method"> 392 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 393 <pre>Retrieves the next page of results. 394 395Args: 396 previous_request: The request for the previous page. (required) 397 previous_response: The response from the request for the previous page. (required) 398 399Returns: 400 A request object that you can call 'execute()' on to request the next 401 page. Returns None if there are no more items in the collection. 402 </pre> 403</div> 404 405<div class="method"> 406 <code class="details" id="unhide">unhide(driveId)</code> 407 <pre>Restores a shared drive to the default view. 408 409Args: 410 driveId: string, The ID of the shared drive. (required) 411 412Returns: 413 An object of the form: 414 415 { # Representation of a shared drive. 416 "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. 417 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 418 "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. 419 "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. 420 "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. 421 }, 422 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 423 "capabilities": { # Capabilities the current user has on this shared drive. 424 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 425 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 426 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 427 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 428 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 429 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 430 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 431 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 432 "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. 433 "canDownload": True or False, # Whether the current user can download files in this shared drive. 434 "canEdit": True or False, # Whether the current user can edit files in this shared drive 435 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 436 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 437 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 438 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 439 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 440 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 441 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 442 }, 443 "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. 444 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 445 "hidden": True or False, # Whether the shared drive is hidden from default view. 446 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 447 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 448 "name": "A String", # The name of this shared drive. 449 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 450 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 451 "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. 452 "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. 453 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 454 }, 455 "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.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. 456}</pre> 457</div> 458 459<div class="method"> 460 <code class="details" id="update">update(driveId, body=None, useDomainAdminAccess=None)</code> 461 <pre>Updates the metadate for a shared drive. 462 463Args: 464 driveId: string, The ID of the shared drive. (required) 465 body: object, The request body. 466 The object takes the form of: 467 468{ # Representation of a shared drive. 469 "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. 470 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 471 "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. 472 "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. 473 "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. 474 }, 475 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 476 "capabilities": { # Capabilities the current user has on this shared drive. 477 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 478 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 479 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 480 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 481 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 482 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 483 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 484 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 485 "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. 486 "canDownload": True or False, # Whether the current user can download files in this shared drive. 487 "canEdit": True or False, # Whether the current user can edit files in this shared drive 488 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 489 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 490 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 491 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 492 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 493 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 494 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 495 }, 496 "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. 497 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 498 "hidden": True or False, # Whether the shared drive is hidden from default view. 499 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 500 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 501 "name": "A String", # The name of this shared drive. 502 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 503 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 504 "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. 505 "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. 506 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 507 }, 508 "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.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. 509} 510 511 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. 512 513Returns: 514 An object of the form: 515 516 { # Representation of a shared drive. 517 "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. 518 "id": "A String", # The ID of an image file in Google Drive to use for the background image. 519 "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. 520 "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. 521 "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. 522 }, 523 "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. 524 "capabilities": { # Capabilities the current user has on this shared drive. 525 "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. 526 "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. 527 "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. 528 "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. 529 "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. 530 "canComment": True or False, # Whether the current user can comment on files in this shared drive. 531 "canCopy": True or False, # Whether the current user can copy files in this shared drive. 532 "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. 533 "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. 534 "canDownload": True or False, # Whether the current user can download files in this shared drive. 535 "canEdit": True or False, # Whether the current user can edit files in this shared drive 536 "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. 537 "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. 538 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. 539 "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. 540 "canRenameDrive": True or False, # Whether the current user can rename this shared drive. 541 "canShare": True or False, # Whether the current user can share files or folders in this shared drive. 542 "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. 543 }, 544 "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. 545 "createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time). 546 "hidden": True or False, # Whether the shared drive is hidden from default view. 547 "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. 548 "kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive". 549 "name": "A String", # The name of this shared drive. 550 "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. 551 "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. 552 "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. 553 "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. 554 "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. 555 }, 556 "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.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. 557}</pre> 558</div> 559 560</body></html>