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



1835
1836
1837
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1835

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:



1644
1645
1646
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1644

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:



1708
1709
1710
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1708

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:



1614
1615
1616
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1614

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:



1772
1773
1774
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1772

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:



1619
1620
1621
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1619

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:



1567
1568
1569
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1567

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:



1736
1737
1738
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1736

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:



1656
1657
1658
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1656

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:



1822
1823
1824
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1822

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:



1688
1689
1690
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1688

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:



1650
1651
1652
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1650

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:



1802
1803
1804
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1802

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:



1752
1753
1754
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1752

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:



1661
1662
1663
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1661

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:



1767
1768
1769
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1767

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:



1797
1798
1799
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1797

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:



1683
1684
1685
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1683

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:



1634
1635
1636
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1634

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:



1747
1748
1749
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1747

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:



1572
1573
1574
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1572

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:



1698
1699
1700
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1698

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:



1762
1763
1764
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1762

def delete_range
  @delete_range
end

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

Deletes the requested sheet. Corresponds to the JSON property deleteSheet

Returns:



1587
1588
1589
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1587

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:



1703
1704
1705
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1703

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:



1577
1578
1579
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1577

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:



1713
1714
1715
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1713

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:



1757
1758
1759
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1757

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:



1833
1834
1835
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1833

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:



1666
1667
1668
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1666

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:



1557
1558
1559
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1557

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:



1603
1604
1605
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1603

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:



1817
1818
1819
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1817

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:



1608
1609
1610
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1608

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:



1778
1779
1780
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1778

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:



1693
1694
1695
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1693

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:



1719
1720
1721
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1719

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:



1582
1583
1584
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1582

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:



1562
1563
1564
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1562

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:



1791
1792
1793
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1791

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:



1624
1625
1626
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1624

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:



1726
1727
1728
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1726

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:



1828
1829
1830
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1828

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:



1598
1599
1600
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1598

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:



1593
1594
1595
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1593

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:



1639
1640
1641
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1639

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:



1672
1673
1674
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1672

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:



1742
1743
1744
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1742

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:



1678
1679
1680
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1678

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:



1629
1630
1631
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1629

def update_spreadsheet_properties
  @update_spreadsheet_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1840

def update!(**args)
  @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)
  @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)
  @add_named_range = args[:add_named_range] if args.key?(:add_named_range)
  @update_cells = args[:update_cells] if args.key?(:update_cells)
  @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)
  @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)
  @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)
  @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)
  @clear_basic_filter = args[:clear_basic_filter] if args.key?(:clear_basic_filter)
  @repeat_cell = args[:repeat_cell] if args.key?(:repeat_cell)
  @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)
end