/
docs-api.json
4342 lines (4342 loc) · 195 KB
/
docs-api.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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/documents": {
"description": "See, edit, create, and delete all your Google Docs documents"
},
"https://www.googleapis.com/auth/documents.readonly": {
"description": "See all your Google Docs documents"
},
"https://www.googleapis.com/auth/drive": {
"description": "See, edit, create, and delete all of your Google Drive files"
},
"https://www.googleapis.com/auth/drive.file": {
"description": "See, edit, create, and delete only the specific Google Drive files you use with this app"
},
"https://www.googleapis.com/auth/drive.readonly": {
"description": "See and download all your Google Drive files"
}
}
}
},
"basePath": "",
"baseUrl": "https://docs.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Docs",
"description": "Reads and writes Google Docs documents.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/docs/",
"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": "docs:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://docs.mtls.googleapis.com/",
"name": "docs",
"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": {
"documents": {
"methods": {
"batchUpdate": {
"description": "Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.",
"flatPath": "v1/documents/{documentId}:batchUpdate",
"httpMethod": "POST",
"id": "docs.documents.batchUpdate",
"parameterOrder": [
"documentId"
],
"parameters": {
"documentId": {
"description": "The ID of the document to update.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/documents/{documentId}:batchUpdate",
"request": {
"$ref": "BatchUpdateDocumentRequest"
},
"response": {
"$ref": "BatchUpdateDocumentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/documents",
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file"
]
},
"create": {
"description": "Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.",
"flatPath": "v1/documents",
"httpMethod": "POST",
"id": "docs.documents.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/documents",
"request": {
"$ref": "Document"
},
"response": {
"$ref": "Document"
},
"scopes": [
"https://www.googleapis.com/auth/documents",
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file"
]
},
"get": {
"description": "Gets the latest version of the specified document.",
"flatPath": "v1/documents/{documentId}",
"httpMethod": "GET",
"id": "docs.documents.get",
"parameterOrder": [
"documentId"
],
"parameters": {
"documentId": {
"description": "The ID of the document to retrieve.",
"location": "path",
"required": true,
"type": "string"
},
"suggestionsViewMode": {
"description": "The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.",
"enum": [
"DEFAULT_FOR_CURRENT_ACCESS",
"SUGGESTIONS_INLINE",
"PREVIEW_SUGGESTIONS_ACCEPTED",
"PREVIEW_WITHOUT_SUGGESTIONS"
],
"enumDescriptions": [
"The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.",
"The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.",
"The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.",
"The returned document is a preview with all suggested changes rejected if there are any suggestions in the document."
],
"location": "query",
"type": "string"
}
},
"path": "v1/documents/{documentId}",
"response": {
"$ref": "Document"
},
"scopes": [
"https://www.googleapis.com/auth/documents",
"https://www.googleapis.com/auth/documents.readonly",
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/drive.readonly"
]
}
}
}
},
"revision": "20220609",
"rootUrl": "https://docs.googleapis.com/",
"schemas": {
"AutoText": {
"description": "A ParagraphElement representing a spot in the text that is dynamically replaced with content that can change over time, like a page number.",
"id": "AutoText",
"properties": {
"suggestedDeletionIds": {
"description": "The suggested deletion IDs. If empty, then there are no suggested deletions of this content.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestedInsertionIds": {
"description": "The suggested insertion IDs. An AutoText may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestedTextStyleChanges": {
"additionalProperties": {
"$ref": "SuggestedTextStyle"
},
"description": "The suggested text style changes to this AutoText, keyed by suggestion ID.",
"type": "object"
},
"textStyle": {
"$ref": "TextStyle",
"description": "The text style of this AutoText."
},
"type": {
"description": "The type of this auto text.",
"enum": [
"TYPE_UNSPECIFIED",
"PAGE_NUMBER",
"PAGE_COUNT"
],
"enumDescriptions": [
"An unspecified auto text type.",
"Type for auto text that represents the current page number.",
"Type for auto text that represents the total number of pages in the document."
],
"type": "string"
}
},
"type": "object"
},
"Background": {
"description": "Represents the background of a document.",
"id": "Background",
"properties": {
"color": {
"$ref": "OptionalColor",
"description": "The background color."
}
},
"type": "object"
},
"BackgroundSuggestionState": {
"description": "A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value.",
"id": "BackgroundSuggestionState",
"properties": {
"backgroundColorSuggested": {
"description": "Indicates whether the current background color has been modified in this suggestion.",
"type": "boolean"
}
},
"type": "object"
},
"BatchUpdateDocumentRequest": {
"description": "Request message for BatchUpdateDocument.",
"id": "BatchUpdateDocumentRequest",
"properties": {
"requests": {
"description": "A list of updates to apply to the document.",
"items": {
"$ref": "Request"
},
"type": "array"
},
"writeControl": {
"$ref": "WriteControl",
"description": "Provides control over how write requests are executed."
}
},
"type": "object"
},
"BatchUpdateDocumentResponse": {
"description": "Response message from a BatchUpdateDocument request.",
"id": "BatchUpdateDocumentResponse",
"properties": {
"documentId": {
"description": "The ID of the document to which the updates were applied to.",
"type": "string"
},
"replies": {
"description": "The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.",
"items": {
"$ref": "Response"
},
"type": "array"
},
"writeControl": {
"$ref": "WriteControl",
"description": "The updated write control after applying the request."
}
},
"type": "object"
},
"Body": {
"description": "The document body. The body typically contains the full document contents except for headers, footers and footnotes.",
"id": "Body",
"properties": {
"content": {
"description": "The contents of the body. The indexes for the body's content begin at zero.",
"items": {
"$ref": "StructuralElement"
},
"type": "array"
}
},
"type": "object"
},
"Bullet": {
"description": "Describes the bullet of a paragraph.",
"id": "Bullet",
"properties": {
"listId": {
"description": "The ID of the list this paragraph belongs to.",
"type": "string"
},
"nestingLevel": {
"description": "The nesting level of this paragraph in the list.",
"format": "int32",
"type": "integer"
},
"textStyle": {
"$ref": "TextStyle",
"description": "The paragraph specific text style applied to this bullet."
}
},
"type": "object"
},
"BulletSuggestionState": {
"description": "A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there is a new suggested value.",
"id": "BulletSuggestionState",
"properties": {
"listIdSuggested": {
"description": "Indicates if there was a suggested change to the list_id.",
"type": "boolean"
},
"nestingLevelSuggested": {
"description": "Indicates if there was a suggested change to the nesting_level.",
"type": "boolean"
},
"textStyleSuggestionState": {
"$ref": "TextStyleSuggestionState",
"description": "A mask that indicates which of the fields in text style have been changed in this suggestion."
}
},
"type": "object"
},
"Color": {
"description": "A solid color.",
"id": "Color",
"properties": {
"rgbColor": {
"$ref": "RgbColor",
"description": "The RGB color value."
}
},
"type": "object"
},
"ColumnBreak": {
"description": "A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column.",
"id": "ColumnBreak",
"properties": {
"suggestedDeletionIds": {
"description": "The suggested deletion IDs. If empty, then there are no suggested deletions of this content.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestedInsertionIds": {
"description": "The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestedTextStyleChanges": {
"additionalProperties": {
"$ref": "SuggestedTextStyle"
},
"description": "The suggested text style changes to this ColumnBreak, keyed by suggestion ID.",
"type": "object"
},
"textStyle": {
"$ref": "TextStyle",
"description": "The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted adjacent to it."
}
},
"type": "object"
},
"CreateFooterRequest": {
"description": "Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.",
"id": "CreateFooterRequest",
"properties": {
"sectionBreakLocation": {
"$ref": "Location",
"description": "The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style."
},
"type": {
"description": "The type of footer to create.",
"enum": [
"HEADER_FOOTER_TYPE_UNSPECIFIED",
"DEFAULT"
],
"enumDescriptions": [
"The header/footer type is unspecified.",
"A default header/footer."
],
"type": "string"
}
},
"type": "object"
},
"CreateFooterResponse": {
"description": "The result of creating a footer.",
"id": "CreateFooterResponse",
"properties": {
"footerId": {
"description": "The ID of the created footer.",
"type": "string"
}
},
"type": "object"
},
"CreateFootnoteRequest": {
"description": "Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character.",
"id": "CreateFootnoteRequest",
"properties": {
"endOfSegmentLocation": {
"$ref": "EndOfSegmentLocation",
"description": "Inserts the footnote reference at the end of the document body. Footnote references cannot be inserted inside a header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty."
},
"location": {
"$ref": "Location",
"description": "Inserts the footnote reference at a specific index in the document. The footnote reference must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Footnote references cannot be inserted inside an equation, header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty."
}
},
"type": "object"
},
"CreateFootnoteResponse": {
"description": "The result of creating a footnote.",
"id": "CreateFootnoteResponse",
"properties": {
"footnoteId": {
"description": "The ID of the created footnote.",
"type": "string"
}
},
"type": "object"
},
"CreateHeaderRequest": {
"description": "Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.",
"id": "CreateHeaderRequest",
"properties": {
"sectionBreakLocation": {
"$ref": "Location",
"description": "The location of the SectionBreak which begins the section this header should belong to. If `section_break_location' is unset or if it refers to the first section break in the document body, the header applies to the DocumentStyle"
},
"type": {
"description": "The type of header to create.",
"enum": [
"HEADER_FOOTER_TYPE_UNSPECIFIED",
"DEFAULT"
],
"enumDescriptions": [
"The header/footer type is unspecified.",
"A default header/footer."
],
"type": "string"
}
},
"type": "object"
},
"CreateHeaderResponse": {
"description": "The result of creating a header.",
"id": "CreateHeaderResponse",
"properties": {
"headerId": {
"description": "The ID of the created header.",
"type": "string"
}
},
"type": "object"
},
"CreateNamedRangeRequest": {
"description": "Creates a NamedRange referencing the given range.",
"id": "CreateNamedRangeRequest",
"properties": {
"name": {
"description": "The name of the NamedRange. Names do not need to be unique. Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units.",
"type": "string"
},
"range": {
"$ref": "Range",
"description": "The range to apply the name to."
}
},
"type": "object"
},
"CreateNamedRangeResponse": {
"description": "The result of creating a named range.",
"id": "CreateNamedRangeResponse",
"properties": {
"namedRangeId": {
"description": "The ID of the created named range.",
"type": "string"
}
},
"type": "object"
},
"CreateParagraphBulletsRequest": {
"description": "Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.",
"id": "CreateParagraphBulletsRequest",
"properties": {
"bulletPreset": {
"description": "The kinds of bullet glyphs to be used.",
"enum": [
"BULLET_GLYPH_PRESET_UNSPECIFIED",
"BULLET_DISC_CIRCLE_SQUARE",
"BULLET_DIAMONDX_ARROW3D_SQUARE",
"BULLET_CHECKBOX",
"BULLET_ARROW_DIAMOND_DISC",
"BULLET_STAR_CIRCLE_SQUARE",
"BULLET_ARROW3D_CIRCLE_SQUARE",
"BULLET_LEFTTRIANGLE_DIAMOND_DISC",
"BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
"BULLET_DIAMOND_CIRCLE_SQUARE",
"NUMBERED_DECIMAL_ALPHA_ROMAN",
"NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS",
"NUMBERED_DECIMAL_NESTED",
"NUMBERED_UPPERALPHA_ALPHA_ROMAN",
"NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL",
"NUMBERED_ZERODECIMAL_ALPHA_ROMAN"
],
"enumDescriptions": [
"The bullet glyph preset is unspecified.",
"A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
"A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet glyph for the first 3 list nesting levels.",
"A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph for the first 3 list nesting levels.",
"A numbered list with `DECIMAL`, `ALPHA` and `ROMAN` numeric glyphs for the first 3 list nesting levels, followed by periods.",
"A numbered list with `DECIMAL`, `ALPHA` and `ROMAN` numeric glyphs for the first 3 list nesting levels, followed by parenthesis.",
"A numbered list with `DECIMAL` numeric glyphs separated by periods, where each nesting level uses the previous nesting level's glyph as a prefix. For example: '1.', '1.1.', '2.', '2.2.'.",
"A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for the first 3 list nesting levels, followed by periods.",
"A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DECIMAL` numeric glyphs for the first 3 list nesting levels, followed by periods.",
"A numbered list with `ZERODECIMAL`, `ALPHA` and `ROMAN` numeric glyphs for the first 3 list nesting levels, followed by periods."
],
"type": "string"
},
"range": {
"$ref": "Range",
"description": "The range to apply the bullet preset to."
}
},
"type": "object"
},
"CropProperties": {
"description": "The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's four edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped.",
"id": "CropProperties",
"properties": {
"angle": {
"description": "The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.",
"format": "float",
"type": "number"
},
"offsetBottom": {
"description": "The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.",
"format": "float",
"type": "number"
},
"offsetLeft": {
"description": "The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.",
"format": "float",
"type": "number"
},
"offsetRight": {
"description": "The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.",
"format": "float",
"type": "number"
},
"offsetTop": {
"description": "The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"CropPropertiesSuggestionState": {
"description": "A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there is a new suggested value.",
"id": "CropPropertiesSuggestionState",
"properties": {
"angleSuggested": {
"description": "Indicates if there was a suggested change to angle.",
"type": "boolean"
},
"offsetBottomSuggested": {
"description": "Indicates if there was a suggested change to offset_bottom.",
"type": "boolean"
},
"offsetLeftSuggested": {
"description": "Indicates if there was a suggested change to offset_left.",
"type": "boolean"
},
"offsetRightSuggested": {
"description": "Indicates if there was a suggested change to offset_right.",
"type": "boolean"
},
"offsetTopSuggested": {
"description": "Indicates if there was a suggested change to offset_top.",
"type": "boolean"
}
},
"type": "object"
},
"DeleteContentRangeRequest": {
"description": "Deletes content from the document.",
"id": "DeleteContentRangeRequest",
"properties": {
"range": {
"$ref": "Range",
"description": "The range of content to delete. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged. Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned. Some examples of invalid delete requests include: * Deleting one code unit of a surrogate pair. * Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents. * Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element. * Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element. * Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed."
}
},
"type": "object"
},
"DeleteFooterRequest": {
"description": "Deletes a Footer from the document.",
"id": "DeleteFooterRequest",
"properties": {
"footerId": {
"description": "The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.",
"type": "string"
}
},
"type": "object"
},
"DeleteHeaderRequest": {
"description": "Deletes a Header from the document.",
"id": "DeleteHeaderRequest",
"properties": {
"headerId": {
"description": "The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.",
"type": "string"
}
},
"type": "object"
},
"DeleteNamedRangeRequest": {
"description": "Deletes a NamedRange.",
"id": "DeleteNamedRangeRequest",
"properties": {
"name": {
"description": "The name of the range(s) to delete. All named ranges with the given name will be deleted.",
"type": "string"
},
"namedRangeId": {
"description": "The ID of the named range to delete.",
"type": "string"
}
},
"type": "object"
},
"DeleteParagraphBulletsRequest": {
"description": "Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.",
"id": "DeleteParagraphBulletsRequest",
"properties": {
"range": {
"$ref": "Range",
"description": "The range to delete bullets from."
}
},
"type": "object"
},
"DeletePositionedObjectRequest": {
"description": "Deletes a PositionedObject from the document.",
"id": "DeletePositionedObjectRequest",
"properties": {
"objectId": {
"description": "The ID of the positioned object to delete.",
"type": "string"
}
},
"type": "object"
},
"DeleteTableColumnRequest": {
"description": "Deletes a column from a table.",
"id": "DeleteTableColumnRequest",
"properties": {
"tableCellLocation": {
"$ref": "TableCellLocation",
"description": "The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted."
}
},
"type": "object"
},
"DeleteTableRowRequest": {
"description": "Deletes a row from a table.",
"id": "DeleteTableRowRequest",
"properties": {
"tableCellLocation": {
"$ref": "TableCellLocation",
"description": "The reference table cell location from which the row will be deleted. The row this cell spans will be deleted. If this is a merged cell that spans multiple rows, all rows that the cell spans will be deleted. If no rows remain in the table after this deletion, the whole table is deleted."
}
},
"type": "object"
},
"Dimension": {
"description": "A magnitude in a single direction in the specified units.",
"id": "Dimension",
"properties": {
"magnitude": {
"description": "The magnitude.",
"format": "double",
"type": "number"
},
"unit": {
"description": "The units for magnitude.",
"enum": [
"UNIT_UNSPECIFIED",
"PT"
],
"enumDescriptions": [
"The units are unknown.",
"A point, 1/72 of an inch."
],
"type": "string"
}
},
"type": "object"
},
"Document": {
"description": "A Google Docs document.",
"id": "Document",
"properties": {
"body": {
"$ref": "Body",
"description": "Output only. The main body of the document."
},
"documentId": {
"description": "Output only. The ID of the document.",
"type": "string"
},
"documentStyle": {
"$ref": "DocumentStyle",
"description": "Output only. The style of the document."
},
"footers": {
"additionalProperties": {
"$ref": "Footer"
},
"description": "Output only. The footers in the document, keyed by footer ID.",
"type": "object"
},
"footnotes": {
"additionalProperties": {
"$ref": "Footnote"
},
"description": "Output only. The footnotes in the document, keyed by footnote ID.",
"type": "object"
},
"headers": {
"additionalProperties": {
"$ref": "Header"
},
"description": "Output only. The headers in the document, keyed by header ID.",
"type": "object"
},
"inlineObjects": {
"additionalProperties": {
"$ref": "InlineObject"
},
"description": "Output only. The inline objects in the document, keyed by object ID.",
"type": "object"
},
"lists": {
"additionalProperties": {
"$ref": "List"
},
"description": "Output only. The lists in the document, keyed by list ID.",
"type": "object"
},
"namedRanges": {
"additionalProperties": {
"$ref": "NamedRanges"
},
"description": "Output only. The named ranges in the document, keyed by name.",
"type": "object"
},
"namedStyles": {
"$ref": "NamedStyles",
"description": "Output only. The named styles of the document."
},
"positionedObjects": {
"additionalProperties": {
"$ref": "PositionedObject"
},
"description": "Output only. The positioned objects in the document, keyed by object ID.",
"type": "object"
},
"revisionId": {
"description": "Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.",
"type": "string"
},
"suggestedDocumentStyleChanges": {
"additionalProperties": {
"$ref": "SuggestedDocumentStyle"
},
"description": "Output only. The suggested changes to the style of the document, keyed by suggestion ID.",
"type": "object"
},
"suggestedNamedStylesChanges": {
"additionalProperties": {
"$ref": "SuggestedNamedStyles"
},
"description": "Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.",
"type": "object"
},
"suggestionsViewMode": {
"description": "Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.",
"enum": [
"DEFAULT_FOR_CURRENT_ACCESS",
"SUGGESTIONS_INLINE",
"PREVIEW_SUGGESTIONS_ACCEPTED",
"PREVIEW_WITHOUT_SUGGESTIONS"
],
"enumDescriptions": [
"The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.",
"The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.",
"The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.",
"The returned document is a preview with all suggested changes rejected if there are any suggestions in the document."
],
"type": "string"
},
"title": {
"description": "The title of the document.",
"type": "string"
}
},
"type": "object"
},
"DocumentStyle": {
"description": "The style of the document.",
"id": "DocumentStyle",
"properties": {
"background": {
"$ref": "Background",
"description": "The background of the document. Documents cannot have a transparent background color."
},
"defaultFooterId": {
"description": "The ID of the default footer. If not set, there is no default footer. This property is read-only.",
"type": "string"
},
"defaultHeaderId": {
"description": "The ID of the default header. If not set, there is no default header. This property is read-only.",
"type": "string"
},
"evenPageFooterId": {
"description": "The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there is no even page footer. This property is read-only.",
"type": "string"
},
"evenPageHeaderId": {
"description": "The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there is no even page header. This property is read-only.",
"type": "string"
},
"firstPageFooterId": {
"description": "The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there is no first page footer. This property is read-only.",
"type": "string"
},
"firstPageHeaderId": {
"description": "The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there is no first page header. This property is read-only.",
"type": "string"
},
"marginBottom": {
"$ref": "Dimension",
"description": "The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles."
},
"marginFooter": {
"$ref": "Dimension",
"description": "The amount of space between the bottom of the page and the contents of the footer."
},
"marginHeader": {
"$ref": "Dimension",
"description": "The amount of space between the top of the page and the contents of the header."
},
"marginLeft": {
"$ref": "Dimension",
"description": "The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections."
},
"marginRight": {
"$ref": "Dimension",
"description": "The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections."
},
"marginTop": {
"$ref": "Dimension",
"description": "The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles."
},
"pageNumberStart": {
"description": "The page number from which to start counting the number of pages.",
"format": "int32",
"type": "integer"
},
"pageSize": {
"$ref": "Size",
"description": "The size of a page in the document."
},
"useCustomHeaderFooterMargins": {
"description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.",
"type": "boolean"
},
"useEvenPageHeaderFooter": {
"description": "Indicates whether to use the even page header / footer IDs for the even pages.",
"type": "boolean"
},
"useFirstPageHeaderFooter": {
"description": "Indicates whether to use the first page header / footer IDs for the first page.",
"type": "boolean"
}
},
"type": "object"
},
"DocumentStyleSuggestionState": {
"description": "A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there is a new suggested value.",
"id": "DocumentStyleSuggestionState",
"properties": {
"backgroundSuggestionState": {
"$ref": "BackgroundSuggestionState",
"description": "A mask that indicates which of the fields in background have been changed in this suggestion."
},
"defaultFooterIdSuggested": {
"description": "Indicates if there was a suggested change to default_footer_id.",
"type": "boolean"
},
"defaultHeaderIdSuggested": {
"description": "Indicates if there was a suggested change to default_header_id.",
"type": "boolean"
},
"evenPageFooterIdSuggested": {
"description": "Indicates if there was a suggested change to even_page_footer_id.",
"type": "boolean"
},
"evenPageHeaderIdSuggested": {
"description": "Indicates if there was a suggested change to even_page_header_id.",
"type": "boolean"
},
"firstPageFooterIdSuggested": {
"description": "Indicates if there was a suggested change to first_page_footer_id.",
"type": "boolean"
},
"firstPageHeaderIdSuggested": {
"description": "Indicates if there was a suggested change to first_page_header_id.",
"type": "boolean"
},
"marginBottomSuggested": {
"description": "Indicates if there was a suggested change to margin_bottom.",
"type": "boolean"
},
"marginFooterSuggested": {
"description": "Indicates if there was a suggested change to margin_footer.",
"type": "boolean"