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



1669
1670
1671
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1669

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

Returns:



1635
1636
1637
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1635

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

Returns:

  • (Boolean) 


1646
1647
1648
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1646

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

Returns:

  • (String) 


1656
1657
1658
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1656

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

Returns:

  • (String) 


1662
1663
1664
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1662

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

Returns:

  • (String) 


1667
1668
1669
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1667

def value_input_option
  @value_input_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1674
1675
1676
1677
1678
1679
1680
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1674

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