class Google::Apis::SheetsV4::SheetsService
@see developers.google.com/workspace/sheets/
service = Sheets::SheetsService.new
Sheets = Google::Apis::SheetsV4 # Alias the module
require ‘google/apis/sheets_v4’
@example
Reads and writes Google Sheets.
Google Sheets API
def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, include_values_in_response: nil, insert_data_option: nil, response_date_time_render_option: nil, response_value_render_option: nil, value_input_option: nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::AppendValuesResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
value_input_option
(String
) -- -
response_value_render_option
(String
) -- -
response_date_time_render_option
(String
) -- -
insert_data_option
(String
) -- -
include_values_in_response
(Boolean
) -- -
value_range_object
(Google::Apis::SheetsV4::ValueRange
) -- -
range
(String
) -- -
spreadsheet_id
(String
) --
def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, include_values_in_response: nil, insert_data_option: nil, response_date_time_render_option: nil, response_value_render_option: nil, value_input_option: nil, fields: nil, quota_user: 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['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil? command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil? command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil? command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil? command.query['valueInputOption'] = value_input_option unless value_input_option.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def apply_command_defaults(command)
def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end
def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchClearValuesResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
batch_clear_values_request_object
(Google::Apis::SheetsV4::BatchClearValuesRequest
) -- -
spreadsheet_id
(String
) --
def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def batch_get_spreadsheet_values(spreadsheet_id, date_time_render_option: nil, major_dimension: nil, ranges: nil, value_render_option: nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchGetValuesResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
value_render_option
(String
) -- -
ranges
(Array
) --, String -
major_dimension
(String
) -- -
date_time_render_option
(String
) -- -
spreadsheet_id
(String
) --
def batch_get_spreadsheet_values(spreadsheet_id, date_time_render_option: nil, major_dimension: nil, ranges: nil, value_render_option: nil, fields: nil, quota_user: 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['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil? command.query['majorDimension'] = major_dimension unless major_dimension.nil? command.query['ranges'] = ranges unless ranges.nil? command.query['valueRenderOption'] = value_render_option unless value_render_option.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def batch_spreadsheet_value_clear_by_data_filter(spreadsheet_id, batch_clear_values_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchClearValuesByDataFilterResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
batch_clear_values_by_data_filter_request_object
(Google::Apis::SheetsV4::BatchClearValuesByDataFilterRequest
) -- -
spreadsheet_id
(String
) --
def batch_spreadsheet_value_clear_by_data_filter(spreadsheet_id, batch_clear_values_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter', options) command.request_representation = Google::Apis::SheetsV4::BatchClearValuesByDataFilterRequest::Representation command.request_object = batch_clear_values_by_data_filter_request_object command.response_representation = Google::Apis::SheetsV4::BatchClearValuesByDataFilterResponse::Representation command.response_class = Google::Apis::SheetsV4::BatchClearValuesByDataFilterResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def batch_spreadsheet_value_get_by_data_filter(spreadsheet_id, batch_get_values_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchGetValuesByDataFilterResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
batch_get_values_by_data_filter_request_object
(Google::Apis::SheetsV4::BatchGetValuesByDataFilterRequest
) -- -
spreadsheet_id
(String
) --
def batch_spreadsheet_value_get_by_data_filter(spreadsheet_id, batch_get_values_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter', options) command.request_representation = Google::Apis::SheetsV4::BatchGetValuesByDataFilterRequest::Representation command.request_object = batch_get_values_by_data_filter_request_object command.response_representation = Google::Apis::SheetsV4::BatchGetValuesByDataFilterResponse::Representation command.response_class = Google::Apis::SheetsV4::BatchGetValuesByDataFilterResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def batch_spreadsheet_value_update_by_data_filter(spreadsheet_id, batch_update_values_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
batch_update_values_by_data_filter_request_object
(Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterRequest
) -- -
spreadsheet_id
(String
) --
def batch_spreadsheet_value_update_by_data_filter(spreadsheet_id, batch_update_values_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter', options) command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterRequest::Representation command.request_object = batch_update_values_by_data_filter_request_object command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterResponse::Representation command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
batch_update_spreadsheet_request_object
(Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest
) -- -
spreadsheet_id
(String
) --
def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::BatchUpdateValuesResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
batch_update_values_request_object
(Google::Apis::SheetsV4::BatchUpdateValuesRequest
) -- -
spreadsheet_id
(String
) --
def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::ClearValuesResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
clear_values_request_object
(Google::Apis::SheetsV4::ClearValuesRequest
) -- -
range
(String
) -- -
spreadsheet_id
(String
) --
def clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::SheetProperties)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
copy_sheet_to_another_spreadsheet_request_object
(Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest
) -- -
sheet_id
(Fixnum
) -- -
spreadsheet_id
(String
) --
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::Spreadsheet)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
spreadsheet_object
(Google::Apis::SheetsV4::Spreadsheet
) --
def create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def get_spreadsheet(spreadsheet_id, exclude_tables_in_banded_ranges: nil, include_grid_data: nil, ranges: nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::Spreadsheet)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
ranges
(Array
) --, String -
include_grid_data
(Boolean
) -- -
exclude_tables_in_banded_ranges
(Boolean
) -- -
spreadsheet_id
(String
) --
def get_spreadsheet(spreadsheet_id, exclude_tables_in_banded_ranges: nil, include_grid_data: nil, ranges: nil, fields: nil, quota_user: 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['excludeTablesInBandedRanges'] = exclude_tables_in_banded_ranges unless exclude_tables_in_banded_ranges.nil? command.query['includeGridData'] = include_grid_data unless include_grid_data.nil? command.query['ranges'] = ranges unless ranges.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def get_spreadsheet_by_data_filter(spreadsheet_id, get_spreadsheet_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::Spreadsheet)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
get_spreadsheet_by_data_filter_request_object
(Google::Apis::SheetsV4::GetSpreadsheetByDataFilterRequest
) -- -
spreadsheet_id
(String
) --
def get_spreadsheet_by_data_filter(spreadsheet_id, get_spreadsheet_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}:getByDataFilter', options) command.request_representation = Google::Apis::SheetsV4::GetSpreadsheetByDataFilterRequest::Representation command.request_object = get_spreadsheet_by_data_filter_request_object 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['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def get_spreadsheet_developer_metadatum(spreadsheet_id, metadata_id, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::DeveloperMetadata)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
metadata_id
(Fixnum
) -- -
spreadsheet_id
(String
) --
def get_spreadsheet_developer_metadatum(spreadsheet_id, metadata_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}', options) command.response_representation = Google::Apis::SheetsV4::DeveloperMetadata::Representation command.response_class = Google::Apis::SheetsV4::DeveloperMetadata command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.params['metadataId'] = metadata_id unless metadata_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def get_spreadsheet_values(spreadsheet_id, range, date_time_render_option: nil, major_dimension: nil, value_render_option: nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::ValueRange)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
value_render_option
(String
) -- -
major_dimension
(String
) -- -
date_time_render_option
(String
) -- -
range
(String
) -- -
spreadsheet_id
(String
) --
def get_spreadsheet_values(spreadsheet_id, range, date_time_render_option: nil, major_dimension: nil, value_render_option: nil, fields: nil, quota_user: 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['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil? command.query['majorDimension'] = major_dimension unless major_dimension.nil? command.query['valueRenderOption'] = value_render_option unless value_render_option.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def initialize
def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-sheets_v4', client_version: Google::Apis::SheetsV4::GEM_VERSION) @batch_path = 'batch' end
def search_developer_metadatum_developer_metadata(spreadsheet_id, search_developer_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::SearchDeveloperMetadataResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
search_developer_metadata_request_object
(Google::Apis::SheetsV4::SearchDeveloperMetadataRequest
) -- -
spreadsheet_id
(String
) --
def search_developer_metadatum_developer_metadata(spreadsheet_id, search_developer_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/developerMetadata:search', options) command.request_representation = Google::Apis::SheetsV4::SearchDeveloperMetadataRequest::Representation command.request_object = search_developer_metadata_request_object command.response_representation = Google::Apis::SheetsV4::SearchDeveloperMetadataResponse::Representation command.response_class = Google::Apis::SheetsV4::SearchDeveloperMetadataResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, include_values_in_response: nil, response_date_time_render_option: nil, response_value_render_option: nil, value_input_option: nil, fields: nil, quota_user: nil, options: nil, &block)
-
(Google::Apis::AuthorizationError)
- Authorization is required -
(Google::Apis::ClientError)
- The request is invalid and should not be retried without modification -
(Google::Apis::ServerError)
- An error occurred on the server and the request can be retried
Returns:
-
(Google::Apis::SheetsV4::UpdateValuesResponse)
-
Other tags:
- Yieldparam: err - error object if request failed
Yieldparam: result - parsed result object
Other tags:
- Yield: - Result & error if block supplied
Parameters:
-
options
(Google::Apis::RequestOptions
) -- -
quota_user
(String
) -- -
fields
(String
) -- -
value_input_option
(String
) -- -
response_value_render_option
(String
) -- -
response_date_time_render_option
(String
) -- -
include_values_in_response
(Boolean
) -- -
value_range_object
(Google::Apis::SheetsV4::ValueRange
) -- -
range
(String
) -- -
spreadsheet_id
(String
) --
def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, include_values_in_response: nil, response_date_time_render_option: nil, response_value_render_option: nil, value_input_option: nil, fields: nil, quota_user: 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['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil? command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil? command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil? command.query['valueInputOption'] = value_input_option unless value_input_option.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end