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



6099
6100
6101
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6099

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

Instance Attribute Details

#add_banding ⇒ Google::Apis::SheetsV4::AddBandingRequest

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

Returns:



6028
6029
6030
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6028

def add_banding
  @add_banding
end

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

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

Returns:



6092
6093
6094
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6092

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:



5998
5999
6000
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5998

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:



5875
5876
5877
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5875

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:



6008
6009
6010
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6008

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:



5956
5957
5958
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5956

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:



5839
5840
5841
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5839

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:



6040
6041
6042
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6040

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:



5925
5926
5927
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5925

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:



6072
6073
6074
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6072

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:



6034
6035
6036
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6034

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:



5920
5921
5922
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5920

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:



5855
5856
5857
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5855

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:



6045
6046
6047
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6045

def cut_paste
  @cut_paste
end

#delete_banding ⇒ Google::Apis::SheetsV4::DeleteBandingRequest

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

Returns:



5870
5871
5872
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5870

def delete_banding
  @delete_banding
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:



5900
5901
5902
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5900

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:



6067
6068
6069
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6067

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:



6018
6019
6020
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6018

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:



5850
5851
5852
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5850

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:



5951
5952
5953
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5951

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:



6082
6083
6084
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6082

def delete_protected_range
  @delete_protected_range
end

#delete_range ⇒ Google::Apis::SheetsV4::DeleteRangeRequest

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

Returns:



5865
5866
5867
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5865

def delete_range
  @delete_range
end

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

Deletes the requested sheet. Corresponds to the JSON property deleteSheet

Returns:



5971
5972
5973
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5971

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:



6087
6088
6089
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6087

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:



5961
5962
5963
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5961

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:



6097
6098
6099
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6097

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:



5860
5861
5862
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5860

def insert_dimension
  @insert_dimension
end

#insert_range ⇒ Google::Apis::SheetsV4::InsertRangeRequest

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

Returns:



5936
5937
5938
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5936

def insert_range
  @insert_range
end

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

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

Returns:



6050
6051
6052
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6050

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:



5941
5942
5943
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5941

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:



5987
5988
5989
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5987

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:



5915
5916
5917
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5915

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:



5992
5993
5994
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5992

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:



5894
5895
5896
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5894

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:



6077
6078
6079
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6077

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:



5829
5830
5831
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5829

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:



5966
5967
5968
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5966

def unmerge_cells
  @unmerge_cells
end

#update_banding ⇒ Google::Apis::SheetsV4::UpdateBandingRequest

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

Returns:



5946
5947
5948
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5946

def update_banding
  @update_banding
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:



5888
5889
5890
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5888

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:



6003
6004
6005
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6003

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:



5823
5824
5825
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5823

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:



5931
5932
5933
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5931

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:



5982
5983
5984
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5982

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:



5977
5978
5979
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5977

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:



6023
6024
6025
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6023

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:



6056
6057
6058
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6056

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:



5845
5846
5847
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5845

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:



6062
6063
6064
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6062

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:



6013
6014
6015
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6013

def update_spreadsheet_properties
  @update_spreadsheet_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6104

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