Model tree
Spreadsheet
Sheet
GridData
EmbeddedChart
Spreadsheet
Resource that represents a spreadsheet.SpreadsheetProperties
Properties of a spreadsheet.CellFormat
The format of a cell.Padding
The amount of padding around the cell, in pixels. When updating padding, every field must be specified.ColorStyle
A color value.Color
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor ofjava.awt.Color in Java; it can also be trivially provided to UIColor’s +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba() string in JavaScript. This reference page doesn’t have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // … public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // … Example (iOS / Obj-C): // … static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // … Example (JavaScript): // … var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!(‘alpha’ in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(’,’); return [‘rgba(’, rgbParams, ’,’, alphaFrac, ’)‘].join(”); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = [’#’]; for (var i = 0; i < missingZeros; i++) { resultBuilder.push(‘0’); } resultBuilder.push(hexString); return resultBuilder.join(”); }; // …
Borders
The borders of the cell.Border
A border along a cell.TextRotation
The rotation applied to text in a cell.NumberFormat
The number format of a cell.TextFormat
The format of a run of text in a cell. Absent values indicate that the field isn’t specified.Link
An external or local reference.SpreadsheetTheme
Represents spreadsheet themeThemeColorPair
A pair mapping a spreadsheet theme color type to the concrete color it represents.IterativeCalculationSettings
Settings to control how circular dependencies are resolved with iterative calculation.Sheet
A sheet in a spreadsheet.DimensionGroup
A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.Slicer
A slicer in a sheet.SlicerSpec
The specifications of a slicer.FilterCriteria
Criteria for showing or hiding rows in a filter or filter view.BooleanCondition
A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.ConditionValue
The value of the condition.EmbeddedObjectPosition
The position of an embedded object such as a chart.OverlayPosition
The location an object is overlaid on top of a grid.GridCoordinate
A coordinate in a sheet. All indexes are zero-based.Table
A table.TableRowsProperties
The table row properties.TableColumnProperties
The table column.TableColumnDataValidationRule
A data validation rule for a column in a table.ConditionalFormatRule
A rule describing a conditional format.BooleanRule
A rule that may or may not match, depending on the condition.GradientRule
A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.InterpolationPoint
A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.BasicFilter
The default filter associated with a sheet. For more information, see Manage data visibility with filters.SortSpec
A sort order associated with a specific column or row.DataSourceColumnReference
An unique identifier that references a data source column.FilterSpec
The filter criteria associated with a specific column.SheetProperties
Properties of a sheet.GridProperties
Properties of a grid.DataSourceColumn
A column in a data source.BandedRange
A banded (alternating colors) range in a sheet.BandingProperties
Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.DeveloperMetadata
Developer metadata associated with a location or object in a spreadsheet. For more information, see Read, write, and search metadata. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and it will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata is still associated with the row it was first associated with (what is now row 6). If the associated object is deleted then its metadata is deleted too.GridData
Data in the grid, as well as metadata about the dimensions.DimensionProperties
Properties about a dimension.RowData
Data about each cell in a row.CellData
Data about a specific cell.DataSourceTable
A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as “Extract” in the Sheets editor.DataValidationRule
A data validation rule.ChipRun
The run of a chip. The chip continues until the start index of the next run.Chip
The Smart Chip.RichLinkProperties
Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of thedrive.file, drive.readonly, or drive OAuth scopes.
PersonProperties
Properties specific to a linked person.PivotTable
A pivot table.PivotFilterSpec
The pivot table filter criteria associated with a specific source column offset.PivotFilterCriteria
Criteria for showing/hiding rows in a pivot table.PivotValue
The definition of how a value in a pivot table should be calculated.PivotGroup
A single grouping (either row or column) in a pivot table.PivotGroupSortValueBucket
Information about which values in a pivot group should be used for sorting.ExtendedValue
The kinds of value that a cell in a spreadsheet can have.PivotGroupValueMetadata
Metadata about a value in a pivot grouping.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. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not.ManualRule
Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | … +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = ‘Central’, items = [‘AL’, ‘AR’, ‘IA’, …]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | … +-----------+-------------------+ManualRuleGroup
A group name and a list of items from the source data that should be placed in the group with this name.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. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | 708.84 | | 5/8/2017 | 53,731.78 | | 2017-Feb | 94,385.05 | … +--------------+--------------+HistogramRule
Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | 5.24 | | 18 | 20.15 \| ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ \| Grouped Age \| AVERAGE of Amount \| +-------------+-------------------+ \| < 25 \| 19.34 | | 25-45 | 35.87 | | > 65 | 29.12 | +-------------+-------------------+PivotGroupLimit
The count limit on rows or columns in the pivot group.TextFormatRun
A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.EmbeddedChart
A chart embedded in a sheet.ChartSpec
The specifications of a chart.ScorecardChartSpec
A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.ChartCustomNumberFormatOptions
Custom number formatting options for chart attributes.ChartData
The data included in a domain or series.ChartSourceRange
Source ranges for a chart.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. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.ChartHistogramRule
Allows you to organize numeric values in a source data column into buckets of constant size.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.KeyValueFormat
Formatting options for key value.TextPosition
Position settings for text.BaselineValueFormat
Formatting options for baseline value.BubbleChartSpec
A bubble chart.HistogramChartSpec
A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.HistogramSeries
A histogram series containing the series color and data.CandlestickChartSpec
A candlestick chart.CandlestickData
The Candlestick chart data, each containing the low, open, close, and high values for a series.CandlestickSeries
The series of a CandlestickData.CandlestickDomain
The domain of a CandlestickChart.WaterfallChartSpec
A waterfall chart.LineStyle
Properties that describe the style of a line.DataLabel
Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.WaterfallChartSeries
A single series of data for a waterfall chart.WaterfallChartColumnStyle
Styles for a waterfall chart column.WaterfallChartCustomSubtotal
A custom subtotal column for a waterfall chart series.WaterfallChartDomain
The domain of a waterfall chart.OrgChartSpec
An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain “Alice”, “Bob”, “Cathy”, parent_labels contain "", “Alice”, “Alice” and tooltips contain “CEO”, “President”, “VP Sales”.PieChartSpec
A pie chart.DataSourceChartProperties
Properties of a data source chart.BasicChartSpec
The specification for a basic chart. See BasicChartType for the list of charts this supports.BasicChartSeries
A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the “Open Price”, “High Price”, “Low Price” and “Close Price”.PointStyle
The style of a point on the chart.BasicSeriesDataPointStyleOverride
Style override settings for a single series data point.BasicChartDomain
The domain of a chart. For example, if charting stock prices over time, this would be the date.BasicChartAxis
An axis of the chart. A chart may not have more than one axis per axis position.ChartAxisViewWindowOptions
The options that define a “view window” for a chart (such as the visible values in an axis).TreemapChartSpec
A Treemap chart.TreemapChartColorScale
A color scale for a treemap chart.EmbeddedObjectBorder
A border along an embedded object.FilterView
A filter view. For more information, see Manage data visibility with filters.ProtectedRange
A protected range.Editors
The editors of a protected range.CommentAnchor
A location in the spreadsheet that is tied to a CommentThread with the same anchorId. Note: Multiple anchors may refer to the same location.DataSource
Information about an external data source in the spreadsheet.DataSourceSpec
This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.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. Only native tables are allowed.LookerDataSourceSpec
The specification of a Looker data source.DataSourceParameter
A parameter in a data source’s query. The parameter allows the user to pass in values from the spreadsheet into a query.NamedRange
A named range.CommentThread
Represents a single comment thread inside a spreadsheet.Post
A post on a comment thread: the head post or a reply.Request
A single kind of update to apply to a spreadsheet.UpdateSpreadsheetPropertiesRequest
Updates properties of a spreadsheet.FieldMask
FieldMask represents a set of symbolic field paths.
UpdateSheetPropertiesRequest
Updates properties of the sheet with the specified sheetId.UpdateDimensionPropertiesRequest
Updates properties of dimensions within the specified range.DataSourceSheetDimensionRange
A range along a single dimension on a DATA_SOURCE sheet.UpdateNamedRangeRequest
Updates properties of the named range with the specified namedRangeId.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.
AddNamedRangeRequest
Adds a named range to the spreadsheet.DeleteNamedRangeRequest
Removes the named range with the given ID from the spreadsheet.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.DeleteSheetRequest
Deletes the requested sheet.AutoFillRequest
Fills in more data based on existing data.SourceAndDestination
A combination of a source range and how to extend that source.CutPasteRequest
Moves data from the source to the destination.CopyPasteRequest
Copies data from the source to the destination.MergeCellsRequest
Merges all cells in the range.UnmergeCellsRequest
Unmerges cells in the given range.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.
UpdateCellsRequest
Updates all cells in a range with new data.AddFilterViewRequest
Adds a filter view.AppendCellsRequest
Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.ClearBasicFilterRequest
Clears the basic filter, if any exists on the sheet.DeleteDimensionRequest
Deletes the dimensions from the sheet.DeleteEmbeddedObjectRequest
Deletes the embedded object with the given ID.DeleteFilterViewRequest
Deletes a particular filter view.DuplicateFilterViewRequest
Duplicates a particular filter view.DuplicateSheetRequest
Duplicates the contents of a sheet.FindReplaceRequest
Finds and replaces data in cells over a range, sheet, or all sheets.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.MoveDimensionRequest
Moves one or more rows or columns.UpdateEmbeddedObjectPositionRequest
Update an embedded object’s position (such as a moving or resizing a chart or image).PasteDataRequest
Inserts data into the spreadsheet starting at the specified coordinate.TextToColumnsRequest
Splits a column of text into multiple columns, based on a delimiter in each cell.UpdateFilterViewRequest
Updates properties of the filter view.DeleteRangeRequest
Deletes a range of cells, shifting other cells into the deleted area.AppendDimensionRequest
Appends rows or columns to the end of a sheet.AddConditionalFormatRuleRequest
Adds a new conditional format rule at the given index. All subsequent rules’ indexes are incremented.UpdateConditionalFormatRuleRequest
Updates a conditional format rule at the given index, or moves a conditional format rule to another index.DeleteConditionalFormatRuleRequest
Deletes a conditional format rule at the given index. All subsequent rules’ indexes are decremented.SortRangeRequest
Sorts data in rows based on a sort order per column.SetDataValidationRequest
Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.SetBasicFilterRequest
Sets the basic filter associated with a sheet.AddProtectedRangeRequest
Adds a new protected range.UpdateProtectedRangeRequest
Updates an existing protected range with the specified protectedRangeId.DeleteProtectedRangeRequest
Deletes the protected range with the given ID.AutoResizeDimensionsRequest
Automatically resizes one or more dimensions based on the contents of the cells in that dimension.AddChartRequest
Adds a chart to a sheet in the spreadsheet.UpdateChartSpecRequest
Updates a chart’s specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)UpdateBandingRequest
Updates properties of the supplied banded range.AddBandingRequest
Adds a new banded range to the spreadsheet.DeleteBandingRequest
Removes the banded range with the given ID from the spreadsheet.CreateDeveloperMetadataRequest
A request to create developer metadata.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.DeleteDeveloperMetadataRequest
A request to delete developer metadata.RandomizeRangeRequest
Randomizes the order of the rows in a range.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].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.UpdateDimensionGroupRequest
Updates the state of the specified group.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.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.UpdateEmbeddedObjectBorderRequest
Updates an embedded object’s border property.AddSlicerRequest
Adds a slicer to a sheet in the spreadsheet.UpdateSlicerSpecRequest
Updates a slicer’s specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest.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 additionalbigquery.readonly OAuth scope if you are adding a BigQuery data source.
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 additionalbigquery.readonly OAuth scope if you are updating a BigQuery data source.
DeleteDataSourceRequest
Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects.RefreshDataSourceRequest
Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additionalbigquery.readonly OAuth scope if you are refreshing a BigQuery data source. 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.
DataSourceObjectReferences
A list of references to data source objects.DataSourceObjectReference
Reference to a data source object.CancelDataSourceRefreshRequest
Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additionalbigquery.readonly OAuth scope if you are cancelling a refresh on a BigQuery data source.