Class: Google::Apis::SheetsV4::Request

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

A single kind of update to apply to 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) ⇒ Request

Returns a new instance of Request.



5302
5303
5304
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5302

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#add_chart ⇒ Google::Apis::SheetsV4::AddChartRequest

Adds a chart to a sheet in the spreadsheet. Corresponds to the JSON property addChart

Returns:



5195
5196
5197
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5195

def add_chart
  @add_chart
end

#add_conditional_format_rule ⇒ Google::Apis::SheetsV4::AddConditionalFormatRuleRequest

Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented. Corresponds to the JSON property addConditionalFormatRule

Returns:



5229
5230
5231
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5229

def add_conditional_format_rule
  @add_conditional_format_rule
end

#add_filter_view ⇒ Google::Apis::SheetsV4::AddFilterViewRequest

Adds a filter view. Corresponds to the JSON property addFilterView

Returns:



5066
5067
5068
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5066

def add_filter_view
  @add_filter_view
end

#add_named_range ⇒ Google::Apis::SheetsV4::AddNamedRangeRequest

Adds a named range to the spreadsheet. Corresponds to the JSON property addNamedRange

Returns:



5274
5275
5276
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5274

def add_named_range
  @add_named_range
end

#add_protected_range ⇒ Google::Apis::SheetsV4::AddProtectedRangeRequest

Adds a new protected range. Corresponds to the JSON property addProtectedRange

Returns:



5169
5170
5171
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5169

def add_protected_range
  @add_protected_range
end

#add_sheet ⇒ Google::Apis::SheetsV4::AddSheetRequest

Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet. Corresponds to the JSON property addSheet

Returns:



5138
5139
5140
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5138

def add_sheet
  @add_sheet
end

#append_cells ⇒ Google::Apis::SheetsV4::AppendCellsRequest

Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary. Corresponds to the JSON property appendCells

Returns:



5269
5270
5271
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5269

def append_cells
  @append_cells
end

#append_dimension ⇒ Google::Apis::SheetsV4::AppendDimensionRequest

Appends rows or columns to the end of a sheet. Corresponds to the JSON property appendDimension

Returns:



5076
5077
5078
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5076

def append_dimension
  @append_dimension
end

#auto_fill ⇒ Google::Apis::SheetsV4::AutoFillRequest

Fills in more data based on existing data. Corresponds to the JSON property autoFill

Returns:



5279
5280
5281
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5279

def auto_fill
  @auto_fill
end

#auto_resize_dimensions ⇒ Google::Apis::SheetsV4::AutoResizeDimensionsRequest

Automatically resizes one or more dimensions based on the contents of the cells in that dimension. Corresponds to the JSON property autoResizeDimensions

Returns:



5248
5249
5250
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5248

def auto_resize_dimensions
  @auto_resize_dimensions
end

#clear_basic_filter ⇒ Google::Apis::SheetsV4::ClearBasicFilterRequest

Clears the basic filter, if any exists on the sheet. Corresponds to the JSON property clearBasicFilter

Returns:



5097
5098
5099
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5097

def clear_basic_filter
  @clear_basic_filter
end

#copy_paste ⇒ Google::Apis::SheetsV4::CopyPasteRequest

Copies data from the source to the destination. Corresponds to the JSON property copyPaste

Returns:



5300
5301
5302
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5300

def copy_paste
  @copy_paste
end

#cut_paste ⇒ Google::Apis::SheetsV4::CutPasteRequest

Moves data from the source to the destination. Corresponds to the JSON property cutPaste

Returns:



5263
5264
5265
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5263

def cut_paste
  @cut_paste
end

#delete_conditional_format_rule ⇒ Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest

Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented. Corresponds to the JSON property deleteConditionalFormatRule

Returns:



5201
5202
5203
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5201

def delete_conditional_format_rule
  @delete_conditional_format_rule
end

#delete_dimension ⇒ Google::Apis::SheetsV4::DeleteDimensionRequest

Deletes the dimensions from the sheet. Corresponds to the JSON property deleteDimension

Returns:



5213
5214
5215
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5213

def delete_dimension
  @delete_dimension
end

#delete_embedded_object ⇒ Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest

Deletes the embedded object with the given ID. Corresponds to the JSON property deleteEmbeddedObject

Returns:



5218
5219
5220
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5218

def delete_embedded_object
  @delete_embedded_object
end

#delete_filter_view ⇒ Google::Apis::SheetsV4::DeleteFilterViewRequest

Deletes a particular filter view. Corresponds to the JSON property deleteFilterView

Returns:



5092
5093
5094
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5092

def delete_filter_view
  @delete_filter_view
end

#delete_named_range ⇒ Google::Apis::SheetsV4::DeleteNamedRangeRequest

Removes the named range with the given ID from the spreadsheet. Corresponds to the JSON property deleteNamedRange

Returns:



5055
5056
5057
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5055

def delete_named_range
  @delete_named_range
end

#delete_protected_range ⇒ Google::Apis::SheetsV4::DeleteProtectedRangeRequest

Deletes the protected range with the given ID. Corresponds to the JSON property deleteProtectedRange

Returns:



5174
5175
5176
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5174

def delete_protected_range
  @delete_protected_range
end

#delete_sheet ⇒ Google::Apis::SheetsV4::DeleteSheetRequest

Deletes the requested sheet. Corresponds to the JSON property deleteSheet

Returns:



5159
5160
5161
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5159

def delete_sheet
  @delete_sheet
end

#duplicate_filter_view ⇒ Google::Apis::SheetsV4::DuplicateFilterViewRequest

Duplicates a particular filter view. Corresponds to the JSON property duplicateFilterView

Returns:



5258
5259
5260
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5258

def duplicate_filter_view
  @duplicate_filter_view
end

#duplicate_sheet ⇒ Google::Apis::SheetsV4::DuplicateSheetRequest

Duplicates the contents of a sheet. Corresponds to the JSON property duplicateSheet

Returns:



5253
5254
5255
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5253

def duplicate_sheet
  @duplicate_sheet
end

#find_replace ⇒ Google::Apis::SheetsV4::FindReplaceRequest

Finds and replaces data in cells over a range, sheet, or all sheets. Corresponds to the JSON property findReplace

Returns:



5164
5165
5166
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5164

def find_replace
  @find_replace
end

#insert_dimension ⇒ Google::Apis::SheetsV4::InsertDimensionRequest

Inserts rows or columns in a sheet at a particular index. Corresponds to the JSON property insertDimension

Returns:



5295
5296
5297
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5295

def insert_dimension
  @insert_dimension
end

#merge_cells ⇒ Google::Apis::SheetsV4::MergeCellsRequest

Merges all cells in the range. Corresponds to the JSON property mergeCells

Returns:



5190
5191
5192
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5190

def merge_cells
  @merge_cells
end

#move_dimension ⇒ Google::Apis::SheetsV4::MoveDimensionRequest

Moves one or more rows or columns. Corresponds to the JSON property moveDimension

Returns:



5284
5285
5286
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5284

def move_dimension
  @move_dimension
end

#paste_data ⇒ Google::Apis::SheetsV4::PasteDataRequest

Inserts data into the spreadsheet starting at the specified coordinate. Corresponds to the JSON property pasteData

Returns:



5223
5224
5225
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5223

def paste_data
  @paste_data
end

#repeat_cell ⇒ Google::Apis::SheetsV4::RepeatCellRequest

Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula =A1 into range B2:C4, B2 would be =A1, B3 would be =A2, B4 would be =A3, C2 would be =B1, C3 would be =B2, C4 would be =B3. To keep the formula's ranges static, use the $ indicator. For example, use the formula =$A$1 to prevent both the row and the column from incrementing. Corresponds to the JSON property repeatCell

Returns:



5117
5118
5119
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5117

def repeat_cell
  @repeat_cell
end

#set_basic_filter ⇒ Google::Apis::SheetsV4::SetBasicFilterRequest

Sets the basic filter associated with a sheet. Corresponds to the JSON property setBasicFilter

Returns:



5185
5186
5187
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5185

def set_basic_filter
  @set_basic_filter
end

#set_data_validation ⇒ Google::Apis::SheetsV4::SetDataValidationRequest

Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified. Corresponds to the JSON property setDataValidation

Returns:



5123
5124
5125
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5123

def set_data_validation
  @set_data_validation
end

#sort_range ⇒ Google::Apis::SheetsV4::SortRangeRequest

Sorts data in rows based on a sort order per column. Corresponds to the JSON property sortRange

Returns:



5102
5103
5104
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5102

def sort_range
  @sort_range
end

#text_to_columns ⇒ Google::Apis::SheetsV4::TextToColumnsRequest

Splits a column of text into multiple columns, based on a delimiter in each cell. Corresponds to the JSON property textToColumns

Returns:



5290
5291
5292
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5290

def text_to_columns
  @text_to_columns
end

#unmerge_cells ⇒ Google::Apis::SheetsV4::UnmergeCellsRequest

Unmerges cells in the given range. Corresponds to the JSON property unmergeCells

Returns:



5081
5082
5083
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5081

def unmerge_cells
  @unmerge_cells
end

#update_borders ⇒ Google::Apis::SheetsV4::UpdateBordersRequest

Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest:

  1. range: A1:A5 top: RED, bottom: WHITE
  2. range: A1:A5 left: BLUE That would result in A1:A5 having a borders of top: RED, bottom: WHITE, left: BLUE. If you want to clear a border, explicitly set the style to NONE. Corresponds to the JSON property updateBorders

Returns:



5242
5243
5244
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5242

def update_borders
  @update_borders
end

#update_cells ⇒ Google::Apis::SheetsV4::UpdateCellsRequest

Updates all cells in a range with new data. Corresponds to the JSON property updateCells

Returns:



5128
5129
5130
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5128

def update_cells
  @update_cells
end

#update_chart_spec ⇒ Google::Apis::SheetsV4::UpdateChartSpecRequest

Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.) Corresponds to the JSON property updateChartSpec

Returns:



5208
5209
5210
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5208

def update_chart_spec
  @update_chart_spec
end

#update_conditional_format_rule ⇒ Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest

Updates a conditional format rule at the given index, or moves a conditional format rule to another index. Corresponds to the JSON property updateConditionalFormatRule

Returns:



5180
5181
5182
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5180

def update_conditional_format_rule
  @update_conditional_format_rule
end

#update_dimension_properties ⇒ Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest

Updates properties of dimensions within the specified range. Corresponds to the JSON property updateDimensionProperties

Returns:



5154
5155
5156
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5154

def update_dimension_properties
  @update_dimension_properties
end

#update_embedded_object_position ⇒ Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest

Update an embedded object's position (such as a moving or resizing a chart or image). Corresponds to the JSON property updateEmbeddedObjectPosition

Returns:



5050
5051
5052
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5050

def update_embedded_object_position
  @update_embedded_object_position
end

#update_filter_view ⇒ Google::Apis::SheetsV4::UpdateFilterViewRequest

Updates properties of the filter view. Corresponds to the JSON property updateFilterView

Returns:



5143
5144
5145
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5143

def update_filter_view
  @update_filter_view
end

#update_named_range ⇒ Google::Apis::SheetsV4::UpdateNamedRangeRequest

Updates properties of the named range with the specified namedRangeId. Corresponds to the JSON property updateNamedRange

Returns:



5061
5062
5063
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5061

def update_named_range
  @update_named_range
end

#update_protected_range ⇒ Google::Apis::SheetsV4::UpdateProtectedRangeRequest

Updates an existing protected range with the specified protectedRangeId. Corresponds to the JSON property updateProtectedRange

Returns:



5087
5088
5089
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5087

def update_protected_range
  @update_protected_range
end

#update_sheet_properties ⇒ Google::Apis::SheetsV4::UpdateSheetPropertiesRequest

Updates properties of the sheet with the specified sheetId. Corresponds to the JSON property updateSheetProperties

Returns:



5149
5150
5151
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5149

def update_sheet_properties
  @update_sheet_properties
end

#update_spreadsheet_properties ⇒ Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest

Updates properties of a spreadsheet. Corresponds to the JSON property updateSpreadsheetProperties

Returns:



5071
5072
5073
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5071

def update_spreadsheet_properties
  @update_spreadsheet_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5307

def update!(**args)
  @update_embedded_object_position = args[:update_embedded_object_position] if args.key?(:update_embedded_object_position)
  @delete_named_range = args[:delete_named_range] if args.key?(:delete_named_range)
  @update_named_range = args[:update_named_range] if args.key?(:update_named_range)
  @add_filter_view = args[:add_filter_view] if args.key?(:add_filter_view)
  @update_spreadsheet_properties = args[:update_spreadsheet_properties] if args.key?(:update_spreadsheet_properties)
  @append_dimension = args[:append_dimension] if args.key?(:append_dimension)
  @unmerge_cells = args[:unmerge_cells] if args.key?(:unmerge_cells)
  @update_protected_range = args[:update_protected_range] if args.key?(:update_protected_range)
  @delete_filter_view = args[:delete_filter_view] if args.key?(:delete_filter_view)
  @clear_basic_filter = args[:clear_basic_filter] if args.key?(:clear_basic_filter)
  @sort_range = args[:sort_range] if args.key?(:sort_range)
  @repeat_cell = args[:repeat_cell] if args.key?(:repeat_cell)
  @set_data_validation = args[:set_data_validation] if args.key?(:set_data_validation)
  @update_cells = args[:update_cells] if args.key?(:update_cells)
  @add_sheet = args[:add_sheet] if args.key?(:add_sheet)
  @update_filter_view = args[:update_filter_view] if args.key?(:update_filter_view)
  @update_sheet_properties = args[:update_sheet_properties] if args.key?(:update_sheet_properties)
  @update_dimension_properties = args[:update_dimension_properties] if args.key?(:update_dimension_properties)
  @delete_sheet = args[:delete_sheet] if args.key?(:delete_sheet)
  @find_replace = args[:find_replace] if args.key?(:find_replace)
  @add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range)
  @delete_protected_range = args[:delete_protected_range] if args.key?(:delete_protected_range)
  @update_conditional_format_rule = args[:update_conditional_format_rule] if args.key?(:update_conditional_format_rule)
  @set_basic_filter = args[:set_basic_filter] if args.key?(:set_basic_filter)
  @merge_cells = args[:merge_cells] if args.key?(:merge_cells)
  @add_chart = args[:add_chart] if args.key?(:add_chart)
  @delete_conditional_format_rule = args[:delete_conditional_format_rule] if args.key?(:delete_conditional_format_rule)
  @update_chart_spec = args[:update_chart_spec] if args.key?(:update_chart_spec)
  @delete_dimension = args[:delete_dimension] if args.key?(:delete_dimension)
  @delete_embedded_object = args[:delete_embedded_object] if args.key?(:delete_embedded_object)
  @paste_data = args[:paste_data] if args.key?(:paste_data)
  @add_conditional_format_rule = args[:add_conditional_format_rule] if args.key?(:add_conditional_format_rule)
  @update_borders = args[:update_borders] if args.key?(:update_borders)
  @auto_resize_dimensions = args[:auto_resize_dimensions] if args.key?(:auto_resize_dimensions)
  @duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet)
  @duplicate_filter_view = args[:duplicate_filter_view] if args.key?(:duplicate_filter_view)
  @cut_paste = args[:cut_paste] if args.key?(:cut_paste)
  @append_cells = args[:append_cells] if args.key?(:append_cells)
  @add_named_range = args[:add_named_range] if args.key?(:add_named_range)
  @auto_fill = args[:auto_fill] if args.key?(:auto_fill)
  @move_dimension = args[:move_dimension] if args.key?(:move_dimension)
  @text_to_columns = args[:text_to_columns] if args.key?(:text_to_columns)
  @insert_dimension = args[:insert_dimension] if args.key?(:insert_dimension)
  @copy_paste = args[:copy_paste] if args.key?(:copy_paste)
end