Class: Google::Apis::SheetsV4::BatchUpdateValuesRequest
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::BatchUpdateValuesRequest
- 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 updating more than one range of values in a spreadsheet.
Instance Attribute Summary collapse
-
#data ⇒ Array<Google::Apis::SheetsV4::ValueRange>
The new values to apply to the spreadsheet.
-
#include_values_in_response ⇒ Boolean
(also: #include_values_in_response?)
Determines if the update response should include the values of the cells that were updated.
-
#response_date_time_render_option ⇒ String
Determines how dates, times, and durations in the response should be rendered.
-
#response_value_render_option ⇒ String
Determines how values in the response should be rendered.
-
#value_input_option ⇒ String
How the input data should be interpreted.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BatchUpdateValuesRequest
constructor
A new instance of BatchUpdateValuesRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BatchUpdateValuesRequest
Returns a new instance of BatchUpdateValuesRequest
1829 1830 1831 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1829 def initialize(**args) update!(**args) end |
Instance Attribute Details
#data ⇒ Array<Google::Apis::SheetsV4::ValueRange>
The new values to apply to the spreadsheet.
Corresponds to the JSON property data
1795 1796 1797 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1795 def data @data end |
#include_values_in_response ⇒ Boolean Also known as: include_values_in_response?
Determines if the update response should include the values
of the cells that were updated. By default, responses
do not include the updated values. The updatedData
field within
each of the BatchUpdateValuesResponse.responses will contain
the updated values. If the range to write was larger than than the range
actually written, the response will include all values in the requested
range (excluding trailing empty rows and columns).
Corresponds to the JSON property includeValuesInResponse
1806 1807 1808 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1806 def include_values_in_response @include_values_in_response end |
#response_date_time_render_option ⇒ String
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.
Corresponds to the JSON property responseDateTimeRenderOption
1816 1817 1818 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1816 def response_date_time_render_option @response_date_time_render_option end |
#response_value_render_option ⇒ String
Determines how values in the response should be rendered.
The default render option is ValueRenderOption.FORMATTED_VALUE.
Corresponds to the JSON property responseValueRenderOption
1822 1823 1824 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1822 def response_value_render_option @response_value_render_option end |
#value_input_option ⇒ String
How the input data should be interpreted.
Corresponds to the JSON property valueInputOption
1827 1828 1829 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1827 def value_input_option @value_input_option end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1834 1835 1836 1837 1838 1839 1840 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1834 def update!(**args) @data = args[:data] if args.key?(:data) @include_values_in_response = args[:include_values_in_response] if args.key?(:include_values_in_response) @response_date_time_render_option = args[:response_date_time_render_option] if args.key?(:response_date_time_render_option) @response_value_render_option = args[:response_value_render_option] if args.key?(:response_value_render_option) @value_input_option = args[:value_input_option] if args.key?(:value_input_option) end |