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



4006
4007
4008
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4006

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:



3738
3739
3740
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3738

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:



3802
3803
3804
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3802

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:



3989
3990
3991
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3989

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:



3866
3867
3868
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3866

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:



3999
4000
4001
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3999

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:



3942
3943
3944
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3942

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:



3836
3837
3838
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3836

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:



3744
3745
3746
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3744

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:



3916
3917
3918
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3916

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:



3782
3783
3784
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3782

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:



3750
3751
3752
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3750

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:



3911
3912
3913
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3911

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:



3846
3847
3848
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3846

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:



3755
3756
3757
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3755

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:



3861
3862
3863
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3861

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:



3891
3892
3893
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3891

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:



3777
3778
3779
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3777

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:



3728
3729
3730
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3728

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:



3841
3842
3843
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3841

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:



3947
3948
3949
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3947

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:



3792
3793
3794
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3792

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:



3856
3857
3858
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3856

def delete_range
  @delete_range
end

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

Deletes the requested sheet. Corresponds to the JSON property deleteSheet

Returns:



3957
3958
3959
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3957

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:



3797
3798
3799
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3797

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:



3952
3953
3954
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3952

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:



3807
3808
3809
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3807

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:



3851
3852
3853
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3851

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:



3927
3928
3929
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3927

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:



3760
3761
3762
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3760

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:



3932
3933
3934
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3932

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:



3978
3979
3980
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3978

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:



3906
3907
3908
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3906

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:



3983
3984
3985
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3983

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:



3872
3873
3874
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3872

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:



3787
3788
3789
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3787

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:



3813
3814
3815
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3813

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:



3962
3963
3964
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3962

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:



3937
3938
3939
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3937

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:



3885
3886
3887
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3885

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:



3994
3995
3996
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3994

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:



3820
3821
3822
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3820

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:



3922
3923
3924
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3922

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:



3973
3974
3975
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3973

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:



3968
3969
3970
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3968

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:



3733
3734
3735
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3733

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:



3766
3767
3768
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3766

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:



3826
3827
3828
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3826

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:



3772
3773
3774
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3772

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:



4004
4005
4006
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4004

def update_spreadsheet_properties
  @update_spreadsheet_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4011

def update!(**args)
  @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)
  @append_cells = args[:append_cells] if args.key?(:append_cells)
  @auto_resize_dimensions = args[:auto_resize_dimensions] if args.key?(:auto_resize_dimensions)
  @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)
  @text_to_columns = args[:text_to_columns] if args.key?(:text_to_columns)
  @update_chart_spec = args[:update_chart_spec] if args.key?(:update_chart_spec)
  @update_protected_range = args[:update_protected_range] if args.key?(:update_protected_range)
  @add_sheet = args[:add_sheet] if args.key?(:add_sheet)
  @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)
  @set_data_validation = args[:set_data_validation] if args.key?(:set_data_validation)
  @update_borders = args[:update_borders] if args.key?(:update_borders)
  @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)
  @add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range)
  @delete_named_range = args[:delete_named_range] if args.key?(:delete_named_range)
  @duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet)
  @delete_sheet = args[:delete_sheet] if args.key?(:delete_sheet)
  @unmerge_cells = args[:unmerge_cells] if args.key?(:unmerge_cells)
  @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)
end