@maxim_mazurok/gapi.client.sheets-v4 0.2.20260311 → 0.2.20260601
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/index.d.ts +610 -163
- package/package.json +1 -1
- package/readme.md +12 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://sheets.googleapis.com/$discovery/rest?version=v4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260601
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -124,7 +124,7 @@ declare namespace gapi.client {
|
|
|
124
124
|
}
|
|
125
125
|
interface AppendDimensionRequest {
|
|
126
126
|
/** Whether rows or columns should be appended. */
|
|
127
|
-
dimension?:
|
|
127
|
+
dimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
128
128
|
/** The number of rows or columns to append. */
|
|
129
129
|
length?: number;
|
|
130
130
|
/** The sheet to append rows or columns to. */
|
|
@@ -184,7 +184,10 @@ declare namespace gapi.client {
|
|
|
184
184
|
}
|
|
185
185
|
interface BaselineValueFormat {
|
|
186
186
|
/** The comparison type of key value with baseline value. */
|
|
187
|
-
comparisonType?:
|
|
187
|
+
comparisonType?:
|
|
188
|
+
| 'COMPARISON_TYPE_UNDEFINED'
|
|
189
|
+
| 'ABSOLUTE_DIFFERENCE'
|
|
190
|
+
| 'PERCENTAGE_DIFFERENCE';
|
|
188
191
|
/** Description which is appended after the baseline value. This field is optional. */
|
|
189
192
|
description?: string;
|
|
190
193
|
/** Color to be used, in case baseline value represents a negative change for key value. This field is optional. Deprecated: Use negative_color_style. */
|
|
@@ -204,7 +207,11 @@ declare namespace gapi.client {
|
|
|
204
207
|
/** The format of the title. Only valid if the axis is not associated with the domain. The link field is not supported. */
|
|
205
208
|
format?: TextFormat;
|
|
206
209
|
/** The position of this axis. */
|
|
207
|
-
position?:
|
|
210
|
+
position?:
|
|
211
|
+
| 'BASIC_CHART_AXIS_POSITION_UNSPECIFIED'
|
|
212
|
+
| 'BOTTOM_AXIS'
|
|
213
|
+
| 'LEFT_AXIS'
|
|
214
|
+
| 'RIGHT_AXIS';
|
|
208
215
|
/** The title of this axis. If set, this overrides any title inferred from headers of the data. */
|
|
209
216
|
title?: string;
|
|
210
217
|
/** The axis title text position. */
|
|
@@ -234,17 +241,40 @@ declare namespace gapi.client {
|
|
|
234
241
|
/** Style override settings for series data points. */
|
|
235
242
|
styleOverrides?: BasicSeriesDataPointStyleOverride[];
|
|
236
243
|
/** The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. */
|
|
237
|
-
targetAxis?:
|
|
244
|
+
targetAxis?:
|
|
245
|
+
| 'BASIC_CHART_AXIS_POSITION_UNSPECIFIED'
|
|
246
|
+
| 'BOTTOM_AXIS'
|
|
247
|
+
| 'LEFT_AXIS'
|
|
248
|
+
| 'RIGHT_AXIS';
|
|
238
249
|
/** The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. */
|
|
239
|
-
type?:
|
|
250
|
+
type?:
|
|
251
|
+
| 'BASIC_CHART_TYPE_UNSPECIFIED'
|
|
252
|
+
| 'BAR'
|
|
253
|
+
| 'LINE'
|
|
254
|
+
| 'AREA'
|
|
255
|
+
| 'COLUMN'
|
|
256
|
+
| 'SCATTER'
|
|
257
|
+
| 'COMBO'
|
|
258
|
+
| 'STEPPED_AREA';
|
|
240
259
|
}
|
|
241
260
|
interface BasicChartSpec {
|
|
242
261
|
/** The axis on the chart. */
|
|
243
262
|
axis?: BasicChartAxis[];
|
|
244
263
|
/** The type of the chart. */
|
|
245
|
-
chartType?:
|
|
264
|
+
chartType?:
|
|
265
|
+
| 'BASIC_CHART_TYPE_UNSPECIFIED'
|
|
266
|
+
| 'BAR'
|
|
267
|
+
| 'LINE'
|
|
268
|
+
| 'AREA'
|
|
269
|
+
| 'COLUMN'
|
|
270
|
+
| 'SCATTER'
|
|
271
|
+
| 'COMBO'
|
|
272
|
+
| 'STEPPED_AREA';
|
|
246
273
|
/** The behavior of tooltips and data highlighting when hovering on data and chart area. */
|
|
247
|
-
compareMode?:
|
|
274
|
+
compareMode?:
|
|
275
|
+
| 'BASIC_CHART_COMPARE_MODE_UNSPECIFIED'
|
|
276
|
+
| 'DATUM'
|
|
277
|
+
| 'CATEGORY';
|
|
248
278
|
/** The domain of data this is charting. Only a single domain is supported. */
|
|
249
279
|
domains?: BasicChartDomain[];
|
|
250
280
|
/** The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) */
|
|
@@ -252,13 +282,23 @@ declare namespace gapi.client {
|
|
|
252
282
|
/** If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. */
|
|
253
283
|
interpolateNulls?: boolean;
|
|
254
284
|
/** The position of the chart legend. */
|
|
255
|
-
legendPosition?:
|
|
285
|
+
legendPosition?:
|
|
286
|
+
| 'BASIC_CHART_LEGEND_POSITION_UNSPECIFIED'
|
|
287
|
+
| 'BOTTOM_LEGEND'
|
|
288
|
+
| 'LEFT_LEGEND'
|
|
289
|
+
| 'RIGHT_LEGEND'
|
|
290
|
+
| 'TOP_LEGEND'
|
|
291
|
+
| 'NO_LEGEND';
|
|
256
292
|
/** Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. */
|
|
257
293
|
lineSmoothing?: boolean;
|
|
258
294
|
/** The data this chart is visualizing. */
|
|
259
295
|
series?: BasicChartSeries[];
|
|
260
296
|
/** The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. */
|
|
261
|
-
stackedType?:
|
|
297
|
+
stackedType?:
|
|
298
|
+
| 'BASIC_CHART_STACKED_TYPE_UNSPECIFIED'
|
|
299
|
+
| 'NOT_STACKED'
|
|
300
|
+
| 'STACKED'
|
|
301
|
+
| 'PERCENT_STACKED';
|
|
262
302
|
/** True to make the chart 3D. Applies to Bar and Column charts. */
|
|
263
303
|
threeDimensional?: boolean;
|
|
264
304
|
/** Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. These data labels can only be set when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA and stacked_type is either STACKED or PERCENT_STACKED. In addition, for COMBO, this will only be supported if there is only one type of stackable series type or one type has more series than the others and each of the other types have no more than one series. For example, if a chart has two stacked bar series and one area series, the total data labels will be supported. If it has three bar series and two area series, total data labels are not allowed. Neither CUSTOM nor placement can be set on the total_data_label. */
|
|
@@ -310,11 +350,11 @@ declare namespace gapi.client {
|
|
|
310
350
|
/** The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response. */
|
|
311
351
|
dataFilters?: DataFilter[];
|
|
312
352
|
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
313
|
-
dateTimeRenderOption?:
|
|
353
|
+
dateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
314
354
|
/** The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
315
|
-
majorDimension?:
|
|
355
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
316
356
|
/** How values should be represented in the output. The default render option is FORMATTED_VALUE. */
|
|
317
|
-
valueRenderOption?:
|
|
357
|
+
valueRenderOption?: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
318
358
|
}
|
|
319
359
|
interface BatchGetValuesByDataFilterResponse {
|
|
320
360
|
/** The ID of the spreadsheet the data was retrieved from. */
|
|
@@ -352,11 +392,17 @@ declare namespace gapi.client {
|
|
|
352
392
|
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
353
393
|
includeValuesInResponse?: boolean;
|
|
354
394
|
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
355
|
-
responseDateTimeRenderOption?:
|
|
395
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
356
396
|
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
357
|
-
responseValueRenderOption?:
|
|
397
|
+
responseValueRenderOption?:
|
|
398
|
+
| 'FORMATTED_VALUE'
|
|
399
|
+
| 'UNFORMATTED_VALUE'
|
|
400
|
+
| 'FORMULA';
|
|
358
401
|
/** How the input data should be interpreted. */
|
|
359
|
-
valueInputOption?:
|
|
402
|
+
valueInputOption?:
|
|
403
|
+
| 'INPUT_VALUE_OPTION_UNSPECIFIED'
|
|
404
|
+
| 'RAW'
|
|
405
|
+
| 'USER_ENTERED';
|
|
360
406
|
}
|
|
361
407
|
interface BatchUpdateValuesByDataFilterResponse {
|
|
362
408
|
/** The response for each range updated. */
|
|
@@ -378,11 +424,17 @@ declare namespace gapi.client {
|
|
|
378
424
|
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
379
425
|
includeValuesInResponse?: boolean;
|
|
380
426
|
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
381
|
-
responseDateTimeRenderOption?:
|
|
427
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
382
428
|
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
383
|
-
responseValueRenderOption?:
|
|
429
|
+
responseValueRenderOption?:
|
|
430
|
+
| 'FORMATTED_VALUE'
|
|
431
|
+
| 'UNFORMATTED_VALUE'
|
|
432
|
+
| 'FORMULA';
|
|
384
433
|
/** How the input data should be interpreted. */
|
|
385
|
-
valueInputOption?:
|
|
434
|
+
valueInputOption?:
|
|
435
|
+
| 'INPUT_VALUE_OPTION_UNSPECIFIED'
|
|
436
|
+
| 'RAW'
|
|
437
|
+
| 'USER_ENTERED';
|
|
386
438
|
}
|
|
387
439
|
interface BatchUpdateValuesResponse {
|
|
388
440
|
/** One UpdateValuesResponse per requested range, in the same order as the requests appeared. */
|
|
@@ -420,7 +472,40 @@ declare namespace gapi.client {
|
|
|
420
472
|
}
|
|
421
473
|
interface BooleanCondition {
|
|
422
474
|
/** The type of condition. */
|
|
423
|
-
type?:
|
|
475
|
+
type?:
|
|
476
|
+
| 'CONDITION_TYPE_UNSPECIFIED'
|
|
477
|
+
| 'NUMBER_GREATER'
|
|
478
|
+
| 'NUMBER_GREATER_THAN_EQ'
|
|
479
|
+
| 'NUMBER_LESS'
|
|
480
|
+
| 'NUMBER_LESS_THAN_EQ'
|
|
481
|
+
| 'NUMBER_EQ'
|
|
482
|
+
| 'NUMBER_NOT_EQ'
|
|
483
|
+
| 'NUMBER_BETWEEN'
|
|
484
|
+
| 'NUMBER_NOT_BETWEEN'
|
|
485
|
+
| 'TEXT_CONTAINS'
|
|
486
|
+
| 'TEXT_NOT_CONTAINS'
|
|
487
|
+
| 'TEXT_STARTS_WITH'
|
|
488
|
+
| 'TEXT_ENDS_WITH'
|
|
489
|
+
| 'TEXT_EQ'
|
|
490
|
+
| 'TEXT_IS_EMAIL'
|
|
491
|
+
| 'TEXT_IS_URL'
|
|
492
|
+
| 'DATE_EQ'
|
|
493
|
+
| 'DATE_BEFORE'
|
|
494
|
+
| 'DATE_AFTER'
|
|
495
|
+
| 'DATE_ON_OR_BEFORE'
|
|
496
|
+
| 'DATE_ON_OR_AFTER'
|
|
497
|
+
| 'DATE_BETWEEN'
|
|
498
|
+
| 'DATE_NOT_BETWEEN'
|
|
499
|
+
| 'DATE_IS_VALID'
|
|
500
|
+
| 'ONE_OF_RANGE'
|
|
501
|
+
| 'ONE_OF_LIST'
|
|
502
|
+
| 'BLANK'
|
|
503
|
+
| 'NOT_BLANK'
|
|
504
|
+
| 'CUSTOM_FORMULA'
|
|
505
|
+
| 'BOOLEAN'
|
|
506
|
+
| 'TEXT_NOT_EQ'
|
|
507
|
+
| 'DATE_NOT_EQ'
|
|
508
|
+
| 'FILTER_EXPRESSION';
|
|
424
509
|
/** The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values. */
|
|
425
510
|
values?: ConditionValue[];
|
|
426
511
|
}
|
|
@@ -436,7 +521,15 @@ declare namespace gapi.client {
|
|
|
436
521
|
/** The color of the border. If color is also set, this field takes precedence. */
|
|
437
522
|
colorStyle?: ColorStyle;
|
|
438
523
|
/** The style of the border. */
|
|
439
|
-
style?:
|
|
524
|
+
style?:
|
|
525
|
+
| 'STYLE_UNSPECIFIED'
|
|
526
|
+
| 'DOTTED'
|
|
527
|
+
| 'DASHED'
|
|
528
|
+
| 'SOLID'
|
|
529
|
+
| 'SOLID_MEDIUM'
|
|
530
|
+
| 'SOLID_THICK'
|
|
531
|
+
| 'NONE'
|
|
532
|
+
| 'DOUBLE';
|
|
440
533
|
/** The width of the border, in pixels. Deprecated; the width is determined by the "style" field. */
|
|
441
534
|
width?: number;
|
|
442
535
|
}
|
|
@@ -472,7 +565,14 @@ declare namespace gapi.client {
|
|
|
472
565
|
/** The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubble_sizes is specified then this field must also be specified but may contain blank values. This field is optional. */
|
|
473
566
|
groupIds?: ChartData;
|
|
474
567
|
/** Where the legend of the chart should be drawn. */
|
|
475
|
-
legendPosition?:
|
|
568
|
+
legendPosition?:
|
|
569
|
+
| 'BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED'
|
|
570
|
+
| 'BOTTOM_LEGEND'
|
|
571
|
+
| 'LEFT_LEGEND'
|
|
572
|
+
| 'RIGHT_LEGEND'
|
|
573
|
+
| 'TOP_LEGEND'
|
|
574
|
+
| 'NO_LEGEND'
|
|
575
|
+
| 'INSIDE_LEGEND';
|
|
476
576
|
/** The data containing the bubble y-values. These values locate the bubbles in the chart vertically. */
|
|
477
577
|
series?: ChartData;
|
|
478
578
|
}
|
|
@@ -556,23 +656,42 @@ declare namespace gapi.client {
|
|
|
556
656
|
/** The borders of the cell. */
|
|
557
657
|
borders?: Borders;
|
|
558
658
|
/** The horizontal alignment of the value in the cell. */
|
|
559
|
-
horizontalAlignment?:
|
|
659
|
+
horizontalAlignment?:
|
|
660
|
+
| 'HORIZONTAL_ALIGN_UNSPECIFIED'
|
|
661
|
+
| 'LEFT'
|
|
662
|
+
| 'CENTER'
|
|
663
|
+
| 'RIGHT';
|
|
560
664
|
/** If one exists, how a hyperlink should be displayed in the cell. */
|
|
561
|
-
hyperlinkDisplayType?:
|
|
665
|
+
hyperlinkDisplayType?:
|
|
666
|
+
| 'HYPERLINK_DISPLAY_TYPE_UNSPECIFIED'
|
|
667
|
+
| 'LINKED'
|
|
668
|
+
| 'PLAIN_TEXT';
|
|
562
669
|
/** A format describing how number values should be represented to the user. */
|
|
563
670
|
numberFormat?: NumberFormat;
|
|
564
671
|
/** The padding of the cell. */
|
|
565
672
|
padding?: Padding;
|
|
566
673
|
/** The direction of the text in the cell. */
|
|
567
|
-
textDirection?:
|
|
674
|
+
textDirection?:
|
|
675
|
+
| 'TEXT_DIRECTION_UNSPECIFIED'
|
|
676
|
+
| 'LEFT_TO_RIGHT'
|
|
677
|
+
| 'RIGHT_TO_LEFT';
|
|
568
678
|
/** The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link. */
|
|
569
679
|
textFormat?: TextFormat;
|
|
570
680
|
/** The rotation applied to text in the cell. */
|
|
571
681
|
textRotation?: TextRotation;
|
|
572
682
|
/** The vertical alignment of the value in the cell. */
|
|
573
|
-
verticalAlignment?:
|
|
683
|
+
verticalAlignment?:
|
|
684
|
+
| 'VERTICAL_ALIGN_UNSPECIFIED'
|
|
685
|
+
| 'TOP'
|
|
686
|
+
| 'MIDDLE'
|
|
687
|
+
| 'BOTTOM';
|
|
574
688
|
/** The wrap strategy for the value in the cell. */
|
|
575
|
-
wrapStrategy?:
|
|
689
|
+
wrapStrategy?:
|
|
690
|
+
| 'WRAP_STRATEGY_UNSPECIFIED'
|
|
691
|
+
| 'OVERFLOW_CELL'
|
|
692
|
+
| 'LEGACY_WRAP'
|
|
693
|
+
| 'CLIP'
|
|
694
|
+
| 'WRAP';
|
|
576
695
|
}
|
|
577
696
|
interface ChartAxisViewWindowOptions {
|
|
578
697
|
/** The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data. */
|
|
@@ -580,7 +699,11 @@ declare namespace gapi.client {
|
|
|
580
699
|
/** The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data. */
|
|
581
700
|
viewWindowMin?: number;
|
|
582
701
|
/** The view window's mode. */
|
|
583
|
-
viewWindowMode?:
|
|
702
|
+
viewWindowMode?:
|
|
703
|
+
| 'DEFAULT_VIEW_WINDOW_MODE'
|
|
704
|
+
| 'VIEW_WINDOW_MODE_UNSUPPORTED'
|
|
705
|
+
| 'EXPLICIT'
|
|
706
|
+
| 'PRETTY';
|
|
584
707
|
}
|
|
585
708
|
interface ChartCustomNumberFormatOptions {
|
|
586
709
|
/** Custom prefix to be prepended to the chart attribute. This field is optional. */
|
|
@@ -590,7 +713,14 @@ declare namespace gapi.client {
|
|
|
590
713
|
}
|
|
591
714
|
interface ChartData {
|
|
592
715
|
/** The aggregation type for the series of a data source chart. Only supported for data source charts. */
|
|
593
|
-
aggregateType?:
|
|
716
|
+
aggregateType?:
|
|
717
|
+
| 'CHART_AGGREGATE_TYPE_UNSPECIFIED'
|
|
718
|
+
| 'AVERAGE'
|
|
719
|
+
| 'COUNT'
|
|
720
|
+
| 'MAX'
|
|
721
|
+
| 'MEDIAN'
|
|
722
|
+
| 'MIN'
|
|
723
|
+
| 'SUM';
|
|
594
724
|
/** The reference to the data source column that the data reads from. */
|
|
595
725
|
columnReference?: DataSourceColumnReference;
|
|
596
726
|
/** The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts. */
|
|
@@ -600,7 +730,23 @@ declare namespace gapi.client {
|
|
|
600
730
|
}
|
|
601
731
|
interface ChartDateTimeRule {
|
|
602
732
|
/** The type of date-time grouping to apply. */
|
|
603
|
-
type?:
|
|
733
|
+
type?:
|
|
734
|
+
| 'CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED'
|
|
735
|
+
| 'SECOND'
|
|
736
|
+
| 'MINUTE'
|
|
737
|
+
| 'HOUR'
|
|
738
|
+
| 'HOUR_MINUTE'
|
|
739
|
+
| 'HOUR_MINUTE_AMPM'
|
|
740
|
+
| 'DAY_OF_WEEK'
|
|
741
|
+
| 'DAY_OF_YEAR'
|
|
742
|
+
| 'DAY_OF_MONTH'
|
|
743
|
+
| 'DAY_MONTH'
|
|
744
|
+
| 'MONTH'
|
|
745
|
+
| 'QUARTER'
|
|
746
|
+
| 'YEAR'
|
|
747
|
+
| 'YEAR_MONTH'
|
|
748
|
+
| 'YEAR_QUARTER'
|
|
749
|
+
| 'YEAR_MONTH_DAY';
|
|
604
750
|
}
|
|
605
751
|
interface ChartGroupRule {
|
|
606
752
|
/** A ChartDateTimeRule. */
|
|
@@ -640,7 +786,12 @@ declare namespace gapi.client {
|
|
|
640
786
|
/** The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name. */
|
|
641
787
|
fontName?: string;
|
|
642
788
|
/** Determines how the charts will use hidden rows or columns. */
|
|
643
|
-
hiddenDimensionStrategy?:
|
|
789
|
+
hiddenDimensionStrategy?:
|
|
790
|
+
| 'CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED'
|
|
791
|
+
| 'SKIP_HIDDEN_ROWS_AND_COLUMNS'
|
|
792
|
+
| 'SKIP_HIDDEN_ROWS'
|
|
793
|
+
| 'SKIP_HIDDEN_COLUMNS'
|
|
794
|
+
| 'SHOW_ALL';
|
|
644
795
|
/** A histogram chart specification. */
|
|
645
796
|
histogramChart?: HistogramChartSpec;
|
|
646
797
|
/** True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.) */
|
|
@@ -707,7 +858,17 @@ declare namespace gapi.client {
|
|
|
707
858
|
/** RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported. */
|
|
708
859
|
rgbColor?: Color;
|
|
709
860
|
/** Theme color. */
|
|
710
|
-
themeColor?:
|
|
861
|
+
themeColor?:
|
|
862
|
+
| 'THEME_COLOR_TYPE_UNSPECIFIED'
|
|
863
|
+
| 'TEXT'
|
|
864
|
+
| 'BACKGROUND'
|
|
865
|
+
| 'ACCENT1'
|
|
866
|
+
| 'ACCENT2'
|
|
867
|
+
| 'ACCENT3'
|
|
868
|
+
| 'ACCENT4'
|
|
869
|
+
| 'ACCENT5'
|
|
870
|
+
| 'ACCENT6'
|
|
871
|
+
| 'LINK';
|
|
711
872
|
}
|
|
712
873
|
interface ConditionalFormatRule {
|
|
713
874
|
/** The formatting is either "on" or "off" according to the rule. */
|
|
@@ -719,7 +880,14 @@ declare namespace gapi.client {
|
|
|
719
880
|
}
|
|
720
881
|
interface ConditionValue {
|
|
721
882
|
/** A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters. */
|
|
722
|
-
relativeDate?:
|
|
883
|
+
relativeDate?:
|
|
884
|
+
| 'RELATIVE_DATE_UNSPECIFIED'
|
|
885
|
+
| 'PAST_YEAR'
|
|
886
|
+
| 'PAST_MONTH'
|
|
887
|
+
| 'PAST_WEEK'
|
|
888
|
+
| 'YESTERDAY'
|
|
889
|
+
| 'TODAY'
|
|
890
|
+
| 'TOMORROW';
|
|
723
891
|
/** A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+'). */
|
|
724
892
|
userEnteredValue?: string;
|
|
725
893
|
}
|
|
@@ -727,9 +895,16 @@ declare namespace gapi.client {
|
|
|
727
895
|
/** The location to paste to. If the range covers a span that's a multiple of the source's height or width, then the data will be repeated to fill in the destination range. If the range is smaller than the source range, the entire source data will still be copied (beyond the end of the destination range). */
|
|
728
896
|
destination?: GridRange;
|
|
729
897
|
/** How that data should be oriented when pasting. */
|
|
730
|
-
pasteOrientation?:
|
|
898
|
+
pasteOrientation?: 'NORMAL' | 'TRANSPOSE';
|
|
731
899
|
/** What kind of data to paste. */
|
|
732
|
-
pasteType?:
|
|
900
|
+
pasteType?:
|
|
901
|
+
| 'PASTE_NORMAL'
|
|
902
|
+
| 'PASTE_VALUES'
|
|
903
|
+
| 'PASTE_FORMAT'
|
|
904
|
+
| 'PASTE_NO_BORDERS'
|
|
905
|
+
| 'PASTE_FORMULA'
|
|
906
|
+
| 'PASTE_DATA_VALIDATION'
|
|
907
|
+
| 'PASTE_CONDITIONAL_FORMATTING';
|
|
733
908
|
/** The source range to copy. */
|
|
734
909
|
source?: GridRange;
|
|
735
910
|
}
|
|
@@ -749,19 +924,52 @@ declare namespace gapi.client {
|
|
|
749
924
|
/** The top-left coordinate where the data should be pasted. */
|
|
750
925
|
destination?: GridCoordinate;
|
|
751
926
|
/** What kind of data to paste. All the source data will be cut, regardless of what is pasted. */
|
|
752
|
-
pasteType?:
|
|
927
|
+
pasteType?:
|
|
928
|
+
| 'PASTE_NORMAL'
|
|
929
|
+
| 'PASTE_VALUES'
|
|
930
|
+
| 'PASTE_FORMAT'
|
|
931
|
+
| 'PASTE_NO_BORDERS'
|
|
932
|
+
| 'PASTE_FORMULA'
|
|
933
|
+
| 'PASTE_DATA_VALIDATION'
|
|
934
|
+
| 'PASTE_CONDITIONAL_FORMATTING';
|
|
753
935
|
/** The source data to cut. */
|
|
754
936
|
source?: GridRange;
|
|
755
937
|
}
|
|
756
938
|
interface DataExecutionStatus {
|
|
757
939
|
/** The error code. */
|
|
758
|
-
errorCode?:
|
|
940
|
+
errorCode?:
|
|
941
|
+
| 'DATA_EXECUTION_ERROR_CODE_UNSPECIFIED'
|
|
942
|
+
| 'TIMED_OUT'
|
|
943
|
+
| 'TOO_MANY_ROWS'
|
|
944
|
+
| 'TOO_MANY_COLUMNS'
|
|
945
|
+
| 'TOO_MANY_CELLS'
|
|
946
|
+
| 'ENGINE'
|
|
947
|
+
| 'PARAMETER_INVALID'
|
|
948
|
+
| 'UNSUPPORTED_DATA_TYPE'
|
|
949
|
+
| 'DUPLICATE_COLUMN_NAMES'
|
|
950
|
+
| 'INTERRUPTED'
|
|
951
|
+
| 'CONCURRENT_QUERY'
|
|
952
|
+
| 'OTHER'
|
|
953
|
+
| 'TOO_MANY_CHARS_PER_CELL'
|
|
954
|
+
| 'DATA_NOT_FOUND'
|
|
955
|
+
| 'PERMISSION_DENIED'
|
|
956
|
+
| 'MISSING_COLUMN_ALIAS'
|
|
957
|
+
| 'OBJECT_NOT_FOUND'
|
|
958
|
+
| 'OBJECT_IN_ERROR_STATE'
|
|
959
|
+
| 'OBJECT_SPEC_INVALID'
|
|
960
|
+
| 'DATA_EXECUTION_CANCELLED';
|
|
759
961
|
/** The error message, which may be empty. */
|
|
760
962
|
errorMessage?: string;
|
|
761
963
|
/** Gets the time the data last successfully refreshed. */
|
|
762
964
|
lastRefreshTime?: string;
|
|
763
965
|
/** The state of the data execution. */
|
|
764
|
-
state?:
|
|
966
|
+
state?:
|
|
967
|
+
| 'DATA_EXECUTION_STATE_UNSPECIFIED'
|
|
968
|
+
| 'NOT_STARTED'
|
|
969
|
+
| 'RUNNING'
|
|
970
|
+
| 'CANCELLING'
|
|
971
|
+
| 'SUCCEEDED'
|
|
972
|
+
| 'FAILED';
|
|
765
973
|
}
|
|
766
974
|
interface DataFilter {
|
|
767
975
|
/** Selects data that matches the specified A1 range. */
|
|
@@ -775,7 +983,7 @@ declare namespace gapi.client {
|
|
|
775
983
|
/** The data filter describing the location of the values in the spreadsheet. */
|
|
776
984
|
dataFilter?: DataFilter;
|
|
777
985
|
/** The major dimension of the values. */
|
|
778
|
-
majorDimension?:
|
|
986
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
779
987
|
/** The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected. */
|
|
780
988
|
values?: any[][];
|
|
781
989
|
}
|
|
@@ -783,11 +991,20 @@ declare namespace gapi.client {
|
|
|
783
991
|
/** Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from the next column in the source data. For example, if the series is B2:B4,E6:E8 then this data must come from C2:C4,F6:F8. */
|
|
784
992
|
customLabelData?: ChartData;
|
|
785
993
|
/** The placement of the data label relative to the labeled data. */
|
|
786
|
-
placement?:
|
|
994
|
+
placement?:
|
|
995
|
+
| 'DATA_LABEL_PLACEMENT_UNSPECIFIED'
|
|
996
|
+
| 'CENTER'
|
|
997
|
+
| 'LEFT'
|
|
998
|
+
| 'RIGHT'
|
|
999
|
+
| 'ABOVE'
|
|
1000
|
+
| 'BELOW'
|
|
1001
|
+
| 'INSIDE_END'
|
|
1002
|
+
| 'INSIDE_BASE'
|
|
1003
|
+
| 'OUTSIDE_END';
|
|
787
1004
|
/** The text format used for the data label. The link field is not supported. */
|
|
788
1005
|
textFormat?: TextFormat;
|
|
789
1006
|
/** The type of the data label. */
|
|
790
|
-
type?:
|
|
1007
|
+
type?: 'DATA_LABEL_TYPE_UNSPECIFIED' | 'NONE' | 'DATA' | 'CUSTOM';
|
|
791
1008
|
}
|
|
792
1009
|
interface DataSource {
|
|
793
1010
|
/** All calculated columns in the data source. */
|
|
@@ -865,13 +1082,23 @@ declare namespace gapi.client {
|
|
|
865
1082
|
/** Output only. The time interval of the next run. */
|
|
866
1083
|
nextRun?: Interval;
|
|
867
1084
|
/** The scope of the refresh. Must be ALL_DATA_SOURCES. */
|
|
868
|
-
refreshScope?:
|
|
1085
|
+
refreshScope?:
|
|
1086
|
+
| 'DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED'
|
|
1087
|
+
| 'ALL_DATA_SOURCES';
|
|
869
1088
|
/** Weekly refresh schedule. */
|
|
870
1089
|
weeklySchedule?: DataSourceRefreshWeeklySchedule;
|
|
871
1090
|
}
|
|
872
1091
|
interface DataSourceRefreshWeeklySchedule {
|
|
873
1092
|
/** Days of the week to refresh. At least one day must be specified. */
|
|
874
|
-
daysOfWeek?:
|
|
1093
|
+
daysOfWeek?:
|
|
1094
|
+
| 'DAY_OF_WEEK_UNSPECIFIED'
|
|
1095
|
+
| 'MONDAY'
|
|
1096
|
+
| 'TUESDAY'
|
|
1097
|
+
| 'WEDNESDAY'
|
|
1098
|
+
| 'THURSDAY'
|
|
1099
|
+
| 'FRIDAY'
|
|
1100
|
+
| 'SATURDAY'
|
|
1101
|
+
| 'SUNDAY'[];
|
|
875
1102
|
/** The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. */
|
|
876
1103
|
startTime?: TimeOfDay;
|
|
877
1104
|
}
|
|
@@ -901,7 +1128,10 @@ declare namespace gapi.client {
|
|
|
901
1128
|
/** Columns selected for the data source table. The column_selection_type must be SELECTED. */
|
|
902
1129
|
columns?: DataSourceColumnReference[];
|
|
903
1130
|
/** The type to select columns for the data source table. Defaults to SELECTED. */
|
|
904
|
-
columnSelectionType?:
|
|
1131
|
+
columnSelectionType?:
|
|
1132
|
+
| 'DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED'
|
|
1133
|
+
| 'SELECTED'
|
|
1134
|
+
| 'SYNC_ALL';
|
|
905
1135
|
/** Output only. The data execution status. */
|
|
906
1136
|
dataExecutionStatus?: DataExecutionStatus;
|
|
907
1137
|
/** The ID of the data source the data source table is associated with. */
|
|
@@ -925,7 +1155,23 @@ declare namespace gapi.client {
|
|
|
925
1155
|
}
|
|
926
1156
|
interface DateTimeRule {
|
|
927
1157
|
/** The type of date-time grouping to apply. */
|
|
928
|
-
type?:
|
|
1158
|
+
type?:
|
|
1159
|
+
| 'DATE_TIME_RULE_TYPE_UNSPECIFIED'
|
|
1160
|
+
| 'SECOND'
|
|
1161
|
+
| 'MINUTE'
|
|
1162
|
+
| 'HOUR'
|
|
1163
|
+
| 'HOUR_MINUTE'
|
|
1164
|
+
| 'HOUR_MINUTE_AMPM'
|
|
1165
|
+
| 'DAY_OF_WEEK'
|
|
1166
|
+
| 'DAY_OF_YEAR'
|
|
1167
|
+
| 'DAY_OF_MONTH'
|
|
1168
|
+
| 'DAY_MONTH'
|
|
1169
|
+
| 'MONTH'
|
|
1170
|
+
| 'QUARTER'
|
|
1171
|
+
| 'YEAR'
|
|
1172
|
+
| 'YEAR_MONTH'
|
|
1173
|
+
| 'YEAR_QUARTER'
|
|
1174
|
+
| 'YEAR_MONTH_DAY';
|
|
929
1175
|
}
|
|
930
1176
|
interface DeleteBandingRequest {
|
|
931
1177
|
/** The ID of the banded range to delete. */
|
|
@@ -995,7 +1241,7 @@ declare namespace gapi.client {
|
|
|
995
1241
|
/** The range of cells to delete. */
|
|
996
1242
|
range?: GridRange;
|
|
997
1243
|
/** The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells. */
|
|
998
|
-
shiftDimension?:
|
|
1244
|
+
shiftDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
999
1245
|
}
|
|
1000
1246
|
interface DeleteSheetRequest {
|
|
1001
1247
|
/** The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted. */
|
|
@@ -1015,13 +1261,21 @@ declare namespace gapi.client {
|
|
|
1015
1261
|
/** Data associated with the metadata's key. */
|
|
1016
1262
|
metadataValue?: string;
|
|
1017
1263
|
/** The metadata visibility. Developer metadata must always have visibility specified. */
|
|
1018
|
-
visibility?:
|
|
1264
|
+
visibility?:
|
|
1265
|
+
| 'DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED'
|
|
1266
|
+
| 'DOCUMENT'
|
|
1267
|
+
| 'PROJECT';
|
|
1019
1268
|
}
|
|
1020
1269
|
interface DeveloperMetadataLocation {
|
|
1021
1270
|
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns. */
|
|
1022
1271
|
dimensionRange?: DimensionRange;
|
|
1023
1272
|
/** The type of location this object represents. This field is read-only. */
|
|
1024
|
-
locationType?:
|
|
1273
|
+
locationType?:
|
|
1274
|
+
| 'DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED'
|
|
1275
|
+
| 'ROW'
|
|
1276
|
+
| 'COLUMN'
|
|
1277
|
+
| 'SHEET'
|
|
1278
|
+
| 'SPREADSHEET';
|
|
1025
1279
|
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
1026
1280
|
sheetId?: number;
|
|
1027
1281
|
/** True when metadata is associated with an entire spreadsheet. */
|
|
@@ -1029,9 +1283,17 @@ declare namespace gapi.client {
|
|
|
1029
1283
|
}
|
|
1030
1284
|
interface DeveloperMetadataLookup {
|
|
1031
1285
|
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
1032
|
-
locationMatchingStrategy?:
|
|
1286
|
+
locationMatchingStrategy?:
|
|
1287
|
+
| 'DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED'
|
|
1288
|
+
| 'EXACT_LOCATION'
|
|
1289
|
+
| 'INTERSECTING_LOCATION';
|
|
1033
1290
|
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location. Spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
1034
|
-
locationType?:
|
|
1291
|
+
locationType?:
|
|
1292
|
+
| 'DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED'
|
|
1293
|
+
| 'ROW'
|
|
1294
|
+
| 'COLUMN'
|
|
1295
|
+
| 'SHEET'
|
|
1296
|
+
| 'SPREADSHEET';
|
|
1035
1297
|
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
1036
1298
|
metadataId?: number;
|
|
1037
1299
|
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
@@ -1041,7 +1303,10 @@ declare namespace gapi.client {
|
|
|
1041
1303
|
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
1042
1304
|
metadataValue?: string;
|
|
1043
1305
|
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visible to the requesting project is considered. */
|
|
1044
|
-
visibility?:
|
|
1306
|
+
visibility?:
|
|
1307
|
+
| 'DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED'
|
|
1308
|
+
| 'DOCUMENT'
|
|
1309
|
+
| 'PROJECT';
|
|
1045
1310
|
}
|
|
1046
1311
|
interface DimensionGroup {
|
|
1047
1312
|
/** This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false. */
|
|
@@ -1065,7 +1330,7 @@ declare namespace gapi.client {
|
|
|
1065
1330
|
}
|
|
1066
1331
|
interface DimensionRange {
|
|
1067
1332
|
/** The dimension of the span. */
|
|
1068
|
-
dimension?:
|
|
1333
|
+
dimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
1069
1334
|
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
1070
1335
|
endIndex?: number;
|
|
1071
1336
|
/** The sheet this span is on. */
|
|
@@ -1131,7 +1396,17 @@ declare namespace gapi.client {
|
|
|
1131
1396
|
/** A message with more information about the error (in the spreadsheet's locale). */
|
|
1132
1397
|
message?: string;
|
|
1133
1398
|
/** The type of error. */
|
|
1134
|
-
type?:
|
|
1399
|
+
type?:
|
|
1400
|
+
| 'ERROR_TYPE_UNSPECIFIED'
|
|
1401
|
+
| 'ERROR'
|
|
1402
|
+
| 'NULL_VALUE'
|
|
1403
|
+
| 'DIVIDE_BY_ZERO'
|
|
1404
|
+
| 'VALUE'
|
|
1405
|
+
| 'REF'
|
|
1406
|
+
| 'NAME'
|
|
1407
|
+
| 'NUM'
|
|
1408
|
+
| 'N_A'
|
|
1409
|
+
| 'LOADING';
|
|
1135
1410
|
}
|
|
1136
1411
|
interface ExtendedValue {
|
|
1137
1412
|
/** Represents a boolean value. */
|
|
@@ -1285,7 +1560,14 @@ declare namespace gapi.client {
|
|
|
1285
1560
|
/** By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional. */
|
|
1286
1561
|
bucketSize?: number;
|
|
1287
1562
|
/** The position of the chart legend. */
|
|
1288
|
-
legendPosition?:
|
|
1563
|
+
legendPosition?:
|
|
1564
|
+
| 'HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED'
|
|
1565
|
+
| 'BOTTOM_LEGEND'
|
|
1566
|
+
| 'LEFT_LEGEND'
|
|
1567
|
+
| 'RIGHT_LEGEND'
|
|
1568
|
+
| 'TOP_LEGEND'
|
|
1569
|
+
| 'NO_LEGEND'
|
|
1570
|
+
| 'INSIDE_LEGEND';
|
|
1289
1571
|
/** The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5. */
|
|
1290
1572
|
outlierPercentile?: number;
|
|
1291
1573
|
/** The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series. */
|
|
@@ -1319,7 +1601,7 @@ declare namespace gapi.client {
|
|
|
1319
1601
|
/** The range to insert new cells into. The range is constrained to the current sheet boundaries. */
|
|
1320
1602
|
range?: GridRange;
|
|
1321
1603
|
/** The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right. */
|
|
1322
|
-
shiftDimension?:
|
|
1604
|
+
shiftDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
1323
1605
|
}
|
|
1324
1606
|
interface InterpolationPoint {
|
|
1325
1607
|
/** The color this interpolation point should use. Deprecated: Use color_style. */
|
|
@@ -1327,7 +1609,13 @@ declare namespace gapi.client {
|
|
|
1327
1609
|
/** The color this interpolation point should use. If color is also set, this field takes precedence. */
|
|
1328
1610
|
colorStyle?: ColorStyle;
|
|
1329
1611
|
/** How the value should be interpreted. */
|
|
1330
|
-
type?:
|
|
1612
|
+
type?:
|
|
1613
|
+
| 'INTERPOLATION_POINT_TYPE_UNSPECIFIED'
|
|
1614
|
+
| 'MIN'
|
|
1615
|
+
| 'MAX'
|
|
1616
|
+
| 'NUMBER'
|
|
1617
|
+
| 'PERCENT'
|
|
1618
|
+
| 'PERCENTILE';
|
|
1331
1619
|
/** The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX. */
|
|
1332
1620
|
value?: string;
|
|
1333
1621
|
}
|
|
@@ -1351,7 +1639,16 @@ declare namespace gapi.client {
|
|
|
1351
1639
|
}
|
|
1352
1640
|
interface LineStyle {
|
|
1353
1641
|
/** The dash type of the line. */
|
|
1354
|
-
type?:
|
|
1642
|
+
type?:
|
|
1643
|
+
| 'LINE_DASH_TYPE_UNSPECIFIED'
|
|
1644
|
+
| 'INVISIBLE'
|
|
1645
|
+
| 'CUSTOM'
|
|
1646
|
+
| 'SOLID'
|
|
1647
|
+
| 'DOTTED'
|
|
1648
|
+
| 'MEDIUM_DASHED'
|
|
1649
|
+
| 'MEDIUM_DASHED_DOTTED'
|
|
1650
|
+
| 'LONG_DASHED'
|
|
1651
|
+
| 'LONG_DASHED_DOTTED';
|
|
1355
1652
|
/** The thickness of the line, in px. */
|
|
1356
1653
|
width?: number;
|
|
1357
1654
|
}
|
|
@@ -1391,7 +1688,7 @@ declare namespace gapi.client {
|
|
|
1391
1688
|
}
|
|
1392
1689
|
interface MergeCellsRequest {
|
|
1393
1690
|
/** How the cells should be merged. */
|
|
1394
|
-
mergeType?:
|
|
1691
|
+
mergeType?: 'MERGE_ALL' | 'MERGE_COLUMNS' | 'MERGE_ROWS';
|
|
1395
1692
|
/** The range of cells to merge. */
|
|
1396
1693
|
range?: GridRange;
|
|
1397
1694
|
}
|
|
@@ -1413,7 +1710,16 @@ declare namespace gapi.client {
|
|
|
1413
1710
|
/** Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for more information about the supported patterns. */
|
|
1414
1711
|
pattern?: string;
|
|
1415
1712
|
/** The type of the number format. When writing, this field must be set. */
|
|
1416
|
-
type?:
|
|
1713
|
+
type?:
|
|
1714
|
+
| 'NUMBER_FORMAT_TYPE_UNSPECIFIED'
|
|
1715
|
+
| 'TEXT'
|
|
1716
|
+
| 'NUMBER'
|
|
1717
|
+
| 'PERCENT'
|
|
1718
|
+
| 'CURRENCY'
|
|
1719
|
+
| 'DATE'
|
|
1720
|
+
| 'TIME'
|
|
1721
|
+
| 'DATE_TIME'
|
|
1722
|
+
| 'SCIENTIFIC';
|
|
1417
1723
|
}
|
|
1418
1724
|
interface OrgChartSpec {
|
|
1419
1725
|
/** The data containing the labels for all the nodes in the chart. Labels must be unique. */
|
|
@@ -1423,7 +1729,11 @@ declare namespace gapi.client {
|
|
|
1423
1729
|
/** The color of the org chart nodes. If node_color is also set, this field takes precedence. */
|
|
1424
1730
|
nodeColorStyle?: ColorStyle;
|
|
1425
1731
|
/** The size of the org chart nodes. */
|
|
1426
|
-
nodeSize?:
|
|
1732
|
+
nodeSize?:
|
|
1733
|
+
| 'ORG_CHART_LABEL_SIZE_UNSPECIFIED'
|
|
1734
|
+
| 'SMALL'
|
|
1735
|
+
| 'MEDIUM'
|
|
1736
|
+
| 'LARGE';
|
|
1427
1737
|
/** The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional. */
|
|
1428
1738
|
parentLabels?: ChartData;
|
|
1429
1739
|
/** The color of the selected org chart nodes. Deprecated: Use selected_node_color_style. */
|
|
@@ -1465,11 +1775,22 @@ declare namespace gapi.client {
|
|
|
1465
1775
|
/** True if the data is HTML. */
|
|
1466
1776
|
html?: boolean;
|
|
1467
1777
|
/** How the data should be pasted. */
|
|
1468
|
-
type?:
|
|
1778
|
+
type?:
|
|
1779
|
+
| 'PASTE_NORMAL'
|
|
1780
|
+
| 'PASTE_VALUES'
|
|
1781
|
+
| 'PASTE_FORMAT'
|
|
1782
|
+
| 'PASTE_NO_BORDERS'
|
|
1783
|
+
| 'PASTE_FORMULA'
|
|
1784
|
+
| 'PASTE_DATA_VALIDATION'
|
|
1785
|
+
| 'PASTE_CONDITIONAL_FORMATTING';
|
|
1469
1786
|
}
|
|
1470
1787
|
interface PersonProperties {
|
|
1471
1788
|
/** Optional. The display format of the person chip. If not set, the default display format is used. */
|
|
1472
|
-
displayFormat?:
|
|
1789
|
+
displayFormat?:
|
|
1790
|
+
| 'DISPLAY_FORMAT_UNSPECIFIED'
|
|
1791
|
+
| 'DEFAULT'
|
|
1792
|
+
| 'LAST_NAME_COMMA_FIRST_NAME'
|
|
1793
|
+
| 'EMAIL';
|
|
1473
1794
|
/** Required. The email address linked to this person. This field is always present. */
|
|
1474
1795
|
email?: string;
|
|
1475
1796
|
}
|
|
@@ -1477,7 +1798,14 @@ declare namespace gapi.client {
|
|
|
1477
1798
|
/** The data that covers the domain of the pie chart. */
|
|
1478
1799
|
domain?: ChartData;
|
|
1479
1800
|
/** Where the legend of the pie chart should be drawn. */
|
|
1480
|
-
legendPosition?:
|
|
1801
|
+
legendPosition?:
|
|
1802
|
+
| 'PIE_CHART_LEGEND_POSITION_UNSPECIFIED'
|
|
1803
|
+
| 'BOTTOM_LEGEND'
|
|
1804
|
+
| 'LEFT_LEGEND'
|
|
1805
|
+
| 'RIGHT_LEGEND'
|
|
1806
|
+
| 'TOP_LEGEND'
|
|
1807
|
+
| 'NO_LEGEND'
|
|
1808
|
+
| 'LABELED_LEGEND';
|
|
1481
1809
|
/** The size of the hole in the pie chart. */
|
|
1482
1810
|
pieHole?: number;
|
|
1483
1811
|
/** The data that covers the one and only series of the pie chart. */
|
|
@@ -1515,7 +1843,7 @@ declare namespace gapi.client {
|
|
|
1515
1843
|
/** True if the pivot table should include the totals for this grouping. */
|
|
1516
1844
|
showTotals?: boolean;
|
|
1517
1845
|
/** The order the values in this group should be sorted. */
|
|
1518
|
-
sortOrder?:
|
|
1846
|
+
sortOrder?: 'SORT_ORDER_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
|
|
1519
1847
|
/** The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`. */
|
|
1520
1848
|
sourceColumnOffset?: number;
|
|
1521
1849
|
/** The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values. */
|
|
@@ -1565,13 +1893,17 @@ declare namespace gapi.client {
|
|
|
1565
1893
|
/** The range the pivot table is reading data from. */
|
|
1566
1894
|
source?: GridRange;
|
|
1567
1895
|
/** Whether values should be listed horizontally (as columns) or vertically (as rows). */
|
|
1568
|
-
valueLayout?:
|
|
1896
|
+
valueLayout?: 'HORIZONTAL' | 'VERTICAL';
|
|
1569
1897
|
/** A list of values to include in the pivot table. */
|
|
1570
1898
|
values?: PivotValue[];
|
|
1571
1899
|
}
|
|
1572
1900
|
interface PivotValue {
|
|
1573
1901
|
/** If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot table. */
|
|
1574
|
-
calculatedDisplayType?:
|
|
1902
|
+
calculatedDisplayType?:
|
|
1903
|
+
| 'PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED'
|
|
1904
|
+
| 'PERCENT_OF_ROW_TOTAL'
|
|
1905
|
+
| 'PERCENT_OF_COLUMN_TOTAL'
|
|
1906
|
+
| 'PERCENT_OF_GRAND_TOTAL';
|
|
1575
1907
|
/** The reference to the data source column that this value reads from. */
|
|
1576
1908
|
dataSourceColumnReference?: DataSourceColumnReference;
|
|
1577
1909
|
/** A custom formula to calculate the value. The formula must start with an `=` character. */
|
|
@@ -1581,11 +1913,36 @@ declare namespace gapi.client {
|
|
|
1581
1913
|
/** The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`. */
|
|
1582
1914
|
sourceColumnOffset?: number;
|
|
1583
1915
|
/** A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported. */
|
|
1584
|
-
summarizeFunction?:
|
|
1916
|
+
summarizeFunction?:
|
|
1917
|
+
| 'PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED'
|
|
1918
|
+
| 'SUM'
|
|
1919
|
+
| 'COUNTA'
|
|
1920
|
+
| 'COUNT'
|
|
1921
|
+
| 'COUNTUNIQUE'
|
|
1922
|
+
| 'AVERAGE'
|
|
1923
|
+
| 'MAX'
|
|
1924
|
+
| 'MIN'
|
|
1925
|
+
| 'MEDIAN'
|
|
1926
|
+
| 'PRODUCT'
|
|
1927
|
+
| 'STDEV'
|
|
1928
|
+
| 'STDEVP'
|
|
1929
|
+
| 'VAR'
|
|
1930
|
+
| 'VARP'
|
|
1931
|
+
| 'CUSTOM'
|
|
1932
|
+
| 'NONE';
|
|
1585
1933
|
}
|
|
1586
1934
|
interface PointStyle {
|
|
1587
1935
|
/** The point shape. If empty or unspecified, a default shape is used. */
|
|
1588
|
-
shape?:
|
|
1936
|
+
shape?:
|
|
1937
|
+
| 'POINT_SHAPE_UNSPECIFIED'
|
|
1938
|
+
| 'CIRCLE'
|
|
1939
|
+
| 'DIAMOND'
|
|
1940
|
+
| 'HEXAGON'
|
|
1941
|
+
| 'PENTAGON'
|
|
1942
|
+
| 'SQUARE'
|
|
1943
|
+
| 'STAR'
|
|
1944
|
+
| 'TRIANGLE'
|
|
1945
|
+
| 'X_MARK';
|
|
1589
1946
|
/** The point size. If empty, a default size is used. */
|
|
1590
1947
|
size?: number;
|
|
1591
1948
|
}
|
|
@@ -1615,9 +1972,18 @@ declare namespace gapi.client {
|
|
|
1615
1972
|
}
|
|
1616
1973
|
interface RefreshCancellationStatus {
|
|
1617
1974
|
/** The error code. */
|
|
1618
|
-
errorCode?:
|
|
1975
|
+
errorCode?:
|
|
1976
|
+
| 'REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED'
|
|
1977
|
+
| 'EXECUTION_NOT_FOUND'
|
|
1978
|
+
| 'CANCEL_PERMISSION_DENIED'
|
|
1979
|
+
| 'QUERY_EXECUTION_COMPLETED'
|
|
1980
|
+
| 'CONCURRENT_CANCELLATION'
|
|
1981
|
+
| 'CANCEL_OTHER_ERROR';
|
|
1619
1982
|
/** The state of a call to cancel a refresh in Sheets. */
|
|
1620
|
-
state?:
|
|
1983
|
+
state?:
|
|
1984
|
+
| 'REFRESH_CANCELLATION_STATE_UNSPECIFIED'
|
|
1985
|
+
| 'CANCEL_SUCCEEDED'
|
|
1986
|
+
| 'CANCEL_FAILED';
|
|
1621
1987
|
}
|
|
1622
1988
|
interface RefreshDataSourceObjectExecutionStatus {
|
|
1623
1989
|
/** The data execution status. */
|
|
@@ -1851,7 +2217,14 @@ declare namespace gapi.client {
|
|
|
1851
2217
|
}
|
|
1852
2218
|
interface ScorecardChartSpec {
|
|
1853
2219
|
/** The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optional. */
|
|
1854
|
-
aggregateType?:
|
|
2220
|
+
aggregateType?:
|
|
2221
|
+
| 'CHART_AGGREGATE_TYPE_UNSPECIFIED'
|
|
2222
|
+
| 'AVERAGE'
|
|
2223
|
+
| 'COUNT'
|
|
2224
|
+
| 'MAX'
|
|
2225
|
+
| 'MEDIAN'
|
|
2226
|
+
| 'MIN'
|
|
2227
|
+
| 'SUM';
|
|
1855
2228
|
/** The data for scorecard baseline value. This field is optional. */
|
|
1856
2229
|
baselineValueData?: ChartData;
|
|
1857
2230
|
/** Formatting options for baseline value. This field is needed only if baseline_value_data is specified. */
|
|
@@ -1863,7 +2236,10 @@ declare namespace gapi.client {
|
|
|
1863
2236
|
/** Formatting options for key value. */
|
|
1864
2237
|
keyValueFormat?: KeyValueFormat;
|
|
1865
2238
|
/** The number format source used in the scorecard chart. This field is optional. */
|
|
1866
|
-
numberFormatSource?:
|
|
2239
|
+
numberFormatSource?:
|
|
2240
|
+
| 'CHART_NUMBER_FORMAT_SOURCE_UNDEFINED'
|
|
2241
|
+
| 'FROM_DATA'
|
|
2242
|
+
| 'CUSTOM';
|
|
1867
2243
|
/** Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional. */
|
|
1868
2244
|
scaleFactor?: number;
|
|
1869
2245
|
}
|
|
@@ -1931,7 +2307,7 @@ declare namespace gapi.client {
|
|
|
1931
2307
|
/** The ID of the sheet. Must be non-negative. This field cannot be changed once set. */
|
|
1932
2308
|
sheetId?: number;
|
|
1933
2309
|
/** The type of sheet. Defaults to GRID. This field cannot be changed once set. */
|
|
1934
|
-
sheetType?:
|
|
2310
|
+
sheetType?: 'SHEET_TYPE_UNSPECIFIED' | 'GRID' | 'OBJECT' | 'DATA_SOURCE';
|
|
1935
2311
|
/** The color of the tab in the UI. Deprecated: Use tab_color_style. */
|
|
1936
2312
|
tabColor?: Color;
|
|
1937
2313
|
/** The color of the tab in the UI. If tab_color is also set, this field takes precedence. */
|
|
@@ -1961,7 +2337,11 @@ declare namespace gapi.client {
|
|
|
1961
2337
|
/** The filtering criteria of the slicer. */
|
|
1962
2338
|
filterCriteria?: FilterCriteria;
|
|
1963
2339
|
/** The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT` */
|
|
1964
|
-
horizontalAlignment?:
|
|
2340
|
+
horizontalAlignment?:
|
|
2341
|
+
| 'HORIZONTAL_ALIGN_UNSPECIFIED'
|
|
2342
|
+
| 'LEFT'
|
|
2343
|
+
| 'CENTER'
|
|
2344
|
+
| 'RIGHT';
|
|
1965
2345
|
/** The text format of title in the slicer. The link field is not supported. */
|
|
1966
2346
|
textFormat?: TextFormat;
|
|
1967
2347
|
/** The title of the slicer. */
|
|
@@ -1987,11 +2367,11 @@ declare namespace gapi.client {
|
|
|
1987
2367
|
/** The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence. */
|
|
1988
2368
|
foregroundColorStyle?: ColorStyle;
|
|
1989
2369
|
/** The order data should be sorted. */
|
|
1990
|
-
sortOrder?:
|
|
2370
|
+
sortOrder?: 'SORT_ORDER_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
|
|
1991
2371
|
}
|
|
1992
2372
|
interface SourceAndDestination {
|
|
1993
2373
|
/** The dimension that data should be filled into. */
|
|
1994
|
-
dimension?:
|
|
2374
|
+
dimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
1995
2375
|
/** The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source. */
|
|
1996
2376
|
fillLength?: number;
|
|
1997
2377
|
/** The location of the data to use as the source of the autofill. */
|
|
@@ -2017,7 +2397,11 @@ declare namespace gapi.client {
|
|
|
2017
2397
|
}
|
|
2018
2398
|
interface SpreadsheetProperties {
|
|
2019
2399
|
/** The amount of time to wait before volatile functions are recalculated. */
|
|
2020
|
-
autoRecalc?:
|
|
2400
|
+
autoRecalc?:
|
|
2401
|
+
| 'RECALCULATION_INTERVAL_UNSPECIFIED'
|
|
2402
|
+
| 'ON_CHANGE'
|
|
2403
|
+
| 'MINUTE'
|
|
2404
|
+
| 'HOUR';
|
|
2021
2405
|
/** The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only. */
|
|
2022
2406
|
defaultFormat?: CellFormat;
|
|
2023
2407
|
/** Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=url_allowlist). */
|
|
@@ -2061,7 +2445,22 @@ declare namespace gapi.client {
|
|
|
2061
2445
|
/** The column name. */
|
|
2062
2446
|
columnName?: string;
|
|
2063
2447
|
/** The column type. */
|
|
2064
|
-
columnType?:
|
|
2448
|
+
columnType?:
|
|
2449
|
+
| 'COLUMN_TYPE_UNSPECIFIED'
|
|
2450
|
+
| 'DOUBLE'
|
|
2451
|
+
| 'CURRENCY'
|
|
2452
|
+
| 'PERCENT'
|
|
2453
|
+
| 'DATE'
|
|
2454
|
+
| 'TIME'
|
|
2455
|
+
| 'DATE_TIME'
|
|
2456
|
+
| 'TEXT'
|
|
2457
|
+
| 'BOOLEAN'
|
|
2458
|
+
| 'DROPDOWN'
|
|
2459
|
+
| 'FILES_CHIP'
|
|
2460
|
+
| 'PEOPLE_CHIP'
|
|
2461
|
+
| 'FINANCE_CHIP'
|
|
2462
|
+
| 'PLACE_CHIP'
|
|
2463
|
+
| 'RATINGS_CHIP';
|
|
2065
2464
|
/** The column data validation rule. Only set for dropdown column type. */
|
|
2066
2465
|
dataValidationRule?: TableColumnDataValidationRule;
|
|
2067
2466
|
}
|
|
@@ -2103,7 +2502,11 @@ declare namespace gapi.client {
|
|
|
2103
2502
|
}
|
|
2104
2503
|
interface TextPosition {
|
|
2105
2504
|
/** Horizontal alignment setting for the piece of text. */
|
|
2106
|
-
horizontalAlignment?:
|
|
2505
|
+
horizontalAlignment?:
|
|
2506
|
+
| 'HORIZONTAL_ALIGN_UNSPECIFIED'
|
|
2507
|
+
| 'LEFT'
|
|
2508
|
+
| 'CENTER'
|
|
2509
|
+
| 'RIGHT';
|
|
2107
2510
|
}
|
|
2108
2511
|
interface TextRotation {
|
|
2109
2512
|
/** The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction */
|
|
@@ -2115,7 +2518,14 @@ declare namespace gapi.client {
|
|
|
2115
2518
|
/** The delimiter to use. Used only if delimiterType is CUSTOM. */
|
|
2116
2519
|
delimiter?: string;
|
|
2117
2520
|
/** The delimiter type to use. */
|
|
2118
|
-
delimiterType?:
|
|
2521
|
+
delimiterType?:
|
|
2522
|
+
| 'DELIMITER_TYPE_UNSPECIFIED'
|
|
2523
|
+
| 'COMMA'
|
|
2524
|
+
| 'SEMICOLON'
|
|
2525
|
+
| 'PERIOD'
|
|
2526
|
+
| 'SPACE'
|
|
2527
|
+
| 'CUSTOM'
|
|
2528
|
+
| 'AUTODETECT';
|
|
2119
2529
|
/** The source data range. This must span exactly one column. */
|
|
2120
2530
|
source?: GridRange;
|
|
2121
2531
|
}
|
|
@@ -2123,7 +2533,17 @@ declare namespace gapi.client {
|
|
|
2123
2533
|
/** The concrete color corresponding to the theme color type. */
|
|
2124
2534
|
color?: ColorStyle;
|
|
2125
2535
|
/** The type of the spreadsheet theme color. */
|
|
2126
|
-
colorType?:
|
|
2536
|
+
colorType?:
|
|
2537
|
+
| 'THEME_COLOR_TYPE_UNSPECIFIED'
|
|
2538
|
+
| 'TEXT'
|
|
2539
|
+
| 'BACKGROUND'
|
|
2540
|
+
| 'ACCENT1'
|
|
2541
|
+
| 'ACCENT2'
|
|
2542
|
+
| 'ACCENT3'
|
|
2543
|
+
| 'ACCENT4'
|
|
2544
|
+
| 'ACCENT5'
|
|
2545
|
+
| 'ACCENT6'
|
|
2546
|
+
| 'LINK';
|
|
2127
2547
|
}
|
|
2128
2548
|
interface TimeOfDay {
|
|
2129
2549
|
/** Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
|
|
@@ -2385,7 +2805,7 @@ declare namespace gapi.client {
|
|
|
2385
2805
|
}
|
|
2386
2806
|
interface ValueRange {
|
|
2387
2807
|
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
2388
|
-
majorDimension?:
|
|
2808
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
2389
2809
|
/** The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
2390
2810
|
range?: string;
|
|
2391
2811
|
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
@@ -2441,7 +2861,10 @@ declare namespace gapi.client {
|
|
|
2441
2861
|
/** The data this waterfall chart is visualizing. */
|
|
2442
2862
|
series?: WaterfallChartSeries[];
|
|
2443
2863
|
/** The stacked type. */
|
|
2444
|
-
stackedType?:
|
|
2864
|
+
stackedType?:
|
|
2865
|
+
| 'WATERFALL_STACKED_TYPE_UNSPECIFIED'
|
|
2866
|
+
| 'STACKED'
|
|
2867
|
+
| 'SEQUENTIAL';
|
|
2445
2868
|
/** Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label. */
|
|
2446
2869
|
totalDataLabel?: DataLabel;
|
|
2447
2870
|
}
|
|
@@ -2449,11 +2872,11 @@ declare namespace gapi.client {
|
|
|
2449
2872
|
/** Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). */
|
|
2450
2873
|
get(request?: {
|
|
2451
2874
|
/** V1 error format. */
|
|
2452
|
-
'$.xgafv'?:
|
|
2875
|
+
'$.xgafv'?: '1' | '2';
|
|
2453
2876
|
/** OAuth access token. */
|
|
2454
2877
|
access_token?: string;
|
|
2455
2878
|
/** Data format for response. */
|
|
2456
|
-
alt?:
|
|
2879
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2457
2880
|
/** JSONP */
|
|
2458
2881
|
callback?: string;
|
|
2459
2882
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2478,11 +2901,11 @@ declare namespace gapi.client {
|
|
|
2478
2901
|
/** Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region. */
|
|
2479
2902
|
search(request: {
|
|
2480
2903
|
/** V1 error format. */
|
|
2481
|
-
'$.xgafv'?:
|
|
2904
|
+
'$.xgafv'?: '1' | '2';
|
|
2482
2905
|
/** OAuth access token. */
|
|
2483
2906
|
access_token?: string;
|
|
2484
2907
|
/** Data format for response. */
|
|
2485
|
-
alt?:
|
|
2908
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2486
2909
|
/** JSONP */
|
|
2487
2910
|
callback?: string;
|
|
2488
2911
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2507,11 +2930,11 @@ declare namespace gapi.client {
|
|
|
2507
2930
|
search(
|
|
2508
2931
|
request: {
|
|
2509
2932
|
/** V1 error format. */
|
|
2510
|
-
'$.xgafv'?:
|
|
2933
|
+
'$.xgafv'?: '1' | '2';
|
|
2511
2934
|
/** OAuth access token. */
|
|
2512
2935
|
access_token?: string;
|
|
2513
2936
|
/** Data format for response. */
|
|
2514
|
-
alt?:
|
|
2937
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2515
2938
|
/** JSONP */
|
|
2516
2939
|
callback?: string;
|
|
2517
2940
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2538,11 +2961,11 @@ declare namespace gapi.client {
|
|
|
2538
2961
|
/** Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet. */
|
|
2539
2962
|
copyTo(request: {
|
|
2540
2963
|
/** V1 error format. */
|
|
2541
|
-
'$.xgafv'?:
|
|
2964
|
+
'$.xgafv'?: '1' | '2';
|
|
2542
2965
|
/** OAuth access token. */
|
|
2543
2966
|
access_token?: string;
|
|
2544
2967
|
/** Data format for response. */
|
|
2545
|
-
alt?:
|
|
2968
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2546
2969
|
/** JSONP */
|
|
2547
2970
|
callback?: string;
|
|
2548
2971
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2569,11 +2992,11 @@ declare namespace gapi.client {
|
|
|
2569
2992
|
copyTo(
|
|
2570
2993
|
request: {
|
|
2571
2994
|
/** V1 error format. */
|
|
2572
|
-
'$.xgafv'?:
|
|
2995
|
+
'$.xgafv'?: '1' | '2';
|
|
2573
2996
|
/** OAuth access token. */
|
|
2574
2997
|
access_token?: string;
|
|
2575
2998
|
/** Data format for response. */
|
|
2576
|
-
alt?:
|
|
2999
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2577
3000
|
/** JSONP */
|
|
2578
3001
|
callback?: string;
|
|
2579
3002
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2602,11 +3025,11 @@ declare namespace gapi.client {
|
|
|
2602
3025
|
/** Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. */
|
|
2603
3026
|
append(request: {
|
|
2604
3027
|
/** V1 error format. */
|
|
2605
|
-
'$.xgafv'?:
|
|
3028
|
+
'$.xgafv'?: '1' | '2';
|
|
2606
3029
|
/** OAuth access token. */
|
|
2607
3030
|
access_token?: string;
|
|
2608
3031
|
/** Data format for response. */
|
|
2609
|
-
alt?:
|
|
3032
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2610
3033
|
/** JSONP */
|
|
2611
3034
|
callback?: string;
|
|
2612
3035
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2614,7 +3037,7 @@ declare namespace gapi.client {
|
|
|
2614
3037
|
/** Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */
|
|
2615
3038
|
includeValuesInResponse?: boolean;
|
|
2616
3039
|
/** How the input data should be inserted. */
|
|
2617
|
-
insertDataOption?:
|
|
3040
|
+
insertDataOption?: 'OVERWRITE' | 'INSERT_ROWS';
|
|
2618
3041
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2619
3042
|
key?: string;
|
|
2620
3043
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -2626,9 +3049,12 @@ declare namespace gapi.client {
|
|
|
2626
3049
|
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */
|
|
2627
3050
|
range: string;
|
|
2628
3051
|
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
2629
|
-
responseDateTimeRenderOption?:
|
|
3052
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
2630
3053
|
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
2631
|
-
responseValueRenderOption?:
|
|
3054
|
+
responseValueRenderOption?:
|
|
3055
|
+
| 'FORMATTED_VALUE'
|
|
3056
|
+
| 'UNFORMATTED_VALUE'
|
|
3057
|
+
| 'FORMULA';
|
|
2632
3058
|
/** The ID of the spreadsheet to update. */
|
|
2633
3059
|
spreadsheetId: string;
|
|
2634
3060
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -2636,18 +3062,21 @@ declare namespace gapi.client {
|
|
|
2636
3062
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2637
3063
|
uploadType?: string;
|
|
2638
3064
|
/** How the input data should be interpreted. */
|
|
2639
|
-
valueInputOption?:
|
|
3065
|
+
valueInputOption?:
|
|
3066
|
+
| 'INPUT_VALUE_OPTION_UNSPECIFIED'
|
|
3067
|
+
| 'RAW'
|
|
3068
|
+
| 'USER_ENTERED';
|
|
2640
3069
|
/** Request body */
|
|
2641
3070
|
resource: ValueRange;
|
|
2642
3071
|
}): client.Request<AppendValuesResponse>;
|
|
2643
3072
|
append(
|
|
2644
3073
|
request: {
|
|
2645
3074
|
/** V1 error format. */
|
|
2646
|
-
'$.xgafv'?:
|
|
3075
|
+
'$.xgafv'?: '1' | '2';
|
|
2647
3076
|
/** OAuth access token. */
|
|
2648
3077
|
access_token?: string;
|
|
2649
3078
|
/** Data format for response. */
|
|
2650
|
-
alt?:
|
|
3079
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2651
3080
|
/** JSONP */
|
|
2652
3081
|
callback?: string;
|
|
2653
3082
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2655,7 +3084,7 @@ declare namespace gapi.client {
|
|
|
2655
3084
|
/** Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */
|
|
2656
3085
|
includeValuesInResponse?: boolean;
|
|
2657
3086
|
/** How the input data should be inserted. */
|
|
2658
|
-
insertDataOption?:
|
|
3087
|
+
insertDataOption?: 'OVERWRITE' | 'INSERT_ROWS';
|
|
2659
3088
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2660
3089
|
key?: string;
|
|
2661
3090
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -2667,9 +3096,12 @@ declare namespace gapi.client {
|
|
|
2667
3096
|
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */
|
|
2668
3097
|
range: string;
|
|
2669
3098
|
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
2670
|
-
responseDateTimeRenderOption?:
|
|
3099
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
2671
3100
|
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
2672
|
-
responseValueRenderOption?:
|
|
3101
|
+
responseValueRenderOption?:
|
|
3102
|
+
| 'FORMATTED_VALUE'
|
|
3103
|
+
| 'UNFORMATTED_VALUE'
|
|
3104
|
+
| 'FORMULA';
|
|
2673
3105
|
/** The ID of the spreadsheet to update. */
|
|
2674
3106
|
spreadsheetId: string;
|
|
2675
3107
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -2677,18 +3109,21 @@ declare namespace gapi.client {
|
|
|
2677
3109
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2678
3110
|
uploadType?: string;
|
|
2679
3111
|
/** How the input data should be interpreted. */
|
|
2680
|
-
valueInputOption?:
|
|
3112
|
+
valueInputOption?:
|
|
3113
|
+
| 'INPUT_VALUE_OPTION_UNSPECIFIED'
|
|
3114
|
+
| 'RAW'
|
|
3115
|
+
| 'USER_ENTERED';
|
|
2681
3116
|
},
|
|
2682
3117
|
body: ValueRange,
|
|
2683
3118
|
): client.Request<AppendValuesResponse>;
|
|
2684
3119
|
/** Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept. */
|
|
2685
3120
|
batchClear(request: {
|
|
2686
3121
|
/** V1 error format. */
|
|
2687
|
-
'$.xgafv'?:
|
|
3122
|
+
'$.xgafv'?: '1' | '2';
|
|
2688
3123
|
/** OAuth access token. */
|
|
2689
3124
|
access_token?: string;
|
|
2690
3125
|
/** Data format for response. */
|
|
2691
|
-
alt?:
|
|
3126
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2692
3127
|
/** JSONP */
|
|
2693
3128
|
callback?: string;
|
|
2694
3129
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2713,11 +3148,11 @@ declare namespace gapi.client {
|
|
|
2713
3148
|
batchClear(
|
|
2714
3149
|
request: {
|
|
2715
3150
|
/** V1 error format. */
|
|
2716
|
-
'$.xgafv'?:
|
|
3151
|
+
'$.xgafv'?: '1' | '2';
|
|
2717
3152
|
/** OAuth access token. */
|
|
2718
3153
|
access_token?: string;
|
|
2719
3154
|
/** Data format for response. */
|
|
2720
|
-
alt?:
|
|
3155
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2721
3156
|
/** JSONP */
|
|
2722
3157
|
callback?: string;
|
|
2723
3158
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2742,11 +3177,11 @@ declare namespace gapi.client {
|
|
|
2742
3177
|
/** Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept. */
|
|
2743
3178
|
batchClearByDataFilter(request: {
|
|
2744
3179
|
/** V1 error format. */
|
|
2745
|
-
'$.xgafv'?:
|
|
3180
|
+
'$.xgafv'?: '1' | '2';
|
|
2746
3181
|
/** OAuth access token. */
|
|
2747
3182
|
access_token?: string;
|
|
2748
3183
|
/** Data format for response. */
|
|
2749
|
-
alt?:
|
|
3184
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2750
3185
|
/** JSONP */
|
|
2751
3186
|
callback?: string;
|
|
2752
3187
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2771,11 +3206,11 @@ declare namespace gapi.client {
|
|
|
2771
3206
|
batchClearByDataFilter(
|
|
2772
3207
|
request: {
|
|
2773
3208
|
/** V1 error format. */
|
|
2774
|
-
'$.xgafv'?:
|
|
3209
|
+
'$.xgafv'?: '1' | '2';
|
|
2775
3210
|
/** OAuth access token. */
|
|
2776
3211
|
access_token?: string;
|
|
2777
3212
|
/** Data format for response. */
|
|
2778
|
-
alt?:
|
|
3213
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2779
3214
|
/** JSONP */
|
|
2780
3215
|
callback?: string;
|
|
2781
3216
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2800,21 +3235,21 @@ declare namespace gapi.client {
|
|
|
2800
3235
|
/** Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. */
|
|
2801
3236
|
batchGet(request?: {
|
|
2802
3237
|
/** V1 error format. */
|
|
2803
|
-
'$.xgafv'?:
|
|
3238
|
+
'$.xgafv'?: '1' | '2';
|
|
2804
3239
|
/** OAuth access token. */
|
|
2805
3240
|
access_token?: string;
|
|
2806
3241
|
/** Data format for response. */
|
|
2807
|
-
alt?:
|
|
3242
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2808
3243
|
/** JSONP */
|
|
2809
3244
|
callback?: string;
|
|
2810
3245
|
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
2811
|
-
dateTimeRenderOption?:
|
|
3246
|
+
dateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
2812
3247
|
/** Selector specifying which fields to include in a partial response. */
|
|
2813
3248
|
fields?: string;
|
|
2814
3249
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2815
3250
|
key?: string;
|
|
2816
3251
|
/** The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=["A1:B2"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
2817
|
-
majorDimension?:
|
|
3252
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
2818
3253
|
/** OAuth 2.0 token for the current user. */
|
|
2819
3254
|
oauth_token?: string;
|
|
2820
3255
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2830,16 +3265,16 @@ declare namespace gapi.client {
|
|
|
2830
3265
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2831
3266
|
uploadType?: string;
|
|
2832
3267
|
/** How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */
|
|
2833
|
-
valueRenderOption?:
|
|
3268
|
+
valueRenderOption?: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
2834
3269
|
}): client.Request<BatchGetValuesResponse>;
|
|
2835
3270
|
/** Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned. */
|
|
2836
3271
|
batchGetByDataFilter(request: {
|
|
2837
3272
|
/** V1 error format. */
|
|
2838
|
-
'$.xgafv'?:
|
|
3273
|
+
'$.xgafv'?: '1' | '2';
|
|
2839
3274
|
/** OAuth access token. */
|
|
2840
3275
|
access_token?: string;
|
|
2841
3276
|
/** Data format for response. */
|
|
2842
|
-
alt?:
|
|
3277
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2843
3278
|
/** JSONP */
|
|
2844
3279
|
callback?: string;
|
|
2845
3280
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2864,11 +3299,11 @@ declare namespace gapi.client {
|
|
|
2864
3299
|
batchGetByDataFilter(
|
|
2865
3300
|
request: {
|
|
2866
3301
|
/** V1 error format. */
|
|
2867
|
-
'$.xgafv'?:
|
|
3302
|
+
'$.xgafv'?: '1' | '2';
|
|
2868
3303
|
/** OAuth access token. */
|
|
2869
3304
|
access_token?: string;
|
|
2870
3305
|
/** Data format for response. */
|
|
2871
|
-
alt?:
|
|
3306
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2872
3307
|
/** JSONP */
|
|
2873
3308
|
callback?: string;
|
|
2874
3309
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2893,11 +3328,11 @@ declare namespace gapi.client {
|
|
|
2893
3328
|
/** Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. */
|
|
2894
3329
|
batchUpdate(request: {
|
|
2895
3330
|
/** V1 error format. */
|
|
2896
|
-
'$.xgafv'?:
|
|
3331
|
+
'$.xgafv'?: '1' | '2';
|
|
2897
3332
|
/** OAuth access token. */
|
|
2898
3333
|
access_token?: string;
|
|
2899
3334
|
/** Data format for response. */
|
|
2900
|
-
alt?:
|
|
3335
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2901
3336
|
/** JSONP */
|
|
2902
3337
|
callback?: string;
|
|
2903
3338
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2922,11 +3357,11 @@ declare namespace gapi.client {
|
|
|
2922
3357
|
batchUpdate(
|
|
2923
3358
|
request: {
|
|
2924
3359
|
/** V1 error format. */
|
|
2925
|
-
'$.xgafv'?:
|
|
3360
|
+
'$.xgafv'?: '1' | '2';
|
|
2926
3361
|
/** OAuth access token. */
|
|
2927
3362
|
access_token?: string;
|
|
2928
3363
|
/** Data format for response. */
|
|
2929
|
-
alt?:
|
|
3364
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2930
3365
|
/** JSONP */
|
|
2931
3366
|
callback?: string;
|
|
2932
3367
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2951,11 +3386,11 @@ declare namespace gapi.client {
|
|
|
2951
3386
|
/** Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. */
|
|
2952
3387
|
batchUpdateByDataFilter(request: {
|
|
2953
3388
|
/** V1 error format. */
|
|
2954
|
-
'$.xgafv'?:
|
|
3389
|
+
'$.xgafv'?: '1' | '2';
|
|
2955
3390
|
/** OAuth access token. */
|
|
2956
3391
|
access_token?: string;
|
|
2957
3392
|
/** Data format for response. */
|
|
2958
|
-
alt?:
|
|
3393
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2959
3394
|
/** JSONP */
|
|
2960
3395
|
callback?: string;
|
|
2961
3396
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2980,11 +3415,11 @@ declare namespace gapi.client {
|
|
|
2980
3415
|
batchUpdateByDataFilter(
|
|
2981
3416
|
request: {
|
|
2982
3417
|
/** V1 error format. */
|
|
2983
|
-
'$.xgafv'?:
|
|
3418
|
+
'$.xgafv'?: '1' | '2';
|
|
2984
3419
|
/** OAuth access token. */
|
|
2985
3420
|
access_token?: string;
|
|
2986
3421
|
/** Data format for response. */
|
|
2987
|
-
alt?:
|
|
3422
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2988
3423
|
/** JSONP */
|
|
2989
3424
|
callback?: string;
|
|
2990
3425
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3009,11 +3444,11 @@ declare namespace gapi.client {
|
|
|
3009
3444
|
/** Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. */
|
|
3010
3445
|
clear(request: {
|
|
3011
3446
|
/** V1 error format. */
|
|
3012
|
-
'$.xgafv'?:
|
|
3447
|
+
'$.xgafv'?: '1' | '2';
|
|
3013
3448
|
/** OAuth access token. */
|
|
3014
3449
|
access_token?: string;
|
|
3015
3450
|
/** Data format for response. */
|
|
3016
|
-
alt?:
|
|
3451
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3017
3452
|
/** JSONP */
|
|
3018
3453
|
callback?: string;
|
|
3019
3454
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3040,11 +3475,11 @@ declare namespace gapi.client {
|
|
|
3040
3475
|
clear(
|
|
3041
3476
|
request: {
|
|
3042
3477
|
/** V1 error format. */
|
|
3043
|
-
'$.xgafv'?:
|
|
3478
|
+
'$.xgafv'?: '1' | '2';
|
|
3044
3479
|
/** OAuth access token. */
|
|
3045
3480
|
access_token?: string;
|
|
3046
3481
|
/** Data format for response. */
|
|
3047
|
-
alt?:
|
|
3482
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3048
3483
|
/** JSONP */
|
|
3049
3484
|
callback?: string;
|
|
3050
3485
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3071,21 +3506,21 @@ declare namespace gapi.client {
|
|
|
3071
3506
|
/** Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. */
|
|
3072
3507
|
get(request?: {
|
|
3073
3508
|
/** V1 error format. */
|
|
3074
|
-
'$.xgafv'?:
|
|
3509
|
+
'$.xgafv'?: '1' | '2';
|
|
3075
3510
|
/** OAuth access token. */
|
|
3076
3511
|
access_token?: string;
|
|
3077
3512
|
/** Data format for response. */
|
|
3078
|
-
alt?:
|
|
3513
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3079
3514
|
/** JSONP */
|
|
3080
3515
|
callback?: string;
|
|
3081
3516
|
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3082
|
-
dateTimeRenderOption?:
|
|
3517
|
+
dateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3083
3518
|
/** Selector specifying which fields to include in a partial response. */
|
|
3084
3519
|
fields?: string;
|
|
3085
3520
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3086
3521
|
key?: string;
|
|
3087
3522
|
/** The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
3088
|
-
majorDimension?:
|
|
3523
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
3089
3524
|
/** OAuth 2.0 token for the current user. */
|
|
3090
3525
|
oauth_token?: string;
|
|
3091
3526
|
/** Returns response with indentations and line breaks. */
|
|
@@ -3101,16 +3536,16 @@ declare namespace gapi.client {
|
|
|
3101
3536
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3102
3537
|
uploadType?: string;
|
|
3103
3538
|
/** How values should be represented in the output. The default render option is FORMATTED_VALUE. */
|
|
3104
|
-
valueRenderOption?:
|
|
3539
|
+
valueRenderOption?: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3105
3540
|
}): client.Request<ValueRange>;
|
|
3106
3541
|
/** Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. */
|
|
3107
3542
|
update(request: {
|
|
3108
3543
|
/** V1 error format. */
|
|
3109
|
-
'$.xgafv'?:
|
|
3544
|
+
'$.xgafv'?: '1' | '2';
|
|
3110
3545
|
/** OAuth access token. */
|
|
3111
3546
|
access_token?: string;
|
|
3112
3547
|
/** Data format for response. */
|
|
3113
|
-
alt?:
|
|
3548
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3114
3549
|
/** JSONP */
|
|
3115
3550
|
callback?: string;
|
|
3116
3551
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3128,9 +3563,12 @@ declare namespace gapi.client {
|
|
|
3128
3563
|
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update. */
|
|
3129
3564
|
range: string;
|
|
3130
3565
|
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3131
|
-
responseDateTimeRenderOption?:
|
|
3566
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3132
3567
|
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3133
|
-
responseValueRenderOption?:
|
|
3568
|
+
responseValueRenderOption?:
|
|
3569
|
+
| 'FORMATTED_VALUE'
|
|
3570
|
+
| 'UNFORMATTED_VALUE'
|
|
3571
|
+
| 'FORMULA';
|
|
3134
3572
|
/** The ID of the spreadsheet to update. */
|
|
3135
3573
|
spreadsheetId: string;
|
|
3136
3574
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -3138,18 +3576,21 @@ declare namespace gapi.client {
|
|
|
3138
3576
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3139
3577
|
uploadType?: string;
|
|
3140
3578
|
/** How the input data should be interpreted. */
|
|
3141
|
-
valueInputOption?:
|
|
3579
|
+
valueInputOption?:
|
|
3580
|
+
| 'INPUT_VALUE_OPTION_UNSPECIFIED'
|
|
3581
|
+
| 'RAW'
|
|
3582
|
+
| 'USER_ENTERED';
|
|
3142
3583
|
/** Request body */
|
|
3143
3584
|
resource: ValueRange;
|
|
3144
3585
|
}): client.Request<UpdateValuesResponse>;
|
|
3145
3586
|
update(
|
|
3146
3587
|
request: {
|
|
3147
3588
|
/** V1 error format. */
|
|
3148
|
-
'$.xgafv'?:
|
|
3589
|
+
'$.xgafv'?: '1' | '2';
|
|
3149
3590
|
/** OAuth access token. */
|
|
3150
3591
|
access_token?: string;
|
|
3151
3592
|
/** Data format for response. */
|
|
3152
|
-
alt?:
|
|
3593
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3153
3594
|
/** JSONP */
|
|
3154
3595
|
callback?: string;
|
|
3155
3596
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3167,9 +3608,12 @@ declare namespace gapi.client {
|
|
|
3167
3608
|
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update. */
|
|
3168
3609
|
range: string;
|
|
3169
3610
|
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3170
|
-
responseDateTimeRenderOption?:
|
|
3611
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3171
3612
|
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3172
|
-
responseValueRenderOption?:
|
|
3613
|
+
responseValueRenderOption?:
|
|
3614
|
+
| 'FORMATTED_VALUE'
|
|
3615
|
+
| 'UNFORMATTED_VALUE'
|
|
3616
|
+
| 'FORMULA';
|
|
3173
3617
|
/** The ID of the spreadsheet to update. */
|
|
3174
3618
|
spreadsheetId: string;
|
|
3175
3619
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -3177,7 +3621,10 @@ declare namespace gapi.client {
|
|
|
3177
3621
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3178
3622
|
uploadType?: string;
|
|
3179
3623
|
/** How the input data should be interpreted. */
|
|
3180
|
-
valueInputOption?:
|
|
3624
|
+
valueInputOption?:
|
|
3625
|
+
| 'INPUT_VALUE_OPTION_UNSPECIFIED'
|
|
3626
|
+
| 'RAW'
|
|
3627
|
+
| 'USER_ENTERED';
|
|
3181
3628
|
},
|
|
3182
3629
|
body: ValueRange,
|
|
3183
3630
|
): client.Request<UpdateValuesResponse>;
|
|
@@ -3186,11 +3633,11 @@ declare namespace gapi.client {
|
|
|
3186
3633
|
/** Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes. */
|
|
3187
3634
|
batchUpdate(request: {
|
|
3188
3635
|
/** V1 error format. */
|
|
3189
|
-
'$.xgafv'?:
|
|
3636
|
+
'$.xgafv'?: '1' | '2';
|
|
3190
3637
|
/** OAuth access token. */
|
|
3191
3638
|
access_token?: string;
|
|
3192
3639
|
/** Data format for response. */
|
|
3193
|
-
alt?:
|
|
3640
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3194
3641
|
/** JSONP */
|
|
3195
3642
|
callback?: string;
|
|
3196
3643
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3215,11 +3662,11 @@ declare namespace gapi.client {
|
|
|
3215
3662
|
batchUpdate(
|
|
3216
3663
|
request: {
|
|
3217
3664
|
/** V1 error format. */
|
|
3218
|
-
'$.xgafv'?:
|
|
3665
|
+
'$.xgafv'?: '1' | '2';
|
|
3219
3666
|
/** OAuth access token. */
|
|
3220
3667
|
access_token?: string;
|
|
3221
3668
|
/** Data format for response. */
|
|
3222
|
-
alt?:
|
|
3669
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3223
3670
|
/** JSONP */
|
|
3224
3671
|
callback?: string;
|
|
3225
3672
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3244,11 +3691,11 @@ declare namespace gapi.client {
|
|
|
3244
3691
|
/** Creates a spreadsheet, returning the newly created spreadsheet. */
|
|
3245
3692
|
create(request: {
|
|
3246
3693
|
/** V1 error format. */
|
|
3247
|
-
'$.xgafv'?:
|
|
3694
|
+
'$.xgafv'?: '1' | '2';
|
|
3248
3695
|
/** OAuth access token. */
|
|
3249
3696
|
access_token?: string;
|
|
3250
3697
|
/** Data format for response. */
|
|
3251
|
-
alt?:
|
|
3698
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3252
3699
|
/** JSONP */
|
|
3253
3700
|
callback?: string;
|
|
3254
3701
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3271,11 +3718,11 @@ declare namespace gapi.client {
|
|
|
3271
3718
|
create(
|
|
3272
3719
|
request: {
|
|
3273
3720
|
/** V1 error format. */
|
|
3274
|
-
'$.xgafv'?:
|
|
3721
|
+
'$.xgafv'?: '1' | '2';
|
|
3275
3722
|
/** OAuth access token. */
|
|
3276
3723
|
access_token?: string;
|
|
3277
3724
|
/** Data format for response. */
|
|
3278
|
-
alt?:
|
|
3725
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3279
3726
|
/** JSONP */
|
|
3280
3727
|
callback?: string;
|
|
3281
3728
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3298,11 +3745,11 @@ declare namespace gapi.client {
|
|
|
3298
3745
|
/** Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges. */
|
|
3299
3746
|
get(request?: {
|
|
3300
3747
|
/** V1 error format. */
|
|
3301
|
-
'$.xgafv'?:
|
|
3748
|
+
'$.xgafv'?: '1' | '2';
|
|
3302
3749
|
/** OAuth access token. */
|
|
3303
3750
|
access_token?: string;
|
|
3304
3751
|
/** Data format for response. */
|
|
3305
|
-
alt?:
|
|
3752
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3306
3753
|
/** JSONP */
|
|
3307
3754
|
callback?: string;
|
|
3308
3755
|
/** True if tables should be excluded in the banded ranges. False if not set. */
|
|
@@ -3331,11 +3778,11 @@ declare namespace gapi.client {
|
|
|
3331
3778
|
/** Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. */
|
|
3332
3779
|
getByDataFilter(request: {
|
|
3333
3780
|
/** V1 error format. */
|
|
3334
|
-
'$.xgafv'?:
|
|
3781
|
+
'$.xgafv'?: '1' | '2';
|
|
3335
3782
|
/** OAuth access token. */
|
|
3336
3783
|
access_token?: string;
|
|
3337
3784
|
/** Data format for response. */
|
|
3338
|
-
alt?:
|
|
3785
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3339
3786
|
/** JSONP */
|
|
3340
3787
|
callback?: string;
|
|
3341
3788
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -3360,11 +3807,11 @@ declare namespace gapi.client {
|
|
|
3360
3807
|
getByDataFilter(
|
|
3361
3808
|
request: {
|
|
3362
3809
|
/** V1 error format. */
|
|
3363
|
-
'$.xgafv'?:
|
|
3810
|
+
'$.xgafv'?: '1' | '2';
|
|
3364
3811
|
/** OAuth access token. */
|
|
3365
3812
|
access_token?: string;
|
|
3366
3813
|
/** Data format for response. */
|
|
3367
|
-
alt?:
|
|
3814
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3368
3815
|
/** JSONP */
|
|
3369
3816
|
callback?: string;
|
|
3370
3817
|
/** Selector specifying which fields to include in a partial response. */
|