sheets.v4 library Null safety

Google Sheets API - v4

Reads and writes Google Sheets.

For more information, see developers.google.com/sheets/

Create an instance of SheetsApi to access these resources:

Classes

AddBandingRequest
Adds a new banded range to the spreadsheet.
AddBandingResponse
The result of adding a banded range.
AddChartRequest
Adds a chart to a sheet in the spreadsheet.
AddChartResponse
The result of adding a chart to a spreadsheet.
AddConditionalFormatRuleRequest
Adds a new conditional format rule at the given index. [...]
AddDataSourceRequest
Adds a data source. [...]
AddDataSourceResponse
The result of adding a data source.
AddDimensionGroupRequest
Creates a group over the specified range. [...]
AddDimensionGroupResponse
The result of adding a group.
AddFilterViewRequest
Adds a filter view.
AddFilterViewResponse
The result of adding a filter view.
AddNamedRangeRequest
Adds a named range to the spreadsheet.
AddNamedRangeResponse
The result of adding a named range.
AddProtectedRangeRequest
Adds a new protected range.
AddProtectedRangeResponse
The result of adding a new protected range.
AddSheetRequest
Adds a new sheet. [...]
AddSheetResponse
The result of adding a sheet.
AddSlicerRequest
Adds a slicer to a sheet in the spreadsheet.
AddSlicerResponse
The result of adding a slicer to a spreadsheet.
AppendCellsRequest
Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.
AppendDimensionRequest
Appends rows or columns to the end of a sheet.
AppendValuesResponse
The response when updating a range of values in a spreadsheet.
AutoFillRequest
Fills in more data based on existing data.
AutoResizeDimensionsRequest
Automatically resizes one or more dimensions based on the contents of the cells in that dimension.
BandedRange
A banded (alternating colors) range in a sheet.
BandingProperties
Properties referring a single dimension (either row or column). [...]
BaselineValueFormat
Formatting options for baseline value.
BasicChartAxis
An axis of the chart. [...]
BasicChartDomain
The domain of a chart. [...]
BasicChartSeries
A single series of data in a chart. [...]
BasicChartSpec
The specification for a basic chart. [...]
BasicFilter
The default filter associated with a sheet.
BasicSeriesDataPointStyleOverride
Style override settings for a single series data point.
BatchClearValuesByDataFilterRequest
The request for clearing more than one range selected by a DataFilter in a spreadsheet.
BatchClearValuesByDataFilterResponse
The response when clearing a range of values selected with DataFilters in a spreadsheet.
BatchClearValuesRequest
The request for clearing more than one range of values in a spreadsheet.
BatchClearValuesResponse
The response when clearing a range of values in a spreadsheet.
BatchGetValuesByDataFilterRequest
The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
BatchGetValuesByDataFilterResponse
The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.
BatchGetValuesResponse
The response when retrieving more than one range of values in a spreadsheet.
BatchUpdateSpreadsheetRequest
The request for updating any aspect of a spreadsheet.
BatchUpdateSpreadsheetResponse
The reply for batch updating a spreadsheet.
BatchUpdateValuesByDataFilterRequest
The request for updating more than one range of values in a spreadsheet.
BatchUpdateValuesByDataFilterResponse
The response when updating a range of values in a spreadsheet.
BatchUpdateValuesRequest
The request for updating more than one range of values in a spreadsheet.
BatchUpdateValuesResponse
The response when updating a range of values in a spreadsheet.
BigQueryDataSourceSpec
The specification of a BigQuery data source that's connected to a sheet.
BigQueryQuerySpec
Specifies a custom BigQuery query.
BigQueryTableSpec
Specifies a BigQuery table definition. [...]
BooleanCondition
A condition that can evaluate to true or false. [...]
BooleanRule
A rule that may or may not match, depending on the condition.
Border
A border along a cell.
Borders
The borders of the cell.
BubbleChartSpec
A bubble chart.
CandlestickChartSpec
A candlestick chart.
CandlestickData
The Candlestick chart data, each containing the low, open, close, and high values for a series.
CandlestickDomain
The domain of a CandlestickChart.
CandlestickSeries
The series of a CandlestickData.
CellData
Data about a specific cell.
CellFormat
The format of a cell.
ChartAxisViewWindowOptions
The options that define a "view window" for a chart (such as the visible values in an axis).
ChartCustomNumberFormatOptions
Custom number formatting options for chart attributes.
ChartData
The data included in a domain or series.
ChartDateTimeRule
Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.
ChartGroupRule
An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. [...]
ChartHistogramRule
Allows you to organize numeric values in a source data column into buckets of constant size.
ChartSourceRange
Source ranges for a chart.
ChartSpec
The specifications of a chart.
ClearBasicFilterRequest
Clears the basic filter, if any exists on the sheet.
ClearValuesRequest
The request for clearing a range of values in a spreadsheet.
ClearValuesResponse
The response when clearing a range of values in a spreadsheet.
Color
Represents a color in the RGBA color space. [...]
ColorStyle
A color value.
ConditionalFormatRule
A rule describing a conditional format.
ConditionValue
The value of the condition.
CopyPasteRequest
Copies data from the source to the destination.
CopySheetToAnotherSpreadsheetRequest
The request to copy a sheet across spreadsheets.
CreateDeveloperMetadataRequest
A request to create developer metadata.
CreateDeveloperMetadataResponse
The response from creating developer metadata.
CutPasteRequest
Moves data from the source to the destination.
DataExecutionStatus
The data execution status. [...]
DataFilter
Filter that describes what data should be selected or returned from a request.
DataFilterValueRange
A range of values whose location is specified by a DataFilter.
DataLabel
Settings for one set of data labels. [...]
DataSource
Information about an external data source in the spreadsheet.
DataSourceChartProperties
Properties of a data source chart.
DataSourceColumn
A column in a data source.
DataSourceColumnReference
An unique identifier that references a data source column.
DataSourceFormula
A data source formula.
DataSourceObjectReference
Reference to a data source object.
DataSourceObjectReferences
A list of references to data source objects.
DataSourceParameter
A parameter in a data source's query. [...]
DataSourceRefreshDailySchedule
A schedule for data to refresh every day in a given time interval.
DataSourceRefreshMonthlySchedule
A monthly schedule for data to refresh on specific days in the month in a given time interval.
DataSourceRefreshSchedule
Schedule for refreshing the data source. [...]
DataSourceRefreshWeeklySchedule
A weekly schedule for data to refresh on specific days in a given time interval.
DataSourceSheetDimensionRange
A range along a single dimension on a DATA_SOURCE sheet.
DataSourceSheetProperties
Additional properties of a DATA_SOURCE sheet.
DataSourceSpec
This specifies the details of the data source. [...]
DataSourceTable
A data source table, which allows the user to import a static table of data from the DataSource into Sheets. [...]
DataValidationRule
A data validation rule.
DateTimeRule
Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. [...]
DeleteBandingRequest
Removes the banded range with the given ID from the spreadsheet.
DeleteConditionalFormatRuleRequest
Deletes a conditional format rule at the given index. [...]
DeleteConditionalFormatRuleResponse
The result of deleting a conditional format rule.
DeleteDataSourceRequest
Deletes a data source. [...]
DeleteDeveloperMetadataRequest
A request to delete developer metadata.
DeleteDeveloperMetadataResponse
The response from deleting developer metadata.
DeleteDimensionGroupRequest
Deletes a group over the specified range by decrementing the depth of the dimensions in the range. [...]
DeleteDimensionGroupResponse
The result of deleting a group.
DeleteDimensionRequest
Deletes the dimensions from the sheet.
DeleteDuplicatesRequest
Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. [...]
DeleteDuplicatesResponse
The result of removing duplicates in a range.
DeleteEmbeddedObjectRequest
Deletes the embedded object with the given ID.
DeleteFilterViewRequest
Deletes a particular filter view.
DeleteNamedRangeRequest
Removes the named range with the given ID from the spreadsheet.
DeleteProtectedRangeRequest
Deletes the protected range with the given ID.
DeleteRangeRequest
Deletes a range of cells, shifting other cells into the deleted area.
DeleteSheetRequest
Deletes the requested sheet.
DeveloperMetadata
Developer metadata associated with a location or object in a spreadsheet. [...]
DeveloperMetadataLocation
A location where metadata may be associated in a spreadsheet.
DeveloperMetadataLookup
Selects DeveloperMetadata that matches all of the specified fields. [...]
DimensionGroup
A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. [...]
DimensionProperties
Properties about a dimension.
DimensionRange
A range along a single dimension on a sheet. [...]
DuplicateFilterViewRequest
Duplicates a particular filter view.
DuplicateFilterViewResponse
The result of a filter view being duplicated.
DuplicateSheetRequest
Duplicates the contents of a sheet.
DuplicateSheetResponse
The result of duplicating a sheet.
Editors
The editors of a protected range.
EmbeddedChart
A chart embedded in a sheet.
EmbeddedObjectBorder
A border along an embedded object.
EmbeddedObjectPosition
The position of an embedded object such as a chart.
ErrorValue
An error in a cell.
ExtendedValue
The kinds of value that a cell in a spreadsheet can have.
FilterCriteria
Criteria for showing/hiding rows in a filter or filter view.
FilterSpec
The filter criteria associated with a specific column.
FilterView
A filter view.
FindReplaceRequest
Finds and replaces data in cells over a range, sheet, or all sheets.
FindReplaceResponse
The result of the find/replace.
GetSpreadsheetByDataFilterRequest
The request for retrieving a Spreadsheet.
GradientRule
A rule that applies a gradient color scale format, based on the interpolation points listed. [...]
GridCoordinate
A coordinate in a sheet. [...]
GridData
Data in the grid, as well as metadata about the dimensions.
GridProperties
Properties of a grid.
GridRange
A range on a sheet. [...]
HistogramChartSpec
A histogram chart. [...]
HistogramRule
Allows you to organize the numeric values in a source data column into buckets of a constant size. [...]
HistogramSeries
A histogram series containing the series color and data.
InsertDimensionRequest
Inserts rows or columns in a sheet at a particular index.
InsertRangeRequest
Inserts cells into a range, shifting the existing cells over or down.
InterpolationPoint
A single interpolation point on a gradient conditional format. [...]
Interval
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). [...]
IterativeCalculationSettings
Settings to control how circular dependencies are resolved with iterative calculation.
KeyValueFormat
Formatting options for key value.
LineStyle
Properties that describe the style of a line.
An external or local reference.
ManualRule
Allows you to manually organize the values in a source data column into buckets with names of your choosing. [...]
ManualRuleGroup
A group name and a list of items from the source data that should be placed in the group with this name.
MatchedDeveloperMetadata
A developer metadata entry and the data filters specified in the original request that matched it.
MatchedValueRange
A value range that was matched by one or more data filers.
MergeCellsRequest
Merges all cells in the range.
MoveDimensionRequest
Moves one or more rows or columns.
NamedRange
A named range.
NumberFormat
The number format of a cell.
OrgChartSpec
An org chart. [...]
OverlayPosition
The location an object is overlaid on top of a grid.
Padding
The amount of padding around the cell, in pixels. [...]
PasteDataRequest
Inserts data into the spreadsheet starting at the specified coordinate.
PieChartSpec
A pie chart.
PivotFilterCriteria
Criteria for showing/hiding rows in a pivot table.
PivotFilterSpec
The pivot table filter criteria associated with a specific source column offset.
PivotGroup
A single grouping (either row or column) in a pivot table.
PivotGroupLimit
The count limit on rows or columns in the pivot group.
PivotGroupRule
An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. [...]
PivotGroupSortValueBucket
Information about which values in a pivot group should be used for sorting.
PivotGroupValueMetadata
Metadata about a value in a pivot grouping.
PivotTable
A pivot table.
PivotValue
The definition of how a value in a pivot table should be calculated.
PointStyle
The style of a point on the chart.
ProtectedRange
A protected range.
RandomizeRangeRequest
Randomizes the order of the rows in a range.
RefreshDataSourceObjectExecutionStatus
The execution status of refreshing one data source object.
RefreshDataSourceRequest
Refreshes one or multiple data source objects in the spreadsheet by the specified references. [...]
RefreshDataSourceResponse
The response from refreshing one or multiple data source objects.
RepeatCellRequest
Updates all cells in the range to the values in the given Cell object. [...]
Request
A single kind of update to apply to a spreadsheet.
Response
A single response from an update.
RowData
Data about each cell in a row.
ScorecardChartSpec
A scorecard chart. [...]
SearchDeveloperMetadataRequest
A request to retrieve all developer metadata matching the set of specified criteria.
SearchDeveloperMetadataResponse
A reply to a developer metadata search request.
SetBasicFilterRequest
Sets the basic filter associated with a sheet.
SetDataValidationRequest
Sets a data validation rule to every cell in the range. [...]
Sheet
A sheet in a spreadsheet.
SheetProperties
Properties of a sheet.
SheetsApi
Reads and writes Google Sheets.
Slicer
A slicer in a sheet.
SlicerSpec
The specifications of a slicer.
SortRangeRequest
Sorts data in rows based on a sort order per column.
SortSpec
A sort order associated with a specific column or row.
SourceAndDestination
A combination of a source range and how to extend that source.
Spreadsheet
Resource that represents a spreadsheet.
SpreadsheetProperties
Properties of a spreadsheet.
SpreadsheetsDeveloperMetadataResource
SpreadsheetsResource
SpreadsheetsSheetsResource
SpreadsheetsValuesResource
SpreadsheetTheme
Represents spreadsheet theme
TextFormat
The format of a run of text in a cell. [...]
TextFormatRun
A run of a text format. [...]
TextPosition
Position settings for text.
TextRotation
The rotation applied to text in a cell.
TextToColumnsRequest
Splits a column of text into multiple columns, based on a delimiter in each cell.
ThemeColorPair
A pair mapping a spreadsheet theme color type to the concrete color it represents.
TimeOfDay
Represents a time of day. [...]
TreemapChartColorScale
A color scale for a treemap chart.
TreemapChartSpec
A Treemap chart.
TrimWhitespaceRequest
Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. [...]
TrimWhitespaceResponse
The result of trimming whitespace in cells.
UnmergeCellsRequest
Unmerges cells in the given range.
UpdateBandingRequest
Updates properties of the supplied banded range.
UpdateBordersRequest
Updates the borders of a range. [...]
UpdateCellsRequest
Updates all cells in a range with new data.
UpdateChartSpecRequest
Updates a chart's specifications. [...]
UpdateConditionalFormatRuleRequest
Updates a conditional format rule at the given index, or moves a conditional format rule to another index.
UpdateConditionalFormatRuleResponse
The result of updating a conditional format rule.
UpdateDataSourceRequest
Updates a data source. [...]
UpdateDataSourceResponse
The response from updating data source.
UpdateDeveloperMetadataRequest
A request to update properties of developer metadata. [...]
UpdateDeveloperMetadataResponse
The response from updating developer metadata.
UpdateDimensionGroupRequest
Updates the state of the specified group.
UpdateDimensionPropertiesRequest
Updates properties of dimensions within the specified range.
UpdateEmbeddedObjectBorderRequest
Updates an embedded object's border property.
UpdateEmbeddedObjectPositionRequest
Update an embedded object's position (such as a moving or resizing a chart or image).
UpdateEmbeddedObjectPositionResponse
The result of updating an embedded object's position.
UpdateFilterViewRequest
Updates properties of the filter view.
UpdateNamedRangeRequest
Updates properties of the named range with the specified namedRangeId.
UpdateProtectedRangeRequest
Updates an existing protected range with the specified protectedRangeId.
UpdateSheetPropertiesRequest
Updates properties of the sheet with the specified sheetId.
UpdateSlicerSpecRequest
Updates a slicer's specifications. [...]
UpdateSpreadsheetPropertiesRequest
Updates properties of a spreadsheet.
UpdateValuesByDataFilterResponse
The response when updating a range of values by a data filter in a spreadsheet.
UpdateValuesResponse
The response when updating a range of values in a spreadsheet.
ValueRange
Data within a range of the spreadsheet.
WaterfallChartColumnStyle
Styles for a waterfall chart column.
WaterfallChartCustomSubtotal
A custom subtotal column for a waterfall chart series.
WaterfallChartDomain
The domain of a waterfall chart.
WaterfallChartSeries
A single series of data for a waterfall chart.
WaterfallChartSpec
A waterfall chart.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.