/
drive_v2.files.html
6277 lines (6173 loc) 路 579 KB
/
drive_v2.files.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.files.html">files</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="#copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</a></code></p>
<p class="firstline">Creates a copy of the specified file. Folders cannot be copied.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
<p class="firstline">Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.</p>
<p class="toc_element">
<code><a href="#emptyTrash">emptyTrash(driveId=None, enforceSingleParent=None)</a></code></p>
<p class="firstline">Permanently deletes all trashed files of a user or shared drive.</p>
<p class="toc_element">
<code><a href="#export">export(fileId, mimeType)</a></code></p>
<p class="firstline">Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#export_media">export_media(fileId, mimeType)</a></code></p>
<p class="firstline">Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#generateIds">generateIds(maxResults=None, space=None, type=None)</a></code></p>
<p class="firstline">Generates a set of file IDs which can be provided in insert or copy requests.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
<p class="toc_element">
<code><a href="#get_media">get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)</a></code></p>
<p class="firstline">Insert a new file.</p>
<p class="toc_element">
<code><a href="#list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>
<p class="firstline">Lists the user's files.</p>
<p class="toc_element">
<code><a href="#listLabels">listLabels(fileId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">Lists the labels on a file.</p>
<p class="toc_element">
<code><a href="#listLabels_next">listLabels_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="#modifyLabels">modifyLabels(fileId, body=None)</a></code></p>
<p class="firstline">Modifies the set of labels on a file.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</a></code></p>
<p class="firstline">Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#touch">touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
<p class="firstline">Set the file's updated time to the current server time.</p>
<p class="toc_element">
<code><a href="#trash">trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
<p class="firstline">Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.</p>
<p class="toc_element">
<code><a href="#untrash">untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
<p class="firstline">Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</a></code></p>
<p class="firstline">Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#watch">watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Subscribe to changes on a file.</p>
<p class="toc_element">
<code><a href="#watch_media">watch_media(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Subscribe to changes on a file.</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="copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</code>
<pre>Creates a copy of the specified file. Folders cannot be copied.
Args:
fileId: string, The ID of the file to copy. (required)
body: object, The request body.
The object takes the form of:
{ # The metadata for a file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
"canComment": True or False, # Deprecated: use capabilities/canComment.
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # 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, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
"canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canComment": True or False, # Whether the current user can comment on this file.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canDelete": True or False, # Whether the current user can delete this file.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Whether the current user can download this file.
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.
"canModifyLabels": True or False, # Whether the current user can modify the labels on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Whether the current user can read the labels on this file.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it isn't a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Whether the current user can rename this file.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # 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.
"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Deprecated: use capabilities/canEdit.
"embedLink": "A String", # A link for embedding the file.
"etag": "A String", # ETag of the file.
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
"exportLinks": { # Links for exporting Docs Editors files to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"fileExtension": "A String", # The final component of fullFileExtension 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 isn't populated for Docs Editors or shortcut files.
"fileSize": "A String", # The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it is not populated for shortcuts or 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", # 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 isn't populated for Docs Editors or shortcut files.
"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"iconLink": "A String", # A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"cameraMake": "A String", # The make of the camera used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureMode": "A String", # The exposure mode used to create the photo.
"exposureTime": 3.14, # The length of the exposure, in seconds.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"isoSpeed": 42, # The ISO speed used to create the photo.
"lens": "A String", # The lens used to create the photo.
"location": { # Geographic location information stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # The metering mode used to create the photo.
"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"width": 42, # The width of the image in pixels.
},
"indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata.
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"kind": "drive#file", # The type of file. This is always drive#file.
"labelInfo": { # An overview of the labels on the file.
"labels": [ # 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 its fields.
"fields": { # A map of the label's fields keyed by the field ID.
"a_key": { # Representation of a label field.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this 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", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # 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, # Deprecated.
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # 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, # Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Whether the security update is enabled for this file.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't 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": { # 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, # Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
},
],
"parents": [ # Collection of parent folders which contain this file.
# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.
{ # A reference to a file's parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Whether or not the parent is the root folder.
"kind": "drive#parentReference", # This is always drive#parentReference.
"parentLink": "A String", # A link to the parent.
"selfLink": "A String", # A link back to this reference.
},
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
{ # A permission for a 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", # Deprecated.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"etag": "A String", # 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 cannot be set on shared drive items
# - 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
"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.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # 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": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - reader
},
],
"photoLink": "A String", # 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", # A link back to this permission.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
"A String",
],
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
},
],
"type": "A String", # The 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 is the only supported value.
"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.
"etag": "A String", # ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # This is always drive#property.
"selfLink": "A String", # 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 and PUBLIC. (Default: PRIVATE). 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", # The number of quota bytes used by this file.
"resourceKey": "A String", # A key needed to access the item via a shared link.
"selfLink": "A String", # A link back to this file.
"sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"shareable": True or False, # Deprecated: use capabilities/canShare.
"shared": True or False, # 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. # User that shared the item with the current user, if available.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # 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.
"targetId": "A String", # The ID of the file that this shortcut points to.
"targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # The ResourceKey for the target file.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"teamDriveId": "A String", # 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", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"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. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. # 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", # Deprecated.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"etag": "A String", # 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 cannot be set on shared drive items
# - 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
"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.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # 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": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - reader
},
],
"photoLink": "A String", # 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", # A link back to this permission.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
"A String",
],
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
},
],
"type": "A String", # The 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 is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
"width": 42, # The width of the video in pixels.
},
"webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.
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.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
visibility: string, The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
Allowed values
DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
PRIVATE - The new file will be visible to only the owner.
Returns:
An object of the form:
{ # The metadata for a file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Whether this file is in the Application Data folder.
"canComment": True or False, # Deprecated: use capabilities/canComment.
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # 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, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
"canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canComment": True or False, # Whether the current user can comment on this file.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canDelete": True or False, # Whether the current user can delete this file.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Whether the current user can download this file.
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.
"canModifyLabels": True or False, # Whether the current user can modify the labels on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Whether the current user can read the labels on this file.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it isn't a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Whether the current user can rename this file.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # 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.
"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Deprecated: use capabilities/canEdit.
"embedLink": "A String", # A link for embedding the file.
"etag": "A String", # ETag of the file.
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
"exportLinks": { # Links for exporting Docs Editors files to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"fileExtension": "A String", # The final component of fullFileExtension 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 isn't populated for Docs Editors or shortcut files.
"fileSize": "A String", # The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it is not populated for shortcuts or 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", # 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 isn't populated for Docs Editors or shortcut files.
"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"iconLink": "A String", # A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"cameraMake": "A String", # The make of the camera used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureMode": "A String", # The exposure mode used to create the photo.
"exposureTime": 3.14, # The length of the exposure, in seconds.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"isoSpeed": 42, # The ISO speed used to create the photo.
"lens": "A String", # The lens used to create the photo.
"location": { # Geographic location information stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # The metering mode used to create the photo.
"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"width": 42, # The width of the image in pixels.
},
"indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata.
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"kind": "drive#file", # The type of file. This is always drive#file.
"labelInfo": { # An overview of the labels on the file.
"labels": [ # 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 its fields.
"fields": { # A map of the label's fields keyed by the field ID.
"a_key": { # Representation of a label field.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this 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", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # 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, # Deprecated.
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # 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, # Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Whether the security update is enabled for this file.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't 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": { # 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, # Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"owners": [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
},
],
"parents": [ # Collection of parent folders which contain this file.
# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.
{ # A reference to a file's parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Whether or not the parent is the root folder.
"kind": "drive#parentReference", # This is always drive#parentReference.
"parentLink": "A String", # A link to the parent.
"selfLink": "A String", # A link back to this reference.
},
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
{ # A permission for a 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", # Deprecated.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"etag": "A String", # 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 cannot be set on shared drive items
# - 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
"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.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # 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": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - reader
},
],
"photoLink": "A String", # 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", # A link back to this permission.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
"A String",
],
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
},
],
"type": "A String", # The 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 is the only supported value.
"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.
"etag": "A String", # ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # This is always drive#property.
"selfLink": "A String", # 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 and PUBLIC. (Default: PRIVATE). 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", # The number of quota bytes used by this file.
"resourceKey": "A String", # A key needed to access the item via a shared link.
"selfLink": "A String", # A link back to this file.
"sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
"shareable": True or False, # Deprecated: use capabilities/canShare.
"shared": True or False, # 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. # User that shared the item with the current user, if available.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # 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.
"targetId": "A String", # The ID of the file that this shortcut points to.
"targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # The ResourceKey for the target file.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"teamDriveId": "A String", # 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", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"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. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
"emailAddress": "A String", # The email address of the user.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # This is always drive#user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. # 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", # Deprecated.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"etag": "A String", # 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 cannot be set on shared drive items
# - 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
"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.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # 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": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - reader
},
],
"photoLink": "A String", # 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", # A link back to this permission.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
"A String",
],
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.