google-apis-sheets_v4 0.39.0 → 0.41.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/sheets_v4/classes.rb +291 -17
- data/lib/google/apis/sheets_v4/gem_version.rb +3 -3
- data/lib/google/apis/sheets_v4/representations.rb +126 -0
- data/lib/google/apis/sheets_v4/service.rb +31 -25
- data/lib/google/apis/sheets_v4.rb +1 -1
- metadata +4 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b480e5466bc36e73ba80e34972d75d8dd6e211caa0dfe2443b5c5a46b451f8cc
|
4
|
+
data.tar.gz: e6468749cdaaebd44ae206dc484a97562eda9518c89b4674cdff525b7afd0f20
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 69a7b293eb23a968ef1f77f1ee0ef74aac21a20e0b335653efe6d4865183586dba6fe3954568a2c5caa90ea2eed6c7d61039bc89a0eefddeeaafff9acae1c352
|
7
|
+
data.tar.gz: e957e669f3bfbe7e54d155682c7c5b5619d2b707dc7dc549e104f0bd5103791de4407bb23dc1115fb53d79f989c4e6a8a8d9313bcbdd458f8ea68dc63eb37e30
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,14 @@
|
|
1
1
|
# Release history for google-apis-sheets_v4
|
2
2
|
|
3
|
+
### v0.41.0 (2025-04-27)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250415
|
6
|
+
|
7
|
+
### v0.40.0 (2025-04-06)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20250325
|
10
|
+
* Regenerated using generator version 0.16.0
|
11
|
+
|
3
12
|
### v0.39.0 (2024-12-15)
|
4
13
|
|
5
14
|
* Regenerated from discovery document revision 20241203
|
data/OVERVIEW.md
CHANGED
@@ -79,7 +79,7 @@ Gem names for modern clients are often of the form `google-cloud-<service_name>`
|
|
79
79
|
|
80
80
|
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
81
|
|
82
|
-
The [product documentation](https://developers.google.com/sheets/) may provide guidance regarding the preferred client library to use.
|
82
|
+
The [product documentation](https://developers.google.com/workspace/sheets/) may provide guidance regarding the preferred client library to use.
|
83
83
|
|
84
84
|
## Supported Ruby versions
|
85
85
|
|
@@ -424,6 +424,25 @@ module Google
|
|
424
424
|
end
|
425
425
|
end
|
426
426
|
|
427
|
+
# Adds a new table to the spreadsheet.
|
428
|
+
class AddTableRequest
|
429
|
+
include Google::Apis::Core::Hashable
|
430
|
+
|
431
|
+
# A table.
|
432
|
+
# Corresponds to the JSON property `table`
|
433
|
+
# @return [Google::Apis::SheetsV4::Table]
|
434
|
+
attr_accessor :table
|
435
|
+
|
436
|
+
def initialize(**args)
|
437
|
+
update!(**args)
|
438
|
+
end
|
439
|
+
|
440
|
+
# Update properties of this object
|
441
|
+
def update!(**args)
|
442
|
+
@table = args[:table] if args.key?(:table)
|
443
|
+
end
|
444
|
+
end
|
445
|
+
|
427
446
|
# Adds new cells after the last row with data in a sheet, inserting new rows
|
428
447
|
# into the sheet if necessary.
|
429
448
|
class AppendCellsRequest
|
@@ -446,6 +465,12 @@ module Google
|
|
446
465
|
# @return [Fixnum]
|
447
466
|
attr_accessor :sheet_id
|
448
467
|
|
468
|
+
# The ID of the table to append data to. The data will be only appended to the
|
469
|
+
# table body. This field also takes precedence over the `sheet_id` field.
|
470
|
+
# Corresponds to the JSON property `tableId`
|
471
|
+
# @return [String]
|
472
|
+
attr_accessor :table_id
|
473
|
+
|
449
474
|
def initialize(**args)
|
450
475
|
update!(**args)
|
451
476
|
end
|
@@ -455,6 +480,7 @@ module Google
|
|
455
480
|
@fields = args[:fields] if args.key?(:fields)
|
456
481
|
@rows = args[:rows] if args.key?(:rows)
|
457
482
|
@sheet_id = args[:sheet_id] if args.key?(:sheet_id)
|
483
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
458
484
|
end
|
459
485
|
end
|
460
486
|
|
@@ -1394,6 +1420,12 @@ module Google
|
|
1394
1420
|
# @return [Array<Google::Apis::SheetsV4::SortSpec>]
|
1395
1421
|
attr_accessor :sort_specs
|
1396
1422
|
|
1423
|
+
# The table this filter is backed by, if any. When writing, only one of range or
|
1424
|
+
# table_id may be set.
|
1425
|
+
# Corresponds to the JSON property `tableId`
|
1426
|
+
# @return [String]
|
1427
|
+
attr_accessor :table_id
|
1428
|
+
|
1397
1429
|
def initialize(**args)
|
1398
1430
|
update!(**args)
|
1399
1431
|
end
|
@@ -1404,6 +1436,7 @@ module Google
|
|
1404
1436
|
@filter_specs = args[:filter_specs] if args.key?(:filter_specs)
|
1405
1437
|
@range = args[:range] if args.key?(:range)
|
1406
1438
|
@sort_specs = args[:sort_specs] if args.key?(:sort_specs)
|
1439
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
1407
1440
|
end
|
1408
1441
|
end
|
1409
1442
|
|
@@ -1513,10 +1546,10 @@ module Google
|
|
1513
1546
|
class BatchClearValuesByDataFilterResponse
|
1514
1547
|
include Google::Apis::Core::Hashable
|
1515
1548
|
|
1516
|
-
# The ranges that were cleared, in [A1 notation](/
|
1517
|
-
# cell). If the requests are for an
|
1518
|
-
# bounds of the sheet, this is the
|
1519
|
-
# the sheet's limits.
|
1549
|
+
# The ranges that were cleared, in [A1 notation](https://developers.google.com/
|
1550
|
+
# workspace/sheets/api/guides/concepts#cell). If the requests are for an
|
1551
|
+
# unbounded range or a ranger larger than the bounds of the sheet, this is the
|
1552
|
+
# actual ranges that were cleared, bounded to the sheet's limits.
|
1520
1553
|
# Corresponds to the JSON property `clearedRanges`
|
1521
1554
|
# @return [Array<String>]
|
1522
1555
|
attr_accessor :cleared_ranges
|
@@ -1541,8 +1574,8 @@ module Google
|
|
1541
1574
|
class BatchClearValuesRequest
|
1542
1575
|
include Google::Apis::Core::Hashable
|
1543
1576
|
|
1544
|
-
# The ranges to clear, in [A1 notation or R1C1 notation](
|
1545
|
-
# concepts#cell).
|
1577
|
+
# The ranges to clear, in [A1 notation or R1C1 notation](https://developers.
|
1578
|
+
# google.com/workspace/sheets/api/guides/concepts#cell).
|
1546
1579
|
# Corresponds to the JSON property `ranges`
|
1547
1580
|
# @return [Array<String>]
|
1548
1581
|
attr_accessor :ranges
|
@@ -4860,6 +4893,25 @@ module Google
|
|
4860
4893
|
end
|
4861
4894
|
end
|
4862
4895
|
|
4896
|
+
# Removes the table with the given ID from the spreadsheet.
|
4897
|
+
class DeleteTableRequest
|
4898
|
+
include Google::Apis::Core::Hashable
|
4899
|
+
|
4900
|
+
# The ID of the table to delete.
|
4901
|
+
# Corresponds to the JSON property `tableId`
|
4902
|
+
# @return [String]
|
4903
|
+
attr_accessor :table_id
|
4904
|
+
|
4905
|
+
def initialize(**args)
|
4906
|
+
update!(**args)
|
4907
|
+
end
|
4908
|
+
|
4909
|
+
# Update properties of this object
|
4910
|
+
def update!(**args)
|
4911
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
4912
|
+
end
|
4913
|
+
end
|
4914
|
+
|
4863
4915
|
# Developer metadata associated with a location or object in a spreadsheet.
|
4864
4916
|
# Developer metadata may be used to associate arbitrary data with various parts
|
4865
4917
|
# of a spreadsheet and will remain associated at those locations as they move
|
@@ -5699,7 +5751,7 @@ module Google
|
|
5699
5751
|
attr_accessor :filter_view_id
|
5700
5752
|
|
5701
5753
|
# The named range this filter view is backed by, if any. When writing, only one
|
5702
|
-
# of range or named_range_id may be set.
|
5754
|
+
# of range or named_range_id or table_id may be set.
|
5703
5755
|
# Corresponds to the JSON property `namedRangeId`
|
5704
5756
|
# @return [String]
|
5705
5757
|
attr_accessor :named_range_id
|
@@ -5727,6 +5779,12 @@ module Google
|
|
5727
5779
|
# @return [Array<Google::Apis::SheetsV4::SortSpec>]
|
5728
5780
|
attr_accessor :sort_specs
|
5729
5781
|
|
5782
|
+
# The table this filter view is backed by, if any. When writing, only one of
|
5783
|
+
# range or named_range_id or table_id may be set.
|
5784
|
+
# Corresponds to the JSON property `tableId`
|
5785
|
+
# @return [String]
|
5786
|
+
attr_accessor :table_id
|
5787
|
+
|
5730
5788
|
# The name of the filter view.
|
5731
5789
|
# Corresponds to the JSON property `title`
|
5732
5790
|
# @return [String]
|
@@ -5744,6 +5802,7 @@ module Google
|
|
5744
5802
|
@named_range_id = args[:named_range_id] if args.key?(:named_range_id)
|
5745
5803
|
@range = args[:range] if args.key?(:range)
|
5746
5804
|
@sort_specs = args[:sort_specs] if args.key?(:sort_specs)
|
5805
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
5747
5806
|
@title = args[:title] if args.key?(:title)
|
5748
5807
|
end
|
5749
5808
|
end
|
@@ -5893,6 +5952,12 @@ module Google
|
|
5893
5952
|
# @return [Array<Google::Apis::SheetsV4::DataFilter>]
|
5894
5953
|
attr_accessor :data_filters
|
5895
5954
|
|
5955
|
+
# True if tables should be excluded in the banded ranges. False if not set.
|
5956
|
+
# Corresponds to the JSON property `excludeTablesInBandedRanges`
|
5957
|
+
# @return [Boolean]
|
5958
|
+
attr_accessor :exclude_tables_in_banded_ranges
|
5959
|
+
alias_method :exclude_tables_in_banded_ranges?, :exclude_tables_in_banded_ranges
|
5960
|
+
|
5896
5961
|
# True if grid data should be returned. This parameter is ignored if a field
|
5897
5962
|
# mask was set in the request.
|
5898
5963
|
# Corresponds to the JSON property `includeGridData`
|
@@ -5907,6 +5972,7 @@ module Google
|
|
5907
5972
|
# Update properties of this object
|
5908
5973
|
def update!(**args)
|
5909
5974
|
@data_filters = args[:data_filters] if args.key?(:data_filters)
|
5975
|
+
@exclude_tables_in_banded_ranges = args[:exclude_tables_in_banded_ranges] if args.key?(:exclude_tables_in_banded_ranges)
|
5910
5976
|
@include_grid_data = args[:include_grid_data] if args.key?(:include_grid_data)
|
5911
5977
|
end
|
5912
5978
|
end
|
@@ -6874,8 +6940,8 @@ module Google
|
|
6874
6940
|
|
6875
6941
|
# Pattern string used for formatting. If not set, a default pattern based on the
|
6876
6942
|
# user's locale will be used if necessary for the given type. See the [Date and
|
6877
|
-
# Number Formats guide](/sheets/api/
|
6878
|
-
# the supported patterns.
|
6943
|
+
# Number Formats guide](https://developers.google.com/workspace/sheets/api/
|
6944
|
+
# guides/formats) for more information about the supported patterns.
|
6879
6945
|
# Corresponds to the JSON property `pattern`
|
6880
6946
|
# @return [String]
|
6881
6947
|
attr_accessor :pattern
|
@@ -7738,7 +7804,7 @@ module Google
|
|
7738
7804
|
attr_accessor :editors
|
7739
7805
|
|
7740
7806
|
# The named range this protected range is backed by, if any. When writing, only
|
7741
|
-
# one of range or named_range_id may be set.
|
7807
|
+
# one of range or named_range_id or table_id may be set.
|
7742
7808
|
# Corresponds to the JSON property `namedRangeId`
|
7743
7809
|
# @return [String]
|
7744
7810
|
attr_accessor :named_range_id
|
@@ -7772,6 +7838,12 @@ module Google
|
|
7772
7838
|
attr_accessor :requesting_user_can_edit
|
7773
7839
|
alias_method :requesting_user_can_edit?, :requesting_user_can_edit
|
7774
7840
|
|
7841
|
+
# The table this protected range is backed by, if any. When writing, only one of
|
7842
|
+
# range or named_range_id or table_id may be set.
|
7843
|
+
# Corresponds to the JSON property `tableId`
|
7844
|
+
# @return [String]
|
7845
|
+
attr_accessor :table_id
|
7846
|
+
|
7775
7847
|
# The list of unprotected ranges within a protected sheet. Unprotected ranges
|
7776
7848
|
# are only supported on protected sheets.
|
7777
7849
|
# Corresponds to the JSON property `unprotectedRanges`
|
@@ -7802,6 +7874,7 @@ module Google
|
|
7802
7874
|
@protected_range_id = args[:protected_range_id] if args.key?(:protected_range_id)
|
7803
7875
|
@range = args[:range] if args.key?(:range)
|
7804
7876
|
@requesting_user_can_edit = args[:requesting_user_can_edit] if args.key?(:requesting_user_can_edit)
|
7877
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
7805
7878
|
@unprotected_ranges = args[:unprotected_ranges] if args.key?(:unprotected_ranges)
|
7806
7879
|
@warning_only = args[:warning_only] if args.key?(:warning_only)
|
7807
7880
|
end
|
@@ -8090,6 +8163,11 @@ module Google
|
|
8090
8163
|
# @return [Google::Apis::SheetsV4::AddSlicerRequest]
|
8091
8164
|
attr_accessor :add_slicer
|
8092
8165
|
|
8166
|
+
# Adds a new table to the spreadsheet.
|
8167
|
+
# Corresponds to the JSON property `addTable`
|
8168
|
+
# @return [Google::Apis::SheetsV4::AddTableRequest]
|
8169
|
+
attr_accessor :add_table
|
8170
|
+
|
8093
8171
|
# Adds new cells after the last row with data in a sheet, inserting new rows
|
8094
8172
|
# into the sheet if necessary.
|
8095
8173
|
# Corresponds to the JSON property `appendCells`
|
@@ -8217,6 +8295,11 @@ module Google
|
|
8217
8295
|
# @return [Google::Apis::SheetsV4::DeleteSheetRequest]
|
8218
8296
|
attr_accessor :delete_sheet
|
8219
8297
|
|
8298
|
+
# Removes the table with the given ID from the spreadsheet.
|
8299
|
+
# Corresponds to the JSON property `deleteTable`
|
8300
|
+
# @return [Google::Apis::SheetsV4::DeleteTableRequest]
|
8301
|
+
attr_accessor :delete_table
|
8302
|
+
|
8220
8303
|
# Duplicates a particular filter view.
|
8221
8304
|
# Corresponds to the JSON property `duplicateFilterView`
|
8222
8305
|
# @return [Google::Apis::SheetsV4::DuplicateFilterViewRequest]
|
@@ -8422,6 +8505,11 @@ module Google
|
|
8422
8505
|
# @return [Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest]
|
8423
8506
|
attr_accessor :update_spreadsheet_properties
|
8424
8507
|
|
8508
|
+
# Updates a table in the spreadsheet.
|
8509
|
+
# Corresponds to the JSON property `updateTable`
|
8510
|
+
# @return [Google::Apis::SheetsV4::UpdateTableRequest]
|
8511
|
+
attr_accessor :update_table
|
8512
|
+
|
8425
8513
|
def initialize(**args)
|
8426
8514
|
update!(**args)
|
8427
8515
|
end
|
@@ -8438,6 +8526,7 @@ module Google
|
|
8438
8526
|
@add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range)
|
8439
8527
|
@add_sheet = args[:add_sheet] if args.key?(:add_sheet)
|
8440
8528
|
@add_slicer = args[:add_slicer] if args.key?(:add_slicer)
|
8529
|
+
@add_table = args[:add_table] if args.key?(:add_table)
|
8441
8530
|
@append_cells = args[:append_cells] if args.key?(:append_cells)
|
8442
8531
|
@append_dimension = args[:append_dimension] if args.key?(:append_dimension)
|
8443
8532
|
@auto_fill = args[:auto_fill] if args.key?(:auto_fill)
|
@@ -8460,6 +8549,7 @@ module Google
|
|
8460
8549
|
@delete_protected_range = args[:delete_protected_range] if args.key?(:delete_protected_range)
|
8461
8550
|
@delete_range = args[:delete_range] if args.key?(:delete_range)
|
8462
8551
|
@delete_sheet = args[:delete_sheet] if args.key?(:delete_sheet)
|
8552
|
+
@delete_table = args[:delete_table] if args.key?(:delete_table)
|
8463
8553
|
@duplicate_filter_view = args[:duplicate_filter_view] if args.key?(:duplicate_filter_view)
|
8464
8554
|
@duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet)
|
8465
8555
|
@find_replace = args[:find_replace] if args.key?(:find_replace)
|
@@ -8494,6 +8584,7 @@ module Google
|
|
8494
8584
|
@update_sheet_properties = args[:update_sheet_properties] if args.key?(:update_sheet_properties)
|
8495
8585
|
@update_slicer_spec = args[:update_slicer_spec] if args.key?(:update_slicer_spec)
|
8496
8586
|
@update_spreadsheet_properties = args[:update_spreadsheet_properties] if args.key?(:update_spreadsheet_properties)
|
8587
|
+
@update_table = args[:update_table] if args.key?(:update_table)
|
8497
8588
|
end
|
8498
8589
|
end
|
8499
8590
|
|
@@ -8926,6 +9017,11 @@ module Google
|
|
8926
9017
|
# @return [Array<Google::Apis::SheetsV4::Slicer>]
|
8927
9018
|
attr_accessor :slicers
|
8928
9019
|
|
9020
|
+
# The tables on this sheet.
|
9021
|
+
# Corresponds to the JSON property `tables`
|
9022
|
+
# @return [Array<Google::Apis::SheetsV4::Table>]
|
9023
|
+
attr_accessor :tables
|
9024
|
+
|
8929
9025
|
def initialize(**args)
|
8930
9026
|
update!(**args)
|
8931
9027
|
end
|
@@ -8945,6 +9041,7 @@ module Google
|
|
8945
9041
|
@protected_ranges = args[:protected_ranges] if args.key?(:protected_ranges)
|
8946
9042
|
@row_groups = args[:row_groups] if args.key?(:row_groups)
|
8947
9043
|
@slicers = args[:slicers] if args.key?(:slicers)
|
9044
|
+
@tables = args[:tables] if args.key?(:tables)
|
8948
9045
|
end
|
8949
9046
|
end
|
8950
9047
|
|
@@ -9618,6 +9715,156 @@ module Google
|
|
9618
9715
|
end
|
9619
9716
|
end
|
9620
9717
|
|
9718
|
+
# A table.
|
9719
|
+
class Table
|
9720
|
+
include Google::Apis::Core::Hashable
|
9721
|
+
|
9722
|
+
# The table column properties.
|
9723
|
+
# Corresponds to the JSON property `columnProperties`
|
9724
|
+
# @return [Array<Google::Apis::SheetsV4::TableColumnProperties>]
|
9725
|
+
attr_accessor :column_properties
|
9726
|
+
|
9727
|
+
# The table name. This is unique to all tables in the same spreadsheet.
|
9728
|
+
# Corresponds to the JSON property `name`
|
9729
|
+
# @return [String]
|
9730
|
+
attr_accessor :name
|
9731
|
+
|
9732
|
+
# A range on a sheet. All indexes are zero-based. Indexes are half open, i.e.
|
9733
|
+
# the start index is inclusive and the end index is exclusive -- [start_index,
|
9734
|
+
# end_index). Missing indexes indicate the range is unbounded on that side. For
|
9735
|
+
# example, if `"Sheet1"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id:
|
9736
|
+
# 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0,
|
9737
|
+
# end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2,
|
9738
|
+
# end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B ==
|
9739
|
+
# sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B ==
|
9740
|
+
# sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index:
|
9741
|
+
# 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or
|
9742
|
+
# equal to the end index. If the start index equals the end index, then the
|
9743
|
+
# range is empty. Empty ranges are typically not meaningful and are usually
|
9744
|
+
# rendered in the UI as `#REF!`.
|
9745
|
+
# Corresponds to the JSON property `range`
|
9746
|
+
# @return [Google::Apis::SheetsV4::GridRange]
|
9747
|
+
attr_accessor :range
|
9748
|
+
|
9749
|
+
# The table row properties.
|
9750
|
+
# Corresponds to the JSON property `rowsProperties`
|
9751
|
+
# @return [Google::Apis::SheetsV4::TableRowsProperties]
|
9752
|
+
attr_accessor :rows_properties
|
9753
|
+
|
9754
|
+
# The id of the table.
|
9755
|
+
# Corresponds to the JSON property `tableId`
|
9756
|
+
# @return [String]
|
9757
|
+
attr_accessor :table_id
|
9758
|
+
|
9759
|
+
def initialize(**args)
|
9760
|
+
update!(**args)
|
9761
|
+
end
|
9762
|
+
|
9763
|
+
# Update properties of this object
|
9764
|
+
def update!(**args)
|
9765
|
+
@column_properties = args[:column_properties] if args.key?(:column_properties)
|
9766
|
+
@name = args[:name] if args.key?(:name)
|
9767
|
+
@range = args[:range] if args.key?(:range)
|
9768
|
+
@rows_properties = args[:rows_properties] if args.key?(:rows_properties)
|
9769
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
9770
|
+
end
|
9771
|
+
end
|
9772
|
+
|
9773
|
+
# A data validation rule for a column in a table.
|
9774
|
+
class TableColumnDataValidationRule
|
9775
|
+
include Google::Apis::Core::Hashable
|
9776
|
+
|
9777
|
+
# A condition that can evaluate to true or false. BooleanConditions are used by
|
9778
|
+
# conditional formatting, data validation, and the criteria in filters.
|
9779
|
+
# Corresponds to the JSON property `condition`
|
9780
|
+
# @return [Google::Apis::SheetsV4::BooleanCondition]
|
9781
|
+
attr_accessor :condition
|
9782
|
+
|
9783
|
+
def initialize(**args)
|
9784
|
+
update!(**args)
|
9785
|
+
end
|
9786
|
+
|
9787
|
+
# Update properties of this object
|
9788
|
+
def update!(**args)
|
9789
|
+
@condition = args[:condition] if args.key?(:condition)
|
9790
|
+
end
|
9791
|
+
end
|
9792
|
+
|
9793
|
+
# The table column.
|
9794
|
+
class TableColumnProperties
|
9795
|
+
include Google::Apis::Core::Hashable
|
9796
|
+
|
9797
|
+
# The 0-based column index. This index is relative to its position in the table
|
9798
|
+
# and is not necessarily the same as the column index in the sheet.
|
9799
|
+
# Corresponds to the JSON property `columnIndex`
|
9800
|
+
# @return [Fixnum]
|
9801
|
+
attr_accessor :column_index
|
9802
|
+
|
9803
|
+
# The column name.
|
9804
|
+
# Corresponds to the JSON property `columnName`
|
9805
|
+
# @return [String]
|
9806
|
+
attr_accessor :column_name
|
9807
|
+
|
9808
|
+
# The column type.
|
9809
|
+
# Corresponds to the JSON property `columnType`
|
9810
|
+
# @return [String]
|
9811
|
+
attr_accessor :column_type
|
9812
|
+
|
9813
|
+
# A data validation rule for a column in a table.
|
9814
|
+
# Corresponds to the JSON property `dataValidationRule`
|
9815
|
+
# @return [Google::Apis::SheetsV4::TableColumnDataValidationRule]
|
9816
|
+
attr_accessor :data_validation_rule
|
9817
|
+
|
9818
|
+
def initialize(**args)
|
9819
|
+
update!(**args)
|
9820
|
+
end
|
9821
|
+
|
9822
|
+
# Update properties of this object
|
9823
|
+
def update!(**args)
|
9824
|
+
@column_index = args[:column_index] if args.key?(:column_index)
|
9825
|
+
@column_name = args[:column_name] if args.key?(:column_name)
|
9826
|
+
@column_type = args[:column_type] if args.key?(:column_type)
|
9827
|
+
@data_validation_rule = args[:data_validation_rule] if args.key?(:data_validation_rule)
|
9828
|
+
end
|
9829
|
+
end
|
9830
|
+
|
9831
|
+
# The table row properties.
|
9832
|
+
class TableRowsProperties
|
9833
|
+
include Google::Apis::Core::Hashable
|
9834
|
+
|
9835
|
+
# A color value.
|
9836
|
+
# Corresponds to the JSON property `firstBandColorStyle`
|
9837
|
+
# @return [Google::Apis::SheetsV4::ColorStyle]
|
9838
|
+
attr_accessor :first_band_color_style
|
9839
|
+
|
9840
|
+
# A color value.
|
9841
|
+
# Corresponds to the JSON property `footerColorStyle`
|
9842
|
+
# @return [Google::Apis::SheetsV4::ColorStyle]
|
9843
|
+
attr_accessor :footer_color_style
|
9844
|
+
|
9845
|
+
# A color value.
|
9846
|
+
# Corresponds to the JSON property `headerColorStyle`
|
9847
|
+
# @return [Google::Apis::SheetsV4::ColorStyle]
|
9848
|
+
attr_accessor :header_color_style
|
9849
|
+
|
9850
|
+
# A color value.
|
9851
|
+
# Corresponds to the JSON property `secondBandColorStyle`
|
9852
|
+
# @return [Google::Apis::SheetsV4::ColorStyle]
|
9853
|
+
attr_accessor :second_band_color_style
|
9854
|
+
|
9855
|
+
def initialize(**args)
|
9856
|
+
update!(**args)
|
9857
|
+
end
|
9858
|
+
|
9859
|
+
# Update properties of this object
|
9860
|
+
def update!(**args)
|
9861
|
+
@first_band_color_style = args[:first_band_color_style] if args.key?(:first_band_color_style)
|
9862
|
+
@footer_color_style = args[:footer_color_style] if args.key?(:footer_color_style)
|
9863
|
+
@header_color_style = args[:header_color_style] if args.key?(:header_color_style)
|
9864
|
+
@second_band_color_style = args[:second_band_color_style] if args.key?(:second_band_color_style)
|
9865
|
+
end
|
9866
|
+
end
|
9867
|
+
|
9621
9868
|
# The format of a run of text in a cell. Absent values indicate that the field
|
9622
9869
|
# isn't specified.
|
9623
9870
|
class TextFormat
|
@@ -11101,6 +11348,33 @@ module Google
|
|
11101
11348
|
end
|
11102
11349
|
end
|
11103
11350
|
|
11351
|
+
# Updates a table in the spreadsheet.
|
11352
|
+
class UpdateTableRequest
|
11353
|
+
include Google::Apis::Core::Hashable
|
11354
|
+
|
11355
|
+
# Required. The fields that should be updated. At least one field must be
|
11356
|
+
# specified. The root `table` is implied and should not be specified. A single `"
|
11357
|
+
# *"` can be used as short-hand for listing every field.
|
11358
|
+
# Corresponds to the JSON property `fields`
|
11359
|
+
# @return [String]
|
11360
|
+
attr_accessor :fields
|
11361
|
+
|
11362
|
+
# A table.
|
11363
|
+
# Corresponds to the JSON property `table`
|
11364
|
+
# @return [Google::Apis::SheetsV4::Table]
|
11365
|
+
attr_accessor :table
|
11366
|
+
|
11367
|
+
def initialize(**args)
|
11368
|
+
update!(**args)
|
11369
|
+
end
|
11370
|
+
|
11371
|
+
# Update properties of this object
|
11372
|
+
def update!(**args)
|
11373
|
+
@fields = args[:fields] if args.key?(:fields)
|
11374
|
+
@table = args[:table] if args.key?(:table)
|
11375
|
+
end
|
11376
|
+
end
|
11377
|
+
|
11104
11378
|
# The response when updating a range of values by a data filter in a spreadsheet.
|
11105
11379
|
class UpdateValuesByDataFilterResponse
|
11106
11380
|
include Google::Apis::Core::Hashable
|
@@ -11125,8 +11399,8 @@ module Google
|
|
11125
11399
|
# @return [Google::Apis::SheetsV4::ValueRange]
|
11126
11400
|
attr_accessor :updated_data
|
11127
11401
|
|
11128
|
-
# The range (in [A1 notation](/sheets/api/
|
11129
|
-
# were applied to.
|
11402
|
+
# The range (in [A1 notation](https://developers.google.com/workspace/sheets/api/
|
11403
|
+
# guides/concepts#cell)) that updates were applied to.
|
11130
11404
|
# Corresponds to the JSON property `updatedRange`
|
11131
11405
|
# @return [String]
|
11132
11406
|
attr_accessor :updated_range
|
@@ -11215,11 +11489,11 @@ module Google
|
|
11215
11489
|
# @return [String]
|
11216
11490
|
attr_accessor :major_dimension
|
11217
11491
|
|
11218
|
-
# The range the values cover, in [A1 notation](/
|
11219
|
-
# For output, this range indicates
|
11220
|
-
#
|
11221
|
-
# field represents the range to search
|
11222
|
-
# appended.
|
11492
|
+
# The range the values cover, in [A1 notation](https://developers.google.com/
|
11493
|
+
# workspace/sheets/api/guides/concepts#cell). For output, this range indicates
|
11494
|
+
# the entire requested range, even though the values will exclude trailing rows
|
11495
|
+
# and columns. When appending values, this field represents the range to search
|
11496
|
+
# for a table, after which values will be appended.
|
11223
11497
|
# Corresponds to the JSON property `range`
|
11224
11498
|
# @return [String]
|
11225
11499
|
attr_accessor :range
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module SheetsV4
|
18
18
|
# Version of the google-apis-sheets_v4 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.41.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.16.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250415"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -136,6 +136,12 @@ module Google
|
|
136
136
|
include Google::Apis::Core::JsonObjectSupport
|
137
137
|
end
|
138
138
|
|
139
|
+
class AddTableRequest
|
140
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
141
|
+
|
142
|
+
include Google::Apis::Core::JsonObjectSupport
|
143
|
+
end
|
144
|
+
|
139
145
|
class AppendCellsRequest
|
140
146
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
141
147
|
|
@@ -754,6 +760,12 @@ module Google
|
|
754
760
|
include Google::Apis::Core::JsonObjectSupport
|
755
761
|
end
|
756
762
|
|
763
|
+
class DeleteTableRequest
|
764
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
765
|
+
|
766
|
+
include Google::Apis::Core::JsonObjectSupport
|
767
|
+
end
|
768
|
+
|
757
769
|
class DeveloperMetadata
|
758
770
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
759
771
|
|
@@ -1276,6 +1288,30 @@ module Google
|
|
1276
1288
|
include Google::Apis::Core::JsonObjectSupport
|
1277
1289
|
end
|
1278
1290
|
|
1291
|
+
class Table
|
1292
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1293
|
+
|
1294
|
+
include Google::Apis::Core::JsonObjectSupport
|
1295
|
+
end
|
1296
|
+
|
1297
|
+
class TableColumnDataValidationRule
|
1298
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1299
|
+
|
1300
|
+
include Google::Apis::Core::JsonObjectSupport
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
class TableColumnProperties
|
1304
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1305
|
+
|
1306
|
+
include Google::Apis::Core::JsonObjectSupport
|
1307
|
+
end
|
1308
|
+
|
1309
|
+
class TableRowsProperties
|
1310
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1311
|
+
|
1312
|
+
include Google::Apis::Core::JsonObjectSupport
|
1313
|
+
end
|
1314
|
+
|
1279
1315
|
class TextFormat
|
1280
1316
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1281
1317
|
|
@@ -1474,6 +1510,12 @@ module Google
|
|
1474
1510
|
include Google::Apis::Core::JsonObjectSupport
|
1475
1511
|
end
|
1476
1512
|
|
1513
|
+
class UpdateTableRequest
|
1514
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1515
|
+
|
1516
|
+
include Google::Apis::Core::JsonObjectSupport
|
1517
|
+
end
|
1518
|
+
|
1477
1519
|
class UpdateValuesByDataFilterResponse
|
1478
1520
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1479
1521
|
|
@@ -1677,6 +1719,14 @@ module Google
|
|
1677
1719
|
end
|
1678
1720
|
end
|
1679
1721
|
|
1722
|
+
class AddTableRequest
|
1723
|
+
# @private
|
1724
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1725
|
+
property :table, as: 'table', class: Google::Apis::SheetsV4::Table, decorator: Google::Apis::SheetsV4::Table::Representation
|
1726
|
+
|
1727
|
+
end
|
1728
|
+
end
|
1729
|
+
|
1680
1730
|
class AppendCellsRequest
|
1681
1731
|
# @private
|
1682
1732
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1684,6 +1734,7 @@ module Google
|
|
1684
1734
|
collection :rows, as: 'rows', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation
|
1685
1735
|
|
1686
1736
|
property :sheet_id, as: 'sheetId'
|
1737
|
+
property :table_id, as: 'tableId'
|
1687
1738
|
end
|
1688
1739
|
end
|
1689
1740
|
|
@@ -1860,6 +1911,7 @@ module Google
|
|
1860
1911
|
|
1861
1912
|
collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation
|
1862
1913
|
|
1914
|
+
property :table_id, as: 'tableId'
|
1863
1915
|
end
|
1864
1916
|
end
|
1865
1917
|
|
@@ -2810,6 +2862,13 @@ module Google
|
|
2810
2862
|
end
|
2811
2863
|
end
|
2812
2864
|
|
2865
|
+
class DeleteTableRequest
|
2866
|
+
# @private
|
2867
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2868
|
+
property :table_id, as: 'tableId'
|
2869
|
+
end
|
2870
|
+
end
|
2871
|
+
|
2813
2872
|
class DeveloperMetadata
|
2814
2873
|
# @private
|
2815
2874
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3016,6 +3075,7 @@ module Google
|
|
3016
3075
|
|
3017
3076
|
collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation
|
3018
3077
|
|
3078
|
+
property :table_id, as: 'tableId'
|
3019
3079
|
property :title, as: 'title'
|
3020
3080
|
end
|
3021
3081
|
end
|
@@ -3052,6 +3112,7 @@ module Google
|
|
3052
3112
|
class Representation < Google::Apis::Core::JsonRepresentation
|
3053
3113
|
collection :data_filters, as: 'dataFilters', class: Google::Apis::SheetsV4::DataFilter, decorator: Google::Apis::SheetsV4::DataFilter::Representation
|
3054
3114
|
|
3115
|
+
property :exclude_tables_in_banded_ranges, as: 'excludeTablesInBandedRanges'
|
3055
3116
|
property :include_grid_data, as: 'includeGridData'
|
3056
3117
|
end
|
3057
3118
|
end
|
@@ -3504,6 +3565,7 @@ module Google
|
|
3504
3565
|
property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation
|
3505
3566
|
|
3506
3567
|
property :requesting_user_can_edit, as: 'requestingUserCanEdit'
|
3568
|
+
property :table_id, as: 'tableId'
|
3507
3569
|
collection :unprotected_ranges, as: 'unprotectedRanges', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation
|
3508
3570
|
|
3509
3571
|
property :warning_only, as: 'warningOnly'
|
@@ -3589,6 +3651,8 @@ module Google
|
|
3589
3651
|
|
3590
3652
|
property :add_slicer, as: 'addSlicer', class: Google::Apis::SheetsV4::AddSlicerRequest, decorator: Google::Apis::SheetsV4::AddSlicerRequest::Representation
|
3591
3653
|
|
3654
|
+
property :add_table, as: 'addTable', class: Google::Apis::SheetsV4::AddTableRequest, decorator: Google::Apis::SheetsV4::AddTableRequest::Representation
|
3655
|
+
|
3592
3656
|
property :append_cells, as: 'appendCells', class: Google::Apis::SheetsV4::AppendCellsRequest, decorator: Google::Apis::SheetsV4::AppendCellsRequest::Representation
|
3593
3657
|
|
3594
3658
|
property :append_dimension, as: 'appendDimension', class: Google::Apis::SheetsV4::AppendDimensionRequest, decorator: Google::Apis::SheetsV4::AppendDimensionRequest::Representation
|
@@ -3633,6 +3697,8 @@ module Google
|
|
3633
3697
|
|
3634
3698
|
property :delete_sheet, as: 'deleteSheet', class: Google::Apis::SheetsV4::DeleteSheetRequest, decorator: Google::Apis::SheetsV4::DeleteSheetRequest::Representation
|
3635
3699
|
|
3700
|
+
property :delete_table, as: 'deleteTable', class: Google::Apis::SheetsV4::DeleteTableRequest, decorator: Google::Apis::SheetsV4::DeleteTableRequest::Representation
|
3701
|
+
|
3636
3702
|
property :duplicate_filter_view, as: 'duplicateFilterView', class: Google::Apis::SheetsV4::DuplicateFilterViewRequest, decorator: Google::Apis::SheetsV4::DuplicateFilterViewRequest::Representation
|
3637
3703
|
|
3638
3704
|
property :duplicate_sheet, as: 'duplicateSheet', class: Google::Apis::SheetsV4::DuplicateSheetRequest, decorator: Google::Apis::SheetsV4::DuplicateSheetRequest::Representation
|
@@ -3701,6 +3767,8 @@ module Google
|
|
3701
3767
|
|
3702
3768
|
property :update_spreadsheet_properties, as: 'updateSpreadsheetProperties', class: Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest::Representation
|
3703
3769
|
|
3770
|
+
property :update_table, as: 'updateTable', class: Google::Apis::SheetsV4::UpdateTableRequest, decorator: Google::Apis::SheetsV4::UpdateTableRequest::Representation
|
3771
|
+
|
3704
3772
|
end
|
3705
3773
|
end
|
3706
3774
|
|
@@ -3849,6 +3917,8 @@ module Google
|
|
3849
3917
|
|
3850
3918
|
collection :slicers, as: 'slicers', class: Google::Apis::SheetsV4::Slicer, decorator: Google::Apis::SheetsV4::Slicer::Representation
|
3851
3919
|
|
3920
|
+
collection :tables, as: 'tables', class: Google::Apis::SheetsV4::Table, decorator: Google::Apis::SheetsV4::Table::Representation
|
3921
|
+
|
3852
3922
|
end
|
3853
3923
|
end
|
3854
3924
|
|
@@ -3987,6 +4057,53 @@ module Google
|
|
3987
4057
|
end
|
3988
4058
|
end
|
3989
4059
|
|
4060
|
+
class Table
|
4061
|
+
# @private
|
4062
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4063
|
+
collection :column_properties, as: 'columnProperties', class: Google::Apis::SheetsV4::TableColumnProperties, decorator: Google::Apis::SheetsV4::TableColumnProperties::Representation
|
4064
|
+
|
4065
|
+
property :name, as: 'name'
|
4066
|
+
property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation
|
4067
|
+
|
4068
|
+
property :rows_properties, as: 'rowsProperties', class: Google::Apis::SheetsV4::TableRowsProperties, decorator: Google::Apis::SheetsV4::TableRowsProperties::Representation
|
4069
|
+
|
4070
|
+
property :table_id, as: 'tableId'
|
4071
|
+
end
|
4072
|
+
end
|
4073
|
+
|
4074
|
+
class TableColumnDataValidationRule
|
4075
|
+
# @private
|
4076
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4077
|
+
property :condition, as: 'condition', class: Google::Apis::SheetsV4::BooleanCondition, decorator: Google::Apis::SheetsV4::BooleanCondition::Representation
|
4078
|
+
|
4079
|
+
end
|
4080
|
+
end
|
4081
|
+
|
4082
|
+
class TableColumnProperties
|
4083
|
+
# @private
|
4084
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4085
|
+
property :column_index, as: 'columnIndex'
|
4086
|
+
property :column_name, as: 'columnName'
|
4087
|
+
property :column_type, as: 'columnType'
|
4088
|
+
property :data_validation_rule, as: 'dataValidationRule', class: Google::Apis::SheetsV4::TableColumnDataValidationRule, decorator: Google::Apis::SheetsV4::TableColumnDataValidationRule::Representation
|
4089
|
+
|
4090
|
+
end
|
4091
|
+
end
|
4092
|
+
|
4093
|
+
class TableRowsProperties
|
4094
|
+
# @private
|
4095
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4096
|
+
property :first_band_color_style, as: 'firstBandColorStyle', class: Google::Apis::SheetsV4::ColorStyle, decorator: Google::Apis::SheetsV4::ColorStyle::Representation
|
4097
|
+
|
4098
|
+
property :footer_color_style, as: 'footerColorStyle', class: Google::Apis::SheetsV4::ColorStyle, decorator: Google::Apis::SheetsV4::ColorStyle::Representation
|
4099
|
+
|
4100
|
+
property :header_color_style, as: 'headerColorStyle', class: Google::Apis::SheetsV4::ColorStyle, decorator: Google::Apis::SheetsV4::ColorStyle::Representation
|
4101
|
+
|
4102
|
+
property :second_band_color_style, as: 'secondBandColorStyle', class: Google::Apis::SheetsV4::ColorStyle, decorator: Google::Apis::SheetsV4::ColorStyle::Representation
|
4103
|
+
|
4104
|
+
end
|
4105
|
+
end
|
4106
|
+
|
3990
4107
|
class TextFormat
|
3991
4108
|
# @private
|
3992
4109
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4347,6 +4464,15 @@ module Google
|
|
4347
4464
|
end
|
4348
4465
|
end
|
4349
4466
|
|
4467
|
+
class UpdateTableRequest
|
4468
|
+
# @private
|
4469
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4470
|
+
property :fields, as: 'fields'
|
4471
|
+
property :table, as: 'table', class: Google::Apis::SheetsV4::Table, decorator: Google::Apis::SheetsV4::Table::Representation
|
4472
|
+
|
4473
|
+
end
|
4474
|
+
end
|
4475
|
+
|
4350
4476
|
class UpdateValuesByDataFilterResponse
|
4351
4477
|
# @private
|
4352
4478
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -30,7 +30,7 @@ module Google
|
|
30
30
|
# Sheets = Google::Apis::SheetsV4 # Alias the module
|
31
31
|
# service = Sheets::SheetsService.new
|
32
32
|
#
|
33
|
-
# @see https://developers.google.com/sheets/
|
33
|
+
# @see https://developers.google.com/workspace/sheets/
|
34
34
|
class SheetsService < Google::Apis::Core::BaseService
|
35
35
|
DEFAULT_ENDPOINT_TEMPLATE = "https://sheets.$UNIVERSE_DOMAIN$/"
|
36
36
|
|
@@ -128,20 +128,22 @@ module Google
|
|
128
128
|
# Returns the spreadsheet at the given ID. The caller must specify the
|
129
129
|
# spreadsheet ID. By default, data within grids is not returned. You can include
|
130
130
|
# grid data in one of 2 ways: * Specify a [field mask](https://developers.google.
|
131
|
-
# com/sheets/api/guides/field-masks) listing your desired fields using
|
132
|
-
# fields` URL parameter in HTTP * Set the includeGridData URL parameter to
|
133
|
-
# If a field mask is set, the `includeGridData` parameter is ignored For
|
134
|
-
# spreadsheets, as a best practice, retrieve only the specific spreadsheet
|
131
|
+
# com/workspace/sheets/api/guides/field-masks) listing your desired fields using
|
132
|
+
# the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to
|
133
|
+
# true. If a field mask is set, the `includeGridData` parameter is ignored For
|
134
|
+
# large spreadsheets, as a best practice, retrieve only the specific spreadsheet
|
135
135
|
# fields that you want. To retrieve only subsets of spreadsheet data, use the
|
136
|
-
# ranges URL parameter. Ranges are specified using [A1 notation](
|
137
|
-
# guides/concepts#cell). You can
|
138
|
-
#
|
139
|
-
# sheets within the same spreadsheet (
|
140
|
-
# multiple ranges at once (for example,
|
141
|
-
# Limiting the range returns only the
|
142
|
-
# the requested ranges.
|
136
|
+
# ranges URL parameter. Ranges are specified using [A1 notation](https://
|
137
|
+
# developers.google.com/workspace/sheets/api/guides/concepts#cell). You can
|
138
|
+
# define a single cell (for example, `A1`) or multiple cells (for example, `A1:
|
139
|
+
# D5`). You can also get cells from other sheets within the same spreadsheet (
|
140
|
+
# for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example,
|
141
|
+
# `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the
|
142
|
+
# portions of the spreadsheet that intersect the requested ranges.
|
143
143
|
# @param [String] spreadsheet_id
|
144
144
|
# The spreadsheet to request.
|
145
|
+
# @param [Boolean] exclude_tables_in_banded_ranges
|
146
|
+
# True if tables should be excluded in the banded ranges. False if not set.
|
145
147
|
# @param [Boolean] include_grid_data
|
146
148
|
# True if grid data should be returned. This parameter is ignored if a field
|
147
149
|
# mask was set in the request.
|
@@ -164,11 +166,12 @@ module Google
|
|
164
166
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
165
167
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
166
168
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
167
|
-
def get_spreadsheet(spreadsheet_id, include_grid_data: nil, ranges: nil, fields: nil, quota_user: nil, options: nil, &block)
|
169
|
+
def get_spreadsheet(spreadsheet_id, exclude_tables_in_banded_ranges: nil, include_grid_data: nil, ranges: nil, fields: nil, quota_user: nil, options: nil, &block)
|
168
170
|
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options)
|
169
171
|
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
170
172
|
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
171
173
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
174
|
+
command.query['excludeTablesInBandedRanges'] = exclude_tables_in_banded_ranges unless exclude_tables_in_banded_ranges.nil?
|
172
175
|
command.query['includeGridData'] = include_grid_data unless include_grid_data.nil?
|
173
176
|
command.query['ranges'] = ranges unless ranges.nil?
|
174
177
|
command.query['fields'] = fields unless fields.nil?
|
@@ -183,8 +186,8 @@ module Google
|
|
183
186
|
# or more data filters returns the portions of the spreadsheet that intersect
|
184
187
|
# ranges matched by any of the filters. By default, data within grids is not
|
185
188
|
# returned. You can include grid data one of 2 ways: * Specify a [field mask](
|
186
|
-
# https://developers.google.com/sheets/api/guides/field-masks) listing
|
187
|
-
# desired fields using the `fields` URL parameter in HTTP * Set the
|
189
|
+
# https://developers.google.com/workspace/sheets/api/guides/field-masks) listing
|
190
|
+
# your desired fields using the `fields` URL parameter in HTTP * Set the
|
188
191
|
# includeGridData parameter to true. If a field mask is set, the `
|
189
192
|
# includeGridData` parameter is ignored For large spreadsheets, as a best
|
190
193
|
# practice, retrieve only the specific spreadsheet fields that you want.
|
@@ -331,7 +334,8 @@ module Google
|
|
331
334
|
# Appends values to a spreadsheet. The input range is used to search for
|
332
335
|
# existing data and find a "table" within that range. Values will be appended to
|
333
336
|
# the next row of the table, starting with the first column of the table. See
|
334
|
-
# the [guide](/sheets/api/guides/values#
|
337
|
+
# the [guide](https://developers.google.com/workspace/sheets/api/guides/values#
|
338
|
+
# appending_values) and [sample code](https://developers.google.com/workspace/
|
335
339
|
# sheets/api/samples/writing#append_values) for specific details of how tables
|
336
340
|
# are detected and data is appended. The caller must specify the spreadsheet ID,
|
337
341
|
# range, and a valueInputOption. The `valueInputOption` only controls how the
|
@@ -340,8 +344,9 @@ module Google
|
|
340
344
|
# @param [String] spreadsheet_id
|
341
345
|
# The ID of the spreadsheet to update.
|
342
346
|
# @param [String] range
|
343
|
-
# The [A1 notation](/sheets/api/guides/
|
344
|
-
#
|
347
|
+
# The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/
|
348
|
+
# concepts#cell) of a range to search for a logical table of data. Values are
|
349
|
+
# appended after the last row of the table.
|
345
350
|
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
|
346
351
|
# @param [Boolean] include_values_in_response
|
347
352
|
# Determines if the update response should include the values of the cells that
|
@@ -479,8 +484,8 @@ module Google
|
|
479
484
|
# majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:
|
480
485
|
# B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
|
481
486
|
# @param [Array<String>, String] ranges
|
482
|
-
# The [A1 notation or R1C1 notation](/
|
483
|
-
# range to retrieve values from.
|
487
|
+
# The [A1 notation or R1C1 notation](https://developers.google.com/workspace/
|
488
|
+
# sheets/api/guides/concepts#cell) of the range to retrieve values from.
|
484
489
|
# @param [String] value_render_option
|
485
490
|
# How values should be represented in the output. The default render option is
|
486
491
|
# ValueRenderOption.FORMATTED_VALUE.
|
@@ -624,8 +629,8 @@ module Google
|
|
624
629
|
# @param [String] spreadsheet_id
|
625
630
|
# The ID of the spreadsheet to update.
|
626
631
|
# @param [String] range
|
627
|
-
# The [A1 notation or R1C1 notation](/
|
628
|
-
# values to clear.
|
632
|
+
# The [A1 notation or R1C1 notation](https://developers.google.com/workspace/
|
633
|
+
# sheets/api/guides/concepts#cell) of the values to clear.
|
629
634
|
# @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object
|
630
635
|
# @param [String] fields
|
631
636
|
# Selector specifying which fields to include in a partial response.
|
@@ -662,8 +667,8 @@ module Google
|
|
662
667
|
# @param [String] spreadsheet_id
|
663
668
|
# The ID of the spreadsheet to retrieve data from.
|
664
669
|
# @param [String] range
|
665
|
-
# The [A1 notation or R1C1 notation](/
|
666
|
-
# range to retrieve values from.
|
670
|
+
# The [A1 notation or R1C1 notation](https://developers.google.com/workspace/
|
671
|
+
# sheets/api/guides/concepts#cell) of the range to retrieve values from.
|
667
672
|
# @param [String] date_time_render_option
|
668
673
|
# How dates, times, and durations should be represented in the output. This is
|
669
674
|
# ignored if value_render_option is FORMATTED_VALUE. The default dateTime render
|
@@ -712,7 +717,8 @@ module Google
|
|
712
717
|
# @param [String] spreadsheet_id
|
713
718
|
# The ID of the spreadsheet to update.
|
714
719
|
# @param [String] range
|
715
|
-
# The [A1 notation](/sheets/api/guides/
|
720
|
+
# The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/
|
721
|
+
# concepts#cell) of the values to update.
|
716
722
|
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
|
717
723
|
# @param [Boolean] include_values_in_response
|
718
724
|
# Determines if the update response should include the values of the cells that
|
@@ -23,7 +23,7 @@ module Google
|
|
23
23
|
#
|
24
24
|
# Reads and writes Google Sheets.
|
25
25
|
#
|
26
|
-
# @see https://developers.google.com/sheets/
|
26
|
+
# @see https://developers.google.com/workspace/sheets/
|
27
27
|
module SheetsV4
|
28
28
|
# Version of the Google Sheets API this client connects to.
|
29
29
|
# This is NOT the gem version.
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-sheets_v4
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.41.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-04-27 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: google-apis-core
|
@@ -58,9 +57,8 @@ licenses:
|
|
58
57
|
metadata:
|
59
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-sheets_v4/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-sheets_v4/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-sheets_v4/v0.41.0
|
62
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-sheets_v4
|
63
|
-
post_install_message:
|
64
62
|
rdoc_options: []
|
65
63
|
require_paths:
|
66
64
|
- lib
|
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
73
|
- !ruby/object:Gem::Version
|
76
74
|
version: '0'
|
77
75
|
requirements: []
|
78
|
-
rubygems_version: 3.5
|
79
|
-
signing_key:
|
76
|
+
rubygems_version: 3.6.5
|
80
77
|
specification_version: 4
|
81
78
|
summary: Simple REST client for Google Sheets API V4
|
82
79
|
test_files: []
|