@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/v4.ts CHANGED
@@ -411,7 +411,7 @@ export namespace sheets_v4 {
411
411
  */
412
412
  export interface Schema$BandingProperties {
413
413
  /**
414
- * The first color that is alternating. (Required)
414
+ * The first color that is alternating. (Required) Deprecated: Use first_band_color_style.
415
415
  */
416
416
  firstBandColor?: Schema$Color;
417
417
  /**
@@ -419,7 +419,7 @@ export namespace sheets_v4 {
419
419
  */
420
420
  firstBandColorStyle?: Schema$ColorStyle;
421
421
  /**
422
- * 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.
422
+ * 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.
423
423
  */
424
424
  footerColor?: Schema$Color;
425
425
  /**
@@ -427,7 +427,7 @@ export namespace sheets_v4 {
427
427
  */
428
428
  footerColorStyle?: Schema$ColorStyle;
429
429
  /**
430
- * 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.
430
+ * 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.
431
431
  */
432
432
  headerColor?: Schema$Color;
433
433
  /**
@@ -435,7 +435,7 @@ export namespace sheets_v4 {
435
435
  */
436
436
  headerColorStyle?: Schema$ColorStyle;
437
437
  /**
438
- * The second color that is alternating. (Required)
438
+ * The second color that is alternating. (Required) Deprecated: Use second_band_color_style.
439
439
  */
440
440
  secondBandColor?: Schema$Color;
441
441
  /**
@@ -456,7 +456,7 @@ export namespace sheets_v4 {
456
456
  */
457
457
  description?: string | null;
458
458
  /**
459
- * Color to be used, in case baseline value represents a negative change for key value. This field is optional.
459
+ * Color to be used, in case baseline value represents a negative change for key value. This field is optional. Deprecated: Use negative_color_style.
460
460
  */
461
461
  negativeColor?: Schema$Color;
462
462
  /**
@@ -468,7 +468,7 @@ export namespace sheets_v4 {
468
468
  */
469
469
  position?: Schema$TextPosition;
470
470
  /**
471
- * Color to be used, in case baseline value represents a positive change for key value. This field is optional.
471
+ * Color to be used, in case baseline value represents a positive change for key value. This field is optional. Deprecated: Use positive_color_style.
472
472
  */
473
473
  positiveColor?: Schema$Color;
474
474
  /**
@@ -476,7 +476,7 @@ export namespace sheets_v4 {
476
476
  */
477
477
  positiveColorStyle?: Schema$ColorStyle;
478
478
  /**
479
- * Text formatting options for baseline value.
479
+ * Text formatting options for baseline value. The link field is not supported.
480
480
  */
481
481
  textFormat?: Schema$TextFormat;
482
482
  }
@@ -485,7 +485,7 @@ export namespace sheets_v4 {
485
485
  */
486
486
  export interface Schema$BasicChartAxis {
487
487
  /**
488
- * The format of the title. Only valid if the axis is not associated with the domain.
488
+ * The format of the title. Only valid if the axis is not associated with the domain. The link field is not supported.
489
489
  */
490
490
  format?: Schema$TextFormat;
491
491
  /**
@@ -523,7 +523,7 @@ export namespace sheets_v4 {
523
523
  */
524
524
  export interface Schema$BasicChartSeries {
525
525
  /**
526
- * The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used.
526
+ * 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.
527
527
  */
528
528
  color?: Schema$Color;
529
529
  /**
@@ -638,7 +638,7 @@ export namespace sheets_v4 {
638
638
  */
639
639
  export interface Schema$BasicSeriesDataPointStyleOverride {
640
640
  /**
641
- * Color of the series data point. If empty, the series default is used.
641
+ * Color of the series data point. If empty, the series default is used. Deprecated: Use color_style.
642
642
  */
643
643
  color?: Schema$Color;
644
644
  /**
@@ -668,7 +668,7 @@ export namespace sheets_v4 {
668
668
  */
669
669
  export interface Schema$BatchClearValuesByDataFilterResponse {
670
670
  /**
671
- * 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.
671
+ * 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.
672
672
  */
673
673
  clearedRanges?: string[] | null;
674
674
  /**
@@ -681,7 +681,7 @@ export namespace sheets_v4 {
681
681
  */
682
682
  export interface Schema$BatchClearValuesRequest {
683
683
  /**
684
- * The ranges to clear, in A1 or R1C1 notation.
684
+ * The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell).
685
685
  */
686
686
  ranges?: string[] | null;
687
687
  }
@@ -707,7 +707,7 @@ export namespace sheets_v4 {
707
707
  */
708
708
  dataFilters?: Schema$DataFilter[];
709
709
  /**
710
- * 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].
710
+ * 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.
711
711
  */
712
712
  dateTimeRenderOption?: string | null;
713
713
  /**
@@ -715,7 +715,7 @@ export namespace sheets_v4 {
715
715
  */
716
716
  majorDimension?: string | null;
717
717
  /**
718
- * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
718
+ * How values should be represented in the output. The default render option is FORMATTED_VALUE.
719
719
  */
720
720
  valueRenderOption?: string | null;
721
721
  }
@@ -779,7 +779,7 @@ export namespace sheets_v4 {
779
779
  */
780
780
  spreadsheetId?: string | null;
781
781
  /**
782
- * The spreadsheet after updates were applied. This is only set if [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.
782
+ * The spreadsheet after updates were applied. This is only set if BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response is `true`.
783
783
  */
784
784
  updatedSpreadsheet?: Schema$Spreadsheet;
785
785
  }
@@ -796,11 +796,11 @@ export namespace sheets_v4 {
796
796
  */
797
797
  includeValuesInResponse?: boolean | null;
798
798
  /**
799
- * 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.
799
+ * 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.
800
800
  */
801
801
  responseDateTimeRenderOption?: string | null;
802
802
  /**
803
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
803
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
804
804
  */
805
805
  responseValueRenderOption?: string | null;
806
806
  /**
@@ -850,11 +850,11 @@ export namespace sheets_v4 {
850
850
  */
851
851
  includeValuesInResponse?: boolean | null;
852
852
  /**
853
- * 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.
853
+ * 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.
854
854
  */
855
855
  responseDateTimeRenderOption?: string | null;
856
856
  /**
857
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
857
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
858
858
  */
859
859
  responseValueRenderOption?: string | null;
860
860
  /**
@@ -965,7 +965,7 @@ export namespace sheets_v4 {
965
965
  */
966
966
  export interface Schema$Border {
967
967
  /**
968
- * The color of the border.
968
+ * The color of the border. Deprecated: Use [color_style].
969
969
  */
970
970
  color?: Schema$Color;
971
971
  /**
@@ -1007,7 +1007,7 @@ export namespace sheets_v4 {
1007
1007
  */
1008
1008
  export interface Schema$BubbleChartSpec {
1009
1009
  /**
1010
- * The bubble border color.
1010
+ * The bubble border color. Deprecated: Use bubble_border_color_style.
1011
1011
  */
1012
1012
  bubbleBorderColor?: Schema$Color;
1013
1013
  /**
@@ -1035,7 +1035,7 @@ export namespace sheets_v4 {
1035
1035
  */
1036
1036
  bubbleSizes?: Schema$ChartData;
1037
1037
  /**
1038
- * The format of the text inside the bubbles. Strikethrough and underline are not supported.
1038
+ * The format of the text inside the bubbles. Strikethrough, underline, and link are not supported.
1039
1039
  */
1040
1040
  bubbleTextStyle?: Schema$TextFormat;
1041
1041
  /**
@@ -1116,7 +1116,7 @@ export namespace sheets_v4 {
1116
1116
  */
1117
1117
  export interface Schema$CellData {
1118
1118
  /**
1119
- * 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)`.
1119
+ * 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)`.
1120
1120
  */
1121
1121
  dataSourceFormula?: Schema$DataSourceFormula;
1122
1122
  /**
@@ -1140,7 +1140,7 @@ export namespace sheets_v4 {
1140
1140
  */
1141
1141
  formattedValue?: string | null;
1142
1142
  /**
1143
- * 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.
1143
+ * 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.
1144
1144
  */
1145
1145
  hyperlink?: string | null;
1146
1146
  /**
@@ -1169,7 +1169,7 @@ export namespace sheets_v4 {
1169
1169
  */
1170
1170
  export interface Schema$CellFormat {
1171
1171
  /**
1172
- * The background color of the cell.
1172
+ * The background color of the cell. Deprecated: Use background_color_style.
1173
1173
  */
1174
1174
  backgroundColor?: Schema$Color;
1175
1175
  /**
@@ -1201,7 +1201,7 @@ export namespace sheets_v4 {
1201
1201
  */
1202
1202
  textDirection?: string | null;
1203
1203
  /**
1204
- * The format of the text in the cell (unless overridden by a format run).
1204
+ * 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.
1205
1205
  */
1206
1206
  textFormat?: Schema$TextFormat;
1207
1207
  /**
@@ -1325,7 +1325,7 @@ export namespace sheets_v4 {
1325
1325
  */
1326
1326
  altText?: string | null;
1327
1327
  /**
1328
- * The background color of the entire chart. Not applicable to Org charts.
1328
+ * The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
1329
1329
  */
1330
1330
  backgroundColor?: Schema$Color;
1331
1331
  /**
@@ -1389,7 +1389,7 @@ export namespace sheets_v4 {
1389
1389
  */
1390
1390
  subtitle?: string | null;
1391
1391
  /**
1392
- * The subtitle text format. Strikethrough and underline are not supported.
1392
+ * The subtitle text format. Strikethrough, underline, and link are not supported.
1393
1393
  */
1394
1394
  subtitleTextFormat?: Schema$TextFormat;
1395
1395
  /**
@@ -1401,7 +1401,7 @@ export namespace sheets_v4 {
1401
1401
  */
1402
1402
  title?: string | null;
1403
1403
  /**
1404
- * The title text format. Strikethrough and underline are not supported.
1404
+ * The title text format. Strikethrough, underline, and link are not supported.
1405
1405
  */
1406
1406
  titleTextFormat?: Schema$TextFormat;
1407
1407
  /**
@@ -1640,7 +1640,7 @@ export namespace sheets_v4 {
1640
1640
  */
1641
1641
  placement?: string | null;
1642
1642
  /**
1643
- * The text format used for the data label.
1643
+ * The text format used for the data label. The link field is not supported.
1644
1644
  */
1645
1645
  textFormat?: Schema$TextFormat;
1646
1646
  /**
@@ -2099,7 +2099,7 @@ export namespace sheets_v4 {
2099
2099
  */
2100
2100
  export interface Schema$DeleteSheetRequest {
2101
2101
  /**
2102
- * The ID of the sheet to delete. If the sheet is of SheetType.DATA_SOURCE type, the associated DataSource is also deleted.
2102
+ * The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.
2103
2103
  */
2104
2104
  sheetId?: number | null;
2105
2105
  }
@@ -2336,7 +2336,7 @@ export namespace sheets_v4 {
2336
2336
  */
2337
2337
  export interface Schema$EmbeddedObjectBorder {
2338
2338
  /**
2339
- * The color of the border.
2339
+ * The color of the border. Deprecated: Use color_style.
2340
2340
  */
2341
2341
  color?: Schema$Color;
2342
2342
  /**
@@ -2391,7 +2391,7 @@ export namespace sheets_v4 {
2391
2391
  */
2392
2392
  formulaValue?: string | null;
2393
2393
  /**
2394
- * Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in "serial number" format.
2394
+ * Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
2395
2395
  */
2396
2396
  numberValue?: number | null;
2397
2397
  /**
@@ -2412,7 +2412,7 @@ export namespace sheets_v4 {
2412
2412
  */
2413
2413
  hiddenValues?: string[] | null;
2414
2414
  /**
2415
- * The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color.
2415
+ * 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.
2416
2416
  */
2417
2417
  visibleBackgroundColor?: Schema$Color;
2418
2418
  /**
@@ -2420,7 +2420,7 @@ export namespace sheets_v4 {
2420
2420
  */
2421
2421
  visibleBackgroundColorStyle?: Schema$ColorStyle;
2422
2422
  /**
2423
- * The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color.
2423
+ * 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.
2424
2424
  */
2425
2425
  visibleForegroundColor?: Schema$Color;
2426
2426
  /**
@@ -2650,7 +2650,7 @@ export namespace sheets_v4 {
2650
2650
  rowGroupControlAfter?: boolean | null;
2651
2651
  }
2652
2652
  /**
2653
- * 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!`.
2653
+ * 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!`.
2654
2654
  */
2655
2655
  export interface Schema$GridRange {
2656
2656
  /**
@@ -2721,7 +2721,7 @@ export namespace sheets_v4 {
2721
2721
  */
2722
2722
  export interface Schema$HistogramSeries {
2723
2723
  /**
2724
- * The color of the column representing this series in each bucket. This field is optional.
2724
+ * The color of the column representing this series in each bucket. This field is optional. Deprecated: Use bar_color_style.
2725
2725
  */
2726
2726
  barColor?: Schema$Color;
2727
2727
  /**
@@ -2764,7 +2764,7 @@ export namespace sheets_v4 {
2764
2764
  */
2765
2765
  export interface Schema$InterpolationPoint {
2766
2766
  /**
2767
- * The color this interpolation point should use.
2767
+ * The color this interpolation point should use. Deprecated: Use color_style.
2768
2768
  */
2769
2769
  color?: Schema$Color;
2770
2770
  /**
@@ -2815,7 +2815,7 @@ export namespace sheets_v4 {
2815
2815
  */
2816
2816
  position?: Schema$TextPosition;
2817
2817
  /**
2818
- * Text formatting options for key value.
2818
+ * Text formatting options for key value. The link field is not supported.
2819
2819
  */
2820
2820
  textFormat?: Schema$TextFormat;
2821
2821
  }
@@ -2954,7 +2954,7 @@ export namespace sheets_v4 {
2954
2954
  */
2955
2955
  labels?: Schema$ChartData;
2956
2956
  /**
2957
- * The color of the org chart nodes.
2957
+ * The color of the org chart nodes. Deprecated: Use node_color_style.
2958
2958
  */
2959
2959
  nodeColor?: Schema$Color;
2960
2960
  /**
@@ -2970,7 +2970,7 @@ export namespace sheets_v4 {
2970
2970
  */
2971
2971
  parentLabels?: Schema$ChartData;
2972
2972
  /**
2973
- * The color of the selected org chart nodes.
2973
+ * The color of the selected org chart nodes. Deprecated: Use selected_node_color_style.
2974
2974
  */
2975
2975
  selectedNodeColor?: Schema$Color;
2976
2976
  /**
@@ -3940,7 +3940,7 @@ export namespace sheets_v4 {
3940
3940
  */
3941
3941
  sheetType?: string | null;
3942
3942
  /**
3943
- * The color of the tab in the UI.
3943
+ * The color of the tab in the UI. Deprecated: Use tab_color_style.
3944
3944
  */
3945
3945
  tabColor?: Schema$Color;
3946
3946
  /**
@@ -3978,7 +3978,7 @@ export namespace sheets_v4 {
3978
3978
  */
3979
3979
  applyToPivotTables?: boolean | null;
3980
3980
  /**
3981
- * The background color of the slicer.
3981
+ * The background color of the slicer. Deprecated: Use background_color_style.
3982
3982
  */
3983
3983
  backgroundColor?: Schema$Color;
3984
3984
  /**
@@ -4002,7 +4002,7 @@ export namespace sheets_v4 {
4002
4002
  */
4003
4003
  horizontalAlignment?: string | null;
4004
4004
  /**
4005
- * The text format of title in the slicer.
4005
+ * The text format of title in the slicer. The link field is not supported.
4006
4006
  */
4007
4007
  textFormat?: Schema$TextFormat;
4008
4008
  /**
@@ -4028,7 +4028,7 @@ export namespace sheets_v4 {
4028
4028
  */
4029
4029
  export interface Schema$SortSpec {
4030
4030
  /**
4031
- * The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color.
4031
+ * 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.
4032
4032
  */
4033
4033
  backgroundColor?: Schema$Color;
4034
4034
  /**
@@ -4044,7 +4044,7 @@ export namespace sheets_v4 {
4044
4044
  */
4045
4045
  dimensionIndex?: number | null;
4046
4046
  /**
4047
- * The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color.
4047
+ * 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.
4048
4048
  */
4049
4049
  foregroundColor?: Schema$Color;
4050
4050
  /**
@@ -4173,7 +4173,7 @@ export namespace sheets_v4 {
4173
4173
  */
4174
4174
  fontSize?: number | null;
4175
4175
  /**
4176
- * The foreground color of the text.
4176
+ * The foreground color of the text. Deprecated: Use foreground_color_style.
4177
4177
  */
4178
4178
  foregroundColor?: Schema$Color;
4179
4179
  /**
@@ -4185,7 +4185,7 @@ export namespace sheets_v4 {
4185
4185
  */
4186
4186
  italic?: boolean | null;
4187
4187
  /**
4188
- * 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.
4188
+ * 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.
4189
4189
  */
4190
4190
  link?: Schema$Link;
4191
4191
  /**
@@ -4288,7 +4288,7 @@ export namespace sheets_v4 {
4288
4288
  */
4289
4289
  export interface Schema$TreemapChartColorScale {
4290
4290
  /**
4291
- * The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified.
4291
+ * 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.
4292
4292
  */
4293
4293
  maxValueColor?: Schema$Color;
4294
4294
  /**
@@ -4296,7 +4296,7 @@ export namespace sheets_v4 {
4296
4296
  */
4297
4297
  maxValueColorStyle?: Schema$ColorStyle;
4298
4298
  /**
4299
- * The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified.
4299
+ * 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.
4300
4300
  */
4301
4301
  midValueColor?: Schema$Color;
4302
4302
  /**
@@ -4304,7 +4304,7 @@ export namespace sheets_v4 {
4304
4304
  */
4305
4305
  midValueColorStyle?: Schema$ColorStyle;
4306
4306
  /**
4307
- * The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified.
4307
+ * 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.
4308
4308
  */
4309
4309
  minValueColor?: Schema$Color;
4310
4310
  /**
@@ -4312,7 +4312,7 @@ export namespace sheets_v4 {
4312
4312
  */
4313
4313
  minValueColorStyle?: Schema$ColorStyle;
4314
4314
  /**
4315
- * The background color for cells that have no color data associated with them. Defaults to #000000 if not specified.
4315
+ * 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.
4316
4316
  */
4317
4317
  noDataColor?: Schema$Color;
4318
4318
  /**
@@ -4333,7 +4333,7 @@ export namespace sheets_v4 {
4333
4333
  */
4334
4334
  colorScale?: Schema$TreemapChartColorScale;
4335
4335
  /**
4336
- * The background color for header cells.
4336
+ * The background color for header cells. Deprecated: Use header_color_style.
4337
4337
  */
4338
4338
  headerColor?: Schema$Color;
4339
4339
  /**
@@ -4373,7 +4373,7 @@ export namespace sheets_v4 {
4373
4373
  */
4374
4374
  sizeData?: Schema$ChartData;
4375
4375
  /**
4376
- * The text format for all labels on the chart.
4376
+ * The text format for all labels on the chart. The link field is not supported.
4377
4377
  */
4378
4378
  textFormat?: Schema$TextFormat;
4379
4379
  }
@@ -4758,7 +4758,7 @@ export namespace sheets_v4 {
4758
4758
  */
4759
4759
  updatedData?: Schema$ValueRange;
4760
4760
  /**
4761
- * The range (in A1 notation) that updates were applied to.
4761
+ * The range (in [A1 notation](/sheets/api/guides/concepts#cell)) that updates were applied to.
4762
4762
  */
4763
4763
  updatedRange?: string | null;
4764
4764
  /**
@@ -4804,7 +4804,7 @@ export namespace sheets_v4 {
4804
4804
  */
4805
4805
  majorDimension?: string | null;
4806
4806
  /**
4807
- * 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.
4807
+ * 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.
4808
4808
  */
4809
4809
  range?: string | null;
4810
4810
  /**
@@ -4817,7 +4817,7 @@ export namespace sheets_v4 {
4817
4817
  */
4818
4818
  export interface Schema$WaterfallChartColumnStyle {
4819
4819
  /**
4820
- * The color of the column.
4820
+ * The color of the column. Deprecated: Use color_style.
4821
4821
  */
4822
4822
  color?: Schema$Color;
4823
4823
  /**
@@ -5244,7 +5244,7 @@ export namespace sheets_v4 {
5244
5244
  }
5245
5245
 
5246
5246
  /**
5247
- * 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.
5247
+ * 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.
5248
5248
  * @example
5249
5249
  * ```js
5250
5250
  * // Before running the sample:
@@ -5389,7 +5389,7 @@ export namespace sheets_v4 {
5389
5389
  }
5390
5390
 
5391
5391
  /**
5392
- * 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.
5392
+ * 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.
5393
5393
  * @example
5394
5394
  * ```js
5395
5395
  * // Before running the sample:
@@ -6123,11 +6123,11 @@ export namespace sheets_v4 {
6123
6123
  * includeValuesInResponse: 'placeholder-value',
6124
6124
  * // How the input data should be inserted.
6125
6125
  * insertDataOption: 'placeholder-value',
6126
- * // The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
6126
+ * // 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.
6127
6127
  * range: 'placeholder-value',
6128
- * // 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].
6128
+ * // 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.
6129
6129
  * responseDateTimeRenderOption: 'placeholder-value',
6130
- * // Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
6130
+ * // Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
6131
6131
  * responseValueRenderOption: 'placeholder-value',
6132
6132
  * // The ID of the spreadsheet to update.
6133
6133
  * spreadsheetId: 'placeholder-value',
@@ -6250,7 +6250,7 @@ export namespace sheets_v4 {
6250
6250
  }
6251
6251
 
6252
6252
  /**
6253
- * 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.
6253
+ * 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.
6254
6254
  * @example
6255
6255
  * ```js
6256
6256
  * // Before running the sample:
@@ -6510,7 +6510,8 @@ export namespace sheets_v4 {
6510
6510
 
6511
6511
  if (typeof paramsOrCallback === 'function') {
6512
6512
  callback = paramsOrCallback;
6513
- params = {} as Params$Resource$Spreadsheets$Values$Batchclearbydatafilter;
6513
+ params =
6514
+ {} as Params$Resource$Spreadsheets$Values$Batchclearbydatafilter;
6514
6515
  options = {};
6515
6516
  }
6516
6517
 
@@ -6581,11 +6582,11 @@ export namespace sheets_v4 {
6581
6582
  *
6582
6583
  * // Do the magic
6583
6584
  * const res = await sheets.spreadsheets.values.batchGet({
6584
- * // 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].
6585
+ * // 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.
6585
6586
  * dateTimeRenderOption: 'placeholder-value',
6586
- * // 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]]`.
6587
+ * // 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]]`.
6587
6588
  * majorDimension: 'placeholder-value',
6588
- * // The A1 notation or R1C1 notation of the range to retrieve values from.
6589
+ * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
6589
6590
  * ranges: 'placeholder-value',
6590
6591
  * // The ID of the spreadsheet to retrieve data from.
6591
6592
  * spreadsheetId: 'placeholder-value',
@@ -7129,7 +7130,8 @@ export namespace sheets_v4 {
7129
7130
 
7130
7131
  if (typeof paramsOrCallback === 'function') {
7131
7132
  callback = paramsOrCallback;
7132
- params = {} as Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter;
7133
+ params =
7134
+ {} as Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter;
7133
7135
  options = {};
7134
7136
  }
7135
7137
 
@@ -7198,7 +7200,7 @@ export namespace sheets_v4 {
7198
7200
  *
7199
7201
  * // Do the magic
7200
7202
  * const res = await sheets.spreadsheets.values.clear({
7201
- * // The A1 notation or R1C1 notation of the values to clear.
7203
+ * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.
7202
7204
  * range: 'placeholder-value',
7203
7205
  * // The ID of the spreadsheet to update.
7204
7206
  * spreadsheetId: 'placeholder-value',
@@ -7344,15 +7346,15 @@ export namespace sheets_v4 {
7344
7346
  *
7345
7347
  * // Do the magic
7346
7348
  * const res = await sheets.spreadsheets.values.get({
7347
- * // 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].
7349
+ * // 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.
7348
7350
  * dateTimeRenderOption: 'placeholder-value',
7349
7351
  * // 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]]`.
7350
7352
  * majorDimension: 'placeholder-value',
7351
- * // The A1 notation or R1C1 notation of the range to retrieve values from.
7353
+ * // The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
7352
7354
  * range: 'placeholder-value',
7353
7355
  * // The ID of the spreadsheet to retrieve data from.
7354
7356
  * spreadsheetId: 'placeholder-value',
7355
- * // How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
7357
+ * // How values should be represented in the output. The default render option is FORMATTED_VALUE.
7356
7358
  * valueRenderOption: 'placeholder-value',
7357
7359
  * });
7358
7360
  * console.log(res.data);
@@ -7488,11 +7490,11 @@ export namespace sheets_v4 {
7488
7490
  * const res = await sheets.spreadsheets.values.update({
7489
7491
  * // 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).
7490
7492
  * includeValuesInResponse: 'placeholder-value',
7491
- * // The A1 notation of the values to update.
7493
+ * // The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
7492
7494
  * range: 'placeholder-value',
7493
- * // 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.
7495
+ * // 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.
7494
7496
  * responseDateTimeRenderOption: 'placeholder-value',
7495
- * // Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
7497
+ * // Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
7496
7498
  * responseValueRenderOption: 'placeholder-value',
7497
7499
  * // The ID of the spreadsheet to update.
7498
7500
  * spreadsheetId: 'placeholder-value',
@@ -7629,15 +7631,15 @@ export namespace sheets_v4 {
7629
7631
  */
7630
7632
  insertDataOption?: string;
7631
7633
  /**
7632
- * The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.
7634
+ * 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.
7633
7635
  */
7634
7636
  range?: string;
7635
7637
  /**
7636
- * 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].
7638
+ * 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.
7637
7639
  */
7638
7640
  responseDateTimeRenderOption?: string;
7639
7641
  /**
7640
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
7642
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
7641
7643
  */
7642
7644
  responseValueRenderOption?: string;
7643
7645
  /**
@@ -7681,15 +7683,15 @@ export namespace sheets_v4 {
7681
7683
  export interface Params$Resource$Spreadsheets$Values$Batchget
7682
7684
  extends StandardParameters {
7683
7685
  /**
7684
- * 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].
7686
+ * 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.
7685
7687
  */
7686
7688
  dateTimeRenderOption?: string;
7687
7689
  /**
7688
- * 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]]`.
7690
+ * 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]]`.
7689
7691
  */
7690
7692
  majorDimension?: string;
7691
7693
  /**
7692
- * The A1 notation or R1C1 notation of the range to retrieve values from.
7694
+ * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
7693
7695
  */
7694
7696
  ranges?: string[];
7695
7697
  /**
@@ -7740,7 +7742,7 @@ export namespace sheets_v4 {
7740
7742
  export interface Params$Resource$Spreadsheets$Values$Clear
7741
7743
  extends StandardParameters {
7742
7744
  /**
7743
- * The A1 notation or R1C1 notation of the values to clear.
7745
+ * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.
7744
7746
  */
7745
7747
  range?: string;
7746
7748
  /**
@@ -7756,7 +7758,7 @@ export namespace sheets_v4 {
7756
7758
  export interface Params$Resource$Spreadsheets$Values$Get
7757
7759
  extends StandardParameters {
7758
7760
  /**
7759
- * 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].
7761
+ * 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.
7760
7762
  */
7761
7763
  dateTimeRenderOption?: string;
7762
7764
  /**
@@ -7764,7 +7766,7 @@ export namespace sheets_v4 {
7764
7766
  */
7765
7767
  majorDimension?: string;
7766
7768
  /**
7767
- * The A1 notation or R1C1 notation of the range to retrieve values from.
7769
+ * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.
7768
7770
  */
7769
7771
  range?: string;
7770
7772
  /**
@@ -7772,7 +7774,7 @@ export namespace sheets_v4 {
7772
7774
  */
7773
7775
  spreadsheetId?: string;
7774
7776
  /**
7775
- * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
7777
+ * How values should be represented in the output. The default render option is FORMATTED_VALUE.
7776
7778
  */
7777
7779
  valueRenderOption?: string;
7778
7780
  }
@@ -7783,15 +7785,15 @@ export namespace sheets_v4 {
7783
7785
  */
7784
7786
  includeValuesInResponse?: boolean;
7785
7787
  /**
7786
- * The A1 notation of the values to update.
7788
+ * The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
7787
7789
  */
7788
7790
  range?: string;
7789
7791
  /**
7790
- * 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.
7792
+ * 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.
7791
7793
  */
7792
7794
  responseDateTimeRenderOption?: string;
7793
7795
  /**
7794
- * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
7796
+ * Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
7795
7797
  */
7796
7798
  responseValueRenderOption?: string;
7797
7799
  /**