@googleapis/docs 3.0.2 → 3.1.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 +7 -0
- package/build/v1.d.ts +226 -14
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +212 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [3.1.0](https://github.com/googleapis/google-api-nodejs-client/compare/docs-v3.0.2...docs-v3.1.0) (2024-08-16)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **docs:** update the API ([0736162](https://github.com/googleapis/google-api-nodejs-client/commit/07361625ae5b3bfee8e3e556b766a83f4c020854))
|
|
9
|
+
|
|
3
10
|
## [3.0.2](https://github.com/googleapis/google-api-nodejs-client/compare/docs-v3.0.1...docs-v3.0.2) (2024-05-02)
|
|
4
11
|
|
|
5
12
|
|
package/build/v1.d.ts
CHANGED
|
@@ -155,6 +155,19 @@ export declare namespace docs_v1 {
|
|
|
155
155
|
*/
|
|
156
156
|
content?: Schema$StructuralElement[];
|
|
157
157
|
}
|
|
158
|
+
/**
|
|
159
|
+
* A reference to a bookmark in this document.
|
|
160
|
+
*/
|
|
161
|
+
export interface Schema$BookmarkLink {
|
|
162
|
+
/**
|
|
163
|
+
* The ID of a bookmark in this document.
|
|
164
|
+
*/
|
|
165
|
+
id?: string | null;
|
|
166
|
+
/**
|
|
167
|
+
* The ID of the tab containing this bookmark.
|
|
168
|
+
*/
|
|
169
|
+
tabId?: string | null;
|
|
170
|
+
}
|
|
158
171
|
/**
|
|
159
172
|
* Describes the bullet of a paragraph.
|
|
160
173
|
*/
|
|
@@ -389,6 +402,10 @@ export declare namespace docs_v1 {
|
|
|
389
402
|
* 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.
|
|
390
403
|
*/
|
|
391
404
|
footerId?: string | null;
|
|
405
|
+
/**
|
|
406
|
+
* The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
407
|
+
*/
|
|
408
|
+
tabId?: string | null;
|
|
392
409
|
}
|
|
393
410
|
/**
|
|
394
411
|
* Deletes a Header from the document.
|
|
@@ -398,6 +415,10 @@ export declare namespace docs_v1 {
|
|
|
398
415
|
* 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.
|
|
399
416
|
*/
|
|
400
417
|
headerId?: string | null;
|
|
418
|
+
/**
|
|
419
|
+
* The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
420
|
+
*/
|
|
421
|
+
tabId?: string | null;
|
|
401
422
|
}
|
|
402
423
|
/**
|
|
403
424
|
* Deletes a NamedRange.
|
|
@@ -411,6 +432,10 @@ export declare namespace docs_v1 {
|
|
|
411
432
|
* The ID of the named range to delete.
|
|
412
433
|
*/
|
|
413
434
|
namedRangeId?: string | null;
|
|
435
|
+
/**
|
|
436
|
+
* Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs.
|
|
437
|
+
*/
|
|
438
|
+
tabsCriteria?: Schema$TabsCriteria;
|
|
414
439
|
}
|
|
415
440
|
/**
|
|
416
441
|
* 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.
|
|
@@ -429,6 +454,10 @@ export declare namespace docs_v1 {
|
|
|
429
454
|
* The ID of the positioned object to delete.
|
|
430
455
|
*/
|
|
431
456
|
objectId?: string | null;
|
|
457
|
+
/**
|
|
458
|
+
* The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
459
|
+
*/
|
|
460
|
+
tabId?: string | null;
|
|
432
461
|
}
|
|
433
462
|
/**
|
|
434
463
|
* Deletes a column from a table.
|
|
@@ -466,7 +495,7 @@ export declare namespace docs_v1 {
|
|
|
466
495
|
*/
|
|
467
496
|
export interface Schema$Document {
|
|
468
497
|
/**
|
|
469
|
-
* Output only. The main body of the document.
|
|
498
|
+
* Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
470
499
|
*/
|
|
471
500
|
body?: Schema$Body;
|
|
472
501
|
/**
|
|
@@ -474,51 +503,51 @@ export declare namespace docs_v1 {
|
|
|
474
503
|
*/
|
|
475
504
|
documentId?: string | null;
|
|
476
505
|
/**
|
|
477
|
-
* Output only. The style of the document.
|
|
506
|
+
* Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
478
507
|
*/
|
|
479
508
|
documentStyle?: Schema$DocumentStyle;
|
|
480
509
|
/**
|
|
481
|
-
* Output only. The footers in the document, keyed by footer ID.
|
|
510
|
+
* Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
482
511
|
*/
|
|
483
512
|
footers?: {
|
|
484
513
|
[key: string]: Schema$Footer;
|
|
485
514
|
} | null;
|
|
486
515
|
/**
|
|
487
|
-
* Output only. The footnotes in the document, keyed by footnote ID.
|
|
516
|
+
* Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
488
517
|
*/
|
|
489
518
|
footnotes?: {
|
|
490
519
|
[key: string]: Schema$Footnote;
|
|
491
520
|
} | null;
|
|
492
521
|
/**
|
|
493
|
-
* Output only. The headers in the document, keyed by header ID.
|
|
522
|
+
* Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
494
523
|
*/
|
|
495
524
|
headers?: {
|
|
496
525
|
[key: string]: Schema$Header;
|
|
497
526
|
} | null;
|
|
498
527
|
/**
|
|
499
|
-
* Output only. The inline objects in the document, keyed by object ID.
|
|
528
|
+
* Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
500
529
|
*/
|
|
501
530
|
inlineObjects?: {
|
|
502
531
|
[key: string]: Schema$InlineObject;
|
|
503
532
|
} | null;
|
|
504
533
|
/**
|
|
505
|
-
* Output only. The lists in the document, keyed by list ID.
|
|
534
|
+
* Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
506
535
|
*/
|
|
507
536
|
lists?: {
|
|
508
537
|
[key: string]: Schema$List;
|
|
509
538
|
} | null;
|
|
510
539
|
/**
|
|
511
|
-
* Output only. The named ranges in the document, keyed by name.
|
|
540
|
+
* Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
512
541
|
*/
|
|
513
542
|
namedRanges?: {
|
|
514
543
|
[key: string]: Schema$NamedRanges;
|
|
515
544
|
} | null;
|
|
516
545
|
/**
|
|
517
|
-
* Output only. The named styles of the document.
|
|
546
|
+
* Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
518
547
|
*/
|
|
519
548
|
namedStyles?: Schema$NamedStyles;
|
|
520
549
|
/**
|
|
521
|
-
* Output only. The positioned objects in the document, keyed by object ID.
|
|
550
|
+
* Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
522
551
|
*/
|
|
523
552
|
positionedObjects?: {
|
|
524
553
|
[key: string]: Schema$PositionedObject;
|
|
@@ -528,13 +557,13 @@ export declare namespace docs_v1 {
|
|
|
528
557
|
*/
|
|
529
558
|
revisionId?: string | null;
|
|
530
559
|
/**
|
|
531
|
-
* Output only. The suggested changes to the style of the document, keyed by suggestion ID.
|
|
560
|
+
* Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
532
561
|
*/
|
|
533
562
|
suggestedDocumentStyleChanges?: {
|
|
534
563
|
[key: string]: Schema$SuggestedDocumentStyle;
|
|
535
564
|
} | null;
|
|
536
565
|
/**
|
|
537
|
-
* Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.
|
|
566
|
+
* Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
538
567
|
*/
|
|
539
568
|
suggestedNamedStylesChanges?: {
|
|
540
569
|
[key: string]: Schema$SuggestedNamedStyles;
|
|
@@ -543,6 +572,10 @@ export declare namespace docs_v1 {
|
|
|
543
572
|
* 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.
|
|
544
573
|
*/
|
|
545
574
|
suggestionsViewMode?: string | null;
|
|
575
|
+
/**
|
|
576
|
+
* Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.
|
|
577
|
+
*/
|
|
578
|
+
tabs?: Schema$Tab[];
|
|
546
579
|
/**
|
|
547
580
|
* The title of the document.
|
|
548
581
|
*/
|
|
@@ -710,6 +743,77 @@ export declare namespace docs_v1 {
|
|
|
710
743
|
*/
|
|
711
744
|
useFirstPageHeaderFooterSuggested?: boolean | null;
|
|
712
745
|
}
|
|
746
|
+
/**
|
|
747
|
+
* A tab with document contents.
|
|
748
|
+
*/
|
|
749
|
+
export interface Schema$DocumentTab {
|
|
750
|
+
/**
|
|
751
|
+
* The main body of the document tab.
|
|
752
|
+
*/
|
|
753
|
+
body?: Schema$Body;
|
|
754
|
+
/**
|
|
755
|
+
* The style of the document tab.
|
|
756
|
+
*/
|
|
757
|
+
documentStyle?: Schema$DocumentStyle;
|
|
758
|
+
/**
|
|
759
|
+
* The footers in the document tab, keyed by footer ID.
|
|
760
|
+
*/
|
|
761
|
+
footers?: {
|
|
762
|
+
[key: string]: Schema$Footer;
|
|
763
|
+
} | null;
|
|
764
|
+
/**
|
|
765
|
+
* The footnotes in the document tab, keyed by footnote ID.
|
|
766
|
+
*/
|
|
767
|
+
footnotes?: {
|
|
768
|
+
[key: string]: Schema$Footnote;
|
|
769
|
+
} | null;
|
|
770
|
+
/**
|
|
771
|
+
* The headers in the document tab, keyed by header ID.
|
|
772
|
+
*/
|
|
773
|
+
headers?: {
|
|
774
|
+
[key: string]: Schema$Header;
|
|
775
|
+
} | null;
|
|
776
|
+
/**
|
|
777
|
+
* The inline objects in the document tab, keyed by object ID.
|
|
778
|
+
*/
|
|
779
|
+
inlineObjects?: {
|
|
780
|
+
[key: string]: Schema$InlineObject;
|
|
781
|
+
} | null;
|
|
782
|
+
/**
|
|
783
|
+
* The lists in the document tab, keyed by list ID.
|
|
784
|
+
*/
|
|
785
|
+
lists?: {
|
|
786
|
+
[key: string]: Schema$List;
|
|
787
|
+
} | null;
|
|
788
|
+
/**
|
|
789
|
+
* The named ranges in the document tab, keyed by name.
|
|
790
|
+
*/
|
|
791
|
+
namedRanges?: {
|
|
792
|
+
[key: string]: Schema$NamedRanges;
|
|
793
|
+
} | null;
|
|
794
|
+
/**
|
|
795
|
+
* The named styles of the document tab.
|
|
796
|
+
*/
|
|
797
|
+
namedStyles?: Schema$NamedStyles;
|
|
798
|
+
/**
|
|
799
|
+
* The positioned objects in the document tab, keyed by object ID.
|
|
800
|
+
*/
|
|
801
|
+
positionedObjects?: {
|
|
802
|
+
[key: string]: Schema$PositionedObject;
|
|
803
|
+
} | null;
|
|
804
|
+
/**
|
|
805
|
+
* The suggested changes to the style of the document tab, keyed by suggestion ID.
|
|
806
|
+
*/
|
|
807
|
+
suggestedDocumentStyleChanges?: {
|
|
808
|
+
[key: string]: Schema$SuggestedDocumentStyle;
|
|
809
|
+
} | null;
|
|
810
|
+
/**
|
|
811
|
+
* The suggested changes to the named styles of the document tab, keyed by suggestion ID.
|
|
812
|
+
*/
|
|
813
|
+
suggestedNamedStylesChanges?: {
|
|
814
|
+
[key: string]: Schema$SuggestedNamedStyles;
|
|
815
|
+
} | null;
|
|
816
|
+
}
|
|
713
817
|
/**
|
|
714
818
|
* 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.
|
|
715
819
|
*/
|
|
@@ -868,6 +972,10 @@ export declare namespace docs_v1 {
|
|
|
868
972
|
* The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.
|
|
869
973
|
*/
|
|
870
974
|
segmentId?: string | null;
|
|
975
|
+
/**
|
|
976
|
+
* The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
977
|
+
*/
|
|
978
|
+
tabId?: string | null;
|
|
871
979
|
}
|
|
872
980
|
/**
|
|
873
981
|
* A ParagraphElement representing an equation.
|
|
@@ -952,6 +1060,19 @@ export declare namespace docs_v1 {
|
|
|
952
1060
|
*/
|
|
953
1061
|
headerId?: string | null;
|
|
954
1062
|
}
|
|
1063
|
+
/**
|
|
1064
|
+
* A reference to a heading in this document.
|
|
1065
|
+
*/
|
|
1066
|
+
export interface Schema$HeadingLink {
|
|
1067
|
+
/**
|
|
1068
|
+
* The ID of a heading in this document.
|
|
1069
|
+
*/
|
|
1070
|
+
id?: string | null;
|
|
1071
|
+
/**
|
|
1072
|
+
* The ID of the tab containing this heading.
|
|
1073
|
+
*/
|
|
1074
|
+
tabId?: string | null;
|
|
1075
|
+
}
|
|
955
1076
|
/**
|
|
956
1077
|
* A ParagraphElement representing a horizontal line.
|
|
957
1078
|
*/
|
|
@@ -1251,13 +1372,25 @@ export declare namespace docs_v1 {
|
|
|
1251
1372
|
*/
|
|
1252
1373
|
export interface Schema$Link {
|
|
1253
1374
|
/**
|
|
1254
|
-
*
|
|
1375
|
+
* A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
|
|
1376
|
+
*/
|
|
1377
|
+
bookmark?: Schema$BookmarkLink;
|
|
1378
|
+
/**
|
|
1379
|
+
* The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.
|
|
1255
1380
|
*/
|
|
1256
1381
|
bookmarkId?: string | null;
|
|
1257
1382
|
/**
|
|
1258
|
-
*
|
|
1383
|
+
* A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
|
|
1384
|
+
*/
|
|
1385
|
+
heading?: Schema$HeadingLink;
|
|
1386
|
+
/**
|
|
1387
|
+
* The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.
|
|
1259
1388
|
*/
|
|
1260
1389
|
headingId?: string | null;
|
|
1390
|
+
/**
|
|
1391
|
+
* The ID of a tab in this document.
|
|
1392
|
+
*/
|
|
1393
|
+
tabId?: string | null;
|
|
1261
1394
|
/**
|
|
1262
1395
|
* An external URL.
|
|
1263
1396
|
*/
|
|
@@ -1334,6 +1467,10 @@ export declare namespace docs_v1 {
|
|
|
1334
1467
|
* The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.
|
|
1335
1468
|
*/
|
|
1336
1469
|
segmentId?: string | null;
|
|
1470
|
+
/**
|
|
1471
|
+
* The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
1472
|
+
*/
|
|
1473
|
+
tabId?: string | null;
|
|
1337
1474
|
}
|
|
1338
1475
|
/**
|
|
1339
1476
|
* Merges cells in a Table.
|
|
@@ -1996,6 +2133,10 @@ export declare namespace docs_v1 {
|
|
|
1996
2133
|
* The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
|
|
1997
2134
|
*/
|
|
1998
2135
|
startIndex?: number | null;
|
|
2136
|
+
/**
|
|
2137
|
+
* The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
2138
|
+
*/
|
|
2139
|
+
tabId?: string | null;
|
|
1999
2140
|
}
|
|
2000
2141
|
/**
|
|
2001
2142
|
* Replaces all instances of text matching a criteria with replace text.
|
|
@@ -2009,6 +2150,10 @@ export declare namespace docs_v1 {
|
|
|
2009
2150
|
* The text that will replace the matched text.
|
|
2010
2151
|
*/
|
|
2011
2152
|
replaceText?: string | null;
|
|
2153
|
+
/**
|
|
2154
|
+
* Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs.
|
|
2155
|
+
*/
|
|
2156
|
+
tabsCriteria?: Schema$TabsCriteria;
|
|
2012
2157
|
}
|
|
2013
2158
|
/**
|
|
2014
2159
|
* The result of replacing text.
|
|
@@ -2031,6 +2176,10 @@ export declare namespace docs_v1 {
|
|
|
2031
2176
|
* The replacement method.
|
|
2032
2177
|
*/
|
|
2033
2178
|
imageReplaceMethod?: string | null;
|
|
2179
|
+
/**
|
|
2180
|
+
* The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
2181
|
+
*/
|
|
2182
|
+
tabId?: string | null;
|
|
2034
2183
|
/**
|
|
2035
2184
|
* The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.
|
|
2036
2185
|
*/
|
|
@@ -2048,6 +2197,10 @@ export declare namespace docs_v1 {
|
|
|
2048
2197
|
* The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.
|
|
2049
2198
|
*/
|
|
2050
2199
|
namedRangeName?: string | null;
|
|
2200
|
+
/**
|
|
2201
|
+
* Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs.
|
|
2202
|
+
*/
|
|
2203
|
+
tabsCriteria?: Schema$TabsCriteria;
|
|
2051
2204
|
/**
|
|
2052
2205
|
* Replaces the content of the specified named range(s) with the given text.
|
|
2053
2206
|
*/
|
|
@@ -2641,6 +2794,23 @@ export declare namespace docs_v1 {
|
|
|
2641
2794
|
*/
|
|
2642
2795
|
textStyleSuggestionState?: Schema$TextStyleSuggestionState;
|
|
2643
2796
|
}
|
|
2797
|
+
/**
|
|
2798
|
+
* A tab in a document.
|
|
2799
|
+
*/
|
|
2800
|
+
export interface Schema$Tab {
|
|
2801
|
+
/**
|
|
2802
|
+
* The child tabs nested within this tab.
|
|
2803
|
+
*/
|
|
2804
|
+
childTabs?: Schema$Tab[];
|
|
2805
|
+
/**
|
|
2806
|
+
* A tab with document contents, like text and images.
|
|
2807
|
+
*/
|
|
2808
|
+
documentTab?: Schema$DocumentTab;
|
|
2809
|
+
/**
|
|
2810
|
+
* The properties of the tab, like ID and title.
|
|
2811
|
+
*/
|
|
2812
|
+
tabProperties?: Schema$TabProperties;
|
|
2813
|
+
}
|
|
2644
2814
|
/**
|
|
2645
2815
|
* A StructuralElement representing a table.
|
|
2646
2816
|
*/
|
|
@@ -2962,6 +3132,40 @@ export declare namespace docs_v1 {
|
|
|
2962
3132
|
*/
|
|
2963
3133
|
tableColumnProperties?: Schema$TableColumnProperties[];
|
|
2964
3134
|
}
|
|
3135
|
+
/**
|
|
3136
|
+
* Properties of a tab.
|
|
3137
|
+
*/
|
|
3138
|
+
export interface Schema$TabProperties {
|
|
3139
|
+
/**
|
|
3140
|
+
* The zero-based index of the tab within the parent.
|
|
3141
|
+
*/
|
|
3142
|
+
index?: number | null;
|
|
3143
|
+
/**
|
|
3144
|
+
* Output only. The depth of the tab within the document. Root-level tabs start at 0.
|
|
3145
|
+
*/
|
|
3146
|
+
nestingLevel?: number | null;
|
|
3147
|
+
/**
|
|
3148
|
+
* Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.
|
|
3149
|
+
*/
|
|
3150
|
+
parentTabId?: string | null;
|
|
3151
|
+
/**
|
|
3152
|
+
* Output only. The ID of the tab. This field can't be changed.
|
|
3153
|
+
*/
|
|
3154
|
+
tabId?: string | null;
|
|
3155
|
+
/**
|
|
3156
|
+
* The user-visible name of the tab.
|
|
3157
|
+
*/
|
|
3158
|
+
title?: string | null;
|
|
3159
|
+
}
|
|
3160
|
+
/**
|
|
3161
|
+
* A criteria that specifies in which tabs a request executes.
|
|
3162
|
+
*/
|
|
3163
|
+
export interface Schema$TabsCriteria {
|
|
3164
|
+
/**
|
|
3165
|
+
* The list of tab IDs in which the request executes.
|
|
3166
|
+
*/
|
|
3167
|
+
tabIds?: string[] | null;
|
|
3168
|
+
}
|
|
2965
3169
|
/**
|
|
2966
3170
|
* A tab stop within a paragraph.
|
|
2967
3171
|
*/
|
|
@@ -3121,6 +3325,10 @@ export declare namespace docs_v1 {
|
|
|
3121
3325
|
* The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`.
|
|
3122
3326
|
*/
|
|
3123
3327
|
fields?: string | null;
|
|
3328
|
+
/**
|
|
3329
|
+
* The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.
|
|
3330
|
+
*/
|
|
3331
|
+
tabId?: string | null;
|
|
3124
3332
|
}
|
|
3125
3333
|
/**
|
|
3126
3334
|
* Update the styling of all paragraphs that overlap with the given range.
|
|
@@ -3329,6 +3537,10 @@ export declare namespace docs_v1 {
|
|
|
3329
3537
|
* The ID of the document to retrieve.
|
|
3330
3538
|
*/
|
|
3331
3539
|
documentId?: string;
|
|
3540
|
+
/**
|
|
3541
|
+
* Whether to populate the Document.tabs field instead of the text content fields like `body` and `documentStyle` on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.
|
|
3542
|
+
*/
|
|
3543
|
+
includeTabsContent?: boolean;
|
|
3332
3544
|
/**
|
|
3333
3545
|
* 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.
|
|
3334
3546
|
*/
|
package/build/v1.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"v1.js","sourceRoot":"","sources":["../v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,OAAO,
|
|
1
|
+
{"version":3,"file":"v1.js","sourceRoot":"","sources":["../v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,OAAO,CAkrHvB;AAlrHD,WAAiB,OAAO;IAgEtB;;;;;;;;;;OAUG;IACH,MAAa,IAAI;QAIf,YAAY,OAAsB,EAAE,MAA2B;YAC7D,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,IAAI,EAAE;gBACvB,MAAM;aACP,CAAC;YAEF,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;KACF;IAZY,YAAI,OAYhB,CAAA;IA0yGD,MAAa,kBAAkB;QAE7B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QAqCD,WAAW,CACT,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA0C,CAAC;YAC/C,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAA2C,CAAC;gBACrD,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,8BAA8B,CAAC;YAClE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,wCAAwC,CAAC,CAAC,OAAO,CAC/D,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,MAAM;oBACd,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,YAAY,CAAC;gBAC9B,UAAU,EAAE,CAAC,YAAY,CAAC;gBAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,IAAA,oCAAgB,EAAqC,UAAU,CAAC,CAAC;aACzE;QACH,CAAC;QAiCD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAElC,IAAI,MAAM,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAqC,CAAC;YAC1E,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAsC,CAAC;gBAChD,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,8BAA8B,CAAC;YAClE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC9D,MAAM,EAAE,MAAM;oBACd,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,EAAE;gBAClB,UAAU,EAAE,EAAE;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,IAAA,oCAAgB,EAAkB,UAAU,CAAC,CAAC;aACtD;QACH,CAAC;QAiCD,GAAG,CACD,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAElC,IAAI,MAAM,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAkC,CAAC;YACvE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAmC,CAAC;gBAC7C,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,8BAA8B,CAAC;YAClE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,4BAA4B,CAAC,CAAC,OAAO,CACnD,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,YAAY,CAAC;gBAC9B,UAAU,EAAE,CAAC,YAAY,CAAC;gBAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,IAAA,oCAAgB,EAAkB,UAAU,CAAC,CAAC;aACtD;QACH,CAAC;KACF;IA/QY,0BAAkB,qBA+Q9B,CAAA;AAkCH,CAAC,EAlrHgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAkrHvB"}
|
package/package.json
CHANGED
package/v1.ts
CHANGED
|
@@ -208,6 +208,19 @@ export namespace docs_v1 {
|
|
|
208
208
|
*/
|
|
209
209
|
content?: Schema$StructuralElement[];
|
|
210
210
|
}
|
|
211
|
+
/**
|
|
212
|
+
* A reference to a bookmark in this document.
|
|
213
|
+
*/
|
|
214
|
+
export interface Schema$BookmarkLink {
|
|
215
|
+
/**
|
|
216
|
+
* The ID of a bookmark in this document.
|
|
217
|
+
*/
|
|
218
|
+
id?: string | null;
|
|
219
|
+
/**
|
|
220
|
+
* The ID of the tab containing this bookmark.
|
|
221
|
+
*/
|
|
222
|
+
tabId?: string | null;
|
|
223
|
+
}
|
|
211
224
|
/**
|
|
212
225
|
* Describes the bullet of a paragraph.
|
|
213
226
|
*/
|
|
@@ -442,6 +455,10 @@ export namespace docs_v1 {
|
|
|
442
455
|
* 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.
|
|
443
456
|
*/
|
|
444
457
|
footerId?: string | null;
|
|
458
|
+
/**
|
|
459
|
+
* The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
460
|
+
*/
|
|
461
|
+
tabId?: string | null;
|
|
445
462
|
}
|
|
446
463
|
/**
|
|
447
464
|
* Deletes a Header from the document.
|
|
@@ -451,6 +468,10 @@ export namespace docs_v1 {
|
|
|
451
468
|
* 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.
|
|
452
469
|
*/
|
|
453
470
|
headerId?: string | null;
|
|
471
|
+
/**
|
|
472
|
+
* The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
473
|
+
*/
|
|
474
|
+
tabId?: string | null;
|
|
454
475
|
}
|
|
455
476
|
/**
|
|
456
477
|
* Deletes a NamedRange.
|
|
@@ -464,6 +485,10 @@ export namespace docs_v1 {
|
|
|
464
485
|
* The ID of the named range to delete.
|
|
465
486
|
*/
|
|
466
487
|
namedRangeId?: string | null;
|
|
488
|
+
/**
|
|
489
|
+
* Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs.
|
|
490
|
+
*/
|
|
491
|
+
tabsCriteria?: Schema$TabsCriteria;
|
|
467
492
|
}
|
|
468
493
|
/**
|
|
469
494
|
* 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.
|
|
@@ -482,6 +507,10 @@ export namespace docs_v1 {
|
|
|
482
507
|
* The ID of the positioned object to delete.
|
|
483
508
|
*/
|
|
484
509
|
objectId?: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
512
|
+
*/
|
|
513
|
+
tabId?: string | null;
|
|
485
514
|
}
|
|
486
515
|
/**
|
|
487
516
|
* Deletes a column from a table.
|
|
@@ -519,7 +548,7 @@ export namespace docs_v1 {
|
|
|
519
548
|
*/
|
|
520
549
|
export interface Schema$Document {
|
|
521
550
|
/**
|
|
522
|
-
* Output only. The main body of the document.
|
|
551
|
+
* Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
523
552
|
*/
|
|
524
553
|
body?: Schema$Body;
|
|
525
554
|
/**
|
|
@@ -527,39 +556,39 @@ export namespace docs_v1 {
|
|
|
527
556
|
*/
|
|
528
557
|
documentId?: string | null;
|
|
529
558
|
/**
|
|
530
|
-
* Output only. The style of the document.
|
|
559
|
+
* Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
531
560
|
*/
|
|
532
561
|
documentStyle?: Schema$DocumentStyle;
|
|
533
562
|
/**
|
|
534
|
-
* Output only. The footers in the document, keyed by footer ID.
|
|
563
|
+
* Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
535
564
|
*/
|
|
536
565
|
footers?: {[key: string]: Schema$Footer} | null;
|
|
537
566
|
/**
|
|
538
|
-
* Output only. The footnotes in the document, keyed by footnote ID.
|
|
567
|
+
* Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
539
568
|
*/
|
|
540
569
|
footnotes?: {[key: string]: Schema$Footnote} | null;
|
|
541
570
|
/**
|
|
542
|
-
* Output only. The headers in the document, keyed by header ID.
|
|
571
|
+
* Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
543
572
|
*/
|
|
544
573
|
headers?: {[key: string]: Schema$Header} | null;
|
|
545
574
|
/**
|
|
546
|
-
* Output only. The inline objects in the document, keyed by object ID.
|
|
575
|
+
* Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
547
576
|
*/
|
|
548
577
|
inlineObjects?: {[key: string]: Schema$InlineObject} | null;
|
|
549
578
|
/**
|
|
550
|
-
* Output only. The lists in the document, keyed by list ID.
|
|
579
|
+
* Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
551
580
|
*/
|
|
552
581
|
lists?: {[key: string]: Schema$List} | null;
|
|
553
582
|
/**
|
|
554
|
-
* Output only. The named ranges in the document, keyed by name.
|
|
583
|
+
* Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
555
584
|
*/
|
|
556
585
|
namedRanges?: {[key: string]: Schema$NamedRanges} | null;
|
|
557
586
|
/**
|
|
558
|
-
* Output only. The named styles of the document.
|
|
587
|
+
* Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
559
588
|
*/
|
|
560
589
|
namedStyles?: Schema$NamedStyles;
|
|
561
590
|
/**
|
|
562
|
-
* Output only. The positioned objects in the document, keyed by object ID.
|
|
591
|
+
* Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
563
592
|
*/
|
|
564
593
|
positionedObjects?: {[key: string]: Schema$PositionedObject} | null;
|
|
565
594
|
/**
|
|
@@ -567,13 +596,13 @@ export namespace docs_v1 {
|
|
|
567
596
|
*/
|
|
568
597
|
revisionId?: string | null;
|
|
569
598
|
/**
|
|
570
|
-
* Output only. The suggested changes to the style of the document, keyed by suggestion ID.
|
|
599
|
+
* Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
571
600
|
*/
|
|
572
601
|
suggestedDocumentStyleChanges?: {
|
|
573
602
|
[key: string]: Schema$SuggestedDocumentStyle;
|
|
574
603
|
} | null;
|
|
575
604
|
/**
|
|
576
|
-
* Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.
|
|
605
|
+
* Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.
|
|
577
606
|
*/
|
|
578
607
|
suggestedNamedStylesChanges?: {
|
|
579
608
|
[key: string]: Schema$SuggestedNamedStyles;
|
|
@@ -582,6 +611,10 @@ export namespace docs_v1 {
|
|
|
582
611
|
* 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.
|
|
583
612
|
*/
|
|
584
613
|
suggestionsViewMode?: string | null;
|
|
614
|
+
/**
|
|
615
|
+
* Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.
|
|
616
|
+
*/
|
|
617
|
+
tabs?: Schema$Tab[];
|
|
585
618
|
/**
|
|
586
619
|
* The title of the document.
|
|
587
620
|
*/
|
|
@@ -749,6 +782,63 @@ export namespace docs_v1 {
|
|
|
749
782
|
*/
|
|
750
783
|
useFirstPageHeaderFooterSuggested?: boolean | null;
|
|
751
784
|
}
|
|
785
|
+
/**
|
|
786
|
+
* A tab with document contents.
|
|
787
|
+
*/
|
|
788
|
+
export interface Schema$DocumentTab {
|
|
789
|
+
/**
|
|
790
|
+
* The main body of the document tab.
|
|
791
|
+
*/
|
|
792
|
+
body?: Schema$Body;
|
|
793
|
+
/**
|
|
794
|
+
* The style of the document tab.
|
|
795
|
+
*/
|
|
796
|
+
documentStyle?: Schema$DocumentStyle;
|
|
797
|
+
/**
|
|
798
|
+
* The footers in the document tab, keyed by footer ID.
|
|
799
|
+
*/
|
|
800
|
+
footers?: {[key: string]: Schema$Footer} | null;
|
|
801
|
+
/**
|
|
802
|
+
* The footnotes in the document tab, keyed by footnote ID.
|
|
803
|
+
*/
|
|
804
|
+
footnotes?: {[key: string]: Schema$Footnote} | null;
|
|
805
|
+
/**
|
|
806
|
+
* The headers in the document tab, keyed by header ID.
|
|
807
|
+
*/
|
|
808
|
+
headers?: {[key: string]: Schema$Header} | null;
|
|
809
|
+
/**
|
|
810
|
+
* The inline objects in the document tab, keyed by object ID.
|
|
811
|
+
*/
|
|
812
|
+
inlineObjects?: {[key: string]: Schema$InlineObject} | null;
|
|
813
|
+
/**
|
|
814
|
+
* The lists in the document tab, keyed by list ID.
|
|
815
|
+
*/
|
|
816
|
+
lists?: {[key: string]: Schema$List} | null;
|
|
817
|
+
/**
|
|
818
|
+
* The named ranges in the document tab, keyed by name.
|
|
819
|
+
*/
|
|
820
|
+
namedRanges?: {[key: string]: Schema$NamedRanges} | null;
|
|
821
|
+
/**
|
|
822
|
+
* The named styles of the document tab.
|
|
823
|
+
*/
|
|
824
|
+
namedStyles?: Schema$NamedStyles;
|
|
825
|
+
/**
|
|
826
|
+
* The positioned objects in the document tab, keyed by object ID.
|
|
827
|
+
*/
|
|
828
|
+
positionedObjects?: {[key: string]: Schema$PositionedObject} | null;
|
|
829
|
+
/**
|
|
830
|
+
* The suggested changes to the style of the document tab, keyed by suggestion ID.
|
|
831
|
+
*/
|
|
832
|
+
suggestedDocumentStyleChanges?: {
|
|
833
|
+
[key: string]: Schema$SuggestedDocumentStyle;
|
|
834
|
+
} | null;
|
|
835
|
+
/**
|
|
836
|
+
* The suggested changes to the named styles of the document tab, keyed by suggestion ID.
|
|
837
|
+
*/
|
|
838
|
+
suggestedNamedStylesChanges?: {
|
|
839
|
+
[key: string]: Schema$SuggestedNamedStyles;
|
|
840
|
+
} | null;
|
|
841
|
+
}
|
|
752
842
|
/**
|
|
753
843
|
* 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.
|
|
754
844
|
*/
|
|
@@ -905,6 +995,10 @@ export namespace docs_v1 {
|
|
|
905
995
|
* The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.
|
|
906
996
|
*/
|
|
907
997
|
segmentId?: string | null;
|
|
998
|
+
/**
|
|
999
|
+
* The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
1000
|
+
*/
|
|
1001
|
+
tabId?: string | null;
|
|
908
1002
|
}
|
|
909
1003
|
/**
|
|
910
1004
|
* A ParagraphElement representing an equation.
|
|
@@ -989,6 +1083,19 @@ export namespace docs_v1 {
|
|
|
989
1083
|
*/
|
|
990
1084
|
headerId?: string | null;
|
|
991
1085
|
}
|
|
1086
|
+
/**
|
|
1087
|
+
* A reference to a heading in this document.
|
|
1088
|
+
*/
|
|
1089
|
+
export interface Schema$HeadingLink {
|
|
1090
|
+
/**
|
|
1091
|
+
* The ID of a heading in this document.
|
|
1092
|
+
*/
|
|
1093
|
+
id?: string | null;
|
|
1094
|
+
/**
|
|
1095
|
+
* The ID of the tab containing this heading.
|
|
1096
|
+
*/
|
|
1097
|
+
tabId?: string | null;
|
|
1098
|
+
}
|
|
992
1099
|
/**
|
|
993
1100
|
* A ParagraphElement representing a horizontal line.
|
|
994
1101
|
*/
|
|
@@ -1288,13 +1395,25 @@ export namespace docs_v1 {
|
|
|
1288
1395
|
*/
|
|
1289
1396
|
export interface Schema$Link {
|
|
1290
1397
|
/**
|
|
1291
|
-
*
|
|
1398
|
+
* A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
|
|
1399
|
+
*/
|
|
1400
|
+
bookmark?: Schema$BookmarkLink;
|
|
1401
|
+
/**
|
|
1402
|
+
* The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.
|
|
1292
1403
|
*/
|
|
1293
1404
|
bookmarkId?: string | null;
|
|
1294
1405
|
/**
|
|
1295
|
-
*
|
|
1406
|
+
* A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
|
|
1407
|
+
*/
|
|
1408
|
+
heading?: Schema$HeadingLink;
|
|
1409
|
+
/**
|
|
1410
|
+
* The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.
|
|
1296
1411
|
*/
|
|
1297
1412
|
headingId?: string | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* The ID of a tab in this document.
|
|
1415
|
+
*/
|
|
1416
|
+
tabId?: string | null;
|
|
1298
1417
|
/**
|
|
1299
1418
|
* An external URL.
|
|
1300
1419
|
*/
|
|
@@ -1371,6 +1490,10 @@ export namespace docs_v1 {
|
|
|
1371
1490
|
* The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.
|
|
1372
1491
|
*/
|
|
1373
1492
|
segmentId?: string | null;
|
|
1493
|
+
/**
|
|
1494
|
+
* The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
1495
|
+
*/
|
|
1496
|
+
tabId?: string | null;
|
|
1374
1497
|
}
|
|
1375
1498
|
/**
|
|
1376
1499
|
* Merges cells in a Table.
|
|
@@ -2031,6 +2154,10 @@ export namespace docs_v1 {
|
|
|
2031
2154
|
* The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
|
|
2032
2155
|
*/
|
|
2033
2156
|
startIndex?: number | null;
|
|
2157
|
+
/**
|
|
2158
|
+
* The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
2159
|
+
*/
|
|
2160
|
+
tabId?: string | null;
|
|
2034
2161
|
}
|
|
2035
2162
|
/**
|
|
2036
2163
|
* Replaces all instances of text matching a criteria with replace text.
|
|
@@ -2044,6 +2171,10 @@ export namespace docs_v1 {
|
|
|
2044
2171
|
* The text that will replace the matched text.
|
|
2045
2172
|
*/
|
|
2046
2173
|
replaceText?: string | null;
|
|
2174
|
+
/**
|
|
2175
|
+
* Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs.
|
|
2176
|
+
*/
|
|
2177
|
+
tabsCriteria?: Schema$TabsCriteria;
|
|
2047
2178
|
}
|
|
2048
2179
|
/**
|
|
2049
2180
|
* The result of replacing text.
|
|
@@ -2066,6 +2197,10 @@ export namespace docs_v1 {
|
|
|
2066
2197
|
* The replacement method.
|
|
2067
2198
|
*/
|
|
2068
2199
|
imageReplaceMethod?: string | null;
|
|
2200
|
+
/**
|
|
2201
|
+
* The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
|
|
2202
|
+
*/
|
|
2203
|
+
tabId?: string | null;
|
|
2069
2204
|
/**
|
|
2070
2205
|
* The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.
|
|
2071
2206
|
*/
|
|
@@ -2083,6 +2218,10 @@ export namespace docs_v1 {
|
|
|
2083
2218
|
* The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.
|
|
2084
2219
|
*/
|
|
2085
2220
|
namedRangeName?: string | null;
|
|
2221
|
+
/**
|
|
2222
|
+
* Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs.
|
|
2223
|
+
*/
|
|
2224
|
+
tabsCriteria?: Schema$TabsCriteria;
|
|
2086
2225
|
/**
|
|
2087
2226
|
* Replaces the content of the specified named range(s) with the given text.
|
|
2088
2227
|
*/
|
|
@@ -2676,6 +2815,23 @@ export namespace docs_v1 {
|
|
|
2676
2815
|
*/
|
|
2677
2816
|
textStyleSuggestionState?: Schema$TextStyleSuggestionState;
|
|
2678
2817
|
}
|
|
2818
|
+
/**
|
|
2819
|
+
* A tab in a document.
|
|
2820
|
+
*/
|
|
2821
|
+
export interface Schema$Tab {
|
|
2822
|
+
/**
|
|
2823
|
+
* The child tabs nested within this tab.
|
|
2824
|
+
*/
|
|
2825
|
+
childTabs?: Schema$Tab[];
|
|
2826
|
+
/**
|
|
2827
|
+
* A tab with document contents, like text and images.
|
|
2828
|
+
*/
|
|
2829
|
+
documentTab?: Schema$DocumentTab;
|
|
2830
|
+
/**
|
|
2831
|
+
* The properties of the tab, like ID and title.
|
|
2832
|
+
*/
|
|
2833
|
+
tabProperties?: Schema$TabProperties;
|
|
2834
|
+
}
|
|
2679
2835
|
/**
|
|
2680
2836
|
* A StructuralElement representing a table.
|
|
2681
2837
|
*/
|
|
@@ -2997,6 +3153,40 @@ export namespace docs_v1 {
|
|
|
2997
3153
|
*/
|
|
2998
3154
|
tableColumnProperties?: Schema$TableColumnProperties[];
|
|
2999
3155
|
}
|
|
3156
|
+
/**
|
|
3157
|
+
* Properties of a tab.
|
|
3158
|
+
*/
|
|
3159
|
+
export interface Schema$TabProperties {
|
|
3160
|
+
/**
|
|
3161
|
+
* The zero-based index of the tab within the parent.
|
|
3162
|
+
*/
|
|
3163
|
+
index?: number | null;
|
|
3164
|
+
/**
|
|
3165
|
+
* Output only. The depth of the tab within the document. Root-level tabs start at 0.
|
|
3166
|
+
*/
|
|
3167
|
+
nestingLevel?: number | null;
|
|
3168
|
+
/**
|
|
3169
|
+
* Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.
|
|
3170
|
+
*/
|
|
3171
|
+
parentTabId?: string | null;
|
|
3172
|
+
/**
|
|
3173
|
+
* Output only. The ID of the tab. This field can't be changed.
|
|
3174
|
+
*/
|
|
3175
|
+
tabId?: string | null;
|
|
3176
|
+
/**
|
|
3177
|
+
* The user-visible name of the tab.
|
|
3178
|
+
*/
|
|
3179
|
+
title?: string | null;
|
|
3180
|
+
}
|
|
3181
|
+
/**
|
|
3182
|
+
* A criteria that specifies in which tabs a request executes.
|
|
3183
|
+
*/
|
|
3184
|
+
export interface Schema$TabsCriteria {
|
|
3185
|
+
/**
|
|
3186
|
+
* The list of tab IDs in which the request executes.
|
|
3187
|
+
*/
|
|
3188
|
+
tabIds?: string[] | null;
|
|
3189
|
+
}
|
|
3000
3190
|
/**
|
|
3001
3191
|
* A tab stop within a paragraph.
|
|
3002
3192
|
*/
|
|
@@ -3156,6 +3346,10 @@ export namespace docs_v1 {
|
|
|
3156
3346
|
* The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`.
|
|
3157
3347
|
*/
|
|
3158
3348
|
fields?: string | null;
|
|
3349
|
+
/**
|
|
3350
|
+
* The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.
|
|
3351
|
+
*/
|
|
3352
|
+
tabId?: string | null;
|
|
3159
3353
|
}
|
|
3160
3354
|
/**
|
|
3161
3355
|
* Update the styling of all paragraphs that overlap with the given range.
|
|
@@ -3594,6 +3788,10 @@ export namespace docs_v1 {
|
|
|
3594
3788
|
* The ID of the document to retrieve.
|
|
3595
3789
|
*/
|
|
3596
3790
|
documentId?: string;
|
|
3791
|
+
/**
|
|
3792
|
+
* Whether to populate the Document.tabs field instead of the text content fields like `body` and `documentStyle` on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.
|
|
3793
|
+
*/
|
|
3794
|
+
includeTabsContent?: boolean;
|
|
3597
3795
|
/**
|
|
3598
3796
|
* 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.
|
|
3599
3797
|
*/
|