Class: Google::Apis::SheetsV4::BatchGetValuesByDataFilterRequest
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::BatchGetValuesByDataFilterRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb
Overview
The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
Instance Attribute Summary collapse
-
#data_filters ⇒ Array<Google::Apis::SheetsV4::DataFilter>
The data filters used to match the ranges of values to retrieve.
-
#date_time_render_option ⇒ String
How dates, times, and durations should be represented in the output.
-
#major_dimension ⇒ String
The major dimension that results should use.
-
#value_render_option ⇒ String
How values should be represented in the output.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BatchGetValuesByDataFilterRequest
constructor
A new instance of BatchGetValuesByDataFilterRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BatchGetValuesByDataFilterRequest
Returns a new instance of BatchGetValuesByDataFilterRequest.
1896 1897 1898 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1896 def initialize(**args) update!(**args) end |
Instance Attribute Details
#data_filters ⇒ Array<Google::Apis::SheetsV4::DataFilter>
The data filters used to match the ranges of values to retrieve. Ranges
that match any of the specified data filters are included in the response.
Corresponds to the JSON property dataFilters
1871 1872 1873 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1871 def data_filters @data_filters end |
#date_time_render_option ⇒ String
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].
Corresponds to the JSON property dateTimeRenderOption
1879 1880 1881 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1879 def date_time_render_option @date_time_render_option end |
#major_dimension ⇒ String
The major dimension that results should use.
For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4
,
then a request that selects that range and sets majorDimension=ROWS
returns [[1,2],[3,4]]
, whereas a request that sets
majorDimension=COLUMNS
returns [[1,3],[2,4]]
.
Corresponds to the JSON property majorDimension
1888 1889 1890 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1888 def major_dimension @major_dimension end |
#value_render_option ⇒ String
How values should be represented in the output.
The default render option is ValueRenderOption.FORMATTED_VALUE.
Corresponds to the JSON property valueRenderOption
1894 1895 1896 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1894 def value_render_option @value_render_option end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1901 1902 1903 1904 1905 1906 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1901 def update!(**args) @data_filters = args[:data_filters] if args.key?(:data_filters) @date_time_render_option = args[:date_time_render_option] if args.key?(:date_time_render_option) @major_dimension = args[:major_dimension] if args.key?(:major_dimension) @value_render_option = args[:value_render_option] if args.key?(:value_render_option) end |