Class: Google::Apis::SheetsV4::Request
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::Request
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb
Overview
A single kind of update to apply to a spreadsheet.
Instance Attribute Summary collapse
-
#add_banding ⇒ Google::Apis::SheetsV4::AddBandingRequest
Adds a new banded range to the spreadsheet.
-
#add_chart ⇒ Google::Apis::SheetsV4::AddChartRequest
Adds a chart to a sheet in the spreadsheet.
-
#add_conditional_format_rule ⇒ Google::Apis::SheetsV4::AddConditionalFormatRuleRequest
Adds a new conditional format rule at the given index.
-
#add_data_source ⇒ Google::Apis::SheetsV4::AddDataSourceRequest
Adds a data source.
-
#add_dimension_group ⇒ Google::Apis::SheetsV4::AddDimensionGroupRequest
Creates a group over the specified range.
-
#add_filter_view ⇒ Google::Apis::SheetsV4::AddFilterViewRequest
Adds a filter view.
-
#add_named_range ⇒ Google::Apis::SheetsV4::AddNamedRangeRequest
Adds a named range to the spreadsheet.
-
#add_protected_range ⇒ Google::Apis::SheetsV4::AddProtectedRangeRequest
Adds a new protected range.
-
#add_sheet ⇒ Google::Apis::SheetsV4::AddSheetRequest
Adds a new sheet.
-
#add_slicer ⇒ Google::Apis::SheetsV4::AddSlicerRequest
Adds a slicer to a sheet in the spreadsheet.
-
#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.
-
#append_dimension ⇒ Google::Apis::SheetsV4::AppendDimensionRequest
Appends rows or columns to the end of a sheet.
-
#auto_fill ⇒ Google::Apis::SheetsV4::AutoFillRequest
Fills in more data based on existing data.
-
#auto_resize_dimensions ⇒ Google::Apis::SheetsV4::AutoResizeDimensionsRequest
Automatically resizes one or more dimensions based on the contents of the cells in that dimension.
-
#clear_basic_filter ⇒ Google::Apis::SheetsV4::ClearBasicFilterRequest
Clears the basic filter, if any exists on the sheet.
-
#copy_paste ⇒ Google::Apis::SheetsV4::CopyPasteRequest
Copies data from the source to the destination.
-
#create_developer_metadata ⇒ Google::Apis::SheetsV4::CreateDeveloperMetadataRequest
A request to create developer metadata.
-
#cut_paste ⇒ Google::Apis::SheetsV4::CutPasteRequest
Moves data from the source to the destination.
-
#delete_banding ⇒ Google::Apis::SheetsV4::DeleteBandingRequest
Removes the banded range with the given ID from the spreadsheet.
-
#delete_conditional_format_rule ⇒ Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest
Deletes a conditional format rule at the given index.
-
#delete_data_source ⇒ Google::Apis::SheetsV4::DeleteDataSourceRequest
Deletes a data source.
-
#delete_developer_metadata ⇒ Google::Apis::SheetsV4::DeleteDeveloperMetadataRequest
A request to delete developer metadata.
-
#delete_dimension ⇒ Google::Apis::SheetsV4::DeleteDimensionRequest
Deletes the dimensions from the sheet.
-
#delete_dimension_group ⇒ Google::Apis::SheetsV4::DeleteDimensionGroupRequest
Deletes a group over the specified range by decrementing the depth of the dimensions in the range.
-
#delete_duplicates ⇒ Google::Apis::SheetsV4::DeleteDuplicatesRequest
Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row.
-
#delete_embedded_object ⇒ Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest
Deletes the embedded object with the given ID.
-
#delete_filter_view ⇒ Google::Apis::SheetsV4::DeleteFilterViewRequest
Deletes a particular filter view.
-
#delete_named_range ⇒ Google::Apis::SheetsV4::DeleteNamedRangeRequest
Removes the named range with the given ID from the spreadsheet.
-
#delete_protected_range ⇒ Google::Apis::SheetsV4::DeleteProtectedRangeRequest
Deletes the protected range with the given ID.
-
#delete_range ⇒ Google::Apis::SheetsV4::DeleteRangeRequest
Deletes a range of cells, shifting other cells into the deleted area.
-
#delete_sheet ⇒ Google::Apis::SheetsV4::DeleteSheetRequest
Deletes the requested sheet.
-
#duplicate_filter_view ⇒ Google::Apis::SheetsV4::DuplicateFilterViewRequest
Duplicates a particular filter view.
-
#duplicate_sheet ⇒ Google::Apis::SheetsV4::DuplicateSheetRequest
Duplicates the contents of a sheet.
-
#find_replace ⇒ Google::Apis::SheetsV4::FindReplaceRequest
Finds and replaces data in cells over a range, sheet, or all sheets.
-
#insert_dimension ⇒ Google::Apis::SheetsV4::InsertDimensionRequest
Inserts rows or columns in a sheet at a particular index.
-
#insert_range ⇒ Google::Apis::SheetsV4::InsertRangeRequest
Inserts cells into a range, shifting the existing cells over or down.
-
#merge_cells ⇒ Google::Apis::SheetsV4::MergeCellsRequest
Merges all cells in the range.
-
#move_dimension ⇒ Google::Apis::SheetsV4::MoveDimensionRequest
Moves one or more rows or columns.
-
#paste_data ⇒ Google::Apis::SheetsV4::PasteDataRequest
Inserts data into the spreadsheet starting at the specified coordinate.
-
#randomize_range ⇒ Google::Apis::SheetsV4::RandomizeRangeRequest
Randomizes the order of the rows in a range.
-
#refresh_data_source ⇒ Google::Apis::SheetsV4::RefreshDataSourceRequest
Refreshes one or multiple data source objects in the spreadsheet by the specified references.
-
#repeat_cell ⇒ Google::Apis::SheetsV4::RepeatCellRequest
Updates all cells in the range to the values in the given Cell object.
-
#set_basic_filter ⇒ Google::Apis::SheetsV4::SetBasicFilterRequest
Sets the basic filter associated with a sheet.
-
#set_data_validation ⇒ Google::Apis::SheetsV4::SetDataValidationRequest
Sets a data validation rule to every cell in the range.
-
#sort_range ⇒ Google::Apis::SheetsV4::SortRangeRequest
Sorts data in rows based on a sort order per column.
-
#text_to_columns ⇒ Google::Apis::SheetsV4::TextToColumnsRequest
Splits a column of text into multiple columns, based on a delimiter in each cell.
-
#trim_whitespace ⇒ Google::Apis::SheetsV4::TrimWhitespaceRequest
Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range.
-
#unmerge_cells ⇒ Google::Apis::SheetsV4::UnmergeCellsRequest
Unmerges cells in the given range.
-
#update_banding ⇒ Google::Apis::SheetsV4::UpdateBandingRequest
Updates properties of the supplied banded range.
-
#update_borders ⇒ Google::Apis::SheetsV4::UpdateBordersRequest
Updates the borders of a range.
-
#update_cells ⇒ Google::Apis::SheetsV4::UpdateCellsRequest
Updates all cells in a range with new data.
-
#update_chart_spec ⇒ Google::Apis::SheetsV4::UpdateChartSpecRequest
Updates a chart's specifications.
-
#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.
-
#update_data_source ⇒ Google::Apis::SheetsV4::UpdateDataSourceRequest
Updates a data source.
-
#update_developer_metadata ⇒ Google::Apis::SheetsV4::UpdateDeveloperMetadataRequest
A request to update properties of developer metadata.
-
#update_dimension_group ⇒ Google::Apis::SheetsV4::UpdateDimensionGroupRequest
Updates the state of the specified group.
-
#update_dimension_properties ⇒ Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest
Updates properties of dimensions within the specified range.
-
#update_embedded_object_border ⇒ Google::Apis::SheetsV4::UpdateEmbeddedObjectBorderRequest
Updates an embedded object's border property.
-
#update_embedded_object_position ⇒ Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest
Update an embedded object's position (such as a moving or resizing a chart or image).
-
#update_filter_view ⇒ Google::Apis::SheetsV4::UpdateFilterViewRequest
Updates properties of the filter view.
-
#update_named_range ⇒ Google::Apis::SheetsV4::UpdateNamedRangeRequest
Updates properties of the named range with the specified namedRangeId.
-
#update_protected_range ⇒ Google::Apis::SheetsV4::UpdateProtectedRangeRequest
Updates an existing protected range with the specified protectedRangeId.
-
#update_sheet_properties ⇒ Google::Apis::SheetsV4::UpdateSheetPropertiesRequest
Updates properties of the sheet with the specified sheetId.
-
#update_slicer_spec ⇒ Google::Apis::SheetsV4::UpdateSlicerSpecRequest
Updates a slicer's specifications.
-
#update_spreadsheet_properties ⇒ Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest
Updates properties of a spreadsheet.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Request
constructor
A new instance of Request.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Request
Returns a new instance of Request.
8264 8265 8266 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8264 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
7875 7876 7877 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7875 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
7880 7881 7882 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7880 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
7886 7887 7888 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7886 def add_conditional_format_rule @add_conditional_format_rule end |
#add_data_source ⇒ Google::Apis::SheetsV4::AddDataSourceRequest
Adds a data source. After the data source is added successfully, an associated
DATA_SOURCE sheet is created and an execution is triggered to refresh the
sheet to read data from the data source. The request requires an additional
bigquery.readonly
OAuth scope.
Corresponds to the JSON property addDataSource
7894 7895 7896 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7894 def add_data_source @add_data_source end |
#add_dimension_group ⇒ Google::Apis::SheetsV4::AddDimensionGroupRequest
Creates a group over the specified range. If the requested range is a superset
of the range of an existing group G, then the depth of G is incremented and
this new group G' has the depth of that group. For example, a group [C:D,
depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the
requested range is a subset of the range of an existing group G, then the
depth of the new group G' becomes one greater than the depth of G. For example,
a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D,
depth 2]. If the requested range starts before and ends within, or starts
within and ends after, the range of an existing group G, then the range of the
existing group G becomes the union of the ranges, and the new group G' has
depth one greater than the depth of G and range as the intersection of the
ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E,
depth 1] and [C:D, depth 2].
Corresponds to the JSON property addDimensionGroup
7911 7912 7913 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7911 def add_dimension_group @add_dimension_group end |
#add_filter_view ⇒ Google::Apis::SheetsV4::AddFilterViewRequest
Adds a filter view.
Corresponds to the JSON property addFilterView
7916 7917 7918 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7916 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
7921 7922 7923 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7921 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
7926 7927 7928 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7926 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
7934 7935 7936 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7934 def add_sheet @add_sheet end |
#add_slicer ⇒ Google::Apis::SheetsV4::AddSlicerRequest
Adds a slicer to a sheet in the spreadsheet.
Corresponds to the JSON property addSlicer
7939 7940 7941 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7939 def add_slicer @add_slicer 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
7945 7946 7947 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7945 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
7950 7951 7952 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7950 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
7955 7956 7957 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7955 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
7961 7962 7963 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7961 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
7966 7967 7968 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7966 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
7971 7972 7973 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7971 def copy_paste @copy_paste end |
#create_developer_metadata ⇒ Google::Apis::SheetsV4::CreateDeveloperMetadataRequest
A request to create developer metadata.
Corresponds to the JSON property createDeveloperMetadata
7976 7977 7978 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7976 def @create_developer_metadata end |
#cut_paste ⇒ Google::Apis::SheetsV4::CutPasteRequest
Moves data from the source to the destination.
Corresponds to the JSON property cutPaste
7981 7982 7983 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7981 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
7986 7987 7988 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7986 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
7992 7993 7994 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7992 def delete_conditional_format_rule @delete_conditional_format_rule end |
#delete_data_source ⇒ Google::Apis::SheetsV4::DeleteDataSourceRequest
Deletes a data source. The request also deletes the associated data source
sheet, and unlinks all associated data source objects.
Corresponds to the JSON property deleteDataSource
7998 7999 8000 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 7998 def delete_data_source @delete_data_source end |
#delete_developer_metadata ⇒ Google::Apis::SheetsV4::DeleteDeveloperMetadataRequest
A request to delete developer metadata.
Corresponds to the JSON property deleteDeveloperMetadata
8003 8004 8005 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8003 def @delete_developer_metadata end |
#delete_dimension ⇒ Google::Apis::SheetsV4::DeleteDimensionRequest
Deletes the dimensions from the sheet.
Corresponds to the JSON property deleteDimension
8008 8009 8010 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8008 def delete_dimension @delete_dimension end |
#delete_dimension_group ⇒ Google::Apis::SheetsV4::DeleteDimensionGroupRequest
Deletes a group over the specified range by decrementing the depth of the
dimensions in the range. For example, assume the sheet has a depth-1 group
over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the
sheet with a depth-1 group over B:D and a depth-2 group over C:C.
Corresponds to the JSON property deleteDimensionGroup
8016 8017 8018 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8016 def delete_dimension_group @delete_dimension_group end |
#delete_duplicates ⇒ Google::Apis::SheetsV4::DeleteDuplicatesRequest
Removes rows within this range that contain values in the specified columns
that are duplicates of values in any previous row. Rows with identical values
but different letter cases, formatting, or formulas are considered to be
duplicates. This request also removes duplicate rows hidden from view (for
example, due to a filter). When removing duplicates, the first instance of
each duplicate row scanning from the top downwards is kept in the resulting
range. Content outside of the specified range isn't removed, and rows
considered duplicates do not have to be adjacent to each other in the range.
Corresponds to the JSON property deleteDuplicates
8028 8029 8030 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8028 def delete_duplicates @delete_duplicates end |
#delete_embedded_object ⇒ Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest
Deletes the embedded object with the given ID.
Corresponds to the JSON property deleteEmbeddedObject
8033 8034 8035 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8033 def @delete_embedded_object end |
#delete_filter_view ⇒ Google::Apis::SheetsV4::DeleteFilterViewRequest
Deletes a particular filter view.
Corresponds to the JSON property deleteFilterView
8038 8039 8040 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8038 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
8043 8044 8045 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8043 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
8048 8049 8050 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8048 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
8053 8054 8055 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8053 def delete_range @delete_range end |
#delete_sheet ⇒ Google::Apis::SheetsV4::DeleteSheetRequest
Deletes the requested sheet.
Corresponds to the JSON property deleteSheet
8058 8059 8060 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8058 def delete_sheet @delete_sheet end |
#duplicate_filter_view ⇒ Google::Apis::SheetsV4::DuplicateFilterViewRequest
Duplicates a particular filter view.
Corresponds to the JSON property duplicateFilterView
8063 8064 8065 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8063 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
8068 8069 8070 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8068 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
8073 8074 8075 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8073 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
8078 8079 8080 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8078 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
8083 8084 8085 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8083 def insert_range @insert_range end |
#merge_cells ⇒ Google::Apis::SheetsV4::MergeCellsRequest
Merges all cells in the range.
Corresponds to the JSON property mergeCells
8088 8089 8090 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8088 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
8093 8094 8095 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8093 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
8098 8099 8100 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8098 def paste_data @paste_data end |
#randomize_range ⇒ Google::Apis::SheetsV4::RandomizeRangeRequest
Randomizes the order of the rows in a range.
Corresponds to the JSON property randomizeRange
8103 8104 8105 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8103 def randomize_range @randomize_range end |
#refresh_data_source ⇒ Google::Apis::SheetsV4::RefreshDataSourceRequest
Refreshes one or multiple data source objects in the spreadsheet by the
specified references. The request requires an additional bigquery.readonly
OAuth scope. If there are multiple refresh requests referencing the same data
source objects in one batch, only the last refresh request is processed, and
all those requests will have the same response accordingly.
Corresponds to the JSON property refreshDataSource
8112 8113 8114 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8112 def refresh_data_source @refresh_data_source 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
8124 8125 8126 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8124 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
8129 8130 8131 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8129 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
8135 8136 8137 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8135 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
8140 8141 8142 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8140 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
8146 8147 8148 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8146 def text_to_columns @text_to_columns end |
#trim_whitespace ⇒ Google::Apis::SheetsV4::TrimWhitespaceRequest
Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the
specified range. This request removes all whitespace from the start and end of
each cell's text, and reduces any subsequence of remaining whitespace
characters to a single space. If the resulting trimmed text starts with a '+'
or '=' character, the text remains as a string value and isn't interpreted as
a formula.
Corresponds to the JSON property trimWhitespace
8156 8157 8158 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8156 def trim_whitespace @trim_whitespace end |
#unmerge_cells ⇒ Google::Apis::SheetsV4::UnmergeCellsRequest
Unmerges cells in the given range.
Corresponds to the JSON property unmergeCells
8161 8162 8163 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8161 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
8166 8167 8168 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8166 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
8176 8177 8178 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8176 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
8181 8182 8183 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8181 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
8187 8188 8189 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8187 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
8193 8194 8195 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8193 def update_conditional_format_rule @update_conditional_format_rule end |
#update_data_source ⇒ Google::Apis::SheetsV4::UpdateDataSourceRequest
Updates a data source. After the data source is updated successfully, an
execution is triggered to refresh the associated DATA_SOURCE sheet to read
data from the updated data source. The request requires an additional
bigquery.readonly
OAuth scope.
Corresponds to the JSON property updateDataSource
8201 8202 8203 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8201 def update_data_source @update_data_source end |
#update_developer_metadata ⇒ Google::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
8210 8211 8212 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8210 def @update_developer_metadata end |
#update_dimension_group ⇒ Google::Apis::SheetsV4::UpdateDimensionGroupRequest
Updates the state of the specified group.
Corresponds to the JSON property updateDimensionGroup
8215 8216 8217 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8215 def update_dimension_group @update_dimension_group end |
#update_dimension_properties ⇒ Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest
Updates properties of dimensions within the specified range.
Corresponds to the JSON property updateDimensionProperties
8220 8221 8222 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8220 def update_dimension_properties @update_dimension_properties end |
#update_embedded_object_border ⇒ Google::Apis::SheetsV4::UpdateEmbeddedObjectBorderRequest
Updates an embedded object's border property.
Corresponds to the JSON property updateEmbeddedObjectBorder
8225 8226 8227 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8225 def @update_embedded_object_border 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
8231 8232 8233 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8231 def @update_embedded_object_position end |
#update_filter_view ⇒ Google::Apis::SheetsV4::UpdateFilterViewRequest
Updates properties of the filter view.
Corresponds to the JSON property updateFilterView
8236 8237 8238 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8236 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
8241 8242 8243 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8241 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
8246 8247 8248 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8246 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
8251 8252 8253 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8251 def update_sheet_properties @update_sheet_properties end |
#update_slicer_spec ⇒ Google::Apis::SheetsV4::UpdateSlicerSpecRequest
Updates a slicer's specifications. (This does not move or resize a slicer. To
move or resize a slicer use UpdateEmbeddedObjectPositionRequest.
Corresponds to the JSON property updateSlicerSpec
8257 8258 8259 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8257 def update_slicer_spec @update_slicer_spec end |
#update_spreadsheet_properties ⇒ Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest
Updates properties of a spreadsheet.
Corresponds to the JSON property updateSpreadsheetProperties
8262 8263 8264 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8262 def update_spreadsheet_properties @update_spreadsheet_properties end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 8269 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_data_source = args[:add_data_source] if args.key?(:add_data_source) @add_dimension_group = args[:add_dimension_group] if args.key?(:add_dimension_group) @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) @add_slicer = args[:add_slicer] if args.key?(:add_slicer) @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_data_source = args[:delete_data_source] if args.key?(:delete_data_source) @delete_developer_metadata = args[:delete_developer_metadata] if args.key?(:delete_developer_metadata) @delete_dimension = args[:delete_dimension] if args.key?(:delete_dimension) @delete_dimension_group = args[:delete_dimension_group] if args.key?(:delete_dimension_group) @delete_duplicates = args[:delete_duplicates] if args.key?(:delete_duplicates) @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) @refresh_data_source = args[:refresh_data_source] if args.key?(:refresh_data_source) @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) @trim_whitespace = args[:trim_whitespace] if args.key?(:trim_whitespace) @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_data_source = args[:update_data_source] if args.key?(:update_data_source) @update_developer_metadata = args[:update_developer_metadata] if args.key?(:update_developer_metadata) @update_dimension_group = args[:update_dimension_group] if args.key?(:update_dimension_group) @update_dimension_properties = args[:update_dimension_properties] if args.key?(:update_dimension_properties) @update_embedded_object_border = args[:update_embedded_object_border] if args.key?(:update_embedded_object_border) @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_slicer_spec = args[:update_slicer_spec] if args.key?(:update_slicer_spec) @update_spreadsheet_properties = args[:update_spreadsheet_properties] if args.key?(:update_spreadsheet_properties) end |