google_api_sheets v0.2.0 API Reference
Modules
API calls for all endpoints tagged Spreadsheets
Handle Tesla connections for GoogleApi.Sheets.V4
Helper functions for deserializing responses into models
Adds a new banded range to the spreadsheet
The result of adding a banded range
Adds a chart to a sheet in the spreadsheet
The result of adding a chart to a spreadsheet
Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented
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]
The result of adding a group
Adds a filter view
The result of adding a filter view
Adds a named range to the spreadsheet
The result of adding a named range
Adds a new protected range
The result of adding a new protected range
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
The result of adding a sheet
Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary
Appends rows or columns to the end of a sheet
The response when updating a range of values in a spreadsheet
Fills in more data based on existing data
Automatically resizes one or more dimensions based on the contents of the cells in that dimension
A banded (alternating colors) range in a sheet
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
An axis of the chart. A chart may not have more than one axis per axis position
The domain of a chart. For example, if charting stock prices over time, this would be the date
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"
The specification for a basic chart. See BasicChartType for the list of charts this supports
The default filter associated with a sheet
The request for clearing more than one range selected by a DataFilter in a spreadsheet
The response when clearing a range of values selected with DataFilters in a spreadsheet
The request for clearing more than one range of values in a spreadsheet
The response when clearing a range of values in a spreadsheet
The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters
The response when retrieving more than one range of values in a spreadsheet selected by DataFilters
The response when retrieving more than one range of values in a spreadsheet
The request for updating any aspect of a spreadsheet
The reply for batch updating a spreadsheet
The request for updating more than one range of values in a spreadsheet
The response when updating a range of values in a spreadsheet
The request for updating more than one range of values in a spreadsheet
The response when updating a range of values in a spreadsheet
A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters
A rule that may or may not match, depending on the condition
A border along a cell
The borders of the cell
A <a href="/chart/interactive/docs/gallery/bubblechart">bubble chart</a>
A <a href="/chart/interactive/docs/gallery/candlestickchart">candlestick chart</a>
The Candlestick chart data, each containing the low, open, close, and high values for a series
The domain of a CandlestickChart
The series of a CandlestickData
Data about a specific cell
The format of a cell
The data included in a domain or series
Source ranges for a chart
The specifications of a chart
Clears the basic filter, if any exists on the sheet
The request for clearing a range of values in a spreadsheet
The response when clearing a range of values in a spreadsheet
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.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, as well. Note: this proto does not 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. 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(rgbcolor) { 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 = rgbcolor.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(''); }; //
The value of the condition
A rule describing a conditional format
Copies data from the source to the destination
The request to copy a sheet across spreadsheets
A request to create developer metadata
The response from creating developer metadata
Moves data from the source to the destination
Filter that describes what data should be selected or returned from a request
A range of values whose location is specified by a DataFilter
A data validation 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 | ... +--------------+--------------+
Removes the banded range with the given ID from the spreadsheet
Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented
The result of deleting a conditional format rule
A request to delete developer metadata
The response from deleting developer metadata
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
The result of deleting a group
Deletes the dimensions from the sheet
Deletes the embedded object with the given ID
Deletes a particular filter view
Removes the named range with the given ID from the spreadsheet
Deletes the protected range with the given ID
Deletes a range of cells, shifting other cells into the deleted area
Deletes the requested sheet
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
A location where metadata may be associated in a spreadsheet
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
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
Properties about a dimension
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
Duplicates a particular filter view
The result of a filter view being duplicated
Duplicates the contents of a sheet
The result of duplicating a sheet
The editors of a protected range
A chart embedded in a sheet
The position of an embedded object such as a chart
An error in a cell
The kinds of value that a cell in a spreadsheet can have
Criteria for showing/hiding rows in a filter or filter view
A filter view
Finds and replaces data in cells over a range, sheet, or all sheets
The result of the find/replace
The request for retrieving a Spreadsheet
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
A coordinate in a sheet. All indexes are zero-based
Data in the grid, as well as metadata about the dimensions
Properties of a grid
A range on a sheet. All indexes are zero-based. Indexes are half open, e.g 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: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The 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!`
A <a href="/chart/interactive/docs/gallery/histogram">histogram chart</a>. 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
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 | +-------------+-------------------+
A histogram series containing the series color and data
Inserts rows or columns in a sheet at a particular index
Inserts cells into a range, shifting the existing cells over or down
A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen
Settings to control how circular dependencies are resolved with iterative calculation
Properties that describe the style of a line
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 | ... +-----------+-------------------+
A group name and a list of items from the source data that should be placed in the group with this name
A developer metadata entry and the data filters specified in the original request that matched it
A value range that was matched by one or more data filers
Merges all cells in the range
Moves one or more rows or columns
A named range
The number format of a cell
An <a href="/chart/interactive/docs/gallery/orgchart">org chart</a>. 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"
The location an object is overlaid on top of a grid
The amount of padding around the cell, in pixels. When updating padding, every field must be specified
Inserts data into the spreadsheet starting at the specified coordinate
A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>
Criteria for showing/hiding rows in a pivot table
A single grouping (either row or column) in a pivot table
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
Information about which values in a pivot group should be used for sorting
Metadata about a value in a pivot grouping
A pivot table
The definition of how a value in a pivot table should be calculated
A protected range
Randomizes the order of the rows in a range
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
A single kind of update to apply to a spreadsheet
A single response from an update
Data about each cell in a row
A request to retrieve all developer metadata matching the set of specified criteria
A reply to a developer metadata search request
Sets the basic filter associated with a sheet
Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified
A sheet in a spreadsheet
Properties of a sheet
Sorts data in rows based on a sort order per column
A sort order associated with a specific column or row
A combination of a source range and how to extend that source
Resource that represents a spreadsheet
Properties of a spreadsheet
The format of a run of text in a cell. Absent values indicate that the field isn't specified
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
Position settings for text
The rotation applied to text in a cell
Splits a column of text into multiple columns, based on a delimiter in each cell
A color scale for a treemap chart
A <a href="/chart/interactive/docs/gallery/treemap">Treemap chart</a>
Unmerges cells in the given range
Updates properties of the supplied banded range
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
Updates all cells in a range with new data
Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)
Updates a conditional format rule at the given index, or moves a conditional format rule to another index
The result of updating a conditional format rule
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
The response from updating developer metadata
Updates the state of the specified group
Updates properties of dimensions within the specified range
Update an embedded object's position (such as a moving or resizing a chart or image)
The result of updating an embedded object's position
Updates properties of the filter view
Updates properties of the named range with the specified namedRangeId
Updates an existing protected range with the specified protectedRangeId
Updates properties of the sheet with the specified sheetId
Updates properties of a spreadsheet
The response when updating a range of values by a data filter in a spreadsheet
The response when updating a range of values in a spreadsheet
Data within a range of the spreadsheet
Styles for a waterfall chart column
A custom subtotal column for a waterfall chart series
The domain of a waterfall chart
A single series of data for a waterfall chart
A waterfall chart
Helper functions for building Tesla requests