Class: Google::Apis::SheetsV4::BatchUpdateValuesRequest

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 updating more than one range of values in a spreadsheet.

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) ⇒ BatchUpdateValuesRequest

Returns a new instance of BatchUpdateValuesRequest.



1779
1780
1781
# File 'generated/google/apis/sheets_v4/classes.rb', line 1779

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

Instance Attribute Details

#dataArray<Google::Apis::SheetsV4::ValueRange>

The new values to apply to the spreadsheet. Corresponds to the JSON property data



1748
1749
1750
# File 'generated/google/apis/sheets_v4/classes.rb', line 1748

def data
  @data
end

#include_values_in_responseBoolean 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 contains 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). Corresponds to the JSON property includeValuesInResponse

Returns:

  • (Boolean)


1758
1759
1760
# File 'generated/google/apis/sheets_v4/classes.rb', line 1758

def include_values_in_response
  @include_values_in_response
end

#response_date_time_render_optionString

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

Returns:

  • (String)


1766
1767
1768
# File 'generated/google/apis/sheets_v4/classes.rb', line 1766

def response_date_time_render_option
  @response_date_time_render_option
end

#response_value_render_optionString

Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. Corresponds to the JSON property responseValueRenderOption

Returns:

  • (String)


1772
1773
1774
# File 'generated/google/apis/sheets_v4/classes.rb', line 1772

def response_value_render_option
  @response_value_render_option
end

#value_input_optionString

How the input data should be interpreted. Corresponds to the JSON property valueInputOption

Returns:

  • (String)


1777
1778
1779
# File 'generated/google/apis/sheets_v4/classes.rb', line 1777

def value_input_option
  @value_input_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1784
1785
1786
1787
1788
1789
1790
# File 'generated/google/apis/sheets_v4/classes.rb', line 1784

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