Class: Google::Apis::SheetsV4::BatchGetValuesByDataFilterRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BatchGetValuesByDataFilterRequest

Returns a new instance of BatchGetValuesByDataFilterRequest.


1436
1437
1438
# File 'generated/google/apis/sheets_v4/classes.rb', line 1436

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data_filtersArray<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


1413
1414
1415
# File 'generated/google/apis/sheets_v4/classes.rb', line 1413

def data_filters
  @data_filters
end

#date_time_render_optionString

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

Returns:

  • (String)

1420
1421
1422
# File 'generated/google/apis/sheets_v4/classes.rb', line 1420

def date_time_render_option
  @date_time_render_option
end

#major_dimensionString

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

Returns:

  • (String)

1428
1429
1430
# File 'generated/google/apis/sheets_v4/classes.rb', line 1428

def major_dimension
  @major_dimension
end

#value_render_optionString

How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. Corresponds to the JSON property valueRenderOption

Returns:

  • (String)

1434
1435
1436
# File 'generated/google/apis/sheets_v4/classes.rb', line 1434

def value_render_option
  @value_render_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1441
1442
1443
1444
1445
1446
# File 'generated/google/apis/sheets_v4/classes.rb', line 1441

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