Class: Google::Apis::SheetsV4::SheetsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/sheets_v4/service.rb

Overview

Google Sheets API

Reads and writes Google Sheets.

Examples:

require 'google/apis/sheets_v4'

Sheets = Google::Apis::SheetsV4 # Alias the module
service = Sheets::SheetsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeSheetsService

Returns a new instance of SheetsService.



45
46
47
# File 'generated/google/apis/sheets_v4/service.rb', line 45

def initialize
  super('https://sheets.googleapis.com/', '')
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
# File 'generated/google/apis/sheets_v4/service.rb', line 38

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
# File 'generated/google/apis/sheets_v4/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, insert_data_option: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::AppendValuesResponse

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The valueInputOption only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to update.

  • range (String)

    The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.

  • value_range_object (Google::Apis::SheetsV4::ValueRange) (defaults to: nil)
  • value_input_option (String) (defaults to: nil)

    How the input data should be interpreted.

  • insert_data_option (String) (defaults to: nil)

    How the input data should be inserted.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'generated/google/apis/sheets_v4/service.rb', line 394

def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, insert_data_option: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options)
  command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
  command.request_object = value_range_object
  command.response_representation = Google::Apis::SheetsV4::AppendValuesResponse::Representation
  command.response_class = Google::Apis::SheetsV4::AppendValuesResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.params['range'] = range unless range.nil?
  command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
  command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchClearValuesResponse

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to update.

  • batch_clear_values_request_object (Google::Apis::SheetsV4::BatchClearValuesRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



474
475
476
477
478
479
480
481
482
483
484
# File 'generated/google/apis/sheets_v4/service.rb', line 474

def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchClear', options)
  command.request_representation = Google::Apis::SheetsV4::BatchClearValuesRequest::Representation
  command.request_object = batch_clear_values_request_object
  command.response_representation = Google::Apis::SheetsV4::BatchClearValuesResponse::Representation
  command.response_class = Google::Apis::SheetsV4::BatchClearValuesResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#batch_get_spreadsheet_values(spreadsheet_id, ranges: nil, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchGetValuesResponse

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to retrieve data from.

  • ranges (Array<String>, String) (defaults to: nil)

    The A1 notation of the values to retrieve.

  • value_render_option (String) (defaults to: nil)

    How values should be represented in the output.

  • date_time_render_option (String) (defaults to: nil)

    How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE.

  • major_dimension (String) (defaults to: nil)

    The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting range=A1:B2,majorDimension=ROWS will return [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS will return [[1,3],[2,4]].

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'generated/google/apis/sheets_v4/service.rb', line 254

def batch_get_spreadsheet_values(spreadsheet_id, ranges: nil, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options)
  command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation
  command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.query['ranges'] = ranges unless ranges.nil?
  command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
  command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
  command.query['majorDimension'] = major_dimension unless major_dimension.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse

Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

Parameters:

  • spreadsheet_id (String)

    The spreadsheet to apply the updates to.

  • batch_update_spreadsheet_request_object (Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



167
168
169
170
171
172
173
174
175
176
177
# File 'generated/google/apis/sheets_v4/service.rb', line 167

def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}:batchUpdate', options)
  command.request_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest::Representation
  command.request_object = batch_update_spreadsheet_request_object
  command.response_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse::Representation
  command.response_class = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchUpdateValuesResponse

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to update.

  • batch_update_values_request_object (Google::Apis::SheetsV4::BatchUpdateValuesRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



292
293
294
295
296
297
298
299
300
301
302
# File 'generated/google/apis/sheets_v4/service.rb', line 292

def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options)
  command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation
  command.request_object = batch_update_values_request_object
  command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation
  command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#clear_values(spreadsheet_id, range, clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::ClearValuesResponse

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to update.

  • range (String)

    The A1 notation of the values to clear.

  • clear_values_request_object (Google::Apis::SheetsV4::ClearValuesRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



205
206
207
208
209
210
211
212
213
214
215
216
# File 'generated/google/apis/sheets_v4/service.rb', line 205

def clear_values(spreadsheet_id, range, clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:clear', options)
  command.request_representation = Google::Apis::SheetsV4::ClearValuesRequest::Representation
  command.request_object = clear_values_request_object
  command.response_representation = Google::Apis::SheetsV4::ClearValuesResponse::Representation
  command.response_class = Google::Apis::SheetsV4::ClearValuesResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.params['range'] = range unless range.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::SheetProperties

Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet containing the sheet to copy.

  • sheet_id (Fixnum)

    The ID of the sheet to copy.

  • copy_sheet_to_another_spreadsheet_request_object (Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



510
511
512
513
514
515
516
517
518
519
520
521
# File 'generated/google/apis/sheets_v4/service.rb', line 510

def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options)
  command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation
  command.request_object = copy_sheet_to_another_spreadsheet_request_object
  command.response_representation = Google::Apis::SheetsV4::SheetProperties::Representation
  command.response_class = Google::Apis::SheetsV4::SheetProperties
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.params['sheetId'] = sheet_id unless sheet_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_spreadsheet(spreadsheet_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet

Creates a spreadsheet, returning the newly created spreadsheet.

Parameters:

  • spreadsheet_object (Google::Apis::SheetsV4::Spreadsheet) (defaults to: nil)
  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



68
69
70
71
72
73
74
75
76
77
# File 'generated/google/apis/sheets_v4/service.rb', line 68

def create_spreadsheet(spreadsheet_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v4/spreadsheets', options)
  command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
  command.request_object = spreadsheet_object
  command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
  command.response_class = Google::Apis::SheetsV4::Spreadsheet
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways:

  • Specify a field mask listing your desired fields using the fields URL parameter in HTTP
  • Set the includeGridData URL parameter to true. If a field mask is set, the includeGridData parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

Parameters:

  • spreadsheet_id (String)

    The spreadsheet to request.

  • ranges (Array<String>, String) (defaults to: nil)

    The ranges to retrieve from the spreadsheet.

  • include_grid_data (Boolean) (defaults to: nil)

    True if grid data should be returned. This parameter is ignored if a field mask was set in the request.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



119
120
121
122
123
124
125
126
127
128
129
# File 'generated/google/apis/sheets_v4/service.rb', line 119

def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options)
  command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
  command.response_class = Google::Apis::SheetsV4::Spreadsheet
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.query['ranges'] = ranges unless ranges.nil?
  command.query['includeGridData'] = include_grid_data unless include_grid_data.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_spreadsheet_values(spreadsheet_id, range, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::ValueRange

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to retrieve data from.

  • range (String)

    The A1 notation of the values to retrieve.

  • value_render_option (String) (defaults to: nil)

    How values should be represented in the output.

  • date_time_render_option (String) (defaults to: nil)

    How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE.

  • major_dimension (String) (defaults to: nil)

    The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting range=A1:B2,majorDimension=ROWS will return [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS will return [[1,3],[2,4]].

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'generated/google/apis/sheets_v4/service.rb', line 340

def get_spreadsheet_values(spreadsheet_id, range, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
  command.response_representation = Google::Apis::SheetsV4::ValueRange::Representation
  command.response_class = Google::Apis::SheetsV4::ValueRange
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.params['range'] = range unless range.nil?
  command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
  command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
  command.query['majorDimension'] = major_dimension unless major_dimension.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::UpdateValuesResponse

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.

Parameters:

  • spreadsheet_id (String)

    The ID of the spreadsheet to update.

  • range (String)

    The A1 notation of the values to update.

  • value_range_object (Google::Apis::SheetsV4::ValueRange) (defaults to: nil)
  • value_input_option (String) (defaults to: nil)

    How the input data should be interpreted.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'generated/google/apis/sheets_v4/service.rb', line 436

def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
  command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
  command.request_object = value_range_object
  command.response_representation = Google::Apis::SheetsV4::UpdateValuesResponse::Representation
  command.response_class = Google::Apis::SheetsV4::UpdateValuesResponse
  command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
  command.params['range'] = range unless range.nil?
  command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end