Google Sheets API
  1. spreadsheets
Google Sheets API
  • spreadsheets
    • /v4/spreadsheets
      POST
    • /v4/spreadsheets/{spreadsheetId}
      GET
    • /v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}
      GET
    • /v4/spreadsheets/{spreadsheetId}/developerMetadata:search
      POST
    • /v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo
      POST
    • /v4/spreadsheets/{spreadsheetId}/values/{range}
      GET
    • /v4/spreadsheets/{spreadsheetId}/values/{range}
      PUT
    • /v4/spreadsheets/{spreadsheetId}/values/{range}:append
      POST
    • /v4/spreadsheets/{spreadsheetId}/values/{range}:clear
      POST
    • /v4/spreadsheets/{spreadsheetId}/values:batchClear
      POST
    • /v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter
      POST
    • /v4/spreadsheets/{spreadsheetId}/values:batchGet
      GET
    • /v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
      POST
    • /v4/spreadsheets/{spreadsheetId}/values:batchUpdate
      POST
    • /v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
      POST
    • /v4/spreadsheets/{spreadsheetId}:batchUpdate
      POST
    • /v4/spreadsheets/{spreadsheetId}:getByDataFilter
      POST
  • Schemas
    • Schemas
      • AddBandingRequest
      • AddBandingResponse
      • AddChartRequest
      • AddChartResponse
      • AddConditionalFormatRuleRequest
      • AddDataSourceRequest
      • AddDataSourceResponse
      • AddDimensionGroupRequest
      • AddDimensionGroupResponse
      • AddFilterViewRequest
      • AddFilterViewResponse
      • AddNamedRangeRequest
      • AddNamedRangeResponse
      • AddProtectedRangeRequest
      • AddProtectedRangeResponse
      • AddSheetRequest
      • AddSheetResponse
      • AddSlicerRequest
      • AddSlicerResponse
      • AppendCellsRequest
      • AppendDimensionRequest
      • AppendValuesResponse
      • AutoFillRequest
      • AutoResizeDimensionsRequest
      • BandedRange
      • BandingProperties
      • BaselineValueFormat
      • BasicChartAxis
      • BasicChartDomain
      • BasicChartSeries
      • BasicChartSpec
      • BasicFilter
      • BasicSeriesDataPointStyleOverride
      • BatchClearValuesByDataFilterRequest
      • BatchClearValuesByDataFilterResponse
      • BatchClearValuesRequest
      • BatchClearValuesResponse
      • BatchGetValuesByDataFilterRequest
      • BatchGetValuesByDataFilterResponse
      • BatchGetValuesResponse
      • BatchUpdateSpreadsheetRequest
      • BatchUpdateSpreadsheetResponse
      • BatchUpdateValuesByDataFilterRequest
      • BatchUpdateValuesByDataFilterResponse
      • BatchUpdateValuesRequest
      • BatchUpdateValuesResponse
      • BigQueryDataSourceSpec
      • BigQueryQuerySpec
      • BigQueryTableSpec
      • BooleanCondition
      • BooleanRule
      • Border
      • Borders
      • BubbleChartSpec
      • CandlestickChartSpec
      • CandlestickData
      • CandlestickDomain
      • CandlestickSeries
      • CellData
      • CellFormat
      • ChartAxisViewWindowOptions
      • ChartCustomNumberFormatOptions
      • ChartData
      • ChartDateTimeRule
      • ChartGroupRule
      • ChartHistogramRule
      • ChartSourceRange
      • ChartSpec
      • ClearBasicFilterRequest
      • ClearValuesRequest
      • ClearValuesResponse
      • Color
      • ColorStyle
      • ConditionValue
      • ConditionalFormatRule
      • CopyPasteRequest
      • CopySheetToAnotherSpreadsheetRequest
      • CreateDeveloperMetadataRequest
      • CreateDeveloperMetadataResponse
      • CutPasteRequest
      • DataExecutionStatus
      • DataFilter
      • DataFilterValueRange
      • DataLabel
      • DataSource
      • DataSourceChartProperties
      • DataSourceColumn
      • DataSourceColumnReference
      • DataSourceFormula
      • DataSourceObjectReference
      • DataSourceObjectReferences
      • DataSourceParameter
      • DataSourceRefreshDailySchedule
      • DataSourceRefreshMonthlySchedule
      • DataSourceRefreshSchedule
      • DataSourceRefreshWeeklySchedule
      • DataSourceSheetDimensionRange
      • DataSourceSheetProperties
      • DataSourceSpec
      • DataSourceTable
      • DataValidationRule
      • DateTimeRule
      • DeleteBandingRequest
      • DeleteConditionalFormatRuleRequest
      • DeleteConditionalFormatRuleResponse
      • DeleteDataSourceRequest
      • DeleteDeveloperMetadataRequest
      • DeleteDeveloperMetadataResponse
      • DeleteDimensionGroupRequest
      • DeleteDimensionGroupResponse
      • DeleteDimensionRequest
      • DeleteDuplicatesRequest
      • DeleteDuplicatesResponse
      • DeleteEmbeddedObjectRequest
      • DeleteFilterViewRequest
      • DeleteNamedRangeRequest
      • DeleteProtectedRangeRequest
      • DeleteRangeRequest
      • DeleteSheetRequest
      • DeveloperMetadata
      • DeveloperMetadataLocation
      • DeveloperMetadataLookup
      • DimensionGroup
      • DimensionProperties
      • DimensionRange
      • DuplicateFilterViewRequest
      • DuplicateFilterViewResponse
      • DuplicateSheetRequest
      • DuplicateSheetResponse
      • Editors
      • EmbeddedChart
      • EmbeddedObjectBorder
      • EmbeddedObjectPosition
      • ErrorValue
      • ExtendedValue
      • FilterCriteria
      • FilterSpec
      • FilterView
      • FindReplaceRequest
      • FindReplaceResponse
      • GetSpreadsheetByDataFilterRequest
      • GradientRule
      • GridCoordinate
      • GridData
      • GridProperties
      • GridRange
      • HistogramChartSpec
      • HistogramRule
      • HistogramSeries
      • InsertDimensionRequest
      • InsertRangeRequest
      • InterpolationPoint
      • Interval
      • IterativeCalculationSettings
      • KeyValueFormat
      • LineStyle
      • Link
      • ManualRule
      • ManualRuleGroup
      • MatchedDeveloperMetadata
      • MatchedValueRange
      • MergeCellsRequest
      • MoveDimensionRequest
      • NamedRange
      • NumberFormat
      • OrgChartSpec
      • OverlayPosition
      • Padding
      • PasteDataRequest
      • PieChartSpec
      • PivotFilterCriteria
      • PivotFilterSpec
      • PivotGroup
      • PivotGroupLimit
      • PivotGroupRule
      • PivotGroupSortValueBucket
      • PivotGroupValueMetadata
      • PivotTable
      • PivotValue
      • PointStyle
      • ProtectedRange
      • RandomizeRangeRequest
      • RefreshDataSourceObjectExecutionStatus
      • RefreshDataSourceRequest
      • RefreshDataSourceResponse
      • RepeatCellRequest
      • Request
      • Response
      • RowData
      • ScorecardChartSpec
      • SearchDeveloperMetadataRequest
      • SearchDeveloperMetadataResponse
      • SetBasicFilterRequest
      • SetDataValidationRequest
      • Sheet
      • SheetProperties
      • Slicer
      • SlicerSpec
      • SortRangeRequest
      • SortSpec
      • SourceAndDestination
      • Spreadsheet
      • SpreadsheetProperties
      • SpreadsheetTheme
      • TextFormat
      • TextFormatRun
      • TextPosition
      • TextRotation
      • TextToColumnsRequest
      • ThemeColorPair
      • TimeOfDay
      • TreemapChartColorScale
      • TreemapChartSpec
      • TrimWhitespaceRequest
      • TrimWhitespaceResponse
      • UnmergeCellsRequest
      • UpdateBandingRequest
      • UpdateBordersRequest
      • UpdateCellsRequest
      • UpdateChartSpecRequest
      • UpdateConditionalFormatRuleRequest
      • UpdateConditionalFormatRuleResponse
      • UpdateDataSourceRequest
      • UpdateDataSourceResponse
      • UpdateDeveloperMetadataRequest
      • UpdateDeveloperMetadataResponse
      • UpdateDimensionGroupRequest
      • UpdateDimensionPropertiesRequest
      • UpdateEmbeddedObjectBorderRequest
      • UpdateEmbeddedObjectPositionRequest
      • UpdateEmbeddedObjectPositionResponse
      • UpdateFilterViewRequest
      • UpdateNamedRangeRequest
      • UpdateProtectedRangeRequest
      • UpdateSheetPropertiesRequest
      • UpdateSlicerSpecRequest
      • UpdateSpreadsheetPropertiesRequest
      • UpdateValuesByDataFilterResponse
      • UpdateValuesResponse
      • ValueRange
      • WaterfallChartColumnStyle
      • WaterfallChartCustomSubtotal
      • WaterfallChartDomain
      • WaterfallChartSeries
      • WaterfallChartSpec
  1. spreadsheets

/v4/spreadsheets/{spreadsheetId}:batchUpdate

POST
/v4/spreadsheets/{spreadsheetId}:batchUpdate
Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Successful response
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sheets.googleapis.com//v4/spreadsheets/:batchUpdate' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
Modified at 2023-08-15 07:09:28
Previous
/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
Next
/v4/spreadsheets/{spreadsheetId}:getByDataFilter
Built with