Requests

{

  // Union field kind can be only one of the following:
  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  }
  // End of list of possible types for union field kind.
}

object (UpdateSpreadsheetPropertiesRequest)

Updates the spreadsheet's properties.

object (UpdateSheetPropertiesRequest)

Updates a sheet's properties.

object (UpdateDimensionPropertiesRequest)

Updates dimensions' properties.

object (UpdateNamedRangeRequest)

Updates a named range.

object (RepeatCellRequest)

Repeats a single cell across a range.

object (AddNamedRangeRequest)

Adds a named range.

object (DeleteNamedRangeRequest)

Deletes a named range.

object (AddSheetRequest)

Adds a sheet.

object (DeleteSheetRequest)

Deletes a sheet.

object (AutoFillRequest)

Automatically fills in more data based on existing data.

object (CutPasteRequest)

Cuts data from one area and pastes it to another.

object (CopyPasteRequest)

Copies data from one area and pastes it to another.

object (MergeCellsRequest)

Merges cells together.

object (UnmergeCellsRequest)

Unmerges merged cells.

object (UpdateBordersRequest)

Updates the borders in a range of cells.

object (UpdateCellsRequest)

Updates many cells at once.

object (AddFilterViewRequest)

Adds a filter view.

object (AppendCellsRequest)

Appends cells after the last row with data in a sheet.

object (ClearBasicFilterRequest)

Clears the basic filter on a sheet.

object (DeleteDimensionRequest)

Deletes rows or columns in a sheet.

object (DeleteEmbeddedObjectRequest)

Deletes an embedded object (e.g, chart, image) in a sheet.

object (DeleteFilterViewRequest)

Deletes a filter view from a sheet.

object (DuplicateFilterViewRequest)

Duplicates a filter view.

object (DuplicateSheetRequest)

Duplicates a sheet.

object (FindReplaceRequest)

Finds and replaces occurrences of some text with other text.

object (InsertDimensionRequest)

Inserts new rows or columns in a sheet.

object (InsertRangeRequest)

Inserts new cells in a sheet, shifting the existing cells.

object (MoveDimensionRequest)

Moves rows or columns to another location in a sheet.

object (UpdateEmbeddedObjectPositionRequest)

Updates an embedded object's (e.g. chart, image) position.

object (PasteDataRequest)

Pastes data (HTML or delimited) into a sheet.

object (TextToColumnsRequest)

Converts a column of text into many columns of text.

object (UpdateFilterViewRequest)

Updates the properties of a filter view.

object (DeleteRangeRequest)

Deletes a range of cells from a sheet, shifting the remaining cells.

object (AppendDimensionRequest)

Appends dimensions to the end of a sheet.

object (AddConditionalFormatRuleRequest)

Adds a new conditional format rule.

object (UpdateConditionalFormatRuleRequest)

Updates an existing conditional format rule.

object (DeleteConditionalFormatRuleRequest)

Deletes an existing conditional format rule.

object (SortRangeRequest)

Sorts data in a range.

object (SetDataValidationRequest)

Sets data validation for one or more cells.

object (SetBasicFilterRequest)

Sets the basic filter on a sheet.

object (AddProtectedRangeRequest)

Adds a protected range.

object (UpdateProtectedRangeRequest)

Updates a protected range.

object (DeleteProtectedRangeRequest)

Deletes a protected range.

object (AutoResizeDimensionsRequest)

Automatically resizes one or more dimensions based on the contents of the cells in that dimension.

object (AddChartRequest)

Adds a chart.

object (UpdateChartSpecRequest)

Updates a chart's specifications.

object (UpdateBandingRequest)

Updates a banded range

object (AddBandingRequest)

Adds a new banded range

object (DeleteBandingRequest)

Removes a banded range

object (CreateDeveloperMetadataRequest)

Creates new developer metadata

object (UpdateDeveloperMetadataRequest)

Updates an existing developer metadata entry

object (DeleteDeveloperMetadataRequest)

Deletes developer metadata

object (RandomizeRangeRequest)

Randomizes the order of the rows in a range.

object (AddDimensionGroupRequest)

Creates a group over the specified range.

object (DeleteDimensionGroupRequest)

Deletes a group over the specified range.

object (UpdateDimensionGroupRequest)

Updates the state of the specified group.

object (TrimWhitespaceRequest)

Trims cells of whitespace (such as spaces, tabs, or new lines).

object (DeleteDuplicatesRequest)

Removes rows containing duplicate values in specified columns of a cell range.

object (UpdateEmbeddedObjectBorderRequest)

Updates an embedded object's border.

object (AddSlicerRequest)

Adds a slicer.

object (UpdateSlicerSpecRequest)

Updates a slicer's specifications.

object (AddDataSourceRequest)

Adds a data source.

object (UpdateDataSourceRequest)

Updates a data source.

object (DeleteDataSourceRequest)

Deletes a data source.

object (RefreshDataSourceRequest)

Refreshes one or multiple data sources and associated dbobjects.

object (CancelDataSourceRefreshRequest)

Cancels refreshes of one or multiple data sources and associated dbobjects.

{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}

object (SpreadsheetProperties)

The properties to update.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}

object (SheetProperties)

The properties to update.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root properties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}

object (DimensionProperties)

Properties to update.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root properties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

object (DimensionRange)

The rows or columns to update.

object (DataSourceSheetDimensionRange)

The columns on a data source sheet to update.

{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}

integer

The ID of the data source sheet the range is on.

object (DataSourceColumnReference)

The columns on the data source sheet.

{
  "namedRange": {
    object (NamedRange)
  },
  "fields": string
}

object (NamedRange)

The named range to update with the new properties.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root namedRange is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}

object (GridRange)

The range to repeat the cell in.

object (CellData)

The data to write.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root cell is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "namedRange": {
    object (NamedRange)
  }
}

object (NamedRange)

The named range to add. The namedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)

{
  "namedRangeId": string
}

string

The ID of the named range to delete.

{
  "properties": {
    object (SheetProperties)
  }
}

object (SheetProperties)

The properties the new sheet should have. All properties are optional. The sheetId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a sheet that already exists.)

{
  "sheetId": integer
}

integer

The ID of the sheet to delete.

If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.

{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}

boolean

True if we should generate data with the "alternate" series. This differs based on the type and amount of source data.

object (GridRange)

The range to autofill. This will examine the range and detect the location that has data and automatically fill that data in to the rest of the range.

object (SourceAndDestination)

The source and destination areas to autofill. This explicitly lists the source of the autofill and where to extend that data.

{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}

object (GridRange)

The location of the data to use as the source of the autofill.

enum (Dimension)

The dimension that data should be filled into.

integer

The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source.

{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}

object (GridRange)

The source data to cut.

object (GridCoordinate)

The top-left coordinate where the data should be pasted.

enum (PasteType)

What kind of data to paste. All the source data will be cut, regardless of what is pasted.

{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}

object (GridRange)

The source range to copy.

object (GridRange)

The location to paste to. If the range covers a span that's a multiple of the source's height or width, then the data will be repeated to fill in the destination range. If the range is smaller than the source range, the entire source data will still be copied (beyond the end of the destination range).

enum (PasteType)

What kind of data to paste.

enum (PasteOrientation)

How that data should be oriented when pasting.

{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}

object (GridRange)

The range of cells to merge.

enum (MergeType)

How the cells should be merged.

{
  "range": {
    object (GridRange)
  }
}

object (GridRange)

The range within which all cells should be unmerged. If the range spans multiple merges, all will be unmerged. The range must not partially span any merge.

{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}

object (GridRange)

The range whose borders should be updated.

object (Border)

The border to put at the top of the range.

object (Border)

The border to put at the bottom of the range.

object (Border)

The border to put at the left of the range.

object (Border)

The border to put at the right of the range.

object (Border)

The horizontal border to put within the range.

object (Border)

The vertical border to put within the range.

{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}

object (RowData)

The data to write.

string (FieldMask format)

The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single "*" can be used as short-hand for listing every field.

object (GridCoordinate)

The coordinate to start writing data at. Any number of rows and columns (including a different number of columns per row) may be written.

object (GridRange)

The range to write data to.

If the data in rows does not cover the entire requested range, the fields matching those set in fields will be cleared.

{
  "filter": {
    object (FilterView)
  }
}

object (FilterView)

The filter to add. The filterViewId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a filter that already exists.)

{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}

integer

The sheet ID to append the data to.

object (RowData)

The data to append.

string (FieldMask format)

The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "sheetId": integer
}

integer

The sheet ID on which the basic filter should be cleared.

{
  "range": {
    object (DimensionRange)
  }
}

object (DimensionRange)

The dimensions to delete from the sheet.

{
  "objectId": integer
}

integer

The ID of the embedded object to delete.

{
  "filterId": integer
}

integer

The ID of the filter to delete.

{
  "filterId": integer
}

integer

The ID of the filter being duplicated.

{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}

integer

The sheet to duplicate.

If the source sheet is of DATA_SOURCE type, its backing DataSource is also duplicated and associated with the new copy of the sheet. No data execution is triggered, the grid data of this sheet is also copied over but only available after the batch request completes.

integer

The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented.

integer

If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative.

string

The name of the new sheet. If empty, a new name is chosen for you.

{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}

string

The value to search.

string

The value to use as the replacement.

boolean

True if the search is case sensitive.

boolean

True if the find value should match the entire cell.

boolean

True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents "Google Sheets" and another has "Google Docs", then searching for "o.* (.*)" with a replacement of "$1 Rocks" would change the contents of the cells to "GSheets Rocks" and "GDocs Rocks" respectively.

boolean

True if the search should include cells with formulas. False to skip cells with formulas.

object (GridRange)

The range to find/replace over.

integer

The sheet to find/replace over.

boolean

True to find/replace over all sheets.

{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}

object (DimensionRange)

The dimensions to insert. Both the start and end indexes must be bounded.

boolean

Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after.

For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If inheritFromBefore is true, the two new rows will be red (because the row before the insertion point was red), whereas if inheritFromBefore is false, the two new rows will be green (because the row after the insertion point was green).

{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}

object (GridRange)

The range to insert new cells into.

enum (Dimension)

The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.

{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}

object (DimensionRange)

The source dimensions to move.

integer

The zero-based start index of where to move the source data to, based on the coordinates before the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified.

For example, given A1..A5 of 0, 1, 2, 3, 4 and wanting to move "1" and "2" to between "3" and "4", the source would be ROWS [1..3),and the destination index would be "4" (the zero-based index of row 5). The end result would be A1..A5 of 0, 3, 1, 2, 4.

{
  "objectId": integer,
  "newPosition": {
    object (EmbeddedObjectPosition)
  },
  "fields": string
}

integer

The ID of the object to moved.

object (EmbeddedObjectPosition)

An explicit position to move the embedded object to. If newPosition.sheetId is set, a new sheet with that ID will be created. If newPosition.newSheet is set to true, a new sheet will be created with an ID that will be chosen for you.

string (FieldMask format)

The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root newPosition.overlayPosition is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}

object (GridCoordinate)

The coordinate at which the data should start being inserted.

string

The data to insert.

enum (PasteType)

How the data should be pasted.

string

The delimiter in the data.

boolean

True if the data is HTML.

{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}

object (GridRange)

The source data range. This must span exactly one column.

string

The delimiter to use. Used only if delimiterType is CUSTOM.

enum (DelimiterType)

The delimiter type to use.

{
  "filter": {
    object (FilterView)
  },
  "fields": string
}

object (FilterView)

The new properties of the filter view.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root filter is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}

object (GridRange)

The range of cells to delete.

enum (Dimension)

The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells.

{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}

integer

The sheet to append rows or columns to.

enum (Dimension)

Whether rows or columns should be appended.

integer

The number of rows or columns to append.

{
  "rule": {
    object (ConditionalFormatRule)
  },
  "index": integer
}

object (ConditionalFormatRule)

The rule to add.

integer

The zero-based index where the rule should be inserted.

{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}

integer

The zero-based index of the rule that should be replaced or moved.

integer

The sheet of the rule to move. Required if newIndex is set, unused otherwise.

object (ConditionalFormatRule)

The rule that should replace the rule at the given index.

integer

The zero-based new index the rule should end up at.

{
  "index": integer,
  "sheetId": integer
}

integer

The zero-based index of the rule to be deleted.

integer

The sheet the rule is being deleted from.

{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}

object (GridRange)

The range to sort.

object (SortSpec)

The sort order per column. Later specifications are used when values are equal in the earlier specifications.

{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  }
}

object (GridRange)

The range the data validation rule should apply to.

object (DataValidationRule)

The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.

{
  "filter": {
    object (BasicFilter)
  }
}

object (BasicFilter)

The filter to set.

{
  "protectedRange": {
    object (ProtectedRange)
  }
}

object (ProtectedRange)

The protected range to be added. The protectedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)

{
  "protectedRange": {
    object (ProtectedRange)
  },
  "fields": string
}

object (ProtectedRange)

The protected range to update with the new properties.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root protectedRange is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "protectedRangeId": integer
}

integer

The ID of the protected range to delete.

{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}

object (DimensionRange)

The dimensions to automatically resize.

object (DataSourceSheetDimensionRange)

The dimensions on a data source sheet to automatically resize.

{
  "chart": {
    object (EmbeddedChart)
  }
}

object (EmbeddedChart)

The chart that should be added to the spreadsheet, including the position where it should be placed. The chartId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of an embedded object that already exists.)

{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}

integer

The ID of the chart to update.

object (ChartSpec)

The specification to apply to the chart.

{
  "bandedRange": {
    object (BandedRange)
  },
  "fields": string
}

object (BandedRange)

The banded range to update with the new properties.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root bandedRange is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "bandedRange": {
    object (BandedRange)
  }
}

object (BandedRange)

The banded range to add. The bandedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)

{
  "bandedRangeId": integer
}

integer

The ID of the banded range to delete.

{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}

object (DeveloperMetadata)

The developer metadata to create.

{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}

object (DataFilter)

The filters matching the developer metadata entries to update.

object (DeveloperMetadata)

The value that all metadata matched by the data filters will be updated to.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root developerMetadata is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "dataFilter": {
    object (DataFilter)
  }
}

object (DataFilter)

The data filter describing the criteria used to select which developer metadata entry to delete.

{
  "range": {
    object (GridRange)
  }
}

object (GridRange)

The range to randomize.

{
  "range": {
    object (DimensionRange)
  }
}

object (DimensionRange)

The range over which to create a group.

{
  "range": {
    object (DimensionRange)
  }
}

object (DimensionRange)

The range of the group to be deleted.

{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}

object (DimensionGroup)

The group whose state should be updated. The range and depth of the group should specify a valid group on the sheet, and all other fields updated.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root dimensionGroup is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "range": {
    object (GridRange)
  }
}

object (GridRange)

The range whose cells to trim.

{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}

object (GridRange)

The range to remove duplicates rows from.

object (DimensionRange)

The columns in the range to analyze for duplicate values. If no columns are selected then all columns are analyzed for duplicates.

{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}

integer

The ID of the embedded object to update.

object (EmbeddedObjectBorder)

The border that applies to the embedded object.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root border is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "slicer": {
    object (Slicer)
  }
}

object (Slicer)

The slicer that should be added to the spreadsheet, including the position where it should be placed. The slicerId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a slicer that already exists.)

{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}

integer

The id of the slicer to update.

object (SlicerSpec)

The specification to apply to the slicer.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root SlicerSpec is implied and should not be specified. A single "*"` can be used as short-hand for listing every field.

{
  "dataSource": {
    object (DataSource)
  }
}

object (DataSource)

The data source to add.

{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}

object (DataSource)

The data source to update.

string (FieldMask format)

The fields that should be updated. At least one field must be specified. The root dataSource is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

{
  "dataSourceId": string
}

string

The ID of the data source to delete.

{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}

boolean

Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately.

object (DataSourceObjectReferences)

References to data source objects to refresh.

string

Reference to a DataSource. If specified, refreshes all associated data source objects for the data source.

boolean

Refreshes all existing data source objects in the spreadsheet.

{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}

object (DataSourceObjectReference)

The references.

{

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}

object (DataSourceObjectReferences)

References to data source objects whose refreshes are to be cancelled.

string

Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.

boolean

Cancels all existing data source object refreshes for all data sources in the spreadsheet.