1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
|
<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_v2.html">Drive API</a> . <a href="drive_v2.changes.html">changes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(changeId)</a></code></p>
<p class="firstline">Gets a specific change.</p>
<p class="toc_element">
<code><a href="#list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</a></code></p>
<p class="firstline">Lists the changes for a user.</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="#watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</a></code></p>
<p class="firstline">Subscribe to changes for a user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(changeId)</code>
<pre>Gets a specific change.
Args:
changeId: string, The ID of the change. (required)
Returns:
An object of the form:
{ # Representation of a change to a file.
"kind": "drive#change", # This is always drive#change.
"deleted": True or False, # Whether the file has been deleted.
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
{ # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"etag": "A String", # ETag of the file.
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
{ # A reference to a file's parent.
"selfLink": "A String", # A link back to this reference.
"kind": "drive#parentReference", # This is always drive#parentReference.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Whether or not the parent is the root folder.
"parentLink": "A String", # A link to the parent.
},
],
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"permissions": [ # The list of permissions for users with access to this file.
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"description": "A String", # A short description of the file.
"webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"editable": True or False, # Whether the file can be edited by the current user.
"kind": "drive#file", # The type of file. This is always drive#file.
"canComment": True or False, # Whether the current user can comment on the file.
"quotaBytesUsed": "A String", # The number of quota bytes used by this file.
"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application.
# The following limits apply to file properties:
# - Maximum of 100 properties total per file
# - Maximum of 30 private properties per app
# - Maximum of 30 public properties
# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
"visibility": "A String", # The visibility of this property.
"key": "A String", # The key of this property.
"selfLink": "A String", # The link back to this property.
},
],
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"iconLink": "A String", # A link to the file's icon.
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
"title": "A String", # The title of this file.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"downloadUrl": "A String",
"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
"withLink": True or False, # Whether the link is required for this permission.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
},
"modificationDate": "A String", # The time of this modification.
"id": "A String", # The ID of the change.
"selfLink": "A String", # A link back to this change.
"fileId": "A String", # The ID of the file associated with this change.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</code>
<pre>Lists the changes for a user.
Args:
includeSubscribed: boolean, Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.
includeDeleted: boolean, Whether to include deleted items.
pageToken: string, Page token for changes.
maxResults: integer, Maximum number of changes to return.
startChangeId: string, Change ID to start listing changes from.
spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
Returns:
An object of the form:
{ # A list of changes for a user.
"nextPageToken": "A String", # The page token for the next page of changes.
"kind": "drive#changeList", # This is always drive#changeList.
"items": [ # The actual list of changes.
{ # Representation of a change to a file.
"kind": "drive#change", # This is always drive#change.
"deleted": True or False, # Whether the file has been deleted.
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file.
"hidden": True or False, # Deprecated.
"viewed": True or False, # Whether this file has been viewed by this user.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
{ # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"etag": "A String", # ETag of the file.
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
{ # A reference to a file's parent.
"selfLink": "A String", # A link back to this reference.
"kind": "drive#parentReference", # This is always drive#parentReference.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Whether or not the parent is the root folder.
"parentLink": "A String", # A link to the parent.
},
],
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"permissions": [ # The list of permissions for users with access to this file.
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"description": "A String", # A short description of the file.
"webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"editable": True or False, # Whether the file can be edited by the current user.
"kind": "drive#file", # The type of file. This is always drive#file.
"canComment": True or False, # Whether the current user can comment on the file.
"quotaBytesUsed": "A String", # The number of quota bytes used by this file.
"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application.
# The following limits apply to file properties:
# - Maximum of 100 properties total per file
# - Maximum of 30 private properties per app
# - Maximum of 30 public properties
# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
"kind": "drive#property", # This is always drive#property.
"value": "A String", # The value of this property.
"etag": "A String", # ETag of the property.
"visibility": "A String", # The visibility of this property.
"key": "A String", # The key of this property.
"selfLink": "A String", # The link back to this property.
},
],
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"iconLink": "A String", # A link to the file's icon.
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
"title": "A String", # The title of this file.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
},
"downloadUrl": "A String",
"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
"withLink": True or False, # Whether the link is required for this permission.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
},
"modificationDate": "A String", # The time of this modification.
"id": "A String", # The ID of the change.
"selfLink": "A String", # A link back to this change.
"fileId": "A String", # The ID of the file associated with this change.
},
],
"nextLink": "A String", # A link to the next page of changes.
"etag": "A String", # The ETag of the list.
"largestChangeId": "A String", # The current largest change ID.
"selfLink": "A String", # A link back to this list.
}</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="watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None, spaces=None)</code>
<pre>Subscribe to changes for a user.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
includeSubscribed: boolean, Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.
includeDeleted: boolean, Whether to include deleted items.
pageToken: string, Page token for changes.
maxResults: integer, Maximum number of changes to return.
startChangeId: string, Change ID to start listing changes from.
spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
Returns:
An object of the form:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}</pre>
</div>
</body></html>
|