@googleapis/docs 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/build/index.js +4 -3
- package/build/index.js.map +1 -1
- package/build/v1.d.ts +98 -98
- package/build/v1.js +7 -6
- package/build/v1.js.map +1 -1
- package/package.json +5 -5
- package/v1.ts +98 -98
package/v1.ts
CHANGED
|
@@ -125,7 +125,7 @@ export namespace docs_v1 {
|
|
|
125
125
|
}
|
|
126
126
|
|
|
127
127
|
/**
|
|
128
|
-
* A ParagraphElement representing a spot in the text that
|
|
128
|
+
* A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number.
|
|
129
129
|
*/
|
|
130
130
|
export interface Schema$AutoText {
|
|
131
131
|
/**
|
|
@@ -133,7 +133,7 @@ export namespace docs_v1 {
|
|
|
133
133
|
*/
|
|
134
134
|
suggestedDeletionIds?: string[] | null;
|
|
135
135
|
/**
|
|
136
|
-
* The suggested insertion IDs. An AutoText may have multiple insertion IDs if it
|
|
136
|
+
* The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
137
137
|
*/
|
|
138
138
|
suggestedInsertionIds?: string[] | null;
|
|
139
139
|
/**
|
|
@@ -200,7 +200,7 @@ export namespace docs_v1 {
|
|
|
200
200
|
writeControl?: Schema$WriteControl;
|
|
201
201
|
}
|
|
202
202
|
/**
|
|
203
|
-
* The document body. The body typically contains the full document contents except for headers, footers and footnotes.
|
|
203
|
+
* The document body. The body typically contains the full document contents except for headers, footers, and footnotes.
|
|
204
204
|
*/
|
|
205
205
|
export interface Schema$Body {
|
|
206
206
|
/**
|
|
@@ -221,12 +221,12 @@ export namespace docs_v1 {
|
|
|
221
221
|
*/
|
|
222
222
|
nestingLevel?: number | null;
|
|
223
223
|
/**
|
|
224
|
-
* The paragraph
|
|
224
|
+
* The paragraph-specific text style applied to this bullet.
|
|
225
225
|
*/
|
|
226
226
|
textStyle?: Schema$TextStyle;
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
229
|
-
* 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
|
|
229
|
+
* 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's a new suggested value.
|
|
230
230
|
*/
|
|
231
231
|
export interface Schema$BulletSuggestionState {
|
|
232
232
|
/**
|
|
@@ -260,7 +260,7 @@ export namespace docs_v1 {
|
|
|
260
260
|
*/
|
|
261
261
|
suggestedDeletionIds?: string[] | null;
|
|
262
262
|
/**
|
|
263
|
-
* The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it
|
|
263
|
+
* The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
264
264
|
*/
|
|
265
265
|
suggestedInsertionIds?: string[] | null;
|
|
266
266
|
/**
|
|
@@ -270,7 +270,7 @@ export namespace docs_v1 {
|
|
|
270
270
|
[key: string]: Schema$SuggestedTextStyle;
|
|
271
271
|
} | null;
|
|
272
272
|
/**
|
|
273
|
-
* 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
|
|
273
|
+
* 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 next to it.
|
|
274
274
|
*/
|
|
275
275
|
textStyle?: Schema$TextStyle;
|
|
276
276
|
}
|
|
@@ -376,7 +376,7 @@ export namespace docs_v1 {
|
|
|
376
376
|
range?: Schema$Range;
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
|
-
* The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's
|
|
379
|
+
* The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 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.
|
|
380
380
|
*/
|
|
381
381
|
export interface Schema$CropProperties {
|
|
382
382
|
/**
|
|
@@ -401,7 +401,7 @@ export namespace docs_v1 {
|
|
|
401
401
|
offsetTop?: number | null;
|
|
402
402
|
}
|
|
403
403
|
/**
|
|
404
|
-
* 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
|
|
404
|
+
* 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's a new suggested value.
|
|
405
405
|
*/
|
|
406
406
|
export interface Schema$CropPropertiesSuggestionState {
|
|
407
407
|
/**
|
|
@@ -596,27 +596,27 @@ export namespace docs_v1 {
|
|
|
596
596
|
*/
|
|
597
597
|
background?: Schema$Background;
|
|
598
598
|
/**
|
|
599
|
-
* The ID of the default footer. If not set, there
|
|
599
|
+
* The ID of the default footer. If not set, there's no default footer. This property is read-only.
|
|
600
600
|
*/
|
|
601
601
|
defaultFooterId?: string | null;
|
|
602
602
|
/**
|
|
603
|
-
* The ID of the default header. If not set, there
|
|
603
|
+
* The ID of the default header. If not set, there's no default header. This property is read-only.
|
|
604
604
|
*/
|
|
605
605
|
defaultHeaderId?: string | null;
|
|
606
606
|
/**
|
|
607
|
-
* 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
|
|
607
|
+
* 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's no even page footer. This property is read-only.
|
|
608
608
|
*/
|
|
609
609
|
evenPageFooterId?: string | null;
|
|
610
610
|
/**
|
|
611
|
-
* 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
|
|
611
|
+
* 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's no even page header. This property is read-only.
|
|
612
612
|
*/
|
|
613
613
|
evenPageHeaderId?: string | null;
|
|
614
614
|
/**
|
|
615
|
-
* 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
|
|
615
|
+
* 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's no first page footer. This property is read-only.
|
|
616
616
|
*/
|
|
617
617
|
firstPageFooterId?: string | null;
|
|
618
618
|
/**
|
|
619
|
-
* 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
|
|
619
|
+
* 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's no first page header. This property is read-only.
|
|
620
620
|
*/
|
|
621
621
|
firstPageHeaderId?: string | null;
|
|
622
622
|
/**
|
|
@@ -665,7 +665,7 @@ export namespace docs_v1 {
|
|
|
665
665
|
useFirstPageHeaderFooter?: boolean | null;
|
|
666
666
|
}
|
|
667
667
|
/**
|
|
668
|
-
* 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
|
|
668
|
+
* 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's a new suggested value.
|
|
669
669
|
*/
|
|
670
670
|
export interface Schema$DocumentStyleSuggestionState {
|
|
671
671
|
/**
|
|
@@ -742,11 +742,11 @@ export namespace docs_v1 {
|
|
|
742
742
|
useFirstPageHeaderFooterSuggested?: boolean | null;
|
|
743
743
|
}
|
|
744
744
|
/**
|
|
745
|
-
* The properties of an embedded drawing.
|
|
745
|
+
* The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.
|
|
746
746
|
*/
|
|
747
747
|
export interface Schema$EmbeddedDrawingProperties {}
|
|
748
748
|
/**
|
|
749
|
-
* A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there
|
|
749
|
+
* A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
750
750
|
*/
|
|
751
751
|
export interface Schema$EmbeddedDrawingPropertiesSuggestionState {}
|
|
752
752
|
/**
|
|
@@ -770,7 +770,7 @@ export namespace docs_v1 {
|
|
|
770
770
|
*/
|
|
771
771
|
imageProperties?: Schema$ImageProperties;
|
|
772
772
|
/**
|
|
773
|
-
* A reference to the external linked source content. For example, it contains a reference to the source Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
|
|
773
|
+
* A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
|
|
774
774
|
*/
|
|
775
775
|
linkedContentReference?: Schema$LinkedContentReference;
|
|
776
776
|
/**
|
|
@@ -820,7 +820,7 @@ export namespace docs_v1 {
|
|
|
820
820
|
width?: Schema$Dimension;
|
|
821
821
|
}
|
|
822
822
|
/**
|
|
823
|
-
* A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there
|
|
823
|
+
* A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
824
824
|
*/
|
|
825
825
|
export interface Schema$EmbeddedObjectBorderSuggestionState {
|
|
826
826
|
/**
|
|
@@ -841,7 +841,7 @@ export namespace docs_v1 {
|
|
|
841
841
|
widthSuggested?: boolean | null;
|
|
842
842
|
}
|
|
843
843
|
/**
|
|
844
|
-
* A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there
|
|
844
|
+
* A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
845
845
|
*/
|
|
846
846
|
export interface Schema$EmbeddedObjectSuggestionState {
|
|
847
847
|
/**
|
|
@@ -907,7 +907,7 @@ export namespace docs_v1 {
|
|
|
907
907
|
*/
|
|
908
908
|
suggestedDeletionIds?: string[] | null;
|
|
909
909
|
/**
|
|
910
|
-
* The suggested insertion IDs.
|
|
910
|
+
* The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
911
911
|
*/
|
|
912
912
|
suggestedInsertionIds?: string[] | null;
|
|
913
913
|
}
|
|
@@ -954,7 +954,7 @@ export namespace docs_v1 {
|
|
|
954
954
|
*/
|
|
955
955
|
suggestedDeletionIds?: string[] | null;
|
|
956
956
|
/**
|
|
957
|
-
* The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it
|
|
957
|
+
* The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
958
958
|
*/
|
|
959
959
|
suggestedInsertionIds?: string[] | null;
|
|
960
960
|
/**
|
|
@@ -1000,7 +1000,7 @@ export namespace docs_v1 {
|
|
|
1000
1000
|
[key: string]: Schema$SuggestedTextStyle;
|
|
1001
1001
|
} | null;
|
|
1002
1002
|
/**
|
|
1003
|
-
* The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted
|
|
1003
|
+
* The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
|
|
1004
1004
|
*/
|
|
1005
1005
|
textStyle?: Schema$TextStyle;
|
|
1006
1006
|
}
|
|
@@ -1033,12 +1033,12 @@ export namespace docs_v1 {
|
|
|
1033
1033
|
*/
|
|
1034
1034
|
sourceUri?: string | null;
|
|
1035
1035
|
/**
|
|
1036
|
-
* The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means
|
|
1036
|
+
* The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
|
|
1037
1037
|
*/
|
|
1038
1038
|
transparency?: number | null;
|
|
1039
1039
|
}
|
|
1040
1040
|
/**
|
|
1041
|
-
* A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there
|
|
1041
|
+
* A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1042
1042
|
*/
|
|
1043
1043
|
export interface Schema$ImagePropertiesSuggestionState {
|
|
1044
1044
|
/**
|
|
@@ -1110,7 +1110,7 @@ export namespace docs_v1 {
|
|
|
1110
1110
|
*/
|
|
1111
1111
|
suggestedDeletionIds?: string[] | null;
|
|
1112
1112
|
/**
|
|
1113
|
-
* The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it
|
|
1113
|
+
* The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
1114
1114
|
*/
|
|
1115
1115
|
suggestedInsertionIds?: string[] | null;
|
|
1116
1116
|
/**
|
|
@@ -1120,7 +1120,7 @@ export namespace docs_v1 {
|
|
|
1120
1120
|
[key: string]: Schema$SuggestedTextStyle;
|
|
1121
1121
|
} | null;
|
|
1122
1122
|
/**
|
|
1123
|
-
* The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted
|
|
1123
|
+
* The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
|
|
1124
1124
|
*/
|
|
1125
1125
|
textStyle?: Schema$TextStyle;
|
|
1126
1126
|
}
|
|
@@ -1134,7 +1134,7 @@ export namespace docs_v1 {
|
|
|
1134
1134
|
embeddedObject?: Schema$EmbeddedObject;
|
|
1135
1135
|
}
|
|
1136
1136
|
/**
|
|
1137
|
-
* A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there
|
|
1137
|
+
* A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1138
1138
|
*/
|
|
1139
1139
|
export interface Schema$InlineObjectPropertiesSuggestionState {
|
|
1140
1140
|
/**
|
|
@@ -1302,7 +1302,7 @@ export namespace docs_v1 {
|
|
|
1302
1302
|
sheetsChartReference?: Schema$SheetsChartReference;
|
|
1303
1303
|
}
|
|
1304
1304
|
/**
|
|
1305
|
-
* A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there
|
|
1305
|
+
* A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1306
1306
|
*/
|
|
1307
1307
|
export interface Schema$LinkedContentReferenceSuggestionState {
|
|
1308
1308
|
/**
|
|
@@ -1311,7 +1311,7 @@ export namespace docs_v1 {
|
|
|
1311
1311
|
sheetsChartReferenceSuggestionState?: Schema$SheetsChartReferenceSuggestionState;
|
|
1312
1312
|
}
|
|
1313
1313
|
/**
|
|
1314
|
-
* A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that
|
|
1314
|
+
* A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
|
|
1315
1315
|
*/
|
|
1316
1316
|
export interface Schema$List {
|
|
1317
1317
|
/**
|
|
@@ -1334,16 +1334,16 @@ export namespace docs_v1 {
|
|
|
1334
1334
|
} | null;
|
|
1335
1335
|
}
|
|
1336
1336
|
/**
|
|
1337
|
-
* The properties of a list
|
|
1337
|
+
* The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list.
|
|
1338
1338
|
*/
|
|
1339
1339
|
export interface Schema$ListProperties {
|
|
1340
1340
|
/**
|
|
1341
|
-
* Describes the properties of the bullets at the associated level. A list has at most
|
|
1341
|
+
* Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
|
|
1342
1342
|
*/
|
|
1343
1343
|
nestingLevels?: Schema$NestingLevel[];
|
|
1344
1344
|
}
|
|
1345
1345
|
/**
|
|
1346
|
-
* A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there
|
|
1346
|
+
* A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1347
1347
|
*/
|
|
1348
1348
|
export interface Schema$ListPropertiesSuggestionState {
|
|
1349
1349
|
/**
|
|
@@ -1374,7 +1374,7 @@ export namespace docs_v1 {
|
|
|
1374
1374
|
tableRange?: Schema$TableRange;
|
|
1375
1375
|
}
|
|
1376
1376
|
/**
|
|
1377
|
-
* A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited
|
|
1377
|
+
* A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
|
|
1378
1378
|
*/
|
|
1379
1379
|
export interface Schema$NamedRange {
|
|
1380
1380
|
/**
|
|
@@ -1425,7 +1425,7 @@ export namespace docs_v1 {
|
|
|
1425
1425
|
*/
|
|
1426
1426
|
export interface Schema$NamedStyles {
|
|
1427
1427
|
/**
|
|
1428
|
-
* The named styles. There
|
|
1428
|
+
* The named styles. There's an entry for each of the possible named style types.
|
|
1429
1429
|
*/
|
|
1430
1430
|
styles?: Schema$NamedStyle[];
|
|
1431
1431
|
}
|
|
@@ -1434,7 +1434,7 @@ export namespace docs_v1 {
|
|
|
1434
1434
|
*/
|
|
1435
1435
|
export interface Schema$NamedStylesSuggestionState {
|
|
1436
1436
|
/**
|
|
1437
|
-
* A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states
|
|
1437
|
+
* A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.
|
|
1438
1438
|
*/
|
|
1439
1439
|
stylesSuggestionStates?: Schema$NamedStyleSuggestionState[];
|
|
1440
1440
|
}
|
|
@@ -1464,7 +1464,7 @@ export namespace docs_v1 {
|
|
|
1464
1464
|
*/
|
|
1465
1465
|
bulletAlignment?: string | null;
|
|
1466
1466
|
/**
|
|
1467
|
-
* The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these
|
|
1467
|
+
* The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
|
|
1468
1468
|
*/
|
|
1469
1469
|
glyphFormat?: string | null;
|
|
1470
1470
|
/**
|
|
@@ -1484,7 +1484,7 @@ export namespace docs_v1 {
|
|
|
1484
1484
|
*/
|
|
1485
1485
|
indentStart?: Schema$Dimension;
|
|
1486
1486
|
/**
|
|
1487
|
-
* The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and
|
|
1487
|
+
* The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
|
|
1488
1488
|
*/
|
|
1489
1489
|
startNumber?: number | null;
|
|
1490
1490
|
/**
|
|
@@ -1493,7 +1493,7 @@ export namespace docs_v1 {
|
|
|
1493
1493
|
textStyle?: Schema$TextStyle;
|
|
1494
1494
|
}
|
|
1495
1495
|
/**
|
|
1496
|
-
* A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there
|
|
1496
|
+
* A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1497
1497
|
*/
|
|
1498
1498
|
export interface Schema$NestingLevelSuggestionState {
|
|
1499
1499
|
/**
|
|
@@ -1556,7 +1556,7 @@ export namespace docs_v1 {
|
|
|
1556
1556
|
*/
|
|
1557
1557
|
suggestedDeletionIds?: string[] | null;
|
|
1558
1558
|
/**
|
|
1559
|
-
* The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it
|
|
1559
|
+
* The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
1560
1560
|
*/
|
|
1561
1561
|
suggestedInsertionIds?: string[] | null;
|
|
1562
1562
|
/**
|
|
@@ -1566,12 +1566,12 @@ export namespace docs_v1 {
|
|
|
1566
1566
|
[key: string]: Schema$SuggestedTextStyle;
|
|
1567
1567
|
} | null;
|
|
1568
1568
|
/**
|
|
1569
|
-
* The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted
|
|
1569
|
+
* The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
|
|
1570
1570
|
*/
|
|
1571
1571
|
textStyle?: Schema$TextStyle;
|
|
1572
1572
|
}
|
|
1573
1573
|
/**
|
|
1574
|
-
* A StructuralElement representing a paragraph. A paragraph is a range of content that
|
|
1574
|
+
* A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character.
|
|
1575
1575
|
*/
|
|
1576
1576
|
export interface Schema$Paragraph {
|
|
1577
1577
|
/**
|
|
@@ -1579,7 +1579,7 @@ export namespace docs_v1 {
|
|
|
1579
1579
|
*/
|
|
1580
1580
|
bullet?: Schema$Bullet;
|
|
1581
1581
|
/**
|
|
1582
|
-
* The content of the paragraph broken down into its component parts.
|
|
1582
|
+
* The content of the paragraph, broken down into its component parts.
|
|
1583
1583
|
*/
|
|
1584
1584
|
elements?: Schema$ParagraphElement[];
|
|
1585
1585
|
/**
|
|
@@ -1601,7 +1601,7 @@ export namespace docs_v1 {
|
|
|
1601
1601
|
[key: string]: Schema$SuggestedParagraphStyle;
|
|
1602
1602
|
} | null;
|
|
1603
1603
|
/**
|
|
1604
|
-
* The IDs of the positioned objects
|
|
1604
|
+
* The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
|
|
1605
1605
|
*/
|
|
1606
1606
|
suggestedPositionedObjectIds?: {
|
|
1607
1607
|
[key: string]: Schema$ObjectReferences;
|
|
@@ -1669,7 +1669,7 @@ export namespace docs_v1 {
|
|
|
1669
1669
|
*/
|
|
1670
1670
|
person?: Schema$Person;
|
|
1671
1671
|
/**
|
|
1672
|
-
* A paragraph element that links to a Google resource (such as a file in Drive, a
|
|
1672
|
+
* A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
|
|
1673
1673
|
*/
|
|
1674
1674
|
richLink?: Schema$RichLink;
|
|
1675
1675
|
/**
|
|
@@ -1682,7 +1682,7 @@ export namespace docs_v1 {
|
|
|
1682
1682
|
textRun?: Schema$TextRun;
|
|
1683
1683
|
}
|
|
1684
1684
|
/**
|
|
1685
|
-
* Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that
|
|
1685
|
+
* Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.
|
|
1686
1686
|
*/
|
|
1687
1687
|
export interface Schema$ParagraphStyle {
|
|
1688
1688
|
/**
|
|
@@ -1694,23 +1694,23 @@ export namespace docs_v1 {
|
|
|
1694
1694
|
*/
|
|
1695
1695
|
avoidWidowAndOrphan?: boolean | null;
|
|
1696
1696
|
/**
|
|
1697
|
-
* The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When
|
|
1697
|
+
* The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
|
|
1698
1698
|
*/
|
|
1699
1699
|
borderBetween?: Schema$ParagraphBorder;
|
|
1700
1700
|
/**
|
|
1701
|
-
* The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When
|
|
1701
|
+
* The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
|
|
1702
1702
|
*/
|
|
1703
1703
|
borderBottom?: Schema$ParagraphBorder;
|
|
1704
1704
|
/**
|
|
1705
|
-
* The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When
|
|
1705
|
+
* The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
|
|
1706
1706
|
*/
|
|
1707
1707
|
borderLeft?: Schema$ParagraphBorder;
|
|
1708
1708
|
/**
|
|
1709
|
-
* The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When
|
|
1709
|
+
* The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
|
|
1710
1710
|
*/
|
|
1711
1711
|
borderRight?: Schema$ParagraphBorder;
|
|
1712
1712
|
/**
|
|
1713
|
-
* The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When
|
|
1713
|
+
* The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
|
|
1714
1714
|
*/
|
|
1715
1715
|
borderTop?: Schema$ParagraphBorder;
|
|
1716
1716
|
/**
|
|
@@ -1750,7 +1750,7 @@ export namespace docs_v1 {
|
|
|
1750
1750
|
*/
|
|
1751
1751
|
namedStyleType?: string | null;
|
|
1752
1752
|
/**
|
|
1753
|
-
* Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state
|
|
1753
|
+
* Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
|
|
1754
1754
|
*/
|
|
1755
1755
|
pageBreakBefore?: boolean | null;
|
|
1756
1756
|
/**
|
|
@@ -1775,7 +1775,7 @@ export namespace docs_v1 {
|
|
|
1775
1775
|
tabStops?: Schema$TabStop[];
|
|
1776
1776
|
}
|
|
1777
1777
|
/**
|
|
1778
|
-
* A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there
|
|
1778
|
+
* A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1779
1779
|
*/
|
|
1780
1780
|
export interface Schema$ParagraphStyleSuggestionState {
|
|
1781
1781
|
/**
|
|
@@ -1876,11 +1876,11 @@ export namespace docs_v1 {
|
|
|
1876
1876
|
*/
|
|
1877
1877
|
personProperties?: Schema$PersonProperties;
|
|
1878
1878
|
/**
|
|
1879
|
-
* IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest
|
|
1879
|
+
* IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
|
|
1880
1880
|
*/
|
|
1881
1881
|
suggestedDeletionIds?: string[] | null;
|
|
1882
1882
|
/**
|
|
1883
|
-
* IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it
|
|
1883
|
+
* IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
|
|
1884
1884
|
*/
|
|
1885
1885
|
suggestedInsertionIds?: string[] | null;
|
|
1886
1886
|
/**
|
|
@@ -1903,7 +1903,7 @@ export namespace docs_v1 {
|
|
|
1903
1903
|
*/
|
|
1904
1904
|
email?: string | null;
|
|
1905
1905
|
/**
|
|
1906
|
-
* Output only. The name of the person if it
|
|
1906
|
+
* Output only. The name of the person if it's displayed in the link text instead of the person's email address.
|
|
1907
1907
|
*/
|
|
1908
1908
|
name?: string | null;
|
|
1909
1909
|
}
|
|
@@ -1921,7 +1921,7 @@ export namespace docs_v1 {
|
|
|
1921
1921
|
tableStartLocation?: Schema$Location;
|
|
1922
1922
|
}
|
|
1923
1923
|
/**
|
|
1924
|
-
* An object that
|
|
1924
|
+
* An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
|
|
1925
1925
|
*/
|
|
1926
1926
|
export interface Schema$PositionedObject {
|
|
1927
1927
|
/**
|
|
@@ -1948,7 +1948,7 @@ export namespace docs_v1 {
|
|
|
1948
1948
|
} | null;
|
|
1949
1949
|
}
|
|
1950
1950
|
/**
|
|
1951
|
-
* The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it
|
|
1951
|
+
* The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.
|
|
1952
1952
|
*/
|
|
1953
1953
|
export interface Schema$PositionedObjectPositioning {
|
|
1954
1954
|
/**
|
|
@@ -1956,16 +1956,16 @@ export namespace docs_v1 {
|
|
|
1956
1956
|
*/
|
|
1957
1957
|
layout?: string | null;
|
|
1958
1958
|
/**
|
|
1959
|
-
* The offset of the left edge of the positioned object relative to the beginning of the Paragraph it
|
|
1959
|
+
* The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
|
|
1960
1960
|
*/
|
|
1961
1961
|
leftOffset?: Schema$Dimension;
|
|
1962
1962
|
/**
|
|
1963
|
-
* The offset of the top edge of the positioned object relative to the beginning of the Paragraph it
|
|
1963
|
+
* The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
|
|
1964
1964
|
*/
|
|
1965
1965
|
topOffset?: Schema$Dimension;
|
|
1966
1966
|
}
|
|
1967
1967
|
/**
|
|
1968
|
-
* A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there
|
|
1968
|
+
* A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1969
1969
|
*/
|
|
1970
1970
|
export interface Schema$PositionedObjectPositioningSuggestionState {
|
|
1971
1971
|
/**
|
|
@@ -1995,7 +1995,7 @@ export namespace docs_v1 {
|
|
|
1995
1995
|
positioning?: Schema$PositionedObjectPositioning;
|
|
1996
1996
|
}
|
|
1997
1997
|
/**
|
|
1998
|
-
* A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there
|
|
1998
|
+
* A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
1999
1999
|
*/
|
|
2000
2000
|
export interface Schema$PositionedObjectPropertiesSuggestionState {
|
|
2001
2001
|
/**
|
|
@@ -2016,7 +2016,7 @@ export namespace docs_v1 {
|
|
|
2016
2016
|
*/
|
|
2017
2017
|
endIndex?: number | null;
|
|
2018
2018
|
/**
|
|
2019
|
-
* The ID of the header, footer or footnote that this range is contained in. An empty segment ID signifies the document's body.
|
|
2019
|
+
* The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
|
|
2020
2020
|
*/
|
|
2021
2021
|
segmentId?: string | null;
|
|
2022
2022
|
/**
|
|
@@ -2268,7 +2268,7 @@ export namespace docs_v1 {
|
|
|
2268
2268
|
red?: number | null;
|
|
2269
2269
|
}
|
|
2270
2270
|
/**
|
|
2271
|
-
* A link to a Google resource (
|
|
2271
|
+
* A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event).
|
|
2272
2272
|
*/
|
|
2273
2273
|
export interface Schema$RichLink {
|
|
2274
2274
|
/**
|
|
@@ -2280,11 +2280,11 @@ export namespace docs_v1 {
|
|
|
2280
2280
|
*/
|
|
2281
2281
|
richLinkProperties?: Schema$RichLinkProperties;
|
|
2282
2282
|
/**
|
|
2283
|
-
* IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest
|
|
2283
|
+
* IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
|
|
2284
2284
|
*/
|
|
2285
2285
|
suggestedDeletionIds?: string[] | null;
|
|
2286
2286
|
/**
|
|
2287
|
-
* IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it
|
|
2287
|
+
* IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
|
|
2288
2288
|
*/
|
|
2289
2289
|
suggestedInsertionIds?: string[] | null;
|
|
2290
2290
|
/**
|
|
@@ -2303,7 +2303,7 @@ export namespace docs_v1 {
|
|
|
2303
2303
|
*/
|
|
2304
2304
|
export interface Schema$RichLinkProperties {
|
|
2305
2305
|
/**
|
|
2306
|
-
* Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there
|
|
2306
|
+
* Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
|
|
2307
2307
|
*/
|
|
2308
2308
|
mimeType?: string | null;
|
|
2309
2309
|
/**
|
|
@@ -2316,7 +2316,7 @@ export namespace docs_v1 {
|
|
|
2316
2316
|
uri?: string | null;
|
|
2317
2317
|
}
|
|
2318
2318
|
/**
|
|
2319
|
-
* A StructuralElement representing a section break. A section is a range of content
|
|
2319
|
+
* A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.
|
|
2320
2320
|
*/
|
|
2321
2321
|
export interface Schema$SectionBreak {
|
|
2322
2322
|
/**
|
|
@@ -2328,7 +2328,7 @@ export namespace docs_v1 {
|
|
|
2328
2328
|
*/
|
|
2329
2329
|
suggestedDeletionIds?: string[] | null;
|
|
2330
2330
|
/**
|
|
2331
|
-
* The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it
|
|
2331
|
+
* The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
2332
2332
|
*/
|
|
2333
2333
|
suggestedInsertionIds?: string[] | null;
|
|
2334
2334
|
}
|
|
@@ -2350,11 +2350,11 @@ export namespace docs_v1 {
|
|
|
2350
2350
|
*/
|
|
2351
2351
|
export interface Schema$SectionStyle {
|
|
2352
2352
|
/**
|
|
2353
|
-
* The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than
|
|
2353
|
+
* The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
|
|
2354
2354
|
*/
|
|
2355
2355
|
columnProperties?: Schema$SectionColumnProperties[];
|
|
2356
2356
|
/**
|
|
2357
|
-
* The style of column separators. This style can be set even when there
|
|
2357
|
+
* The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2358
2358
|
*/
|
|
2359
2359
|
columnSeparatorStyle?: string | null;
|
|
2360
2360
|
/**
|
|
@@ -2370,43 +2370,43 @@ export namespace docs_v1 {
|
|
|
2370
2370
|
*/
|
|
2371
2371
|
defaultHeaderId?: string | null;
|
|
2372
2372
|
/**
|
|
2373
|
-
* The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages
|
|
2373
|
+
* The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
|
|
2374
2374
|
*/
|
|
2375
2375
|
evenPageFooterId?: string | null;
|
|
2376
2376
|
/**
|
|
2377
|
-
* The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages
|
|
2377
|
+
* The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
|
|
2378
2378
|
*/
|
|
2379
2379
|
evenPageHeaderId?: string | null;
|
|
2380
2380
|
/**
|
|
2381
|
-
* The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it
|
|
2381
|
+
* The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
|
|
2382
2382
|
*/
|
|
2383
2383
|
firstPageFooterId?: string | null;
|
|
2384
2384
|
/**
|
|
2385
|
-
* The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it
|
|
2385
|
+
* The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
|
|
2386
2386
|
*/
|
|
2387
2387
|
firstPageHeaderId?: string | null;
|
|
2388
2388
|
/**
|
|
2389
|
-
* The bottom page margin of the section. If unset,
|
|
2389
|
+
* The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2390
2390
|
*/
|
|
2391
2391
|
marginBottom?: Schema$Dimension;
|
|
2392
2392
|
/**
|
|
2393
|
-
* The footer margin of the section. If unset,
|
|
2393
|
+
* The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2394
2394
|
*/
|
|
2395
2395
|
marginFooter?: Schema$Dimension;
|
|
2396
2396
|
/**
|
|
2397
|
-
* The header margin of the section. If unset,
|
|
2397
|
+
* The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2398
2398
|
*/
|
|
2399
2399
|
marginHeader?: Schema$Dimension;
|
|
2400
2400
|
/**
|
|
2401
|
-
* The left page margin of the section. If unset,
|
|
2401
|
+
* The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2402
2402
|
*/
|
|
2403
2403
|
marginLeft?: Schema$Dimension;
|
|
2404
2404
|
/**
|
|
2405
|
-
* The right page margin of the section. If unset,
|
|
2405
|
+
* The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2406
2406
|
*/
|
|
2407
2407
|
marginRight?: Schema$Dimension;
|
|
2408
2408
|
/**
|
|
2409
|
-
* The top page margin of the section. If unset,
|
|
2409
|
+
* The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
|
|
2410
2410
|
*/
|
|
2411
2411
|
marginTop?: Schema$Dimension;
|
|
2412
2412
|
/**
|
|
@@ -2432,7 +2432,7 @@ export namespace docs_v1 {
|
|
|
2432
2432
|
backgroundColor?: Schema$OptionalColor;
|
|
2433
2433
|
}
|
|
2434
2434
|
/**
|
|
2435
|
-
* A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there
|
|
2435
|
+
* A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value.
|
|
2436
2436
|
*/
|
|
2437
2437
|
export interface Schema$ShadingSuggestionState {
|
|
2438
2438
|
/**
|
|
@@ -2445,7 +2445,7 @@ export namespace docs_v1 {
|
|
|
2445
2445
|
*/
|
|
2446
2446
|
export interface Schema$SheetsChartReference {
|
|
2447
2447
|
/**
|
|
2448
|
-
* The ID of the specific chart in the Google Sheets spreadsheet that
|
|
2448
|
+
* The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
|
|
2449
2449
|
*/
|
|
2450
2450
|
chartId?: number | null;
|
|
2451
2451
|
/**
|
|
@@ -2454,7 +2454,7 @@ export namespace docs_v1 {
|
|
|
2454
2454
|
spreadsheetId?: string | null;
|
|
2455
2455
|
}
|
|
2456
2456
|
/**
|
|
2457
|
-
* A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there
|
|
2457
|
+
* A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
2458
2458
|
*/
|
|
2459
2459
|
export interface Schema$SheetsChartReferenceSuggestionState {
|
|
2460
2460
|
/**
|
|
@@ -2669,7 +2669,7 @@ export namespace docs_v1 {
|
|
|
2669
2669
|
*/
|
|
2670
2670
|
export interface Schema$Table {
|
|
2671
2671
|
/**
|
|
2672
|
-
* Number of columns in the table. It
|
|
2672
|
+
* Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
|
|
2673
2673
|
*/
|
|
2674
2674
|
columns?: number | null;
|
|
2675
2675
|
/**
|
|
@@ -2681,7 +2681,7 @@ export namespace docs_v1 {
|
|
|
2681
2681
|
*/
|
|
2682
2682
|
suggestedDeletionIds?: string[] | null;
|
|
2683
2683
|
/**
|
|
2684
|
-
* The suggested insertion IDs. A Table may have multiple insertion IDs if it
|
|
2684
|
+
* The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
2685
2685
|
*/
|
|
2686
2686
|
suggestedInsertionIds?: string[] | null;
|
|
2687
2687
|
/**
|
|
@@ -2714,7 +2714,7 @@ export namespace docs_v1 {
|
|
|
2714
2714
|
*/
|
|
2715
2715
|
suggestedDeletionIds?: string[] | null;
|
|
2716
2716
|
/**
|
|
2717
|
-
* The suggested insertion IDs. A TableCell may have multiple insertion IDs if it
|
|
2717
|
+
* The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
2718
2718
|
*/
|
|
2719
2719
|
suggestedInsertionIds?: string[] | null;
|
|
2720
2720
|
/**
|
|
@@ -2816,7 +2816,7 @@ export namespace docs_v1 {
|
|
|
2816
2816
|
rowSpan?: number | null;
|
|
2817
2817
|
}
|
|
2818
2818
|
/**
|
|
2819
|
-
* A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there
|
|
2819
|
+
* A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
2820
2820
|
*/
|
|
2821
2821
|
export interface Schema$TableCellStyleSuggestionState {
|
|
2822
2822
|
/**
|
|
@@ -2932,7 +2932,7 @@ export namespace docs_v1 {
|
|
|
2932
2932
|
*/
|
|
2933
2933
|
suggestedDeletionIds?: string[] | null;
|
|
2934
2934
|
/**
|
|
2935
|
-
* The suggested insertion IDs. A TableRow may have multiple insertion IDs if it
|
|
2935
|
+
* The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
2936
2936
|
*/
|
|
2937
2937
|
suggestedInsertionIds?: string[] | null;
|
|
2938
2938
|
/**
|
|
@@ -2942,7 +2942,7 @@ export namespace docs_v1 {
|
|
|
2942
2942
|
[key: string]: Schema$SuggestedTableRowStyle;
|
|
2943
2943
|
} | null;
|
|
2944
2944
|
/**
|
|
2945
|
-
* The contents and style of each cell in this row. It
|
|
2945
|
+
* The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
|
|
2946
2946
|
*/
|
|
2947
2947
|
tableCells?: Schema$TableCell[];
|
|
2948
2948
|
/**
|
|
@@ -2968,7 +2968,7 @@ export namespace docs_v1 {
|
|
|
2968
2968
|
tableHeader?: boolean | null;
|
|
2969
2969
|
}
|
|
2970
2970
|
/**
|
|
2971
|
-
* A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there
|
|
2971
|
+
* A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
2972
2972
|
*/
|
|
2973
2973
|
export interface Schema$TableRowStyleSuggestionState {
|
|
2974
2974
|
/**
|
|
@@ -3011,7 +3011,7 @@ export namespace docs_v1 {
|
|
|
3011
3011
|
*/
|
|
3012
3012
|
suggestedDeletionIds?: string[] | null;
|
|
3013
3013
|
/**
|
|
3014
|
-
* The suggested insertion IDs. A TextRun may have multiple insertion IDs if it
|
|
3014
|
+
* The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
|
|
3015
3015
|
*/
|
|
3016
3016
|
suggestedInsertionIds?: string[] | null;
|
|
3017
3017
|
/**
|
|
@@ -3026,7 +3026,7 @@ export namespace docs_v1 {
|
|
|
3026
3026
|
textStyle?: Schema$TextStyle;
|
|
3027
3027
|
}
|
|
3028
3028
|
/**
|
|
3029
|
-
* Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that
|
|
3029
|
+
* Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.
|
|
3030
3030
|
*/
|
|
3031
3031
|
export interface Schema$TextStyle {
|
|
3032
3032
|
/**
|
|
@@ -3034,7 +3034,7 @@ export namespace docs_v1 {
|
|
|
3034
3034
|
*/
|
|
3035
3035
|
backgroundColor?: Schema$OptionalColor;
|
|
3036
3036
|
/**
|
|
3037
|
-
* The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field.
|
|
3037
|
+
* The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
|
|
3038
3038
|
*/
|
|
3039
3039
|
baselineOffset?: string | null;
|
|
3040
3040
|
/**
|
|
@@ -3054,7 +3054,7 @@ export namespace docs_v1 {
|
|
|
3054
3054
|
*/
|
|
3055
3055
|
italic?: boolean | null;
|
|
3056
3056
|
/**
|
|
3057
|
-
* The hyperlink destination of the text. If unset, there
|
|
3057
|
+
* The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
|
|
3058
3058
|
*/
|
|
3059
3059
|
link?: Schema$Link;
|
|
3060
3060
|
/**
|
|
@@ -3075,7 +3075,7 @@ export namespace docs_v1 {
|
|
|
3075
3075
|
weightedFontFamily?: Schema$WeightedFontFamily;
|
|
3076
3076
|
}
|
|
3077
3077
|
/**
|
|
3078
|
-
* A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there
|
|
3078
|
+
* A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.
|
|
3079
3079
|
*/
|
|
3080
3080
|
export interface Schema$TextStyleSuggestionState {
|
|
3081
3081
|
/**
|
|
@@ -3268,7 +3268,7 @@ export namespace docs_v1 {
|
|
|
3268
3268
|
*/
|
|
3269
3269
|
fontFamily?: string | null;
|
|
3270
3270
|
/**
|
|
3271
|
-
* The weight of the font. This field can have any value that
|
|
3271
|
+
* The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
|
|
3272
3272
|
*/
|
|
3273
3273
|
weight?: number | null;
|
|
3274
3274
|
}
|