@googleapis/sheets 0.3.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v4.d.ts CHANGED
@@ -357,7 +357,7 @@ export declare namespace sheets_v4 {
357
357
  */
358
358
  export interface Schema$BandingProperties {
359
359
  /**
360
- * The first color that is alternating. (Required)
360
+ * The first color that is alternating. (Required) Deprecated: Use first_band_color_style.
361
361
  */
362
362
  firstBandColor?: Schema$Color;
363
363
  /**
@@ -365,7 +365,7 @@ export declare namespace sheets_v4 {
365
365
  */
366
366
  firstBandColorStyle?: Schema$ColorStyle;
367
367
  /**
368
- * The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column.
368
+ * The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. Deprecated: Use footer_color_style.
369
369
  */
370
370
  footerColor?: Schema$Color;
371
371
  /**
@@ -373,7 +373,7 @@ export declare namespace sheets_v4 {
373
373
  */
374
374
  footerColorStyle?: Schema$ColorStyle;
375
375
  /**
376
- * The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would.
376
+ * The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. Deprecated: Use header_color_style.
377
377
  */
378
378
  headerColor?: Schema$Color;
379
379
  /**
@@ -381,7 +381,7 @@ export declare namespace sheets_v4 {
381
381
  */
382
382
  headerColorStyle?: Schema$ColorStyle;
383
383
  /**
384
- * The second color that is alternating. (Required)
384
+ * The second color that is alternating. (Required) Deprecated: Use second_band_color_style.
385
385
  */
386
386
  secondBandColor?: Schema$Color;
387
387
  /**
@@ -402,7 +402,7 @@ export declare namespace sheets_v4 {
402
402
  */
403
403
  description?: string | null;
404
404
  /**
405
- * Color to be used, in case baseline value represents a negative change for key value. This field is optional.
405
+ * Color to be used, in case baseline value represents a negative change for key value. This field is optional. Deprecated: Use negative_color_style.
406
406
  */
407
407
  negativeColor?: Schema$Color;
408
408
  /**
@@ -414,7 +414,7 @@ export declare namespace sheets_v4 {
414
414
  */
415
415
  position?: Schema$TextPosition;
416
416
  /**
417
- * Color to be used, in case baseline value represents a positive change for key value. This field is optional.
417
+ * Color to be used, in case baseline value represents a positive change for key value. This field is optional. Deprecated: Use positive_color_style.
418
418
  */
419
419
  positiveColor?: Schema$Color;
420
420
  /**
@@ -422,7 +422,7 @@ export declare namespace sheets_v4 {
422
422
  */
423
423
  positiveColorStyle?: Schema$ColorStyle;
424
424
  /**
425
- * Text formatting options for baseline value.
425
+ * Text formatting options for baseline value. The link field is not supported.
426
426
  */
427
427
  textFormat?: Schema$TextFormat;
428
428
  }
@@ -431,7 +431,7 @@ export declare namespace sheets_v4 {
431
431
  */
432
432
  export interface Schema$BasicChartAxis {
433
433
  /**
434
- * The format of the title. Only valid if the axis is not associated with the domain.
434
+ * The format of the title. Only valid if the axis is not associated with the domain. The link field is not supported.
435
435
  */
436
436
  format?: Schema$TextFormat;
437
437
  /**
@@ -469,7 +469,7 @@ export declare namespace sheets_v4 {
469
469
  */
470
470
  export interface Schema$BasicChartSeries {
471
471
  /**
472
- * The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used.
472
+ * The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style.
473
473
  */
474
474
  color?: Schema$Color;
475
475
  /**
@@ -586,7 +586,7 @@ export declare namespace sheets_v4 {
586
586
  */
587
587
  export interface Schema$BasicSeriesDataPointStyleOverride {
588
588
  /**
589
- * Color of the series data point. If empty, the series default is used.
589
+ * Color of the series data point. If empty, the series default is used. Deprecated: Use color_style.
590
590
  */
591
591
  color?: Schema$Color;
592
592
  /**
@@ -616,7 +616,7 @@ export declare namespace sheets_v4 {
616
616
  */
617
617
  export interface Schema$BatchClearValuesByDataFilterResponse {
618
618
  /**
619
- * The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.
619
+ * The ranges that were cleared, in [A1 notation](/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.
620
620
  */
621
621
  clearedRanges?: string[] | null;
622
622
  /**
@@ -629,7 +629,7 @@ export declare namespace sheets_v4 {
629
629
  */
630
630
  export interface Schema$BatchClearValuesRequest {
631
631
  /**
632
- * The ranges to clear, in A1 or R1C1 notation.
632
+ * The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell).
633
633
  */
634
634
  ranges?: string[] | null;
635
635
  }
@@ -655,7 +655,7 @@ export declare namespace sheets_v4 {
655
655
  */
656
656
  dataFilters?: Schema$DataFilter[];
657
657
  /**
658
- * 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 [DateTimeRenderOption.SERIAL_NUMBER].
658
+ * 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.
659
659
  */
660
660
  dateTimeRenderOption?: string | null;
661
661
  /**
@@ -663,7 +663,7 @@ export declare namespace sheets_v4 {
663
663
  */
664
664
  majorDimension?: string | null;
665
665
  /**
666
- * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
666
+ * How values should be represented in the output. The default render option is FORMATTED_VALUE.
667
667
  */
668
668
  valueRenderOption?: string | null;
669
669
  }
@@ -727,7 +727,7 @@ export declare namespace sheets_v4 {
727
727
  */
728
728
  spreadsheetId?: string | null;
729
729
  /**
730
- * The spreadsheet after updates were applied. This is only set if [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.
730
+ * The spreadsheet after updates were applied. This is only set if BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response is `true`.
731
731
  */
732
732
  updatedSpreadsheet?: Schema$Spreadsheet;
733
733
  }
@@ -744,11 +744,11 @@ export declare namespace sheets_v4 {
744
744
  */
745
745
  includeValuesInResponse?: boolean | null;
746
746
  /**
747
- * 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 DateTimeRenderOption.SERIAL_NUMBER.
747
+ * 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.
748
748
  */
749
749
  responseDateTimeRenderOption?: string | null;
750
750
  /**
751
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
751
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
752
752
  */
753
753
  responseValueRenderOption?: string | null;
754
754
  /**
@@ -798,11 +798,11 @@ export declare namespace sheets_v4 {
798
798
  */
799
799
  includeValuesInResponse?: boolean | null;
800
800
  /**
801
- * 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 DateTimeRenderOption.SERIAL_NUMBER.
801
+ * 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.
802
802
  */
803
803
  responseDateTimeRenderOption?: string | null;
804
804
  /**
805
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
805
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
806
806
  */
807
807
  responseValueRenderOption?: string | null;
808
808
  /**
@@ -913,7 +913,7 @@ export declare namespace sheets_v4 {
913
913
  */
914
914
  export interface Schema$Border {
915
915
  /**
916
- * The color of the border.
916
+ * The color of the border. Deprecated: Use [color_style].
917
917
  */
918
918
  color?: Schema$Color;
919
919
  /**
@@ -955,7 +955,7 @@ export declare namespace sheets_v4 {
955
955
  */
956
956
  export interface Schema$BubbleChartSpec {
957
957
  /**
958
- * The bubble border color.
958
+ * The bubble border color. Deprecated: Use bubble_border_color_style.
959
959
  */
960
960
  bubbleBorderColor?: Schema$Color;
961
961
  /**
@@ -983,7 +983,7 @@ export declare namespace sheets_v4 {
983
983
  */
984
984
  bubbleSizes?: Schema$ChartData;
985
985
  /**
986
- * The format of the text inside the bubbles. Strikethrough and underline are not supported.
986
+ * The format of the text inside the bubbles. Strikethrough, underline, and link are not supported.
987
987
  */
988
988
  bubbleTextStyle?: Schema$TextFormat;
989
989
  /**
@@ -1064,7 +1064,7 @@ export declare namespace sheets_v4 {
1064
1064
  */
1065
1065
  export interface Schema$CellData {
1066
1066
  /**
1067
- * Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g `=SUM(DataSheet!Column)`.
1067
+ * Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`.
1068
1068
  */
1069
1069
  dataSourceFormula?: Schema$DataSourceFormula;
1070
1070
  /**
@@ -1088,7 +1088,7 @@ export declare namespace sheets_v4 {
1088
1088
  */
1089
1089
  formattedValue?: string | null;
1090
1090
  /**
1091
- * A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.
1091
+ * A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the userEnteredFormat.textFormat field. Alternatively, set a hyperlink in the textFormatRun.format.link field that spans the entire cell.
1092
1092
  */
1093
1093
  hyperlink?: string | null;
1094
1094
  /**
@@ -1117,7 +1117,7 @@ export declare namespace sheets_v4 {
1117
1117
  */
1118
1118
  export interface Schema$CellFormat {
1119
1119
  /**
1120
- * The background color of the cell.
1120
+ * The background color of the cell. Deprecated: Use background_color_style.
1121
1121
  */
1122
1122
  backgroundColor?: Schema$Color;
1123
1123
  /**
@@ -1149,7 +1149,7 @@ export declare namespace sheets_v4 {
1149
1149
  */
1150
1150
  textDirection?: string | null;
1151
1151
  /**
1152
- * The format of the text in the cell (unless overridden by a format run).
1152
+ * The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here will clear the cell's existing links. Setting the link field in a TextFormatRun will take precedence over the cell-level link.
1153
1153
  */
1154
1154
  textFormat?: Schema$TextFormat;
1155
1155
  /**
@@ -1273,7 +1273,7 @@ export declare namespace sheets_v4 {
1273
1273
  */
1274
1274
  altText?: string | null;
1275
1275
  /**
1276
- * The background color of the entire chart. Not applicable to Org charts.
1276
+ * The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
1277
1277
  */
1278
1278
  backgroundColor?: Schema$Color;
1279
1279
  /**
@@ -1337,7 +1337,7 @@ export declare namespace sheets_v4 {
1337
1337
  */
1338
1338
  subtitle?: string | null;
1339
1339
  /**
1340
- * The subtitle text format. Strikethrough and underline are not supported.
1340
+ * The subtitle text format. Strikethrough, underline, and link are not supported.
1341
1341
  */
1342
1342
  subtitleTextFormat?: Schema$TextFormat;
1343
1343
  /**
@@ -1349,7 +1349,7 @@ export declare namespace sheets_v4 {
1349
1349
  */
1350
1350
  title?: string | null;
1351
1351
  /**
1352
- * The title text format. Strikethrough and underline are not supported.
1352
+ * The title text format. Strikethrough, underline, and link are not supported.
1353
1353
  */
1354
1354
  titleTextFormat?: Schema$TextFormat;
1355
1355
  /**
@@ -1589,7 +1589,7 @@ export declare namespace sheets_v4 {
1589
1589
  */
1590
1590
  placement?: string | null;
1591
1591
  /**
1592
- * The text format used for the data label.
1592
+ * The text format used for the data label. The link field is not supported.
1593
1593
  */
1594
1594
  textFormat?: Schema$TextFormat;
1595
1595
  /**
@@ -2048,7 +2048,7 @@ export declare namespace sheets_v4 {
2048
2048
  */
2049
2049
  export interface Schema$DeleteSheetRequest {
2050
2050
  /**
2051
- * The ID of the sheet to delete. If the sheet is of SheetType.DATA_SOURCE type, the associated DataSource is also deleted.
2051
+ * The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.
2052
2052
  */
2053
2053
  sheetId?: number | null;
2054
2054
  }
@@ -2285,7 +2285,7 @@ export declare namespace sheets_v4 {
2285
2285
  */
2286
2286
  export interface Schema$EmbeddedObjectBorder {
2287
2287
  /**
2288
- * The color of the border.
2288
+ * The color of the border. Deprecated: Use color_style.
2289
2289
  */
2290
2290
  color?: Schema$Color;
2291
2291
  /**
@@ -2340,7 +2340,7 @@ export declare namespace sheets_v4 {
2340
2340
  */
2341
2341
  formulaValue?: string | null;
2342
2342
  /**
2343
- * Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in "serial number" format.
2343
+ * Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
2344
2344
  */
2345
2345
  numberValue?: number | null;
2346
2346
  /**
@@ -2361,7 +2361,7 @@ export declare namespace sheets_v4 {
2361
2361
  */
2362
2362
  hiddenValues?: string[] | null;
2363
2363
  /**
2364
- * The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color.
2364
+ * The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
2365
2365
  */
2366
2366
  visibleBackgroundColor?: Schema$Color;
2367
2367
  /**
@@ -2369,7 +2369,7 @@ export declare namespace sheets_v4 {
2369
2369
  */
2370
2370
  visibleBackgroundColorStyle?: Schema$ColorStyle;
2371
2371
  /**
2372
- * The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color.
2372
+ * The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
2373
2373
  */
2374
2374
  visibleForegroundColor?: Schema$Color;
2375
2375
  /**
@@ -2601,7 +2601,7 @@ export declare namespace sheets_v4 {
2601
2601
  rowGroupControlAfter?: boolean | null;
2602
2602
  }
2603
2603
  /**
2604
- * A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.
2604
+ * A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.
2605
2605
  */
2606
2606
  export interface Schema$GridRange {
2607
2607
  /**
@@ -2672,7 +2672,7 @@ export declare namespace sheets_v4 {
2672
2672
  */
2673
2673
  export interface Schema$HistogramSeries {
2674
2674
  /**
2675
- * The color of the column representing this series in each bucket. This field is optional.
2675
+ * The color of the column representing this series in each bucket. This field is optional. Deprecated: Use bar_color_style.
2676
2676
  */
2677
2677
  barColor?: Schema$Color;
2678
2678
  /**
@@ -2715,7 +2715,7 @@ export declare namespace sheets_v4 {
2715
2715
  */
2716
2716
  export interface Schema$InterpolationPoint {
2717
2717
  /**
2718
- * The color this interpolation point should use.
2718
+ * The color this interpolation point should use. Deprecated: Use color_style.
2719
2719
  */
2720
2720
  color?: Schema$Color;
2721
2721
  /**
@@ -2766,7 +2766,7 @@ export declare namespace sheets_v4 {
2766
2766
  */
2767
2767
  position?: Schema$TextPosition;
2768
2768
  /**
2769
- * Text formatting options for key value.
2769
+ * Text formatting options for key value. The link field is not supported.
2770
2770
  */
2771
2771
  textFormat?: Schema$TextFormat;
2772
2772
  }
@@ -2905,7 +2905,7 @@ export declare namespace sheets_v4 {
2905
2905
  */
2906
2906
  labels?: Schema$ChartData;
2907
2907
  /**
2908
- * The color of the org chart nodes.
2908
+ * The color of the org chart nodes. Deprecated: Use node_color_style.
2909
2909
  */
2910
2910
  nodeColor?: Schema$Color;
2911
2911
  /**
@@ -2921,7 +2921,7 @@ export declare namespace sheets_v4 {
2921
2921
  */
2922
2922
  parentLabels?: Schema$ChartData;
2923
2923
  /**
2924
- * The color of the selected org chart nodes.
2924
+ * The color of the selected org chart nodes. Deprecated: Use selected_node_color_style.
2925
2925
  */
2926
2926
  selectedNodeColor?: Schema$Color;
2927
2927
  /**
@@ -3893,7 +3893,7 @@ export declare namespace sheets_v4 {
3893
3893
  */
3894
3894
  sheetType?: string | null;
3895
3895
  /**
3896
- * The color of the tab in the UI.
3896
+ * The color of the tab in the UI. Deprecated: Use tab_color_style.
3897
3897
  */
3898
3898
  tabColor?: Schema$Color;
3899
3899
  /**
@@ -3931,7 +3931,7 @@ export declare namespace sheets_v4 {
3931
3931
  */
3932
3932
  applyToPivotTables?: boolean | null;
3933
3933
  /**
3934
- * The background color of the slicer.
3934
+ * The background color of the slicer. Deprecated: Use background_color_style.
3935
3935
  */
3936
3936
  backgroundColor?: Schema$Color;
3937
3937
  /**
@@ -3955,7 +3955,7 @@ export declare namespace sheets_v4 {
3955
3955
  */
3956
3956
  horizontalAlignment?: string | null;
3957
3957
  /**
3958
- * The text format of title in the slicer.
3958
+ * The text format of title in the slicer. The link field is not supported.
3959
3959
  */
3960
3960
  textFormat?: Schema$TextFormat;
3961
3961
  /**
@@ -3981,7 +3981,7 @@ export declare namespace sheets_v4 {
3981
3981
  */
3982
3982
  export interface Schema$SortSpec {
3983
3983
  /**
3984
- * The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color.
3984
+ * The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
3985
3985
  */
3986
3986
  backgroundColor?: Schema$Color;
3987
3987
  /**
@@ -3997,7 +3997,7 @@ export declare namespace sheets_v4 {
3997
3997
  */
3998
3998
  dimensionIndex?: number | null;
3999
3999
  /**
4000
- * The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color.
4000
+ * The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
4001
4001
  */
4002
4002
  foregroundColor?: Schema$Color;
4003
4003
  /**
@@ -4126,7 +4126,7 @@ export declare namespace sheets_v4 {
4126
4126
  */
4127
4127
  fontSize?: number | null;
4128
4128
  /**
4129
- * The foreground color of the text.
4129
+ * The foreground color of the text. Deprecated: Use foreground_color_style.
4130
4130
  */
4131
4131
  foregroundColor?: Schema$Color;
4132
4132
  /**
@@ -4138,7 +4138,7 @@ export declare namespace sheets_v4 {
4138
4138
  */
4139
4139
  italic?: boolean | null;
4140
4140
  /**
4141
- * The link destination of the text, if any. Setting a link in a format run will clear an existing cell-level link. When a link is set, the text foreground color will be set to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults.
4141
+ * The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults.
4142
4142
  */
4143
4143
  link?: Schema$Link;
4144
4144
  /**
@@ -4241,7 +4241,7 @@ export declare namespace sheets_v4 {
4241
4241
  */
4242
4242
  export interface Schema$TreemapChartColorScale {
4243
4243
  /**
4244
- * The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified.
4244
+ * The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. Deprecated: Use max_value_color_style.
4245
4245
  */
4246
4246
  maxValueColor?: Schema$Color;
4247
4247
  /**
@@ -4249,7 +4249,7 @@ export declare namespace sheets_v4 {
4249
4249
  */
4250
4250
  maxValueColorStyle?: Schema$ColorStyle;
4251
4251
  /**
4252
- * The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified.
4252
+ * The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. Deprecated: Use mid_value_color_style.
4253
4253
  */
4254
4254
  midValueColor?: Schema$Color;
4255
4255
  /**
@@ -4257,7 +4257,7 @@ export declare namespace sheets_v4 {
4257
4257
  */
4258
4258
  midValueColorStyle?: Schema$ColorStyle;
4259
4259
  /**
4260
- * The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified.
4260
+ * The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. Deprecated: Use min_value_color_style.
4261
4261
  */
4262
4262
  minValueColor?: Schema$Color;
4263
4263
  /**
@@ -4265,7 +4265,7 @@ export declare namespace sheets_v4 {
4265
4265
  */
4266
4266
  minValueColorStyle?: Schema$ColorStyle;
4267
4267
  /**
4268
- * The background color for cells that have no color data associated with them. Defaults to #000000 if not specified.
4268
+ * The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. Deprecated: Use no_data_color_style.
4269
4269
  */
4270
4270
  noDataColor?: Schema$Color;
4271
4271
  /**
@@ -4286,7 +4286,7 @@ export declare namespace sheets_v4 {
4286
4286
  */
4287
4287
  colorScale?: Schema$TreemapChartColorScale;
4288
4288
  /**
4289
- * The background color for header cells.
4289
+ * The background color for header cells. Deprecated: Use header_color_style.
4290
4290
  */
4291
4291
  headerColor?: Schema$Color;
4292
4292
  /**
@@ -4326,7 +4326,7 @@ export declare namespace sheets_v4 {
4326
4326
  */
4327
4327
  sizeData?: Schema$ChartData;
4328
4328
  /**
4329
- * The text format for all labels on the chart.
4329
+ * The text format for all labels on the chart. The link field is not supported.
4330
4330
  */
4331
4331
  textFormat?: Schema$TextFormat;
4332
4332
  }
@@ -4711,7 +4711,7 @@ export declare namespace sheets_v4 {
4711
4711
  */
4712
4712
  updatedData?: Schema$ValueRange;
4713
4713
  /**
4714
- * The range (in A1 notation) that updates were applied to.
4714
+ * The range (in [A1 notation](/sheets/api/guides/concepts#cell)) that updates were applied to.
4715
4715
  */
4716
4716
  updatedRange?: string | null;
4717
4717
  /**
@@ -4757,7 +4757,7 @@ export declare namespace sheets_v4 {
4757
4757
  */
4758
4758
  majorDimension?: string | null;
4759
4759
  /**
4760
- * The range the values cover, in A1 notation. 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.
4760
+ * The range the values cover, in [A1 notation](/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.
4761
4761
  */
4762
4762
  range?: string | null;
4763
4763
  /**
@@ -4770,7 +4770,7 @@ export declare namespace sheets_v4 {
4770
4770
  */
4771
4771
  export interface Schema$WaterfallChartColumnStyle {
4772
4772
  /**
4773
- * The color of the column.
4773
+ * The color of the column. Deprecated: Use color_style.
4774
4774
  */
4775
4775
  color?: Schema$Color;
4776
4776
  /**
@@ -5037,7 +5037,7 @@ export declare namespace sheets_v4 {
5037
5037
  create(params: Params$Resource$Spreadsheets$Create, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
5038
5038
  create(callback: BodyResponseCallback<Schema$Spreadsheet>): void;
5039
5039
  /**
5040
- * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.
5040
+ * 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 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](/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.
5041
5041
  * @example
5042
5042
  * ```js
5043
5043
  * // Before running the sample:
@@ -5110,7 +5110,7 @@ export declare namespace sheets_v4 {
5110
5110
  get(params: Params$Resource$Spreadsheets$Get, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
5111
5111
  get(callback: BodyResponseCallback<Schema$Spreadsheet>): void;
5112
5112
  /**
5113
- * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. 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 will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want.
5113
+ * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. 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 one of 2 ways: * Specify a field mask 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.
5114
5114
  * @example
5115
5115
  * ```js
5116
5116
  * // Before running the sample:
@@ -5519,11 +5519,11 @@ export declare namespace sheets_v4 {
5519
5519
  * includeValuesInResponse: 'placeholder-value',
5520
5520
  * // How the input data should be inserted.
5521
5521
  * insertDataOption: 'placeholder-value',
5522
- * // The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
5522
+ * // The [A1 notation](/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.
5523
5523
  * range: 'placeholder-value',
5524
- * // 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 [DateTimeRenderOption.SERIAL_NUMBER].
5524
+ * // 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.
5525
5525
  * responseDateTimeRenderOption: 'placeholder-value',
5526
- * // Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
5526
+ * // Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
5527
5527
  * responseValueRenderOption: 'placeholder-value',
5528
5528
  * // The ID of the spreadsheet to update.
5529
5529
  * spreadsheetId: 'placeholder-value',
@@ -5569,7 +5569,7 @@ export declare namespace sheets_v4 {
5569
5569
  append(params: Params$Resource$Spreadsheets$Values$Append, callback: BodyResponseCallback<Schema$AppendValuesResponse>): void;
5570
5570
  append(callback: BodyResponseCallback<Schema$AppendValuesResponse>): void;
5571
5571
  /**
5572
- * 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, data validation, etc..) are kept.
5572
+ * 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.
5573
5573
  * @example
5574
5574
  * ```js
5575
5575
  * // Before running the sample:
@@ -5739,11 +5739,11 @@ export declare namespace sheets_v4 {
5739
5739
  *
5740
5740
  * // Do the magic
5741
5741
  * const res = await sheets.spreadsheets.values.batchGet({
5742
- * // 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 [DateTimeRenderOption.SERIAL_NUMBER].
5742
+ * // 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.
5743
5743
  * dateTimeRenderOption: 'placeholder-value',
5744
- * // The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
5744
+ * // 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]]`.
5745
5745
  * majorDimension: 'placeholder-value',
5746
- * // The A1 notation or R1C1 notation of the range to retrieve values from.
5746
+ * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
5747
5747
  * ranges: 'placeholder-value',
5748
5748
  * // The ID of the spreadsheet to retrieve data from.
5749
5749
  * spreadsheetId: 'placeholder-value',
@@ -6034,7 +6034,7 @@ export declare namespace sheets_v4 {
6034
6034
  *
6035
6035
  * // Do the magic
6036
6036
  * const res = await sheets.spreadsheets.values.clear({
6037
- * // The A1 notation or R1C1 notation of the values to clear.
6037
+ * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.
6038
6038
  * range: 'placeholder-value',
6039
6039
  * // The ID of the spreadsheet to update.
6040
6040
  * spreadsheetId: 'placeholder-value',
@@ -6105,15 +6105,15 @@ export declare namespace sheets_v4 {
6105
6105
  *
6106
6106
  * // Do the magic
6107
6107
  * const res = await sheets.spreadsheets.values.get({
6108
- * // 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 [DateTimeRenderOption.SERIAL_NUMBER].
6108
+ * // 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.
6109
6109
  * dateTimeRenderOption: 'placeholder-value',
6110
6110
  * // The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
6111
6111
  * majorDimension: 'placeholder-value',
6112
- * // The A1 notation or R1C1 notation of the range to retrieve values from.
6112
+ * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
6113
6113
  * range: 'placeholder-value',
6114
6114
  * // The ID of the spreadsheet to retrieve data from.
6115
6115
  * spreadsheetId: 'placeholder-value',
6116
- * // How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
6116
+ * // How values should be represented in the output. The default render option is FORMATTED_VALUE.
6117
6117
  * valueRenderOption: 'placeholder-value',
6118
6118
  * });
6119
6119
  * console.log(res.data);
@@ -6177,11 +6177,11 @@ export declare namespace sheets_v4 {
6177
6177
  * const res = await sheets.spreadsheets.values.update({
6178
6178
  * // Determines if the update response should include the values of the cells that were updated. By default, responses do not include 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).
6179
6179
  * includeValuesInResponse: 'placeholder-value',
6180
- * // The A1 notation of the values to update.
6180
+ * // The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
6181
6181
  * range: 'placeholder-value',
6182
- * // 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 DateTimeRenderOption.SERIAL_NUMBER.
6182
+ * // 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.
6183
6183
  * responseDateTimeRenderOption: 'placeholder-value',
6184
- * // Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
6184
+ * // Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
6185
6185
  * responseValueRenderOption: 'placeholder-value',
6186
6186
  * // The ID of the spreadsheet to update.
6187
6187
  * spreadsheetId: 'placeholder-value',
@@ -6240,15 +6240,15 @@ export declare namespace sheets_v4 {
6240
6240
  */
6241
6241
  insertDataOption?: string;
6242
6242
  /**
6243
- * The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
6243
+ * The [A1 notation](/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.
6244
6244
  */
6245
6245
  range?: string;
6246
6246
  /**
6247
- * 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 [DateTimeRenderOption.SERIAL_NUMBER].
6247
+ * 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.
6248
6248
  */
6249
6249
  responseDateTimeRenderOption?: string;
6250
6250
  /**
6251
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
6251
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
6252
6252
  */
6253
6253
  responseValueRenderOption?: string;
6254
6254
  /**
@@ -6286,15 +6286,15 @@ export declare namespace sheets_v4 {
6286
6286
  }
6287
6287
  export interface Params$Resource$Spreadsheets$Values$Batchget extends StandardParameters {
6288
6288
  /**
6289
- * 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 [DateTimeRenderOption.SERIAL_NUMBER].
6289
+ * 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.
6290
6290
  */
6291
6291
  dateTimeRenderOption?: string;
6292
6292
  /**
6293
- * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
6293
+ * 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]]`.
6294
6294
  */
6295
6295
  majorDimension?: string;
6296
6296
  /**
6297
- * The A1 notation or R1C1 notation of the range to retrieve values from.
6297
+ * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
6298
6298
  */
6299
6299
  ranges?: string[];
6300
6300
  /**
@@ -6338,7 +6338,7 @@ export declare namespace sheets_v4 {
6338
6338
  }
6339
6339
  export interface Params$Resource$Spreadsheets$Values$Clear extends StandardParameters {
6340
6340
  /**
6341
- * The A1 notation or R1C1 notation of the values to clear.
6341
+ * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.
6342
6342
  */
6343
6343
  range?: string;
6344
6344
  /**
@@ -6352,7 +6352,7 @@ export declare namespace sheets_v4 {
6352
6352
  }
6353
6353
  export interface Params$Resource$Spreadsheets$Values$Get extends StandardParameters {
6354
6354
  /**
6355
- * 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 [DateTimeRenderOption.SERIAL_NUMBER].
6355
+ * 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.
6356
6356
  */
6357
6357
  dateTimeRenderOption?: string;
6358
6358
  /**
@@ -6360,7 +6360,7 @@ export declare namespace sheets_v4 {
6360
6360
  */
6361
6361
  majorDimension?: string;
6362
6362
  /**
6363
- * The A1 notation or R1C1 notation of the range to retrieve values from.
6363
+ * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
6364
6364
  */
6365
6365
  range?: string;
6366
6366
  /**
@@ -6368,7 +6368,7 @@ export declare namespace sheets_v4 {
6368
6368
  */
6369
6369
  spreadsheetId?: string;
6370
6370
  /**
6371
- * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
6371
+ * How values should be represented in the output. The default render option is FORMATTED_VALUE.
6372
6372
  */
6373
6373
  valueRenderOption?: string;
6374
6374
  }
@@ -6378,15 +6378,15 @@ export declare namespace sheets_v4 {
6378
6378
  */
6379
6379
  includeValuesInResponse?: boolean;
6380
6380
  /**
6381
- * The A1 notation of the values to update.
6381
+ * The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
6382
6382
  */
6383
6383
  range?: string;
6384
6384
  /**
6385
- * 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 DateTimeRenderOption.SERIAL_NUMBER.
6385
+ * 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.
6386
6386
  */
6387
6387
  responseDateTimeRenderOption?: string;
6388
6388
  /**
6389
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
6389
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
6390
6390
  */
6391
6391
  responseValueRenderOption?: string;
6392
6392
  /**