-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
drivelabels.v2.json
2912 lines (2912 loc) 路 127 KB
/
drivelabels.v2.json
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
{
"basePath": "",
"baseUrl": "https://drivelabels.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Drive Labels",
"description": "An API for managing Drive Labels",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/drive/labels",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "drivelabels:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://drivelabels.mtls.googleapis.com/",
"name": "drivelabels",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"labels": {
"methods": {
"create": {
"description": "Creates a new Label.",
"flatPath": "v2/labels",
"httpMethod": "POST",
"id": "drivelabels.labels.create",
"parameterOrder": [],
"parameters": {
"languageCode": {
"description": "The BCP-47 language code to use for evaluating localized Field labels in response. When not specified, values in the default configured language will be used.",
"location": "query",
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin privileges. The server will verify the user is an admin before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/labels",
"request": {
"$ref": "GoogleAppsDriveLabelsV2Label"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2Label"
}
},
"delete": {
"description": "Permanently deletes a Label and related metadata on Drive Items. Once deleted, the Label and related Drive item metadata will be deleted. Only draft Labels, and disabled Labels may be deleted.",
"flatPath": "v2/labels/{labelsId}",
"httpMethod": "DELETE",
"id": "drivelabels.labels.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Label resource name.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
},
"writeControl.requiredRevisionId": {
"description": "The revision_id of the label that the write request will be applied to. If this is not the latest revision of the label, the request will not be processed and will return a 400 Bad Request error.",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
}
},
"delta": {
"description": "Updates a single Label by applying a set of update requests resulting in a new draft revision. The batch update is all-or-nothing: If any of the update requests are invalid, no changes are applied. The resulting draft revision must be published before the changes may be used with Drive Items.",
"flatPath": "v2/labels/{labelsId}:delta",
"httpMethod": "POST",
"id": "drivelabels.labels.delta",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Label to update.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:delta",
"request": {
"$ref": "GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse"
}
},
"disable": {
"description": "Disable a published Label. Disabling a Label will result in a new disabled published revision based on the current published revision. If there is a draft revision, a new disabled draft revision will be created based on the latest draft revision. Older draft revisions will be deleted. Once disabled, a label may be deleted with `DeleteLabel`.",
"flatPath": "v2/labels/{labelsId}:disable",
"httpMethod": "POST",
"id": "drivelabels.labels.disable",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Label resource name.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:disable",
"request": {
"$ref": "GoogleAppsDriveLabelsV2DisableLabelRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2Label"
}
},
"enable": {
"description": "Enable a disabled Label and restore it to its published state. This will result in a new published revision based on the current disabled published revision. If there is an existing disabled draft revision, a new revision will be created based on that draft and will be enabled.",
"flatPath": "v2/labels/{labelsId}:enable",
"httpMethod": "POST",
"id": "drivelabels.labels.enable",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Label resource name.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:enable",
"request": {
"$ref": "GoogleAppsDriveLabelsV2EnableLabelRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2Label"
}
},
"get": {
"description": "Get a label by its resource name. Resource name may be any of: * `labels/{id}` - See `labels/{id}@latest` * `labels/{id}@latest` - Gets the latest revision of the label. * `labels/{id}@published` - Gets the current published revision of the label. * `labels/{id}@{revision_id}` - Gets the label at the specified revision ID.",
"flatPath": "v2/labels/{labelsId}",
"httpMethod": "GET",
"id": "drivelabels.labels.get",
"parameterOrder": [
"name"
],
"parameters": {
"languageCode": {
"description": "The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Label resource name. May be any of: * `labels/{id}` (equivalent to labels/{id}@latest) * `labels/{id}@latest` * `labels/{id}@published` * `labels/{id}@{revision_id}`",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server verifies that the user is an admin for the label before allowing access.",
"location": "query",
"type": "boolean"
},
"view": {
"description": "When specified, only certain fields belonging to the indicated view are returned.",
"enum": [
"LABEL_VIEW_BASIC",
"LABEL_VIEW_FULL"
],
"enumDescriptions": [
"Implies the field mask: `name,id,revision_id,label_type,properties.*`",
"All possible fields."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleAppsDriveLabelsV2Label"
}
},
"list": {
"description": "List labels.",
"flatPath": "v2/labels",
"httpMethod": "GET",
"id": "drivelabels.labels.list",
"parameterOrder": [],
"parameters": {
"customer": {
"description": "The customer to scope this list request to. For example: \"customers/abcd1234\". If unset, will return all labels within the current customer.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.",
"location": "query",
"type": "string"
},
"minimumRole": {
"description": "Specifies the level of access the user must have on the returned Labels. The minimum role a user must have on a label. Defaults to `READER`.",
"enum": [
"LABEL_ROLE_UNSPECIFIED",
"READER",
"APPLIER",
"ORGANIZER",
"EDITOR"
],
"enumDescriptions": [
"Unknown role.",
"A reader can read the label and associated metadata applied to Drive items.",
"An applier can write associated metadata on Drive items in which they also have write access to. Implies `READER`.",
"An organizer can pin this label in shared drives they manage and add new appliers to the label.",
"Editors can make any update including deleting the label which also deletes the associated Drive item metadata. Implies `APPLIER`."
],
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of labels to return per page. Default: 50. Max: 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The token of the page to return.",
"location": "query",
"type": "string"
},
"publishedOnly": {
"description": "Whether to include only published labels in the results. * When `true`, only the current published label revisions are returned. Disabled labels are included. Returned label resource names reference the published revision (`labels/{id}/{revision_id}`). * When `false`, the current label revisions are returned, which might not be published. Returned label resource names don't reference a specific revision (`labels/{id}`).",
"location": "query",
"type": "boolean"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. This will return all Labels within the customer.",
"location": "query",
"type": "boolean"
},
"view": {
"description": "When specified, only certain fields belonging to the indicated view are returned.",
"enum": [
"LABEL_VIEW_BASIC",
"LABEL_VIEW_FULL"
],
"enumDescriptions": [
"Implies the field mask: `name,id,revision_id,label_type,properties.*`",
"All possible fields."
],
"location": "query",
"type": "string"
}
},
"path": "v2/labels",
"response": {
"$ref": "GoogleAppsDriveLabelsV2ListLabelsResponse"
}
},
"publish": {
"description": "Publish all draft changes to the Label. Once published, the Label may not return to its draft state. See `google.apps.drive.labels.v2.Lifecycle` for more information. Publishing a Label will result in a new published revision. All previous draft revisions will be deleted. Previous published revisions will be kept but are subject to automated deletion as needed. Once published, some changes are no longer permitted. Generally, any change that would invalidate or cause new restrictions on existing metadata related to the Label will be rejected. For example, the following changes to a Label will be rejected after the Label is published: * The label cannot be directly deleted. It must be disabled first, then deleted. * Field.FieldType cannot be changed. * Changes to Field validation options cannot reject something that was previously accepted. * Reducing the max entries.",
"flatPath": "v2/labels/{labelsId}:publish",
"httpMethod": "POST",
"id": "drivelabels.labels.publish",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Label resource name.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:publish",
"request": {
"$ref": "GoogleAppsDriveLabelsV2PublishLabelRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2Label"
}
},
"updateLabelCopyMode": {
"description": "Updates a Label's `CopyMode`. Changes to this policy are not revisioned, do not require publishing, and take effect immediately.",
"flatPath": "v2/labels/{labelsId}:updateLabelCopyMode",
"httpMethod": "POST",
"id": "drivelabels.labels.updateLabelCopyMode",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Label to update.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:updateLabelCopyMode",
"request": {
"$ref": "GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2Label"
}
},
"updatePermissions": {
"description": "Updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/permissions",
"httpMethod": "PATCH",
"id": "drivelabels.labels.updatePermissions",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/permissions",
"request": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
}
}
},
"resources": {
"locks": {
"methods": {
"list": {
"description": "Lists the LabelLocks on a Label.",
"flatPath": "v2/labels/{labelsId}/locks",
"httpMethod": "GET",
"id": "drivelabels.labels.locks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of Locks to return per page. Default: 100. Max: 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The token of the page to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Label on which Locks are applied. Format: labels/{label}",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/locks",
"response": {
"$ref": "GoogleAppsDriveLabelsV2ListLabelLocksResponse"
}
}
}
},
"permissions": {
"methods": {
"batchDelete": {
"description": "Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/permissions:batchDelete",
"httpMethod": "POST",
"id": "drivelabels.labels.permissions.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name shared by all permissions being deleted. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/permissions:batchDelete",
"request": {
"$ref": "GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
}
},
"batchUpdate": {
"description": "Updates Label permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/permissions:batchUpdate",
"httpMethod": "POST",
"id": "drivelabels.labels.permissions.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name shared by all permissions being updated. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/permissions:batchUpdate",
"request": {
"$ref": "GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse"
}
},
"create": {
"description": "Updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/permissions",
"httpMethod": "POST",
"id": "drivelabels.labels.permissions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name on the Label Permission is created. Format: labels/{label}",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/permissions",
"request": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
}
},
"delete": {
"description": "Deletes a Label's permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/permissions/{permissionsId}",
"httpMethod": "DELETE",
"id": "drivelabels.labels.permissions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Label Permission resource name.",
"location": "path",
"pattern": "^labels/[^/]+/permissions/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
}
},
"list": {
"description": "Lists a Label's permissions.",
"flatPath": "v2/labels/{labelsId}/permissions",
"httpMethod": "GET",
"id": "drivelabels.labels.permissions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of permissions to return per page. Default: 50. Max: 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The token of the page to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent Label resource name on which Label Permission are listed. Format: labels/{label}",
"location": "path",
"pattern": "^labels/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/permissions",
"response": {
"$ref": "GoogleAppsDriveLabelsV2ListLabelPermissionsResponse"
}
}
}
},
"revisions": {
"methods": {
"updatePermissions": {
"description": "Updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/permissions",
"httpMethod": "PATCH",
"id": "drivelabels.labels.revisions.updatePermissions",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name.",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/permissions",
"request": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
}
}
},
"resources": {
"locks": {
"methods": {
"list": {
"description": "Lists the LabelLocks on a Label.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/locks",
"httpMethod": "GET",
"id": "drivelabels.labels.revisions.locks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of Locks to return per page. Default: 100. Max: 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The token of the page to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Label on which Locks are applied. Format: labels/{label}",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/locks",
"response": {
"$ref": "GoogleAppsDriveLabelsV2ListLabelLocksResponse"
}
}
}
},
"permissions": {
"methods": {
"batchDelete": {
"description": "Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/permissions:batchDelete",
"httpMethod": "POST",
"id": "drivelabels.labels.revisions.permissions.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name shared by all permissions being deleted. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/permissions:batchDelete",
"request": {
"$ref": "GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
}
},
"batchUpdate": {
"description": "Updates Label permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/permissions:batchUpdate",
"httpMethod": "POST",
"id": "drivelabels.labels.revisions.permissions.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name shared by all permissions being updated. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/permissions:batchUpdate",
"request": {
"$ref": "GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse"
}
},
"create": {
"description": "Updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/permissions",
"httpMethod": "POST",
"id": "drivelabels.labels.revisions.permissions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent Label resource name on the Label Permission is created. Format: labels/{label}",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/permissions",
"request": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
},
"response": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
}
},
"delete": {
"description": "Deletes a Label's permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/permissions/{permissionsId}",
"httpMethod": "DELETE",
"id": "drivelabels.labels.revisions.permissions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Label Permission resource name.",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+/permissions/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
}
},
"list": {
"description": "Lists a Label's permissions.",
"flatPath": "v2/labels/{labelsId}/revisions/{revisionsId}/permissions",
"httpMethod": "GET",
"id": "drivelabels.labels.revisions.permissions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of permissions to return per page. Default: 50. Max: 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The token of the page to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent Label resource name on which Label Permission are listed. Format: labels/{label}",
"location": "path",
"pattern": "^labels/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/permissions",
"response": {
"$ref": "GoogleAppsDriveLabelsV2ListLabelPermissionsResponse"
}
}
}
}
}
}
}
},
"limits": {
"methods": {
"getLabel": {
"description": "Get the constraints on the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.",
"flatPath": "v2/limits/label",
"httpMethod": "GET",
"id": "drivelabels.limits.getLabel",
"parameterOrder": [],
"parameters": {
"name": {
"description": "Required. Label revision resource name Must be: \"limits/label\"",
"location": "query",
"type": "string"
}
},
"path": "v2/limits/label",
"response": {
"$ref": "GoogleAppsDriveLabelsV2LabelLimits"
}
}
}
},
"users": {
"methods": {
"getCapabilities": {
"description": "Gets the user capabilities.",
"flatPath": "v2/users/{usersId}/capabilities",
"httpMethod": "GET",
"id": "drivelabels.users.getCapabilities",
"parameterOrder": [
"name"
],
"parameters": {
"customer": {
"description": "The customer to scope this request to. For example: \"customers/abcd1234\". If unset, will return settings within the current customer.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the user. Only \"users/me/capabilities\" is supported.",
"location": "path",
"pattern": "^users/[^/]+/capabilities$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleAppsDriveLabelsV2UserCapabilities"
}
}
}
}
},
"revision": "20230327",
"rootUrl": "https://drivelabels.googleapis.com/",
"schemas": {
"GoogleAppsDriveLabelsV2BadgeColors": {
"description": "The color derived from BadgeConfig and changed to the closest recommended supported color.",
"id": "GoogleAppsDriveLabelsV2BadgeColors",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Output only. Badge background that pairs with the foreground.",
"readOnly": true
},
"foregroundColor": {
"$ref": "GoogleTypeColor",
"description": "Output only. Badge foreground that pairs with the background.",
"readOnly": true
},
"soloColor": {
"$ref": "GoogleTypeColor",
"description": "Output only. Color that can be used for text without a background.",
"readOnly": true
}
},
"type": "object"
},
"GoogleAppsDriveLabelsV2BadgeConfig": {
"description": "Badge status of the label.",
"id": "GoogleAppsDriveLabelsV2BadgeConfig",
"properties": {
"color": {
"$ref": "GoogleTypeColor",
"description": "The color of the badge. When not specified, no badge is rendered. The background, foreground, and solo (light and dark mode) colors set here are changed in the Drive UI into the closest recommended supported color."
},
"priorityOverride": {
"description": "Override the default global priority of this badge. When set to 0, the default priority heuristic is used.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest": {
"description": "Deletes one of more Label Permissions.",
"id": "GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest",
"properties": {
"requests": {
"description": "Required. The request message specifying the resources to update.",
"items": {
"$ref": "GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest"
},
"type": "array"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. If this is set, the use_admin_access field in the DeleteLabelPermissionRequest messages must either be empty or match this field.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest": {
"description": "Updates one or more Label Permissions.",
"id": "GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest",
"properties": {
"requests": {
"description": "Required. The request message specifying the resources to update.",
"items": {
"$ref": "GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest"
},
"type": "array"
},
"useAdminAccess": {
"description": "Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access. If this is set, the use_admin_access field in the UpdateLabelPermissionRequest messages must either be empty or match this field.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse": {
"description": "Response for updating one or more Label Permissions.",
"id": "GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse",
"properties": {
"permissions": {
"description": "Required. Permissions updated.",
"items": {
"$ref": "GoogleAppsDriveLabelsV2LabelPermission"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsDriveLabelsV2DateLimits": {
"description": "Limits for date Field type.",
"id": "GoogleAppsDriveLabelsV2DateLimits",
"properties": {
"maxValue": {
"$ref": "GoogleTypeDate",
"description": "Maximum value for the date Field type."
},
"minValue": {