Requests

Request

A single kind of update to apply to a spreadsheet.

JSON representation
{

  "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)
  },
  "addTable": {
    object (AddTableRequest)
  },
  "updateTable": {
    object (UpdateTableRequest)
  },
  "deleteTable": {
    object (DeleteTableRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  }
}
Fields
Union field kind. The kind of update. Exactly one field is required. kind can be only one of the following:
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

Updates the spreadsheet's properties.

updateSheetProperties

object (UpdateSheetPropertiesRequest)

Updates a sheet's properties.

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

Updates dimensions' properties.

updateNamedRange

object (UpdateNamedRangeRequest)

Updates a named range.

repeatCell

object (RepeatCellRequest)

Repeats a single cell across a range.

addNamedRange

object (AddNamedRangeRequest)

Adds a named range.

deleteNamedRange

object (DeleteNamedRangeRequest)

Deletes a named range.

addSheet

object (AddSheetRequest)

Adds a sheet.

deleteSheet

object (DeleteSheetRequest)

Deletes a sheet.

autoFill

object (AutoFillRequest)

Automatically fills in more data based on existing data.

cutPaste

object (CutPasteRequest)

Cuts data from one area and pastes it to another.

copyPaste

object (CopyPasteRequest)

Copies data from one area and pastes it to another.

mergeCells

object (MergeCellsRequest)

Merges cells together.

unmergeCells

object (UnmergeCellsRequest)

Unmerges merged cells.

updateBorders

object (UpdateBordersRequest)

Updates the borders in a range of cells.

updateCells

object (UpdateCellsRequest)

Updates many cells at once.

addFilterView

object (AddFilterViewRequest)

Adds a filter view.

appendCells

object (AppendCellsRequest)

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

clearBasicFilter

object (ClearBasicFilterRequest)

Clears the basic filter on a sheet.

deleteDimension

object (DeleteDimensionRequest)

Deletes rows or columns in a sheet.

deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

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

deleteFilterView

object (DeleteFilterViewRequest)

Deletes a filter view from a sheet.

duplicateFilterView

object (DuplicateFilterViewRequest)

Duplicates a filter view.

duplicateSheet

object (DuplicateSheetRequest)

Duplicates a sheet.

findReplace

object (FindReplaceRequest)

Finds and replaces occurrences of some text with other text.

insertDimension

object (InsertDimensionRequest)

Inserts new rows or columns in a sheet.

insertRange

object (InsertRangeRequest)

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

moveDimension

object (MoveDimensionRequest)

Moves rows or columns to another location in a sheet.

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionRequest)

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

pasteData

object (PasteDataRequest)

Pastes data (HTML or delimited) into a sheet.

textToColumns

object (TextToColumnsRequest)

Converts a column of text into many columns of text.

updateFilterView

object (UpdateFilterViewRequest)

Updates the properties of a filter view.

deleteRange

object (DeleteRangeRequest)

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

appendDimension

object (AppendDimensionRequest)

Appends dimensions to the end of a sheet.

addConditionalFormatRule

object (AddConditionalFormatRuleRequest)

Adds a new conditional format rule.

updateConditionalFormatRule

object (UpdateConditionalFormatRuleRequest)

Updates an existing conditional format rule.

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

Deletes an existing conditional format rule.

sortRange

object (SortRangeRequest)

Sorts data in a range.

setDataValidation

object (SetDataValidationRequest)

Sets data validation for one or more cells.

setBasicFilter

object (SetBasicFilterRequest)

Sets the basic filter on a sheet.

addProtectedRange

object (AddProtectedRangeRequest)

Adds a protected range.

updateProtectedRange

object (UpdateProtectedRangeRequest)

Updates a protected range.

deleteProtectedRange

object (DeleteProtectedRangeRequest)

Deletes a protected range.

autoResizeDimensions

object (AutoResizeDimensionsRequest)

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

addChart

object (AddChartRequest)

Adds a chart.

updateChartSpec

object (UpdateChartSpecRequest)

Updates a chart's specifications.

updateBanding

object (UpdateBandingRequest)

Updates a banded range

addBanding

object (AddBandingRequest)

Adds a new banded range

deleteBanding

object (DeleteBandingRequest)

Removes a banded range

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

Creates new developer metadata

updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

Updates an existing developer metadata entry

deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

Deletes developer metadata

randomizeRange

object (RandomizeRangeRequest)

Randomizes the order of the rows in a range.

addDimensionGroup

object (AddDimensionGroupRequest)

Creates a group over the specified range.

deleteDimensionGroup

object (DeleteDimensionGroupRequest)

Deletes a group over the specified range.

updateDimensionGroup

object (UpdateDimensionGroupRequest)

Updates the state of the specified group.

trimWhitespace

object (TrimWhitespaceRequest)

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

deleteDuplicates

object (DeleteDuplicatesRequest)

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

updateEmbeddedObjectBorder

object (UpdateEmbeddedObjectBorderRequest)

Updates an embedded object's border.

addSlicer

object (AddSlicerRequest)

Adds a slicer.

updateSlicerSpec

object (UpdateSlicerSpecRequest)

Updates a slicer's specifications.

addDataSource

object (AddDataSourceRequest)

Adds a data source.

updateDataSource

object (UpdateDataSourceRequest)

Updates a data source.

deleteDataSource

object (DeleteDataSourceRequest)

Deletes a data source.

refreshDataSource

object (RefreshDataSourceRequest)

Refreshes one or multiple data sources and associated dbobjects.

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

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

addTable

object (AddTableRequest)

Adds a table.

updateTable

object (UpdateTableRequest)

Updates a table.

deleteTable

object (DeleteTableRequest)

A request for deleting a table.

insertComment

object (InsertCommentRequest)