Class: Google::Apis::SheetsV4::SheetsService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::SheetsV4::SheetsService
- Defined in:
- lib/google/apis/sheets_v4/service.rb
Overview
Google Sheets API
Reads and writes Google Sheets.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://sheets.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::AppendValuesResponse
Appends values to a spreadsheet.
-
#batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchClearValuesResponse
Clears one or more ranges of values from a spreadsheet.
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchGetValuesResponse
Returns one or more ranges of values from a spreadsheet.
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchClearValuesByDataFilterResponse
Clears one or more ranges of values from a spreadsheet.
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchGetValuesByDataFilterResponse
Returns one or more ranges of values that match the specified data filters.
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterResponse
Sets values in one or more ranges of a spreadsheet.
-
#batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse
Applies one or more updates to the spreadsheet.
-
#batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchUpdateValuesResponse
Sets values in one or more ranges of a spreadsheet.
-
#clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::ClearValuesResponse
Clears values from a spreadsheet.
-
#copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::SheetProperties
Copies a single sheet from a spreadsheet to another spreadsheet.
-
#create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet
Creates a spreadsheet, returning the newly created spreadsheet.
-
#get_spreadsheet(spreadsheet_id, include_grid_data: nil, ranges: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet
Returns the spreadsheet at the given ID.
-
#get_spreadsheet_by_data_filter(spreadsheet_id, get_spreadsheet_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet
Returns the spreadsheet at the given ID.
-
#get_spreadsheet_developer_metadatum(spreadsheet_id, metadata_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::DeveloperMetadata
Returns the developer metadata with the specified ID.
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::ValueRange
Returns a range of values from a spreadsheet.
-
#initialize ⇒ SheetsService
constructor
A new instance of SheetsService.
-
#search_developer_metadatum_developer_metadata(spreadsheet_id, search_developer_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::SearchDeveloperMetadataResponse
Returns all developer metadata matching the specified DataFilter.
-
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::UpdateValuesResponse
Sets values in a range of a spreadsheet.
Constructor Details
#initialize ⇒ SheetsService
Returns a new instance of SheetsService.
47 48 49 50 51 52 |
# File 'lib/google/apis/sheets_v4/service.rb', line 47 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-sheets_v4', client_version: Google::Apis::SheetsV4::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
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.
40 41 42 |
# File 'lib/google/apis/sheets_v4/service.rb', line 40 def key @key end |
#quota_user ⇒ String
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.
45 46 47 |
# File 'lib/google/apis/sheets_v4/service.rb', line 45 def quota_user @quota_user end |
Instance Method Details
#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) {|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.
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/apis/sheets_v4/service.rb', line 377 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', ) 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 |
#batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, fields: nil, quota_user: 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 and data validation) are kept.
419 420 421 422 423 424 425 426 427 428 429 |
# File 'lib/google/apis/sheets_v4/service.rb', line 419 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', ) 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 |
#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) {|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.
504 505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'lib/google/apis/sheets_v4/service.rb', line 504 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', ) 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 |
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchClearValuesByDataFilterResponse
Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
456 457 458 459 460 461 462 463 464 465 466 |
# File 'lib/google/apis/sheets_v4/service.rb', line 456 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', ) 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 |
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchGetValuesByDataFilterResponse
Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.
541 542 543 544 545 546 547 548 549 550 551 |
# File 'lib/google/apis/sheets_v4/service.rb', line 541 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', ) 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 |
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterResponse
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
609 610 611 612 613 614 615 616 617 618 619 |
# File 'lib/google/apis/sheets_v4/service.rb', line 609 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', ) 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 |
#batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, fields: nil, quota_user: 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.
86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/google/apis/sheets_v4/service.rb', line 86 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', ) 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 |
#batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: 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.
575 576 577 578 579 580 581 582 583 584 585 |
# File 'lib/google/apis/sheets_v4/service.rb', line 575 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', ) 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 |
#clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: 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.
647 648 649 650 651 652 653 654 655 656 657 658 |
# File 'lib/google/apis/sheets_v4/service.rb', line 647 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', ) 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 |
#copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: 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.
318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/google/apis/sheets_v4/service.rb', line 318 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', ) 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 |
#create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet
Creates a spreadsheet, returning the newly created spreadsheet.
117 118 119 120 121 122 123 124 125 126 |
# File 'lib/google/apis/sheets_v4/service.rb', line 117 def create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets', ) 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 |
#get_spreadsheet(spreadsheet_id, include_grid_data: nil, ranges: nil, fields: nil, quota_user: 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 is not returned. You can include
grid data in one of 2 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, as a best practice, retrieve only the specific spreadsheet
fields that you want. To retrieve only subsets of spreadsheet data, use the
ranges URL parameter. Ranges are specified using A1 notation. You can define a single cell (for example, A1
) or
multiple cells (for example, A1:D5
). You can also get cells from other
sheets within the same spreadsheet (for example, Sheet2!A1:C4
) or retrieve
multiple ranges at once (for example, ?ranges=A1:D5&ranges=Sheet2!A1:C4
).
Limiting the range returns only the portions of the spreadsheet that intersect
the requested ranges.
167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/google/apis/sheets_v4/service.rb', line 167 def get_spreadsheet(spreadsheet_id, include_grid_data: nil, ranges: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', ) 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['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 |
#get_spreadsheet_by_data_filter(spreadsheet_id, get_spreadsheet_by_data_filter_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::Spreadsheet
Returns the spreadsheet at the given ID. The caller must specify the
spreadsheet ID. This method differs from GetSpreadsheet in that it allows
selecting which subsets of spreadsheet data to return by specifying a
dataFilters parameter. Multiple DataFilters can be specified. Specifying one
or more data filters returns the portions of the spreadsheet that intersect
ranges matched by any of the filters. By default, data within grids is not
returned. You can include grid data one of 2 ways: * Specify a field mask listing your
desired fields using the fields
URL parameter in HTTP * Set the
includeGridData parameter to true. If a field mask is set, the
includeGridData
parameter is ignored For large spreadsheets, as a best
practice, retrieve only the specific spreadsheet fields that you want.
211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/google/apis/sheets_v4/service.rb', line 211 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', ) 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 |
#get_spreadsheet_developer_metadatum(spreadsheet_id, metadata_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::DeveloperMetadata
Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.
246 247 248 249 250 251 252 253 254 255 |
# File 'lib/google/apis/sheets_v4/service.rb', line 246 def (spreadsheet_id, , fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}', ) 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'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#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) {|result, err| ... } ⇒ Google::Apis::SheetsV4::ValueRange
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
696 697 698 699 700 701 702 703 704 705 706 707 708 |
# File 'lib/google/apis/sheets_v4/service.rb', line 696 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}', ) 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 |
#search_developer_metadatum_developer_metadata(spreadsheet_id, search_developer_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SheetsV4::SearchDeveloperMetadataResponse
Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.
282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/google/apis/sheets_v4/service.rb', line 282 def (spreadsheet_id, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/developerMetadata:search', ) command.request_representation = Google::Apis::SheetsV4::SearchDeveloperMetadataRequest::Representation command.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 |
#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) {|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.
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
# File 'lib/google/apis/sheets_v4/service.rb', line 749 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}', ) 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 |