Expand description
The data types sent to and returned from the API client.
Structs§
- AddBanding
Request - Adds a new banded range to the spreadsheet.
- AddBanding
Response - The result of adding a banded range.
- AddChart
Request - Adds a chart to a sheet in the spreadsheet.
- AddChart
Response - The result of adding a chart to a spreadsheet.
- AddConditional
Format Rule Request - Adds a new conditional format rule at the given index. All subsequent rules’ indexes are incremented.
- AddData
Source Request - 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 additional
bigquery.readonlyOAuth scope. - AddData
Source Response - The result of adding a data source.
- AddDimension
Group Request - 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].
- AddDimension
Group Response - The result of adding a group.
- AddFilter
View Request - Adds a filter view.
- AddFilter
View Response - The result of adding a filter view.
- AddNamed
Range Request - Adds a named range to the spreadsheet.
- AddNamed
Range Response - The result of adding a named range.
- AddProtected
Range Request - Adds a new protected range.
- AddProtected
Range Response - The result of adding a new protected range.
- AddSheet
Request - 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.
- AddSheet
Response - The result of adding a sheet.
- AddSlicer
Request - Adds a slicer to a sheet in the spreadsheet.
- AddSlicer
Response - The result of adding a slicer to a spreadsheet.
- Append
Cells Request - Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.
- Append
Dimension Request - Appends rows or columns to the end of a sheet.
- Append
Values Response - The response when updating a range of values in a spreadsheet.
- Auto
Fill Request - Fills in more data based on existing data.
- Auto
Resize Dimensions Request - Automatically resizes one or more dimensions based on the contents of the cells in that dimension.
- Banded
Range - A banded (alternating colors) range in a sheet.
- Banding
Properties - 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.
- Baseline
Value Format - Formatting options for baseline value.
- Basic
Chart Axis - An axis of the chart. A chart may not have more than one axis per axis position.
- Basic
Chart Domain - The domain of a chart. For example, if charting stock prices over time, this would be the date.
- Basic
Chart Series - 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”.
- Basic
Chart Spec - The specification for a basic chart. See BasicChartType for the list of charts this supports.
- Basic
Filter - The default filter associated with a sheet.
- Basic
Series Data Point Style Override - Style override settings for a single series data point.
- Batch
Clear Values ByData Filter Request - The request for clearing more than one range selected by a DataFilter in a spreadsheet.
- Batch
Clear Values ByData Filter Response - The response when clearing a range of values selected with DataFilters in a spreadsheet.
- Batch
Clear Values Request - The request for clearing more than one range of values in a spreadsheet.
- Batch
Clear Values Response - The response when clearing a range of values in a spreadsheet.
- Batch
GetValues ByData Filter Request - The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
- Batch
GetValues ByData Filter Response - The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.
- Batch
GetValues Response - The response when retrieving more than one range of values in a spreadsheet.
- Batch
Update Spreadsheet Request - The request for updating any aspect of a spreadsheet.
- Batch
Update Spreadsheet Response - The reply for batch updating a spreadsheet.
- Batch
Update Values ByData Filter Request - The request for updating more than one range of values in a spreadsheet.
- Batch
Update Values ByData Filter Response - The response when updating a range of values in a spreadsheet.
- Batch
Update Values Request - The request for updating more than one range of values in a spreadsheet.
- Batch
Update Values Response - The response when updating a range of values in a spreadsheet.
- BigQuery
Data Source Spec - The specification of a BigQuery data source that’s connected to a sheet.
- BigQuery
Spec - Specifies a custom BigQuery query.
- BigQuery
Table Spec - Specifies a BigQuery table definition. Only native tables is allowed.
- Boolean
Condition - A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.
- Boolean
Rule - A rule that may or may not match, depending on the condition.
- Border
- A border along a cell.
- Borders
- The borders of the cell.
- Bubble
Chart Spec - A bubble chart.
- Candlestick
Chart Spec - A candlestick chart.
- Candlestick
Data - The Candlestick chart data, each containing the low, open, close, and high values for a series.
- Candlestick
Domain - The domain of a CandlestickChart.
- Candlestick
Series - The series of a CandlestickData.
- Cell
Data - Data about a specific cell.
- Cell
Format - The format of a cell.
- Chart
Axis View Window Options - The options that define a “view window” for a chart (such as the visible values in an axis).
- Chart
Custom Number Format Options - Custom number formatting options for chart attributes.
- Chart
Data - The data included in a domain or series.
- Chart
Date Time Rule - 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.
- Chart
Group Rule - 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.
- Chart
Histogram Rule - Allows you to organize numeric values in a source data column into buckets of constant size.
- Chart
Source Range - Source ranges for a chart.
- Chart
Spec - The specifications of a chart.
- Clear
Basic Filter Request - Clears the basic filter, if any exists on the sheet.
- Clear
Values Request - The request for clearing a range of values in a spreadsheet.
- Clear
Values Response - The response when clearing a range of values in a spreadsheet.
- Color
- Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of
java.awt.Colorin Java; it can also be trivially provided to UIColor’s+colorWithRed:green:blue:alphamethod in iOS; and, with just a little work, it can be easily formatted into a CSSrgba()string in JavaScript. This reference page doesn’t carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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(‘’); }; // … - Color
Style - A color value.
- Condition
Value - The value of the condition.
- Conditional
Format Rule - A rule describing a conditional format.
- Copy
Paste Request - Copies data from the source to the destination.
- Copy
Sheet Another Spreadsheet Request - The request to copy a sheet across spreadsheets.
- Create
Developer Metadata Request - A request to create developer metadata.
- Create
Developer Metadata Response - The response from creating developer metadata.
- CutPaste
Request - Moves data from the source to the destination.
- Data
Execution Status - The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects.
- Data
Filter - Filter that describes what data should be selected or returned from a request.
- Data
Filter Value Range - A range of values whose location is specified by a DataFilter.
- Data
Label - 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.
- Data
Source - Information about an external data source in the spreadsheet.
- Data
Source Chart Properties - Properties of a data source chart.
- Data
Source Column - A column in a data source.
- Data
Source Column Reference - An unique identifier that references a data source column.
- Data
Source Formula - A data source formula.
- Data
Source Object Reference - Reference to a data source object.
- Data
Source Object References - A list of references to data source objects.
- Data
Source Parameter - A parameter in a data source’s query. The parameter allows the user to pass in values from the spreadsheet into a query.
- Data
Source Refresh Daily Schedule - A schedule for data to refresh every day in a given time interval.
- Data
Source Refresh Monthly Schedule - A monthly schedule for data to refresh on specific days in the month in a given time interval.
- Data
Source Refresh Schedule - Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8am , the refresh will take place between 8am and 12pm every day.
- Data
Source Refresh Weekly Schedule - A weekly schedule for data to refresh on specific days in a given time interval.
- Data
Source Sheet Dimension Range - A range along a single dimension on a DATA_SOURCE sheet.
- Data
Source Sheet Properties - Additional properties of a DATA_SOURCE sheet.
- Data
Source Spec - This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.
- Data
Source Table - 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.
- Data
Validation Rule - A data validation rule.
- Date
Time Rule - 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 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | … +–––––+–––––––+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +–––––––+–––––––+ | Grouped Date | SUM of Sales | +–––––––+–––––––+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | … +–––––––+–––––––+
- Delete
Banding Request - Removes the banded range with the given ID from the spreadsheet.
- Delete
Conditional Format Rule Request - Deletes a conditional format rule at the given index. All subsequent rules’ indexes are decremented.
- Delete
Conditional Format Rule Response - The result of deleting a conditional format rule.
- Delete
Data Source Request - Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects.
- Delete
Developer Metadata Request - A request to delete developer metadata.
- Delete
Developer Metadata Response - The response from deleting developer metadata.
- Delete
Dimension Group Request - 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.
- Delete
Dimension Group Response - The result of deleting a group.
- Delete
Dimension Request - Deletes the dimensions from the sheet.
- Delete
Duplicates Request - 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.
- Delete
Duplicates Response - The result of removing duplicates in a range.
- Delete
Embedded Object Request - Deletes the embedded object with the given ID.
- Delete
Filter View Request - Deletes a particular filter view.
- Delete
Named Range Request - Removes the named range with the given ID from the spreadsheet.
- Delete
Protected Range Request - Deletes the protected range with the given ID.
- Delete
Range Request - Deletes a range of cells, shifting other cells into the deleted area.
- Delete
Sheet Request - Deletes the requested sheet.
- Developer
Metadata - Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and 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 will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.
- Developer
Metadata Location - A location where metadata may be associated in a spreadsheet.
- Developer
Metadata Lookup - Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified.
- Dimension
Group - 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.
- Dimension
Properties - Properties about a dimension.
- Dimension
Range - A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.
- Duplicate
Filter View Request - Duplicates a particular filter view.
- Duplicate
Filter View Response - The result of a filter view being duplicated.
- Duplicate
Sheet Request - Duplicates the contents of a sheet.
- Duplicate
Sheet Response - The result of duplicating a sheet.
- Editors
- The editors of a protected range.
- Embedded
Chart - A chart embedded in a sheet.
- Embedded
Object Border - A border along an embedded object.
- Embedded
Object Position - The position of an embedded object such as a chart.
- Error
Value - An error in a cell.
- Extended
Value - The kinds of value that a cell in a spreadsheet can have.
- Filter
Criteria - Criteria for showing/hiding rows in a filter or filter view.
- Filter
Spec - The filter criteria associated with a specific column.
- Filter
View - A filter view.
- Find
Replace Request - Finds and replaces data in cells over a range, sheet, or all sheets.
- Find
Replace Response - The result of the find/replace.
- GetSpreadsheet
ByData Filter Request - The request for retrieving a Spreadsheet.
- Gradient
Rule - 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.
- Grid
Coordinate - A coordinate in a sheet. All indexes are zero-based.
- Grid
Data - Data in the grid, as well as metadata about the dimensions.
- Grid
Properties - Properties of a grid.
- Grid
Range - A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive – [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if
"Sheet1"is sheet ID 0, then:Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2Sheet1 == sheet_id:0The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as#REF!. - Histogram
Chart Spec - 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.
- Histogram
Rule - 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 | $27.13 | | 17 | $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 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +———––+—————––+ | Grand Total | $29.12 | +———––+—————––+
- Histogram
Series - A histogram series containing the series color and data.
- Insert
Dimension Request - Inserts rows or columns in a sheet at a particular index.
- Insert
Range Request - Inserts cells into a range, shifting the existing cells over or down.
- Interpolation
Point - A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.
- Interval
- Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
- Iterative
Calculation Settings - Settings to control how circular dependencies are resolved with iterative calculation.
- KeyValue
Format - Formatting options for key value.
- Line
Style - Properties that describe the style of a line.
- Link
- An external or local reference.
- Manual
Rule - 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 | … +———–+—————––+
- Manual
Rule Group - A group name and a list of items from the source data that should be placed in the group with this name.
- Matched
Developer Metadata - A developer metadata entry and the data filters specified in the original request that matched it.
- Matched
Value Range - A value range that was matched by one or more data filers.
- Merge
Cells Request - Merges all cells in the range.
- Move
Dimension Request - Moves one or more rows or columns.
- Named
Range - A named range.
- Number
Format - The number format of a cell.
- OrgChart
Spec - 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”.
- Overlay
Position - The location an object is overlaid on top of a grid.
- Padding
- The amount of padding around the cell, in pixels. When updating padding, every field must be specified.
- Paste
Data Request - Inserts data into the spreadsheet starting at the specified coordinate.
- PieChart
Spec - A pie chart.
- Pivot
Filter Criteria - Criteria for showing/hiding rows in a pivot table.
- Pivot
Filter Spec - The pivot table filter criteria associated with a specific source column offset.
- Pivot
Group - A single grouping (either row or column) in a pivot table.
- Pivot
Group Limit - The count limit on rows or columns in the pivot group.
- Pivot
Group Rule - 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.
- Pivot
Group Sort Value Bucket - Information about which values in a pivot group should be used for sorting.
- Pivot
Group Value Metadata - Metadata about a value in a pivot grouping.
- Pivot
Table - A pivot table.
- Pivot
Value - The definition of how a value in a pivot table should be calculated.
- Point
Style - The style of a point on the chart.
- Protected
Range - A protected range.
- Randomize
Range Request - Randomizes the order of the rows in a range.
- Refresh
Data Source Object Execution Status - The execution status of refreshing one data source object.
- Refresh
Data Source Request - Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional
bigquery.readonlyOAuth scope. 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. - Refresh
Data Source Response - The response from refreshing one or multiple data source objects.
- Repeat
Cell Request - 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
=A1into 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$1to prevent both the row and the column from incrementing. - 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.
- Scorecard
Chart Spec - 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.
- Search
Developer Metadata Request - A request to retrieve all developer metadata matching the set of specified criteria.
- Search
Developer Metadata Response - A reply to a developer metadata search request.
- SetBasic
Filter Request - Sets the basic filter associated with a sheet.
- SetData
Validation Request - Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.
- Sheet
- A sheet in a spreadsheet.
- Sheet
Properties - Properties of a sheet.
- Slicer
- A slicer in a sheet.
- Slicer
Spec - The specifications of a slicer.
- Sort
Range Request - Sorts data in rows based on a sort order per column.
- Sort
Spec - A sort order associated with a specific column or row.
- Source
Destination - A combination of a source range and how to extend that source.
- Spreadsheet
- Resource that represents a spreadsheet.
- Spreadsheet
Properties - Properties of a spreadsheet.
- Spreadsheet
Theme - Represents spreadsheet theme
- Text
Columns Request - Splits a column of text into multiple columns, based on a delimiter in each cell.
- Text
Format - The format of a run of text in a cell. Absent values indicate that the field isn’t specified.
- Text
Format Run - 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.
- Text
Position - Position settings for text.
- Text
Rotation - The rotation applied to text in a cell.
- Theme
Color Pair - A pair mapping a spreadsheet theme color type to the concrete color it represents.
- Time
OfDay - Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and
google.protobuf.Timestamp. - Treemap
Chart Color Scale - A color scale for a treemap chart.
- Treemap
Chart Spec - A Treemap chart.
- Trim
Whitespace Request - 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.
- Trim
Whitespace Response - The result of trimming whitespace in cells.
- Unmerge
Cells Request - Unmerges cells in the given range.
- Update
Banding Request - Updates properties of the supplied banded range.
- Update
Borders Request - 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. - Update
Cells Request - Updates all cells in a range with new data.
- Update
Chart Spec Request - Updates a chart’s specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)
- Update
Conditional Format Rule Request - Updates a conditional format rule at the given index, or moves a conditional format rule to another index.
- Update
Conditional Format Rule Response - The result of updating a conditional format rule.
- Update
Data Source Request - 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 additional
bigquery.readonlyOAuth scope. - Update
Data Source Response - The response from updating data source.
- Update
Developer Metadata Request - 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.
- Update
Developer Metadata Response - The response from updating developer metadata.
- Update
Dimension Group Request - Updates the state of the specified group.
- Update
Dimension Properties Request - Updates properties of dimensions within the specified range.
- Update
Embedded Object Border Request - Updates an embedded object’s border property.
- Update
Embedded Object Position Request - Update an embedded object’s position (such as a moving or resizing a chart or image).
- Update
Embedded Object Position Response - The result of updating an embedded object’s position.
- Update
Filter View Request - Updates properties of the filter view.
- Update
Named Range Request - Updates properties of the named range with the specified namedRangeId.
- Update
Protected Range Request - Updates an existing protected range with the specified protectedRangeId.
- Update
Sheet Properties Request - Updates properties of the sheet with the specified sheetId.
- Update
Slicer Spec Request - Updates a slicer’s specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest.
- Update
Spreadsheet Properties Request - Updates properties of a spreadsheet.
- Update
Values ByData Filter Response - The response when updating a range of values by a data filter in a spreadsheet.
- Update
Values Response - The response when updating a range of values in a spreadsheet.
- Value
Range - Data within a range of the spreadsheet.
- Waterfall
Chart Column Style - Styles for a waterfall chart column.
- Waterfall
Chart Custom Subtotal - A custom subtotal column for a waterfall chart series.
- Waterfall
Chart Domain - The domain of a waterfall chart.
- Waterfall
Chart Series - A single series of data for a waterfall chart.
- Waterfall
Chart Spec - A waterfall chart.
Enums§
- Aggregate
Type - The aggregation type for the series of a data source chart. Only supported for data source charts.
- Alt
- Data format for response.
- Auto
Recalc - The amount of time to wait before volatile functions are recalculated.
- Boolean
Condition Type - The type of condition.
- Bubble
Chart Spec Legend Position - Where the legend of the chart should be drawn.
- Calculated
Display Type - If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as “Show As” in the value section of a pivot table.
- Chart
Date Time Rule Type - The type of date-time grouping to apply.
- Color
Type - The type of the spreadsheet theme color.
- Column
Selection Type - The type to select columns for the data source table. Defaults to SELECTED.
- Compare
Mode - The behavior of tooltips and data highlighting when hovering on data and chart area.
- Comparison
Type - The comparison type of key value with baseline value.
- Data
Label Type - The type of the data label.
- Date
Time Render Option - How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
- Date
Time Rule Type - The type of date-time grouping to apply.
- Days
OfWeek - Delimiter
Type - The delimiter type to use.
- Dimension
- Whether rows or columns should be appended.
- Error
Code - The error code.
- Error
Value Type - The type of error.
- Hidden
Dimension Strategy - Determines how the charts will use hidden rows or columns.
- Histogram
Chart Spec Legend Position - The position of the chart legend.
- Horizontal
Alignment - The horizontal alignment of the value in the cell.
- Hyperlink
Display Type - How a hyperlink, if it exists, should be displayed in the cell.
- Insert
Data Option - How the input data should be inserted.
- Interpolation
Point Type - How the value should be interpreted.
- Legend
Position - The position of the chart legend.
- Line
Style Type - The dash type of the line.
- Location
Matching Strategy - Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
- Location
Type - The type of location this object represents. This field is read-only.
- Merge
Type - How the cells should be merged.
- Node
Size - The size of the org chart nodes.
- Number
Format Source - The number format source used in the scorecard chart. This field is optional.
- Number
Format Type - The type of the number format. When writing, this field must be set.
- Paste
Orientation - How that data should be oriented when pasting.
- Paste
Type - What kind of data to paste.
- PieChart
Spec Legend Position - Where the legend of the pie chart should be drawn.
- Placement
- The placement of the data label relative to the labeled data.
- Position
- The position of this axis.
- Refresh
Scope - The scope of the refresh. Must be ALL_DATA_SOURCES.
- Relative
Date - A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters.
- Shape
- The point shape. If empty or unspecified, a default shape is used.
- Sheet
Type - The type of sheet. Defaults to GRID. This field cannot be changed once set.
- Sort
Order - The order the values in this group should be sorted.
- Stacked
Type - The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.
- State
- The state of the data execution.
- Style
- The style of the border.
- Summarize
Function - A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then
CUSTOMis not supported. - Text
Direction - The direction of the text in the cell.
- Type
- The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.
- Value
Input Option - How the input data should be interpreted.
- Value
Layout - Whether values should be listed horizontally (as columns) or vertically (as rows).
- Value
Render Option - How values should be represented in the output. The default render option is FORMATTED_VALUE.
- Vertical
Alignment - The vertical alignment of the value in the cell.
- View
Window Mode - The view window’s mode.
- Visibility
- The metadata visibility. Developer metadata must always have a visibility specified.
- Waterfall
Chart Spec Stacked Type - The stacked type.
- Wrap
Strategy - The wrap strategy for the value in the cell.
- Xgafv
- V1 error format.