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



3032
3033
3034
# File 'generated/google/apis/sheets_v4/classes.rb', line 3032

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



3021
3022
3023
# File 'generated/google/apis/sheets_v4/classes.rb', line 3021

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


3010
3011
3012
# File 'generated/google/apis/sheets_v4/classes.rb', line 3010

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)


3030
3031
3032
# File 'generated/google/apis/sheets_v4/classes.rb', line 3030

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)


2999
3000
3001
# File 'generated/google/apis/sheets_v4/classes.rb', line 2999

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)


3016
3017
3018
# File 'generated/google/apis/sheets_v4/classes.rb', line 3016

def value_input_option
  @value_input_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3037
3038
3039
3040
3041
3042
3043
# File 'generated/google/apis/sheets_v4/classes.rb', line 3037

def update!(**args)
  @response_value_render_option = args[:response_value_render_option] if args.key?(:response_value_render_option)
  @include_values_in_response = args[:include_values_in_response] if args.key?(:include_values_in_response)
  @value_input_option = args[:value_input_option] if args.key?(:value_input_option)
  @data = args[:data] if args.key?(:data)
  @response_date_time_render_option = args[:response_date_time_render_option] if args.key?(:response_date_time_render_option)
end