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



6562
6563
6564
# File 'generated/google/apis/sheets_v4/classes.rb', line 6562

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

Instance Attribute Details

#add_bandingGoogle::Apis::SheetsV4::AddBandingRequest

Adds a new banded range to the spreadsheet. Corresponds to the JSON property addBanding



6259
6260
6261
# File 'generated/google/apis/sheets_v4/classes.rb', line 6259

def add_banding
  @add_banding
end

#add_chartGoogle::Apis::SheetsV4::AddChartRequest

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



6264
6265
6266
# File 'generated/google/apis/sheets_v4/classes.rb', line 6264

def add_chart
  @add_chart
end

#add_conditional_format_ruleGoogle::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



6270
6271
6272
# File 'generated/google/apis/sheets_v4/classes.rb', line 6270

def add_conditional_format_rule
  @add_conditional_format_rule
end

#add_filter_viewGoogle::Apis::SheetsV4::AddFilterViewRequest

Adds a filter view. Corresponds to the JSON property addFilterView



6275
6276
6277
# File 'generated/google/apis/sheets_v4/classes.rb', line 6275

def add_filter_view
  @add_filter_view
end

#add_named_rangeGoogle::Apis::SheetsV4::AddNamedRangeRequest

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



6280
6281
6282
# File 'generated/google/apis/sheets_v4/classes.rb', line 6280

def add_named_range
  @add_named_range
end

#add_protected_rangeGoogle::Apis::SheetsV4::AddProtectedRangeRequest

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



6285
6286
6287
# File 'generated/google/apis/sheets_v4/classes.rb', line 6285

def add_protected_range
  @add_protected_range
end

#add_sheetGoogle::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



6295
6296
6297
# File 'generated/google/apis/sheets_v4/classes.rb', line 6295

def add_sheet
  @add_sheet
end

#append_cellsGoogle::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



6301
6302
6303
# File 'generated/google/apis/sheets_v4/classes.rb', line 6301

def append_cells
  @append_cells
end

#append_dimensionGoogle::Apis::SheetsV4::AppendDimensionRequest

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



6306
6307
6308
# File 'generated/google/apis/sheets_v4/classes.rb', line 6306

def append_dimension
  @append_dimension
end

#auto_fillGoogle::Apis::SheetsV4::AutoFillRequest

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



6311
6312
6313
# File 'generated/google/apis/sheets_v4/classes.rb', line 6311

def auto_fill
  @auto_fill
end

#auto_resize_dimensionsGoogle::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



6317
6318
6319
# File 'generated/google/apis/sheets_v4/classes.rb', line 6317

def auto_resize_dimensions
  @auto_resize_dimensions
end

#clear_basic_filterGoogle::Apis::SheetsV4::ClearBasicFilterRequest

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



6322
6323
6324
# File 'generated/google/apis/sheets_v4/classes.rb', line 6322

def clear_basic_filter
  @clear_basic_filter
end

#copy_pasteGoogle::Apis::SheetsV4::CopyPasteRequest

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



6327
6328
6329
# File 'generated/google/apis/sheets_v4/classes.rb', line 6327

def copy_paste
  @copy_paste
end

#create_developer_metadataGoogle::Apis::SheetsV4::CreateDeveloperMetadataRequest

A request to create developer metadata. Corresponds to the JSON property createDeveloperMetadata



6332
6333
6334
# File 'generated/google/apis/sheets_v4/classes.rb', line 6332

def 
  @create_developer_metadata
end

#cut_pasteGoogle::Apis::SheetsV4::CutPasteRequest

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



6337
6338
6339
# File 'generated/google/apis/sheets_v4/classes.rb', line 6337

def cut_paste
  @cut_paste
end

#delete_bandingGoogle::Apis::SheetsV4::DeleteBandingRequest

Removes the banded range with the given ID from the spreadsheet. Corresponds to the JSON property deleteBanding



6342
6343
6344
# File 'generated/google/apis/sheets_v4/classes.rb', line 6342

def delete_banding
  @delete_banding
end

#delete_conditional_format_ruleGoogle::Apis::SheetsV4::DeleteConditionalFormatRuleRequest

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



6348
6349
6350
# File 'generated/google/apis/sheets_v4/classes.rb', line 6348

def delete_conditional_format_rule
  @delete_conditional_format_rule
end

#delete_developer_metadataGoogle::Apis::SheetsV4::DeleteDeveloperMetadataRequest

A request to delete developer metadata. Corresponds to the JSON property deleteDeveloperMetadata



6353
6354
6355
# File 'generated/google/apis/sheets_v4/classes.rb', line 6353

def 
  @delete_developer_metadata
end

#delete_dimensionGoogle::Apis::SheetsV4::DeleteDimensionRequest

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



6358
6359
6360
# File 'generated/google/apis/sheets_v4/classes.rb', line 6358

def delete_dimension
  @delete_dimension
end

#delete_embedded_objectGoogle::Apis::SheetsV4::DeleteEmbeddedObjectRequest

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



6363
6364
6365
# File 'generated/google/apis/sheets_v4/classes.rb', line 6363

def delete_embedded_object
  @delete_embedded_object
end

#delete_filter_viewGoogle::Apis::SheetsV4::DeleteFilterViewRequest

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



6368
6369
6370
# File 'generated/google/apis/sheets_v4/classes.rb', line 6368

def delete_filter_view
  @delete_filter_view
end

#delete_named_rangeGoogle::Apis::SheetsV4::DeleteNamedRangeRequest

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



6373
6374
6375
# File 'generated/google/apis/sheets_v4/classes.rb', line 6373

def delete_named_range
  @delete_named_range
end

#delete_protected_rangeGoogle::Apis::SheetsV4::DeleteProtectedRangeRequest

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



6378
6379
6380
# File 'generated/google/apis/sheets_v4/classes.rb', line 6378

def delete_protected_range
  @delete_protected_range
end

#delete_rangeGoogle::Apis::SheetsV4::DeleteRangeRequest

Deletes a range of cells, shifting other cells into the deleted area. Corresponds to the JSON property deleteRange



6383
6384
6385
# File 'generated/google/apis/sheets_v4/classes.rb', line 6383

def delete_range
  @delete_range
end

#delete_sheetGoogle::Apis::SheetsV4::DeleteSheetRequest

Deletes the requested sheet. Corresponds to the JSON property deleteSheet



6388
6389
6390
# File 'generated/google/apis/sheets_v4/classes.rb', line 6388

def delete_sheet
  @delete_sheet
end

#duplicate_filter_viewGoogle::Apis::SheetsV4::DuplicateFilterViewRequest

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



6393
6394
6395
# File 'generated/google/apis/sheets_v4/classes.rb', line 6393

def duplicate_filter_view
  @duplicate_filter_view
end

#duplicate_sheetGoogle::Apis::SheetsV4::DuplicateSheetRequest

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



6398
6399
6400
# File 'generated/google/apis/sheets_v4/classes.rb', line 6398

def duplicate_sheet
  @duplicate_sheet
end

#find_replaceGoogle::Apis::SheetsV4::FindReplaceRequest

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



6403
6404
6405
# File 'generated/google/apis/sheets_v4/classes.rb', line 6403

def find_replace
  @find_replace
end

#insert_dimensionGoogle::Apis::SheetsV4::InsertDimensionRequest

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



6408
6409
6410
# File 'generated/google/apis/sheets_v4/classes.rb', line 6408

def insert_dimension
  @insert_dimension
end

#insert_rangeGoogle::Apis::SheetsV4::InsertRangeRequest

Inserts cells into a range, shifting the existing cells over or down. Corresponds to the JSON property insertRange



6413
6414
6415
# File 'generated/google/apis/sheets_v4/classes.rb', line 6413

def insert_range
  @insert_range
end

#merge_cellsGoogle::Apis::SheetsV4::MergeCellsRequest

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



6418
6419
6420
# File 'generated/google/apis/sheets_v4/classes.rb', line 6418

def merge_cells
  @merge_cells
end

#move_dimensionGoogle::Apis::SheetsV4::MoveDimensionRequest

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



6423
6424
6425
# File 'generated/google/apis/sheets_v4/classes.rb', line 6423

def move_dimension
  @move_dimension
end

#paste_dataGoogle::Apis::SheetsV4::PasteDataRequest

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



6428
6429
6430
# File 'generated/google/apis/sheets_v4/classes.rb', line 6428

def paste_data
  @paste_data
end

#randomize_rangeGoogle::Apis::SheetsV4::RandomizeRangeRequest

Randomizes the order of the rows in a range. Corresponds to the JSON property randomizeRange



6433
6434
6435
# File 'generated/google/apis/sheets_v4/classes.rb', line 6433

def randomize_range
  @randomize_range
end

#repeat_cellGoogle::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



6448
6449
6450
# File 'generated/google/apis/sheets_v4/classes.rb', line 6448

def repeat_cell
  @repeat_cell
end

#set_basic_filterGoogle::Apis::SheetsV4::SetBasicFilterRequest

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



6453
6454
6455
# File 'generated/google/apis/sheets_v4/classes.rb', line 6453

def set_basic_filter
  @set_basic_filter
end

#set_data_validationGoogle::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



6459
6460
6461
# File 'generated/google/apis/sheets_v4/classes.rb', line 6459

def set_data_validation
  @set_data_validation
end

#sort_rangeGoogle::Apis::SheetsV4::SortRangeRequest

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



6464
6465
6466
# File 'generated/google/apis/sheets_v4/classes.rb', line 6464

def sort_range
  @sort_range
end

#text_to_columnsGoogle::Apis::SheetsV4::TextToColumnsRequest

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



6470
6471
6472
# File 'generated/google/apis/sheets_v4/classes.rb', line 6470

def text_to_columns
  @text_to_columns
end

#unmerge_cellsGoogle::Apis::SheetsV4::UnmergeCellsRequest

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



6475
6476
6477
# File 'generated/google/apis/sheets_v4/classes.rb', line 6475

def unmerge_cells
  @unmerge_cells
end

#update_bandingGoogle::Apis::SheetsV4::UpdateBandingRequest

Updates properties of the supplied banded range. Corresponds to the JSON property updateBanding



6480
6481
6482
# File 'generated/google/apis/sheets_v4/classes.rb', line 6480

def update_banding
  @update_banding
end

#update_bordersGoogle::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


6493
6494
6495
# File 'generated/google/apis/sheets_v4/classes.rb', line 6493

def update_borders
  @update_borders
end

#update_cellsGoogle::Apis::SheetsV4::UpdateCellsRequest

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



6498
6499
6500
# File 'generated/google/apis/sheets_v4/classes.rb', line 6498

def update_cells
  @update_cells
end

#update_chart_specGoogle::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



6505
6506
6507
# File 'generated/google/apis/sheets_v4/classes.rb', line 6505

def update_chart_spec
  @update_chart_spec
end

#update_conditional_format_ruleGoogle::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



6511
6512
6513
# File 'generated/google/apis/sheets_v4/classes.rb', line 6511

def update_conditional_format_rule
  @update_conditional_format_rule
end

#update_developer_metadataGoogle::Apis::SheetsV4::UpdateDeveloperMetadataRequest

A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update. Corresponds to the JSON property updateDeveloperMetadata



6521
6522
6523
# File 'generated/google/apis/sheets_v4/classes.rb', line 6521

def 
  @update_developer_metadata
end

#update_dimension_propertiesGoogle::Apis::SheetsV4::UpdateDimensionPropertiesRequest

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



6526
6527
6528
# File 'generated/google/apis/sheets_v4/classes.rb', line 6526

def update_dimension_properties
  @update_dimension_properties
end

#update_embedded_object_positionGoogle::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



6532
6533
6534
# File 'generated/google/apis/sheets_v4/classes.rb', line 6532

def update_embedded_object_position
  @update_embedded_object_position
end

#update_filter_viewGoogle::Apis::SheetsV4::UpdateFilterViewRequest

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



6537
6538
6539
# File 'generated/google/apis/sheets_v4/classes.rb', line 6537

def update_filter_view
  @update_filter_view
end

#update_named_rangeGoogle::Apis::SheetsV4::UpdateNamedRangeRequest

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



6543
6544
6545
# File 'generated/google/apis/sheets_v4/classes.rb', line 6543

def update_named_range
  @update_named_range
end

#update_protected_rangeGoogle::Apis::SheetsV4::UpdateProtectedRangeRequest

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



6549
6550
6551
# File 'generated/google/apis/sheets_v4/classes.rb', line 6549

def update_protected_range
  @update_protected_range
end

#update_sheet_propertiesGoogle::Apis::SheetsV4::UpdateSheetPropertiesRequest

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



6555
6556
6557
# File 'generated/google/apis/sheets_v4/classes.rb', line 6555

def update_sheet_properties
  @update_sheet_properties
end

#update_spreadsheet_propertiesGoogle::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest

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



6560
6561
6562
# File 'generated/google/apis/sheets_v4/classes.rb', line 6560

def update_spreadsheet_properties
  @update_spreadsheet_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
# File 'generated/google/apis/sheets_v4/classes.rb', line 6567

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