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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
|
<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">Google Drive API</a> . <a href="drive_v2.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="#get">get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes.</p>
<p class="toc_element">
<code><a href="#getStartPageToken">getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=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(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=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()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#watch">watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)</code>
<pre>Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes.
Args:
changeId: string, The ID of the change. (required)
driveId: string, The shared drive from which the change will be 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a change to a file or shared drive.
"changeType": "A String", # The type of the change. Possible values are `file` and `drive`.
"deleted": 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.
"drive": { # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for 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", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. 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, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. This is always `drive#drive`
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.insert` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
},
"driveId": "A String", # The ID of the shared drive associated with this change.
"file": { # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID 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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. 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, # Output only. 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, # Output only. 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, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. 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.
"canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. 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`.
"canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. 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, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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, # Output only. Deprecated: Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. 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.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. 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, # Output only. Whether the current user can restore this file from trash.
},
"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.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"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. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. 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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. 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.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. 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 Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
"fullFileExtension": "A String", # Output only. 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 Google Drive; it is not populated for Docs Editors or shortcut files.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. 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.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `drive#file`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of a label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "drive#labelField", # This is always `drive#labelField`.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"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.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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.
"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.
"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.
"openWithLinks": { # Output only. 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",
},
"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 Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"owners": [ # Output only. 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", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
{ # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"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 is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"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 is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"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 Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` requests.
"targetMimeType": "A String", # Output only. 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.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), consider using a proxy server. 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", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"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 is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"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 is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"webContentLink": "A String", # Output only. 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.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
},
"fileId": "A String", # The ID of the file associated with this change.
"id": "A String", # The ID of the change.
"kind": "drive#change", # This is always `drive#change`.
"modificationDate": "A String", # The time of this modification.
"selfLink": "A String", # A link back to this change.
"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.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` 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.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"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`.
"createdDate": "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", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"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.insert` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
},
"teamDriveId": "A String", # Deprecated: Use `driveId` instead.
"type": "A String", # Deprecated: Use `changeType` instead.
}</pre>
</div>
<div class="method">
<code class="details" id="getStartPageToken">getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=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 will be 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)</code>
<pre>Lists the changes for a user or shared drive.
Args:
driveId: string, The shared drive from which changes will be 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.
includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead.
maxResults: integer, Maximum number of changes to return.
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.
spaces: string, A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.
startChangeId: string, Deprecated: Use `pageToken` instead.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of changes for a user.
"etag": "A String", # The ETag of the list.
"items": [ # The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # Representation of a change to a file or shared drive.
"changeType": "A String", # The type of the change. Possible values are `file` and `drive`.
"deleted": 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.
"drive": { # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for 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", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. 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, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. This is always `drive#drive`
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.insert` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
},
"driveId": "A String", # The ID of the shared drive associated with this change.
"file": { # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID 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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. 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, # Output only. 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, # Output only. 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, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. 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.
"canDisableInheritedPermissions": True or False, # Output only. Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. 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`.
"canEnableInheritedPermissions": True or False, # Output only. Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. 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, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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, # Output only. Deprecated: Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. 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.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. 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, # Output only. Whether the current user can restore this file from trash.
},
"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.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"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. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. 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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. 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.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. 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 Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
"fullFileExtension": "A String", # Output only. 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 Google Drive; it is not populated for Docs Editors or shortcut files.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. 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.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `drive#file`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of a label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "drive#labelField", # This is always `drive#labelField`.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"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.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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.
"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.
"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.
"openWithLinks": { # Output only. 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",
},
"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 Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"owners": [ # Output only. 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", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
{ # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"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 is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"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 is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"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 Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` requests.
"targetMimeType": "A String", # Output only. 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.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), consider using a proxy server. 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", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"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 is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"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 is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"webContentLink": "A String", # Output only. 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.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
},
"fileId": "A String", # The ID of the file associated with this change.
"id": "A String", # The ID of the change.
"kind": "drive#change", # This is always `drive#change`.
"modificationDate": "A String", # The time of this modification.
"selfLink": "A String", # A link back to this change.
"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.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` 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.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"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`.
"createdDate": "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", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"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.insert` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
},
"teamDriveId": "A String", # Deprecated: Use `driveId` instead.
"type": "A String", # Deprecated: Use `changeType` instead.
},
],
"kind": "drive#changeList", # This is always `drive#changeList`.
"largestChangeId": "A String", # The current largest change ID.
"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.
"nextLink": "A String", # A link to the next page of changes.
"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.
"selfLink": "A String", # A link back to this list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)</code>
<pre>Subscribe to changes for a user.
Args:
body: object, The request body.
The object takes the form of:
{ # A 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",
},
"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".
}
driveId: string, The shared drive from which changes will be 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.
includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead.
maxResults: integer, Maximum number of changes to return.
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.
spaces: string, A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.
startChangeId: string, Deprecated: Use `pageToken` instead.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A 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",
},
"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".
}</pre>
</div>
</body></html>
|
