/
drive_v3.changes.html
565 lines (532 loc) 路 56 KB
/
drive_v3.changes.html
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.changes.html">changes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getStartPageToken">getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>
<p class="firstline">Gets the starting pageToken for listing future changes.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>
<p class="firstline">Lists the changes for a user or shared drive.</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(pageToken, body=None, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>
<p class="firstline">Subscribes to changes for a user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getStartPageToken">getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code>
<pre>Gets the starting pageToken for listing future changes.
Args:
driveId: string, The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
teamDriveId: string, Deprecated use driveId instead.
Returns:
An object of the form:
{
"kind": "drive#startPageToken", # Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
"startPageToken": "A String", # The starting page token for listing changes.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code>
<pre>Lists the changes for a user or shared drive.
Args:
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. (required)
driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
includeRemoved: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
pageSize: integer, The maximum number of changes to return per page.
restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
spaces: string, A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
teamDriveId: string, Deprecated use driveId instead.
Returns:
An object of the form:
{ # A list of changes for a user.
"changes": [ # The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # A change to a file or shared drive.
"changeType": "A String", # The type of the change. Possible values are file and drive.
"drive": { # Representation of a shared drive. # The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this shared drive's background image.
"capabilities": { # Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
"canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
"canComment": True or False, # Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Whether the current user can download files in this shared drive.
"canEdit": True or False, # Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Whether the current user can rename this shared drive.
"canShare": True or False, # Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Identifies what kind of resource this is. Value: the fixed string "drive#drive".
"name": "A String", # The name of this shared drive.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.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.
},
"driveId": "A String", # The ID of the shared drive associated with this change.
"file": { # The metadata for a file. # The updated state of the file. Present if the type is file and the file has not been removed from this list of changes.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canComment": True or False, # Whether the current user can comment on this file.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canDelete": True or False, # Whether the current user can delete this file.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Whether the current user can download this file.
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Whether the current user can rename this file.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"me": True or False, # Whether this user is the requesting user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Links for exporting Docs Editors files to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"cameraMake": "A String", # The make of the camera used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureMode": "A String", # The exposure mode used to create the photo.
"exposureTime": 3.14, # The length of the exposure, in seconds.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"isoSpeed": 42, # The ISO speed used to create the photo.
"lens": "A String", # The lens used to create the photo.
"location": { # Geographic location information stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # The metering mode used to create the photo.
"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # The white balance mode used to create the photo.
"width": 42, # The width of the image in pixels.
},
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"me": True or False, # Whether this user is the requesting user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"me": True or False, # Whether this user is the requesting user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"me": True or False, # Whether this user is the requesting user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
"targetId": "A String", # The ID of the file that this shortcut points to.
"targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
},
"size": "A String", # The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"me": True or False, # Whether this user is the requesting user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"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 user.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
"width": 42, # The width of the video in pixels.
},
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
},
"fileId": "A String", # The ID of the file which has changed.
"kind": "drive#change", # Identifies what kind of resource this is. Value: the fixed string "drive#change".
"removed": True or False, # Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.
"teamDrive": { # Deprecated: use the drive collection instead. # Deprecated - use drive instead.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.
"createdTime": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".
"name": "A String", # The name of this Team Drive.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive.
"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
},
"teamDriveId": "A String", # Deprecated - use driveId instead.
"time": "A String", # The time of this change (RFC 3339 date-time).
"type": "A String", # Deprecated - use changeType instead.
},
],
"kind": "drive#changeList", # Identifies what kind of resource this is. Value: the fixed string "drive#changeList".
"newStartPageToken": "A String", # The starting page token for future changes. This will be present only if the end of the current changes list has been reached.
"nextPageToken": "A String", # The page token for the next page of changes. This will be absent if the end of the changes 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.
}</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(pageToken, body=None, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code>
<pre>Subscribes to changes for a user.
Args:
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. (required)
body: object, The request body.
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}
driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
includeRemoved: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
pageSize: integer, The maximum number of changes to return per page.
restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
spaces: string, A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
teamDriveId: string, Deprecated use driveId instead.
Returns:
An object of the form:
{ # An notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}</pre>
</div>
</body></html>