diff --git a/.gitignore b/.gitignore
index c831ca6e6..d974132f2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,4 @@ scratch.R
old
docs/
*.xlsx
+pkgdown
diff --git a/DESCRIPTION b/DESCRIPTION
index 8021a78aa..61aff2220 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,6 +1,6 @@
Package: googlesheets4
Title: Access Google Sheets using the Sheets API V4
-Version: 0.1.0
+Version: 0.1.1
Authors@R:
c(person(given = "Jennifer",
family = "Bryan",
@@ -46,4 +46,4 @@ Encoding: UTF-8
Language: en-US
LazyData: true
Roxygen: list(markdown = TRUE)
-RoxygenNote: 6.1.99.9001
+RoxygenNote: 7.1.0
diff --git a/NAMESPACE b/NAMESPACE
index bed378311..1db2ea9d2 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,19 +1,19 @@
# Generated by roxygen2: do not edit by hand
-S3method(as_sheets_id,NULL)
+S3method(as_sheets_id,"NULL")
S3method(as_sheets_id,character)
S3method(as_sheets_id,default)
S3method(as_sheets_id,dribble)
S3method(as_sheets_id,drive_id)
S3method(as_sheets_id,sheets_id)
-S3method(ctype,NULL)
+S3method(ctype,"NULL")
S3method(ctype,SHEETS_CELL)
S3method(ctype,character)
S3method(ctype,default)
S3method(ctype,list)
S3method(format,sheets_meta)
S3method(print,sheets_meta)
-export(`%>%`)
+export("%>%")
export(anchored)
export(as_sheets_id)
export(cell_cols)
@@ -47,8 +47,8 @@ importFrom(cellranger,cell_rows)
importFrom(glue,glue)
importFrom(glue,glue_collapse)
importFrom(glue,glue_data)
-importFrom(magrittr,`%>%`)
-importFrom(purrr,`%||%`)
+importFrom(magrittr,"%>%")
+importFrom(purrr,"%||%")
importFrom(purrr,map)
importFrom(purrr,map2)
importFrom(purrr,map_chr)
diff --git a/NEWS.md b/NEWS.md
index fdcb8c40f..358e85460 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,3 +1,8 @@
+# googlesheets4 0.1.1
+
+* Patch release to modify a test fixture, to be compatible with tibble v3.0.
+ Related to tibble's increased type strictness.
+
# googlesheets4 0.1.0
* Added a `NEWS.md` file to track changes to the package.
diff --git a/R/sysdata.rda b/R/sysdata.rda
index 331c560c9..7b8a1d17a 100644
Binary files a/R/sysdata.rda and b/R/sysdata.rda differ
diff --git a/README.Rmd b/README.Rmd
index 575539be9..084df88c9 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -19,9 +19,6 @@ googlesheets4::sheets_deauth()
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://CRAN.R-project.org/package=googlesheets4)
-[](https://travis-ci.org/tidyverse/googlesheets4)
-[](https://ci.appveyor.com/project/tidyverse/googlesheets4)
-[](https://codecov.io/github/tidyverse/googlesheets4?branch=master)
<!-- badges: end -->
googlesheets4 provides an R interface to [Google Sheets](https://spreadsheets.google.com/) via the [Sheets API v4](https://developers.google.com/sheets/api/). It is a reboot of the existing [googlesheets package](https://cran.r-project.org/package=googlesheets).
diff --git a/README.md b/README.md
index 6b53528bf..fdc0eaab3 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,6 @@
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://CRAN.R-project.org/package=googlesheets4)
-[](https://travis-ci.org/tidyverse/googlesheets4)
-[](https://ci.appveyor.com/project/tidyverse/googlesheets4)
-[](https://codecov.io/github/tidyverse/googlesheets4?branch=master)
<!-- badges: end -->
googlesheets4 provides an R interface to [Google
@@ -79,13 +73,13 @@ sheets_example("chicken-sheet") %>%
#> Reading from 'chicken-sheet'
#>
#> # A tibble: 5 x 4
-#> chicken breed sex motto
-#> <chr> <chr> <chr> <chr>
-#> 1 Foghorn Leghorn Leghorn roost… That's a joke, ah say, that's a jo…
-#> 2 Chicken Little unknown hen The sky is falling!
-#> 3 Ginger Rhode Islan… hen Listen. We'll either die free chic…
-#> 4 Camilla the Chic… Chantecler hen Bawk, buck, ba-gawk.
-#> 5 Ernie The Giant … Brahma roost… Put Captain Solo in the cargo hold.
+#> chicken breed sex motto
+#> <chr> <chr> <chr> <chr>
+#> 1 Foghorn Leghorn Leghorn roost… That's a joke, ah say, that's a joke,…
+#> 2 Chicken Little unknown hen The sky is falling!
+#> 3 Ginger Rhode Island… hen Listen. We'll either die free chicken…
+#> 4 Camilla the Chick… Chantecler hen Bawk, buck, ba-gawk.
+#> 5 Ernie The Giant C… Brahma roost… Put Captain Solo in the cargo hold.
```
Read specific cells, from a specific sheet, using an A1-style notation:
@@ -96,19 +90,18 @@ sheets_example("deaths") %>%
#> Reading from 'deaths'
#> Range "'arts'!A5:F15"
#> # A tibble: 10 x 6
-#> Name Profession Age `Has kids` `Date of birth`
-#> <chr> <chr> <dbl> <lgl> <dttm>
-#> 1 Davi… musician 69 TRUE 1947-01-08 00:00:00
-#> 2 Carr… actor 60 TRUE 1956-10-21 00:00:00
-#> 3 Chuc… musician 90 TRUE 1926-10-18 00:00:00
-#> 4 Bill… actor 61 TRUE 1955-05-17 00:00:00
-#> 5 Prin… musician 57 TRUE 1958-06-07 00:00:00
-#> 6 Alan… actor 69 FALSE 1946-02-21 00:00:00
-#> 7 Flor… actor 82 TRUE 1934-02-14 00:00:00
-#> 8 Harp… author 89 FALSE 1926-04-28 00:00:00
-#> 9 Zsa … actor 99 TRUE 1917-02-06 00:00:00
-#> 10 Geor… musician 53 FALSE 1963-06-25 00:00:00
-#> # … with 1 more variable: `Date of death` <dttm>
+#> Name Profession Age `Has kids` `Date of birth` `Date of death`
+#> <chr> <chr> <dbl> <lgl> <dttm> <dttm>
+#> 1 David Bo… musician 69 TRUE 1947-01-08 00:00:00 2016-01-10 00:00:00
+#> 2 Carrie F… actor 60 TRUE 1956-10-21 00:00:00 2016-12-27 00:00:00
+#> 3 Chuck Be… musician 90 TRUE 1926-10-18 00:00:00 2017-03-18 00:00:00
+#> 4 Bill Pax… actor 61 TRUE 1955-05-17 00:00:00 2017-02-25 00:00:00
+#> 5 Prince musician 57 TRUE 1958-06-07 00:00:00 2016-04-21 00:00:00
+#> 6 Alan Ric… actor 69 FALSE 1946-02-21 00:00:00 2016-01-14 00:00:00
+#> 7 Florence… actor 82 TRUE 1934-02-14 00:00:00 2016-11-24 00:00:00
+#> 8 Harper L… author 89 FALSE 1926-04-28 00:00:00 2016-02-19 00:00:00
+#> 9 Zsa Zsa … actor 99 TRUE 1917-02-06 00:00:00 2016-12-18 00:00:00
+#> 10 George M… musician 53 FALSE 1963-06-25 00:00:00 2016-12-25 00:00:00
```
Read from a named range or region and specify (some of the ) column
@@ -120,18 +113,18 @@ sheets_example("deaths") %>%
#> Reading from 'deaths'
#> Range "arts_data"
#> # A tibble: 10 x 6
-#> Name Profession Age `Has kids` `Date of birth` `Date of death`
-#> <chr> <chr> <int> <lgl> <date> <date>
-#> 1 David Bowie musician 69 TRUE 1947-01-08 2016-01-10
-#> 2 Carrie Fish… actor 60 TRUE 1956-10-21 2016-12-27
-#> 3 Chuck Berry musician 90 TRUE 1926-10-18 2017-03-18
-#> 4 Bill Paxton actor 61 TRUE 1955-05-17 2017-02-25
-#> 5 Prince musician 57 TRUE 1958-06-07 2016-04-21
-#> 6 Alan Rickman actor 69 FALSE 1946-02-21 2016-01-14
-#> 7 Florence He… actor 82 TRUE 1934-02-14 2016-11-24
-#> 8 Harper Lee author 89 FALSE 1926-04-28 2016-02-19
-#> 9 Zsa Zsa Gáb… actor 99 TRUE 1917-02-06 2016-12-18
-#> 10 George Mich… musician 53 FALSE 1963-06-25 2016-12-25
+#> Name Profession Age `Has kids` `Date of birth` `Date of death`
+#> <chr> <chr> <int> <lgl> <date> <date>
+#> 1 David Bowie musician 69 TRUE 1947-01-08 2016-01-10
+#> 2 Carrie Fisher actor 60 TRUE 1956-10-21 2016-12-27
+#> 3 Chuck Berry musician 90 TRUE 1926-10-18 2017-03-18
+#> 4 Bill Paxton actor 61 TRUE 1955-05-17 2017-02-25
+#> 5 Prince musician 57 TRUE 1958-06-07 2016-04-21
+#> 6 Alan Rickman actor 69 FALSE 1946-02-21 2016-01-14
+#> 7 Florence Henders… actor 82 TRUE 1934-02-14 2016-11-24
+#> 8 Harper Lee author 89 FALSE 1926-04-28 2016-02-19
+#> 9 Zsa Zsa Gábor actor 99 TRUE 1917-02-06 2016-12-18
+#> 10 George Michael musician 53 FALSE 1963-06-25 2016-12-25
```
There are various ways to specify the target Sheet. The simplest, but
@@ -144,13 +137,13 @@ read_sheet(url)
#> Reading from 'chicken-sheet'
#>
#> # A tibble: 5 x 4
-#> chicken breed sex motto
-#> <chr> <chr> <chr> <chr>
-#> 1 Foghorn Leghorn Leghorn roost… That's a joke, ah say, that's a jo…
-#> 2 Chicken Little unknown hen The sky is falling!
-#> 3 Ginger Rhode Islan… hen Listen. We'll either die free chic…
-#> 4 Camilla the Chic… Chantecler hen Bawk, buck, ba-gawk.
-#> 5 Ernie The Giant … Brahma roost… Put Captain Solo in the cargo hold.
+#> chicken breed sex motto
+#> <chr> <chr> <chr> <chr>
+#> 1 Foghorn Leghorn Leghorn roost… That's a joke, ah say, that's a joke,…
+#> 2 Chicken Little unknown hen The sky is falling!
+#> 3 Ginger Rhode Island… hen Listen. We'll either die free chicken…
+#> 4 Camilla the Chick… Chantecler hen Bawk, buck, ba-gawk.
+#> 5 Ernie The Giant C… Brahma roost… Put Captain Solo in the cargo hold.
```
For more information, see the package website:
diff --git a/cran-comments.md b/cran-comments.md
index 700514c64..2c268e01d 100644
--- a/cran-comments.md
+++ b/cran-comments.md
@@ -1,55 +1,3 @@
-This is a resubmission.
-
-Original submission: 2018-10-18
-First CRAN Review: 2019-10-22
-
-Second submission: 2019-10-22
-Second CRAN Review: 2019-10-28
-
-The second reviewer brings up new things:
-
-> Please add small files needed for the examples in the inst/extdata
-> subfolder of your package and use system.file() to get the correct
-> package path. e.g. sheets_auth_configure.Rd
->
-> \dontrun{} should be only used if the example really cannot be executed
-> (e.g. because of missing additional software, missing API keys, ...) by
-> the user. That's why wrapping examples in \dontrun{} adds the comment
-> ("# Not run:") as a warning for the user.
-> Does not seem necessary.
-> Please replace \dontrun with \donttest.
-
-I have added the requested file, below inst/extdata/, even though it must be
-filled with fake data. We cannot ship an actual OAuth client ID and secret
-inside a CRAN package this way. As documented for sheets_auth_configure(), the
-user has to obtain this JSON for themselves from Google Cloud Platform Console.
-But this JSON has valid structure and eliminates a \dontrun{}.
-
----
-
-Response to the first review:
-
-The reviewer asked for more details in the description and to explain all acronyms. I have added:
-
- * An explanation that API = "application programming interface" and a
- description of what that means.
- * An explanation that v4 = "version 4" of the Sheets API.
- * A statement that googlesheets4 lets a user retrieve metadata and data
- out of a Google Sheet.
-
-## Test environments
-
-* local macOS 10.14 Mojave, R 3.6.0
-* local Windows 10 VM, R 3.6.0
-* win-builder (devel)
-* Windows Server 2008 R2 SP1, R-devel, 32/64 bit, r-hub
-* Windows Server 2012 R2 x64 (on appveyor), R 3.6.1 Patched
-* Ubuntu 16.04 (on travis-ci), R devel through 3.2
-* Ubuntu Linux 16.04 LTS, R-release, GCC on r-hub
-* Fedora Linux, R-devel, clang, gfortran on r-hub
-
-## R CMD check results
-
-0 errors | 0 warnings | 1 note
-
-* This is a new submission.
+This is small patch release to update a test fixture in anticipation of the
+release of tibble. It also includes an updated internal data object, reflecting
+the Sheets v4 API surface as of today.
diff --git a/data-raw/sheets-v4_2019-09-29.json b/data-raw/sheets-v4_2020-03-12.json
similarity index 86%
rename from data-raw/sheets-v4_2019-09-29.json
rename to data-raw/sheets-v4_2020-03-12.json
index baf7cf193..c683f4d98 100644
--- a/data-raw/sheets-v4_2019-09-29.json
+++ b/data-raw/sheets-v4_2020-03-12.json
@@ -1,5382 +1,271 @@
{
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "Editors": {
- "description": "The editors of a protected range.",
- "type": "object",
- "properties": {
- "users": {
- "description": "The email addresses of users with edit access to the protected range.",
- "type": "array",
- "items": {
- "type": "string"
+ "batchPath": "batch",
+ "mtlsRootUrl": "https://sheets.mtls.googleapis.com/",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Sheets API",
+ "ownerName": "Google",
+ "resources": {
+ "spreadsheets": {
+ "methods": {
+ "get": {
+ "flatPath": "v4/spreadsheets/{spreadsheetId}",
+ "path": "v4/spreadsheets/{spreadsheetId}",
+ "id": "sheets.spreadsheets.get",
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "parameters": {
+ "ranges": {
+ "description": "The ranges to retrieve from the spreadsheet.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "includeGridData": {
+ "location": "query",
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet to request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
}
},
- "groups": {
- "description": "The email addresses of groups with edit access to the protected range.",
- "type": "array",
- "items": {
- "type": "string"
+ "getByDataFilter": {
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
+ "id": "sheets.spreadsheets.getByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.",
+ "request": {
+ "$ref": "GetSpreadsheetByDataFilterRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "Spreadsheet"
}
},
- "domainUsersCanEdit": {
- "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
- "type": "boolean"
- }
- },
- "id": "Editors"
- },
- "UpdateConditionalFormatRuleRequest": {
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
- "type": "object",
- "properties": {
- "index": {
- "description": "The zero-based index of the rule that should be replaced or moved.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
- "format": "int32",
- "type": "integer"
- },
- "newIndex": {
- "type": "integer",
- "description": "The zero-based new index the rule should end up at.",
- "format": "int32"
- },
- "rule": {
- "description": "The rule that should replace the rule at the given index.",
- "$ref": "ConditionalFormatRule"
- }
- },
- "id": "UpdateConditionalFormatRuleRequest"
- },
- "DataValidationRule": {
- "description": "A data validation rule.",
- "type": "object",
- "properties": {
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition that data in the cell must match."
- },
- "showCustomUi": {
- "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
- "type": "boolean"
- },
- "strict": {
- "description": "True if invalid data should be rejected.",
- "type": "boolean"
- },
- "inputMessage": {
- "description": "A message to show the user when adding data to the cell.",
- "type": "string"
- }
- },
- "id": "DataValidationRule"
- },
- "BasicChartDomain": {
- "id": "BasicChartDomain",
- "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
- "type": "object",
- "properties": {
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
- }
- }
- },
- "PasteDataRequest": {
- "properties": {
- "coordinate": {
- "$ref": "GridCoordinate",
- "description": "The coordinate at which the data should start being inserted."
- },
- "data": {
- "description": "The data to insert.",
- "type": "string"
- },
- "delimiter": {
- "type": "string",
- "description": "The delimiter in the data."
- },
- "type": {
- "description": "How the data should be pasted.",
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
+ "create": {
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ]
+ "flatPath": "v4/spreadsheets",
+ "path": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create"
},
- "html": {
- "description": "True if the data is HTML.",
- "type": "boolean"
- }
- },
- "id": "PasteDataRequest",
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
- "type": "object"
- },
- "UpdateDeveloperMetadataResponse": {
- "description": "The response from updating developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The updated developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
+ "batchUpdate": {
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to apply the updates to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "id": "sheets.spreadsheets.batchUpdate",
+ "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.",
+ "request": {
+ "$ref": "BatchUpdateSpreadsheetRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST"
}
},
- "id": "UpdateDeveloperMetadataResponse"
- },
- "AppendDimensionRequest": {
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The sheet to append rows or columns to.",
- "format": "int32",
- "type": "integer"
- },
- "dimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "Whether rows or columns should be appended.",
- "type": "string"
- },
- "length": {
- "description": "The number of rows or columns to append.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AppendDimensionRequest",
- "description": "Appends rows or columns to the end of a sheet."
- },
- "AddNamedRangeRequest": {
- "description": "Adds a named range to the spreadsheet.",
- "type": "object",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
- }
- },
- "id": "AddNamedRangeRequest"
- },
- "CreateDeveloperMetadataResponse": {
- "description": "The response from creating developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The developer metadata that was created."
- }
- },
- "id": "CreateDeveloperMetadataResponse"
- },
- "UpdateEmbeddedObjectPositionRequest": {
- "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the object to moved.",
- "format": "int32",
- "type": "integer"
- },
- "newPosition": {
- "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you.",
- "$ref": "EmbeddedObjectPosition"
- },
- "fields": {
- "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateEmbeddedObjectPositionRequest"
- },
- "TextRotation": {
- "properties": {
- "vertical": {
- "type": "boolean",
- "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |"
- },
- "angle": {
- "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the\ncounterclockwise direction, whereas for RTL they are in the clockwise\ndirection",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextRotation",
- "description": "The rotation applied to text in a cell.",
- "type": "object"
- },
- "DeleteDimensionGroupResponse": {
- "type": "object",
- "properties": {
- "dimensionGroups": {
- "description": "All groups of a dimension after deleting a group from that dimension.",
- "type": "array",
- "items": {
- "$ref": "DimensionGroup"
+ "resources": {
+ "sheets": {
+ "methods": {
+ "copyTo": {
+ "response": {
+ "$ref": "SheetProperties"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "sheetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet containing the sheet to copy.",
+ "required": true,
+ "type": "string"
+ },
+ "sheetId": {
+ "description": "The ID of the sheet to copy.",
+ "format": "int32",
+ "required": true,
+ "type": "integer",
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "id": "sheets.spreadsheets.sheets.copyTo",
+ "request": {
+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet."
+ }
}
- }
- },
- "id": "DeleteDimensionGroupResponse",
- "description": "The result of deleting a group."
- },
- "PieChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "series": {
- "description": "The data that covers the one and only series of the pie chart.",
- "$ref": "ChartData"
- },
- "legendPosition": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "Each pie slice has a label attached to it."
- ],
- "enum": [
- "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "LABELED_LEGEND"
- ],
- "description": "Where the legend of the pie chart should be drawn.",
- "type": "string"
- },
- "pieHole": {
- "description": "The size of the hole in the pie chart.",
- "format": "double",
- "type": "number"
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data that covers the domain of the pie chart."
},
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- }
- },
- "id": "PieChartSpec"
- },
- "UpdateDeveloperMetadataRequest": {
- "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "The filters matching the developer metadata entries to update.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
+ "developerMetadata": {
+ "methods": {
+ "search": {
+ "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.",
+ "request": {
+ "$ref": "SearchDeveloperMetadataRequest"
+ },
+ "response": {
+ "$ref": "SearchDeveloperMetadataResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve metadata from."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
+ "id": "sheets.spreadsheets.developerMetadata.search"
+ },
+ "get": {
+ "response": {
+ "$ref": "DeveloperMetadata"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "metadataId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "metadataId": {
+ "description": "The ID of the developer metadata to retrieve.",
+ "format": "int32",
+ "required": true,
+ "type": "integer",
+ "location": "path"
+ },
+ "spreadsheetId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve metadata from."
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
+ "id": "sheets.spreadsheets.developerMetadata.get",
+ "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId."
+ }
}
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The value that all metadata matched by the data filters will be updated to."
- }
- },
- "id": "UpdateDeveloperMetadataRequest"
- },
- "WaterfallChartColumnStyle": {
- "description": "Styles for a waterfall chart column.",
- "type": "object",
- "properties": {
- "color": {
- "$ref": "Color",
- "description": "The color of the column."
- },
- "label": {
- "description": "The label of the column's legend.",
- "type": "string"
- }
- },
- "id": "WaterfallChartColumnStyle"
- },
- "UpdateFilterViewRequest": {
- "description": "Updates properties of the filter view.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "filter": {
- "$ref": "FilterView",
- "description": "The new properties of the filter view."
- }
- },
- "id": "UpdateFilterViewRequest"
- },
- "ConditionalFormatRule": {
- "type": "object",
- "properties": {
- "ranges": {
- "description": "The ranges that are formatted if the condition is true.\nAll the ranges must be on the same grid.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "gradientRule": {
- "description": "The formatting will vary based on the gradients in the rule.",
- "$ref": "GradientRule"
- },
- "booleanRule": {
- "$ref": "BooleanRule",
- "description": "The formatting is either \"on\" or \"off\" according to the rule."
- }
- },
- "id": "ConditionalFormatRule",
- "description": "A rule describing a conditional format."
- },
- "CopyPasteRequest": {
- "description": "Copies data from the source to the destination.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The source range to copy."
- },
- "pasteType": {
- "description": "What kind of data to paste.",
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ]
- },
- "destination": {
- "$ref": "GridRange",
- "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
- },
- "pasteOrientation": {
- "enumDescriptions": [
- "Paste normally.",
- "Paste transposed, where all rows become columns and vice versa."
- ],
- "enum": [
- "NORMAL",
- "TRANSPOSE"
- ],
- "description": "How that data should be oriented when pasting.",
- "type": "string"
- }
- },
- "id": "CopyPasteRequest"
- },
- "BooleanCondition": {
- "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "The default value, do not use.",
- "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
- "The cell's value must be in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
- "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be TRUE/FALSE or in the list of condition values.\nSupported by data validation.\nRenders as a cell checkbox.\nSupports zero, one or two ConditionValues. No\nvalues indicates the cell must be TRUE or FALSE, where TRUE renders as\nchecked and FALSE renders as unchecked. One value indicates the cell\nwill render as checked when it contains that value and unchecked when it\nis blank. Two values indicate that the cell will render as checked when\nit contains the first value and unchecked when it contains the second\nvalue. For example, [\"Yes\",\"No\"] indicates that the cell will render a\nchecked box when it has the value \"Yes\" and an unchecked box when it has\nthe value \"No\"."
- ],
- "enum": [
- "CONDITION_TYPE_UNSPECIFIED",
- "NUMBER_GREATER",
- "NUMBER_GREATER_THAN_EQ",
- "NUMBER_LESS",
- "NUMBER_LESS_THAN_EQ",
- "NUMBER_EQ",
- "NUMBER_NOT_EQ",
- "NUMBER_BETWEEN",
- "NUMBER_NOT_BETWEEN",
- "TEXT_CONTAINS",
- "TEXT_NOT_CONTAINS",
- "TEXT_STARTS_WITH",
- "TEXT_ENDS_WITH",
- "TEXT_EQ",
- "TEXT_IS_EMAIL",
- "TEXT_IS_URL",
- "DATE_EQ",
- "DATE_BEFORE",
- "DATE_AFTER",
- "DATE_ON_OR_BEFORE",
- "DATE_ON_OR_AFTER",
- "DATE_BETWEEN",
- "DATE_NOT_BETWEEN",
- "DATE_IS_VALID",
- "ONE_OF_RANGE",
- "ONE_OF_LIST",
- "BLANK",
- "NOT_BLANK",
- "CUSTOM_FORMULA",
- "BOOLEAN"
- ],
- "description": "The type of condition.",
- "type": "string"
- },
"values": {
- "type": "array",
- "items": {
- "$ref": "ConditionValue"
- },
- "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values."
- }
- },
- "id": "BooleanCondition"
- },
- "Request": {
- "description": "A single kind of update to apply to a spreadsheet.",
- "type": "object",
- "properties": {
- "updateNamedRange": {
- "$ref": "UpdateNamedRangeRequest",
- "description": "Updates a named range."
- },
- "updateSheetProperties": {
- "$ref": "UpdateSheetPropertiesRequest",
- "description": "Updates a sheet's properties."
- },
- "deleteDimension": {
- "description": "Deletes rows or columns in a sheet.",
- "$ref": "DeleteDimensionRequest"
- },
- "autoFill": {
- "$ref": "AutoFillRequest",
- "description": "Automatically fills in more data based on existing data."
- },
- "sortRange": {
- "$ref": "SortRangeRequest",
- "description": "Sorts data in a range."
- },
- "deleteDimensionGroup": {
- "$ref": "DeleteDimensionGroupRequest",
- "description": "Deletes a group over the specified range."
- },
- "deleteProtectedRange": {
- "$ref": "DeleteProtectedRangeRequest",
- "description": "Deletes a protected range."
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewRequest",
- "description": "Duplicates a filter view."
- },
- "addChart": {
- "$ref": "AddChartRequest",
- "description": "Adds a chart."
- },
- "findReplace": {
- "$ref": "FindReplaceRequest",
- "description": "Finds and replaces occurrences of some text with other text."
- },
- "updateChartSpec": {
- "$ref": "UpdateChartSpecRequest",
- "description": "Updates a chart's specifications."
- },
- "textToColumns": {
- "$ref": "TextToColumnsRequest",
- "description": "Converts a column of text into many columns of text."
- },
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
- },
- "addSheet": {
- "$ref": "AddSheetRequest",
- "description": "Adds a sheet."
- },
- "copyPaste": {
- "$ref": "CopyPasteRequest",
- "description": "Copies data from one area and pastes it to another."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "insertDimension": {
- "description": "Inserts new rows or columns in a sheet.",
- "$ref": "InsertDimensionRequest"
- },
- "deleteRange": {
- "description": "Deletes a range of cells from a sheet, shifting the remaining cells.",
- "$ref": "DeleteRangeRequest"
- },
- "deleteBanding": {
- "description": "Removes a banded range",
- "$ref": "DeleteBandingRequest"
- },
- "addFilterView": {
- "description": "Adds a filter view.",
- "$ref": "AddFilterViewRequest"
- },
- "deleteDuplicates": {
- "$ref": "DeleteDuplicatesRequest",
- "description": "Removes rows containing duplicate values in specified columns of a cell\nrange."
- },
- "setDataValidation": {
- "description": "Sets data validation for one or more cells.",
- "$ref": "SetDataValidationRequest"
- },
- "updateBorders": {
- "description": "Updates the borders in a range of cells.",
- "$ref": "UpdateBordersRequest"
- },
- "deleteConditionalFormatRule": {
- "description": "Deletes an existing conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleRequest"
- },
- "repeatCell": {
- "description": "Repeats a single cell across a range.",
- "$ref": "RepeatCellRequest"
- },
- "clearBasicFilter": {
- "$ref": "ClearBasicFilterRequest",
- "description": "Clears the basic filter on a sheet."
- },
- "appendDimension": {
- "description": "Appends dimensions to the end of a sheet.",
- "$ref": "AppendDimensionRequest"
- },
- "createDeveloperMetadata": {
- "$ref": "CreateDeveloperMetadataRequest",
- "description": "Creates new developer metadata"
- },
- "updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleRequest",
- "description": "Updates an existing conditional format rule."
- },
- "insertRange": {
- "$ref": "InsertRangeRequest",
- "description": "Inserts new cells in a sheet, shifting the existing cells."
- },
- "deleteDeveloperMetadata": {
- "description": "Deletes developer metadata",
- "$ref": "DeleteDeveloperMetadataRequest"
- },
- "moveDimension": {
- "$ref": "MoveDimensionRequest",
- "description": "Moves rows or columns to another location in a sheet."
- },
- "randomizeRange": {
- "$ref": "RandomizeRangeRequest",
- "description": "Randomizes the order of the rows in a range."
- },
- "updateBanding": {
- "$ref": "UpdateBandingRequest",
- "description": "Updates a banded range"
- },
- "addProtectedRange": {
- "description": "Adds a protected range.",
- "$ref": "AddProtectedRangeRequest"
- },
- "deleteNamedRange": {
- "$ref": "DeleteNamedRangeRequest",
- "description": "Deletes a named range."
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetRequest",
- "description": "Duplicates a sheet."
- },
- "deleteSheet": {
- "description": "Deletes a sheet.",
- "$ref": "DeleteSheetRequest"
- },
- "unmergeCells": {
- "description": "Unmerges merged cells.",
- "$ref": "UnmergeCellsRequest"
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionRequest",
- "description": "Updates an embedded object's (e.g. chart, image) position."
- },
- "addDimensionGroup": {
- "description": "Creates a group over the specified range.",
- "$ref": "AddDimensionGroupRequest"
- },
- "updateDimensionProperties": {
- "$ref": "UpdateDimensionPropertiesRequest",
- "description": "Updates dimensions' properties."
- },
- "updateDeveloperMetadata": {
- "$ref": "UpdateDeveloperMetadataRequest",
- "description": "Updates an existing developer metadata entry"
- },
- "updateDimensionGroup": {
- "$ref": "UpdateDimensionGroupRequest",
- "description": "Updates the state of the specified group."
- },
- "pasteData": {
- "description": "Pastes data (HTML or delimited) into a sheet.",
- "$ref": "PasteDataRequest"
- },
- "setBasicFilter": {
- "$ref": "SetBasicFilterRequest",
- "description": "Sets the basic filter on a sheet."
- },
- "addConditionalFormatRule": {
- "$ref": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule."
- },
- "updateCells": {
- "description": "Updates many cells at once.",
- "$ref": "UpdateCellsRequest"
- },
- "addNamedRange": {
- "$ref": "AddNamedRangeRequest",
- "description": "Adds a named range."
- },
- "updateSpreadsheetProperties": {
- "description": "Updates the spreadsheet's properties.",
- "$ref": "UpdateSpreadsheetPropertiesRequest"
- },
- "trimWhitespace": {
- "description": "Trims cells of whitespace (such as spaces, tabs, or new lines).",
- "$ref": "TrimWhitespaceRequest"
- },
- "deleteEmbeddedObject": {
- "$ref": "DeleteEmbeddedObjectRequest",
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
- },
- "updateFilterView": {
- "description": "Updates the properties of a filter view.",
- "$ref": "UpdateFilterViewRequest"
- },
- "addBanding": {
- "$ref": "AddBandingRequest",
- "description": "Adds a new banded range"
- },
- "appendCells": {
- "$ref": "AppendCellsRequest",
- "description": "Appends cells after the last row with data in a sheet."
- },
- "autoResizeDimensions": {
- "$ref": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
- },
- "cutPaste": {
- "$ref": "CutPasteRequest",
- "description": "Cuts data from one area and pastes it to another."
- },
- "mergeCells": {
- "$ref": "MergeCellsRequest",
- "description": "Merges cells together."
- }
- },
- "id": "Request"
- },
- "WaterfallChartDomain": {
- "description": "The domain of a waterfall chart.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the WaterfallChartDomain."
- },
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "WaterfallChartDomain"
- },
- "GridRange": {
- "type": "object",
- "properties": {
- "endRowIndex": {
- "description": "The end row (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "endColumnIndex": {
- "description": "The end column (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "startRowIndex": {
- "description": "The start row (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "startColumnIndex": {
- "type": "integer",
- "description": "The start column (inclusive) of the range, or not set if unbounded.",
- "format": "int32"
- },
- "sheetId": {
- "description": "The sheet this range is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridRange",
- "description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`."
- },
- "BasicChartSpec": {
- "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
- "type": "object",
- "properties": {
- "domains": {
- "description": "The domain of data this is charting.\nOnly a single domain is supported.",
- "type": "array",
- "items": {
- "$ref": "BasicChartDomain"
- }
- },
- "lineSmoothing": {
- "description": "Gets whether all lines should be rendered smooth or straight by default.\nApplies to Line charts.",
- "type": "boolean"
- },
- "headerCount": {
- "description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)",
- "format": "int32",
- "type": "integer"
- },
- "stackedType": {
- "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, Combo, and Stepped Area charts.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "Series are not stacked.",
- "Series values are stacked, each value is rendered vertically beginning\nfrom the top of the value below it.",
- "Vertical stacks are stretched to reach the top of the chart, with\nvalues laid out as percentages of each other."
- ],
- "enum": [
- "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
- "NOT_STACKED",
- "STACKED",
- "PERCENT_STACKED"
- ]
- },
- "axis": {
- "description": "The axis on the chart.",
- "type": "array",
- "items": {
- "$ref": "BasicChartAxis"
- }
- },
- "threeDimensional": {
- "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
- "type": "boolean"
- },
- "chartType": {
- "enumDescriptions": [
- "Default value, do not use.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
- "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter\nchart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area\nchart\u003c/a\u003e."
- ],
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO",
- "STEPPED_AREA"
- ],
- "description": "The type of the chart.",
- "type": "string"
- },
- "interpolateNulls": {
- "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
- "type": "boolean"
- },
- "series": {
- "type": "array",
- "items": {
- "$ref": "BasicChartSeries"
- },
- "description": "The data this chart is visualizing."
- },
- "legendPosition": {
- "description": "The position of the chart legend.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered."
- ],
- "enum": [
- "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND"
- ]
- },
- "compareMode": {
- "enumDescriptions": [
- "Default value, do not use.",
- "Only the focused data element is highlighted and shown in the tooltip.",
- "All data elements with the same category (e.g., domain value) are\nhighlighted and shown in the tooltip."
- ],
- "enum": [
- "BASIC_CHART_COMPARE_MODE_UNSPECIFIED",
- "DATUM",
- "CATEGORY"
- ],
- "description": "The behavior of tooltips and data highlighting when hovering on data and\nchart area.",
- "type": "string"
- }
- },
- "id": "BasicChartSpec"
- },
- "AddDimensionGroupRequest": {
- "type": "object",
- "properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The range over which to create a group."
- }
- },
- "id": "AddDimensionGroupRequest",
- "description": "Creates a group over the specified range.\n\nIf the requested range is a superset of the range of an existing group G,\nthen the depth of G is incremented and this new group G' has the\ndepth of that group. For example, a group [C:D, depth 1] + [B:E] results in\ngroups [B:E, depth 1] and [C:D, depth 2].\nIf the requested range is a subset of the range of an existing group G,\nthen the depth of the new group G' becomes one greater than the depth of G.\nFor example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1]\nand [C:D, depth 2].\nIf the requested range starts before and ends within, or starts within and\nends after, the range of an existing group G, then the range of the existing\ngroup G becomes the union of the ranges, and the new group G' has\ndepth one greater than the depth of G and range as the intersection of the\nranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E,\ndepth 1] and [C:D, depth 2]."
- },
- "DeleteDimensionGroupRequest": {
- "properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The range of the group to be deleted."
- }
- },
- "id": "DeleteDimensionGroupRequest",
- "description": "Deletes a group over the specified range by decrementing the depth of the\ndimensions in the range.\n\nFor example, assume the sheet has a depth-1 group over B:E and a depth-2\ngroup over C:D. Deleting a group over D:E leaves the sheet with a\ndepth-1 group over B:D and a depth-2 group over C:C.",
- "type": "object"
- },
- "BubbleChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "series": {
- "$ref": "ChartData",
- "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
- },
- "legendPosition": {
- "description": "Where the legend of the chart should be drawn.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "The legend is rendered inside the chart area."
- ],
- "enum": [
- "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "INSIDE_LEGEND"
- ]
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
- },
- "bubbleSizes": {
- "$ref": "ChartData",
- "description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional."
- },
- "bubbleOpacity": {
- "description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.",
- "format": "float",
- "type": "number"
- },
- "bubbleBorderColor": {
- "description": "The bubble border color.",
- "$ref": "Color"
- },
- "bubbleTextStyle": {
- "$ref": "TextFormat",
- "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported."
- },
- "groupIds": {
- "description": "The data containing the bubble group IDs. All bubbles with the same group\nID are drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional.",
- "$ref": "ChartData"
- },
- "bubbleLabels": {
- "$ref": "ChartData",
- "description": "The data containing the bubble labels. These do not need to be unique."
- },
- "bubbleMinRadiusSize": {
- "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.",
- "format": "int32",
- "type": "integer"
- },
- "bubbleMaxRadiusSize": {
- "description": "The max radius size of the bubbles, in pixels.\nIf specified, the field must be a positive value.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "BubbleChartSpec"
- },
- "SetDataValidationRequest": {
- "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.",
- "type": "object",
- "properties": {
- "rule": {
- "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range.",
- "$ref": "DataValidationRule"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range the data validation rule should apply to."
- }
- },
- "id": "SetDataValidationRequest"
- },
- "CellData": {
- "description": "Data about a specific cell.",
- "type": "object",
- "properties": {
- "formattedValue": {
- "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
- "type": "string"
- },
- "textFormatRuns": {
- "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs are erased.",
- "type": "array",
- "items": {
- "$ref": "TextFormatRun"
- }
- },
- "hyperlink": {
- "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
- "type": "string"
- },
- "pivotTable": {
- "$ref": "PivotTable",
- "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
- },
- "userEnteredFormat": {
- "$ref": "CellFormat",
- "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
- },
- "note": {
- "description": "Any note on the cell.",
- "type": "string"
- },
- "effectiveFormat": {
- "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only.",
- "$ref": "CellFormat"
- },
- "userEnteredValue": {
- "$ref": "ExtendedValue",
- "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
- },
- "dataValidation": {
- "$ref": "DataValidationRule",
- "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
- },
- "effectiveValue": {
- "description": "The effective value of the cell. For cells with formulas, this is\nthe calculated value. For cells with literals, this is\nthe same as the user_entered_value.\nThis field is read-only.",
- "$ref": "ExtendedValue"
- }
- },
- "id": "CellData"
- },
- "TextPosition": {
- "description": "Position settings for text.",
- "type": "object",
- "properties": {
- "horizontalAlignment": {
- "description": "Horizontal alignment setting for the piece of text.",
- "type": "string",
- "enumDescriptions": [
- "The horizontal alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ]
- }
- },
- "id": "TextPosition"
- },
- "BatchUpdateValuesByDataFilterRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
- "type": "boolean"
- },
- "valueInputOption": {
- "description": "How the input data should be interpreted.",
- "type": "string",
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "data": {
- "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges.",
- "type": "array",
- "items": {
- "$ref": "DataFilterValueRange"
- }
- },
- "responseDateTimeRenderOption": {
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ],
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string"
- },
- "responseValueRenderOption": {
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ],
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- }
- },
- "id": "BatchUpdateValuesByDataFilterRequest"
- },
- "BatchUpdateSpreadsheetRequest": {
- "description": "The request for updating any aspect of a spreadsheet.",
- "type": "object",
- "properties": {
- "includeSpreadsheetInResponse": {
- "description": "Determines if the update response should include the spreadsheet\nresource.",
- "type": "boolean"
- },
- "responseRanges": {
- "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "responseIncludeGridData": {
- "type": "boolean",
- "description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_in_response is 'true'.\nThis parameter is ignored if a field mask was set in the request."
- },
- "requests": {
- "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
- "type": "array",
- "items": {
- "$ref": "Request"
- }
- }
- },
- "id": "BatchUpdateSpreadsheetRequest"
- },
- "BasicChartAxis": {
- "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
- "type": "object",
- "properties": {
- "titleTextPosition": {
- "$ref": "TextPosition",
- "description": "The axis title text position."
- },
- "format": {
- "$ref": "TextFormat",
- "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
- },
- "viewWindowOptions": {
- "description": "The view window options for this axis.",
- "$ref": "ChartAxisViewWindowOptions"
- },
- "position": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ],
- "description": "The position of this axis.",
- "type": "string"
- },
- "title": {
- "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
- "type": "string"
- }
- },
- "id": "BasicChartAxis"
- },
- "Padding": {
- "id": "Padding",
- "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
- "type": "object",
- "properties": {
- "bottom": {
- "description": "The bottom padding of the cell.",
- "format": "int32",
- "type": "integer"
- },
- "top": {
- "description": "The top padding of the cell.",
- "format": "int32",
- "type": "integer"
- },
- "left": {
- "description": "The left padding of the cell.",
- "format": "int32",
- "type": "integer"
- },
- "right": {
- "description": "The right padding of the cell.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "DeleteDimensionRequest": {
- "properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The dimensions to delete from the sheet."
- }
- },
- "id": "DeleteDimensionRequest",
- "description": "Deletes the dimensions from the sheet.",
- "type": "object"
- },
- "UpdateChartSpecRequest": {
- "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
- "type": "object",
- "properties": {
- "chartId": {
- "type": "integer",
- "description": "The ID of the chart to update.",
- "format": "int32"
- },
- "spec": {
- "$ref": "ChartSpec",
- "description": "The specification to apply to the chart."
- }
- },
- "id": "UpdateChartSpecRequest"
- },
- "UpdateDimensionGroupRequest": {
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `dimensionGroup` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "dimensionGroup": {
- "description": "The group whose state should be updated. The range and depth of the group\nshould specify a valid group on the sheet, and all other fields updated.",
- "$ref": "DimensionGroup"
- }
- },
- "id": "UpdateDimensionGroupRequest",
- "description": "Updates the state of the specified group."
- },
- "DeleteFilterViewRequest": {
- "properties": {
- "filterId": {
- "description": "The ID of the filter to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteFilterViewRequest",
- "description": "Deletes a particular filter view.",
- "type": "object"
- },
- "DeleteDeveloperMetadataResponse": {
- "properties": {
- "deletedDeveloperMetadata": {
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- },
- "description": "The metadata that was deleted."
- }
- },
- "id": "DeleteDeveloperMetadataResponse",
- "description": "The response from deleting developer metadata.",
- "type": "object"
- },
- "BatchGetValuesByDataFilterRequest": {
- "properties": {
- "valueRenderOption": {
- "type": "string",
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ],
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE."
- },
- "dateTimeRenderOption": {
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ]
- },
- "majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string"
- },
- "dataFilters": {
- "description": "The data filters used to match the ranges of values to retrieve. Ranges\nthat match any of the specified data filters will be included in the\nresponse.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "BatchGetValuesByDataFilterRequest",
- "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
- "type": "object"
- },
- "BatchUpdateValuesResponse": {
- "id": "BatchUpdateValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "totalUpdatedRows": {
- "description": "The total number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "responses": {
- "type": "array",
- "items": {
- "$ref": "UpdateValuesResponse"
- },
- "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared."
- }
- }
- },
- "SortRangeRequest": {
- "description": "Sorts data in rows based on a sort order per column.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to sort."
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "type": "array",
- "items": {
- "$ref": "SortSpec"
- }
- }
- },
- "id": "SortRangeRequest"
- },
- "MergeCellsRequest": {
- "id": "MergeCellsRequest",
- "description": "Merges all cells in the range.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range of cells to merge.",
- "$ref": "GridRange"
- },
- "mergeType": {
- "enum": [
- "MERGE_ALL",
- "MERGE_COLUMNS",
- "MERGE_ROWS"
- ],
- "description": "How the cells should be merged.",
- "type": "string",
- "enumDescriptions": [
- "Create a single merge from the range",
- "Create a merge for each column in the range",
- "Create a merge for each row in the range"
- ]
- }
- }
- },
- "MatchedDeveloperMetadata": {
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "All filters matching the returned developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- },
- "developerMetadata": {
- "description": "The developer metadata matching the specified filters.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "MatchedDeveloperMetadata",
- "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it."
- },
- "AddProtectedRangeRequest": {
- "description": "Adds a new protected range.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
- }
- },
- "id": "AddProtectedRangeRequest"
- },
- "BatchClearValuesRequest": {
- "description": "The request for clearing more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "ranges": {
- "description": "The ranges to clear, in A1 notation.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "BatchClearValuesRequest"
- },
- "DuplicateFilterViewResponse": {
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly created filter."
- }
- },
- "id": "DuplicateFilterViewResponse",
- "description": "The result of a filter view being duplicated.",
- "type": "object"
- },
- "DeveloperMetadata": {
- "properties": {
- "metadataValue": {
- "description": "Data associated with the metadata's key.",
- "type": "string"
- },
- "metadataKey": {
- "description": "The metadata key. There may be multiple metadata in a spreadsheet with the\nsame key. Developer metadata must always have a key specified.",
- "type": "string"
- },
- "metadataId": {
- "description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be\nspecified when metadata is created, otherwise one will be randomly\ngenerated and assigned. Must be positive.",
- "format": "int32",
- "type": "integer"
- },
- "location": {
- "description": "The location where the metadata is associated.",
- "$ref": "DeveloperMetadataLocation"
- },
- "visibility": {
- "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
- "type": "string",
- "enumDescriptions": [
- "Default value.",
- "Document-visible metadata is accessible from any developer project with\naccess to the document.",
- "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
- ],
- "enum": [
- "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
- "DOCUMENT",
- "PROJECT"
- ]
- }
- },
- "id": "DeveloperMetadata",
- "description": "Developer metadata associated with a location or object in a spreadsheet.\nDeveloper metadata may be used to associate arbitrary data with various\nparts of a spreadsheet and will remain associated at those locations as they\nmove around and the spreadsheet is edited. For example, if developer\nmetadata is associated with row 5 and another row is then subsequently\ninserted above row 5, that original metadata will still be associated with\nthe row it was first associated with (what is now row 6). If the associated\nobject is deleted its metadata is deleted too.",
- "type": "object"
- },
- "DuplicateSheetResponse": {
- "description": "The result of duplicating a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties of the duplicate sheet.",
- "$ref": "SheetProperties"
- }
- },
- "id": "DuplicateSheetResponse"
- },
- "TextToColumnsRequest": {
- "properties": {
- "source": {
- "description": "The source data range. This must span exactly one column.",
- "$ref": "GridRange"
- },
- "delimiterType": {
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM",
- "AUTODETECT"
- ],
- "description": "The delimiter type to use.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter.",
- "Automatically detect columns."
- ]
- },
- "delimiter": {
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
- "type": "string"
- }
- },
- "id": "TextToColumnsRequest",
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "type": "object"
- },
- "ClearBasicFilterRequest": {
- "properties": {
- "sheetId": {
- "description": "The sheet ID on which the basic filter should be cleared.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ClearBasicFilterRequest",
- "description": "Clears the basic filter, if any exists on the sheet.",
- "type": "object"
- },
- "DimensionGroup": {
- "properties": {
- "range": {
- "description": "The range over which this group exists.",
- "$ref": "DimensionRange"
- },
- "depth": {
- "description": "The depth of the group, representing how many groups have a range that\nwholly contains the range of this group.",
- "format": "int32",
- "type": "integer"
- },
- "collapsed": {
- "description": "This field is true if this group is collapsed. A collapsed group remains\ncollapsed if an overlapping group at a shallower depth is expanded.\n\nA true value does not imply that all dimensions within the group are\nhidden, since a dimension's visibility can change independently from this\ngroup property. However, when this property is updated, all dimensions\nwithin it are set to hidden if this field is true, or set to visible if\nthis field is false.",
- "type": "boolean"
- }
- },
- "id": "DimensionGroup",
- "description": "A group over an interval of rows or columns on a sheet, which can contain or\nbe contained within other groups. A group can be collapsed or expanded as a\nunit on the sheet.",
- "type": "object"
- },
- "BatchUpdateSpreadsheetResponse": {
- "properties": {
- "replies": {
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
- "type": "array",
- "items": {
- "$ref": "Response"
- }
- },
- "updatedSpreadsheet": {
- "$ref": "Spreadsheet",
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdateSpreadsheetResponse",
- "description": "The reply for batch updating a spreadsheet.",
- "type": "object"
- },
- "DeleteBandingRequest": {
- "description": "Removes the banded range with the given ID from the spreadsheet.",
- "type": "object",
- "properties": {
- "bandedRangeId": {
- "description": "The ID of the banded range to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteBandingRequest"
- },
- "AppendValuesResponse": {
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "updates": {
- "$ref": "UpdateValuesResponse",
- "description": "Information about the updates that were applied."
- },
- "tableRange": {
- "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
- "type": "string"
- }
- },
- "id": "AppendValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
- },
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "type": "object",
- "properties": {
- "destinationIndex": {
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
- "format": "int32",
- "type": "integer"
- },
- "source": {
- "description": "The source dimensions to move.",
- "$ref": "DimensionRange"
- }
- },
- "id": "MoveDimensionRequest"
- },
- "AddFilterViewRequest": {
- "description": "Adds a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)",
- "$ref": "FilterView"
- }
- },
- "id": "AddFilterViewRequest"
- },
- "PivotFilterCriteria": {
- "properties": {
- "visibleValues": {
- "description": "Values that should be included. Values not listed here are excluded.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PivotFilterCriteria",
- "description": "Criteria for showing/hiding rows in a pivot table.",
- "type": "object"
- },
- "AddConditionalFormatRuleRequest": {
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
- "type": "object",
- "properties": {
- "rule": {
- "description": "The rule to add.",
- "$ref": "ConditionalFormatRule"
- },
- "index": {
- "description": "The zero-based index where the rule should be inserted.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AddConditionalFormatRuleRequest"
- },
- "CreateDeveloperMetadataRequest": {
- "id": "CreateDeveloperMetadataRequest",
- "description": "A request to create developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The developer metadata to create."
- }
- }
- },
- "ChartSpec": {
- "type": "object",
- "properties": {
- "subtitle": {
- "description": "The subtitle of the chart.",
- "type": "string"
- },
- "subtitleTextPosition": {
- "description": "The subtitle text position.\nThis field is optional.",
- "$ref": "TextPosition"
- },
- "backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the entire chart.\nNot applicable to Org charts."
- },
- "basicChart": {
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
- "$ref": "BasicChartSpec"
- },
- "orgChart": {
- "description": "An org chart specification.",
- "$ref": "OrgChartSpec"
- },
- "pieChart": {
- "description": "A pie chart specification.",
- "$ref": "PieChartSpec"
- },
- "titleTextFormat": {
- "description": "The title text format.\nStrikethrough and underline are not supported.",
- "$ref": "TextFormat"
- },
- "title": {
- "description": "The title of the chart.",
- "type": "string"
- },
- "altText": {
- "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
- "type": "string"
- },
- "titleTextPosition": {
- "description": "The title text position.\nThis field is optional.",
- "$ref": "TextPosition"
- },
- "histogramChart": {
- "$ref": "HistogramChartSpec",
- "description": "A histogram chart specification."
- },
- "candlestickChart": {
- "$ref": "CandlestickChartSpec",
- "description": "A candlestick chart specification."
- },
- "bubbleChart": {
- "description": "A bubble chart specification.",
- "$ref": "BubbleChartSpec"
- },
- "waterfallChart": {
- "$ref": "WaterfallChartSpec",
- "description": "A waterfall chart specification."
- },
- "fontName": {
- "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
- "type": "string"
- },
- "maximized": {
- "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
- "type": "boolean"
- },
- "treemapChart": {
- "$ref": "TreemapChartSpec",
- "description": "A treemap chart specification."
- },
- "hiddenDimensionStrategy": {
- "enum": [
- "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
- "SKIP_HIDDEN_ROWS_AND_COLUMNS",
- "SKIP_HIDDEN_ROWS",
- "SKIP_HIDDEN_COLUMNS",
- "SHOW_ALL"
- ],
- "description": "Determines how the charts will use hidden rows or columns.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "Charts will skip hidden rows and columns.",
- "Charts will skip hidden rows only.",
- "Charts will skip hidden columns only.",
- "Charts will not skip any hidden rows or columns."
- ]
- },
- "subtitleTextFormat": {
- "$ref": "TextFormat",
- "description": "The subtitle text format.\nStrikethrough and underline are not supported."
- }
- },
- "id": "ChartSpec",
- "description": "The specifications of a chart."
- },
- "BatchGetValuesByDataFilterResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- },
- "valueRanges": {
- "description": "The requested values with the list of data filters that matched them.",
- "type": "array",
- "items": {
- "$ref": "MatchedValueRange"
- }
- }
- },
- "id": "BatchGetValuesByDataFilterResponse"
- },
- "NumberFormat": {
- "description": "The number format of a cell.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
- "Text formatting, e.g `1000.12`",
- "Number formatting, e.g, `1,000.12`",
- "Percent formatting, e.g `10.12%`",
- "Currency formatting, e.g `$1,000.12`",
- "Date formatting, e.g `9/26/2008`",
- "Time formatting, e.g `3:59:00 PM`",
- "Date+Time formatting, e.g `9/26/08 15:59:00`",
- "Scientific number formatting, e.g `1.01E+03`"
- ],
- "enum": [
- "NUMBER_FORMAT_TYPE_UNSPECIFIED",
- "TEXT",
- "NUMBER",
- "PERCENT",
- "CURRENCY",
- "DATE",
- "TIME",
- "DATE_TIME",
- "SCIENTIFIC"
- ],
- "description": "The type of the number format.\nWhen writing, this field must be set.",
- "type": "string"
- },
- "pattern": {
- "type": "string",
- "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for\nmore information about the supported patterns."
- }
- },
- "id": "NumberFormat"
- },
- "DataFilterValueRange": {
- "description": "A range of values whose location is specified by a DataFilter.",
- "type": "object",
- "properties": {
- "dataFilter": {
- "description": "The data filter describing the location of the values in the spreadsheet.",
- "$ref": "DataFilter"
- },
- "majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension of the values.",
- "type": "string"
- },
- "values": {
- "description": "The data to be written. If the provided values exceed any of the ranges\nmatched by the data filter then the request will fail. If the provided\nvalues are less than the matched ranges only the specified values will be\nwritten, existing values in the matched ranges will remain unaffected.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- }
- },
- "id": "DataFilterValueRange"
- },
- "LineStyle": {
- "id": "LineStyle",
- "description": "Properties that describe the style of a line.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "Default value, do not use.",
- "No dash type, which is equivalent to a non-visible line.",
- "A custom dash for a line. Modifying the exact custom dash style is\ncurrently unsupported.",
- "A solid line.",
- "A dotted line.",
- "A dashed line where the dashes have \"medium\" length.",
- "A line that alternates between a \"medium\" dash and a dot.",
- "A dashed line where the dashes have \"long\" length.",
- "A line that alternates between a \"long\" dash and a dot."
- ],
- "enum": [
- "LINE_DASH_TYPE_UNSPECIFIED",
- "INVISIBLE",
- "CUSTOM",
- "SOLID",
- "DOTTED",
- "MEDIUM_DASHED",
- "MEDIUM_DASHED_DOTTED",
- "LONG_DASHED",
- "LONG_DASHED_DOTTED"
- ],
- "description": "The dash type of the line.",
- "type": "string"
- },
- "width": {
- "description": "The thickness of the line, in px.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "CandlestickDomain": {
- "description": "The domain of a CandlestickChart.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickDomain."
- },
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "CandlestickDomain"
- },
- "SheetProperties": {
- "description": "Properties of a sheet.",
- "type": "object",
- "properties": {
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
- },
- "index": {
- "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet is added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request is ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
- "format": "int32",
- "type": "integer"
- },
- "tabColor": {
- "description": "The color of the tab in the UI.",
- "$ref": "Color"
- },
- "sheetId": {
- "type": "integer",
- "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
- "format": "int32"
- },
- "rightToLeft": {
- "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
- "type": "boolean"
- },
- "hidden": {
- "description": "True if the sheet is hidden in the UI, false if it's visible.",
- "type": "boolean"
- },
- "sheetType": {
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
- ],
- "enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
- ],
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set."
- },
- "gridProperties": {
- "$ref": "GridProperties",
- "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
- }
- },
- "id": "SheetProperties"
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
- },
- "range": {
- "description": "The rows or columns to update.",
- "$ref": "DimensionRange"
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateDimensionPropertiesRequest"
- },
- "SourceAndDestination": {
- "properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The location of the data to use as the source of the autofill."
- },
- "dimension": {
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension that data should be filled into.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ]
- },
- "fillLength": {
- "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SourceAndDestination",
- "description": "A combination of a source range and how to extend that source.",
- "type": "object"
- },
- "FilterView": {
- "id": "FilterView",
- "description": "A filter view.",
- "type": "object",
- "properties": {
- "namedRangeId": {
- "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "filterViewId": {
- "description": "The ID of the filter view.",
- "format": "int32",
- "type": "integer"
- },
- "criteria": {
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FilterCriteria"
- }
- },
- "title": {
- "description": "The name of the filter view.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
- },
- "sortSpecs": {
- "type": "array",
- "items": {
- "$ref": "SortSpec"
- },
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications."
- }
- }
- },
- "OrgChartSpec": {
- "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
- "type": "object",
- "properties": {
- "tooltips": {
- "$ref": "ChartData",
- "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
- },
- "selectedNodeColor": {
- "$ref": "Color",
- "description": "The color of the selected org chart nodes."
- },
- "parentLabels": {
- "$ref": "ChartData",
- "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
- },
- "nodeSize": {
- "enum": [
- "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
- "SMALL",
- "MEDIUM",
- "LARGE"
- ],
- "description": "The size of the org chart nodes.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The small org chart node size.",
- "The medium org chart node size.",
- "The large org chart node size."
- ]
- },
- "labels": {
- "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique.",
- "$ref": "ChartData"
- },
- "nodeColor": {
- "$ref": "Color",
- "description": "The color of the org chart nodes."
- }
- },
- "id": "OrgChartSpec"
- },
- "SearchDeveloperMetadataRequest": {
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "The data filters describing the criteria used to determine which\nDeveloperMetadata entries to return. DeveloperMetadata matching any of the\nspecified filters will be included in the response.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "SearchDeveloperMetadataRequest",
- "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria."
- },
- "BandingProperties": {
- "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
- "type": "object",
- "properties": {
- "firstBandColor": {
- "description": "The first color that is alternating. (Required)",
- "$ref": "Color"
- },
- "secondBandColor": {
- "description": "The second color that is alternating. (Required)",
- "$ref": "Color"
- },
- "footerColor": {
- "$ref": "Color",
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
- },
- "headerColor": {
- "$ref": "Color",
- "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would."
- }
- },
- "id": "BandingProperties"
- },
- "AddProtectedRangeResponse": {
- "description": "The result of adding a new protected range.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The newly added protected range."
- }
- },
- "id": "AddProtectedRangeResponse"
- },
- "BasicFilter": {
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range the filter covers."
- },
- "criteria": {
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FilterCriteria"
- }
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "type": "array",
- "items": {
- "$ref": "SortSpec"
- }
- }
- },
- "id": "BasicFilter",
- "description": "The default filter associated with a sheet."
- },
- "CandlestickSeries": {
- "description": "The series of a CandlestickData.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickSeries."
- }
- },
- "id": "CandlestickSeries"
- },
- "HistogramChartSpec": {
- "type": "object",
- "properties": {
- "bucketSize": {
- "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
- "format": "double",
- "type": "number"
- },
- "outlierPercentile": {
- "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
- "format": "double",
- "type": "number"
- },
- "showItemDividers": {
- "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
- "type": "boolean"
- },
- "series": {
- "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
- "type": "array",
- "items": {
- "$ref": "HistogramSeries"
- }
- },
- "legendPosition": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "The legend is rendered inside the chart area."
- ],
- "enum": [
- "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "INSIDE_LEGEND"
- ],
- "description": "The position of the chart legend.",
- "type": "string"
- }
- },
- "id": "HistogramChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly."
- },
- "UpdateValuesResponse": {
- "type": "object",
- "properties": {
- "updatedRows": {
- "description": "The number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "updatedData": {
- "$ref": "ValueRange",
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
- },
- "updatedColumns": {
- "description": "The number of columns where at least one cell in the column was updated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "updatedRange": {
- "description": "The range (in A1 notation) that updates were applied to.",
- "type": "string"
- },
- "updatedCells": {
- "description": "The number of cells updated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "UpdateValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet."
- },
- "ErrorValue": {
- "description": "An error in a cell.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "The default error type, do not use this.",
- "Corresponds to the `#ERROR!` error.",
- "Corresponds to the `#NULL!` error.",
- "Corresponds to the `#DIV/0` error.",
- "Corresponds to the `#VALUE!` error.",
- "Corresponds to the `#REF!` error.",
- "Corresponds to the `#NAME?` error.",
- "Corresponds to the `#NUM`! error.",
- "Corresponds to the `#N/A` error.",
- "Corresponds to the `Loading...` state."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ERROR",
- "NULL_VALUE",
- "DIVIDE_BY_ZERO",
- "VALUE",
- "REF",
- "NAME",
- "NUM",
- "N_A",
- "LOADING"
- ],
- "description": "The type of error.",
- "type": "string"
- },
- "message": {
- "description": "A message with more information about the error\n(in the spreadsheet's locale).",
- "type": "string"
- }
- },
- "id": "ErrorValue"
- },
- "PivotValue": {
- "description": "The definition of how a value in a pivot table should be calculated.",
- "type": "object",
- "properties": {
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "A name to use for the value.",
- "type": "string"
- },
- "formula": {
- "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
- "type": "string"
- },
- "calculatedDisplayType": {
- "enumDescriptions": [
- "Default value, do not use.",
- "Shows the pivot values as percentage of the row total values.",
- "Shows the pivot values as percentage of the column total values.",
- "Shows the pivot values as percentage of the grand total values."
- ],
- "enum": [
- "PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED",
- "PERCENT_OF_ROW_TOTAL",
- "PERCENT_OF_COLUMN_TOTAL",
- "PERCENT_OF_GRAND_TOTAL"
- ],
- "description": "If specified, indicates that pivot values should be displayed as\nthe result of a calculation with another pivot value. For example, if\ncalculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the\npivot values are displayed as the percentage of the grand total. In\nthe Sheets UI, this is referred to as \"Show As\" in the value section of a\npivot table.",
- "type": "string"
- },
- "summarizeFunction": {
- "enumDescriptions": [
- "The default, do not use.",
- "Corresponds to the `SUM` function.",
- "Corresponds to the `COUNTA` function.",
- "Corresponds to the `COUNT` function.",
- "Corresponds to the `COUNTUNIQUE` function.",
- "Corresponds to the `AVERAGE` function.",
- "Corresponds to the `MAX` function.",
- "Corresponds to the `MIN` function.",
- "Corresponds to the `MEDIAN` function.",
- "Corresponds to the `PRODUCT` function.",
- "Corresponds to the `STDEV` function.",
- "Corresponds to the `STDEVP` function.",
- "Corresponds to the `VAR` function.",
- "Corresponds to the `VARP` function.",
- "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
- ],
- "enum": [
- "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
- "SUM",
- "COUNTA",
- "COUNT",
- "COUNTUNIQUE",
- "AVERAGE",
- "MAX",
- "MIN",
- "MEDIAN",
- "PRODUCT",
- "STDEV",
- "STDEVP",
- "VAR",
- "VARP",
- "CUSTOM"
- ],
- "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
- "type": "string"
- }
- },
- "id": "PivotValue"
- },
- "CopySheetToAnotherSpreadsheetRequest": {
- "description": "The request to copy a sheet across spreadsheets.",
- "type": "object",
- "properties": {
- "destinationSpreadsheetId": {
- "description": "The ID of the spreadsheet to copy the sheet to.",
- "type": "string"
- }
- },
- "id": "CopySheetToAnotherSpreadsheetRequest"
- },
- "WaterfallChartSeries": {
- "description": "A single series of data for a waterfall chart.",
- "type": "object",
- "properties": {
- "positiveColumnsStyle": {
- "$ref": "WaterfallChartColumnStyle",
- "description": "Styles for all columns in this series with positive values."
- },
- "data": {
- "description": "The data being visualized in this series.",
- "$ref": "ChartData"
- },
- "negativeColumnsStyle": {
- "$ref": "WaterfallChartColumnStyle",
- "description": "Styles for all columns in this series with negative values."
- },
- "hideTrailingSubtotal": {
- "description": "True to hide the subtotal column from the end of the series. By default,\na subtotal column will appear at the end of each series. Setting this\nfield to true will hide that subtotal column for this series.",
- "type": "boolean"
- },
- "customSubtotals": {
- "description": "Custom subtotal columns appearing in this series. The order in which\nsubtotals are defined is not significant. Only one subtotal may be\ndefined for each data point.",
- "type": "array",
- "items": {
- "$ref": "WaterfallChartCustomSubtotal"
- }
- },
- "subtotalColumnsStyle": {
- "description": "Styles for all subtotal columns in this series.",
- "$ref": "WaterfallChartColumnStyle"
- }
- },
- "id": "WaterfallChartSeries"
- },
- "PivotGroupSortValueBucket": {
- "id": "PivotGroupSortValueBucket",
- "description": "Information about which values in a pivot group should be used for sorting.",
- "type": "object",
- "properties": {
- "buckets": {
- "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
- "type": "array",
- "items": {
- "$ref": "ExtendedValue"
- }
- },
- "valuesIndex": {
- "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "DeleteDeveloperMetadataRequest": {
- "description": "A request to delete developer metadata.",
- "type": "object",
- "properties": {
- "dataFilter": {
- "$ref": "DataFilter",
- "description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete."
- }
- },
- "id": "DeleteDeveloperMetadataRequest"
- },
- "CandlestickChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick\nchart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "domain": {
- "$ref": "CandlestickDomain",
- "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values."
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "CandlestickData"
- },
- "description": "The Candlestick chart data.\nOnly one CandlestickData is supported."
- }
- },
- "id": "CandlestickChartSpec"
- },
- "BatchClearValuesByDataFilterResponse": {
- "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
- "type": "object",
- "properties": {
- "clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchClearValuesByDataFilterResponse"
- },
- "TreemapChartColorScale": {
- "description": "A color scale for a treemap chart.",
- "type": "object",
- "properties": {
- "midValueColor": {
- "description": "The background color for cells with a color value at the midpoint between\nminValue and\nmaxValue. Defaults to #efe6dc if not\nspecified.",
- "$ref": "Color"
- },
- "maxValueColor": {
- "$ref": "Color",
- "description": "The background color for cells with a color value greater than or equal\nto maxValue. Defaults to #109618 if not\nspecified."
- },
- "minValueColor": {
- "$ref": "Color",
- "description": "The background color for cells with a color value less than or equal to\nminValue. Defaults to #dc3912 if not\nspecified."
- },
- "noDataColor": {
- "$ref": "Color",
- "description": "The background color for cells that have no color data associated with\nthem. Defaults to #000000 if not specified."
- }
- },
- "id": "TreemapChartColorScale"
- },
- "CandlestickData": {
- "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
- "type": "object",
- "properties": {
- "highSeries": {
- "$ref": "CandlestickSeries",
- "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line."
- },
- "lowSeries": {
- "$ref": "CandlestickSeries",
- "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line."
- },
- "closeSeries": {
- "$ref": "CandlestickSeries",
- "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow."
- },
- "openSeries": {
- "$ref": "CandlestickSeries",
- "description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow."
- }
- },
- "id": "CandlestickData"
- },
- "EmbeddedObjectPosition": {
- "properties": {
- "newSheet": {
- "description": "If true, the embedded object is put on a new sheet whose ID\nis chosen for you. Used only when writing.",
- "type": "boolean"
- },
- "sheetId": {
- "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
- "format": "int32",
- "type": "integer"
- },
- "overlayPosition": {
- "$ref": "OverlayPosition",
- "description": "The position at which the object is overlaid on top of a grid."
- }
- },
- "id": "EmbeddedObjectPosition",
- "description": "The position of an embedded object such as a chart.",
- "type": "object"
- },
- "DeleteProtectedRangeRequest": {
- "properties": {
- "protectedRangeId": {
- "description": "The ID of the protected range to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteProtectedRangeRequest",
- "description": "Deletes the protected range with the given ID.",
- "type": "object"
- },
- "DeveloperMetadataLookup": {
- "description": "Selects DeveloperMetadata that matches all of the specified fields. For\nexample, if only a metadata ID is specified this considers the\nDeveloperMetadata with that particular unique ID. If a metadata key is\nspecified, this considers all developer metadata with that key. If a\nkey, visibility, and location type are all specified, this considers all\ndeveloper metadata with that key and visibility that are associated with a\nlocation of that type. In general, this\nselects all DeveloperMetadata that matches the intersection of all the\nspecified fields; any field or combination of fields may be specified.",
- "type": "object",
- "properties": {
- "locationMatchingStrategy": {
- "description": "Determines how this lookup matches the location. If this field is\nspecified as EXACT, only developer metadata associated on the exact\nlocation specified is matched. If this field is specified to INTERSECTING,\ndeveloper metadata associated on intersecting locations is also\nmatched. If left unspecified, this field assumes a default value of\nINTERSECTING.\nIf this field is specified, a metadataLocation\nmust also be specified.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Indicates that a specified location should be matched exactly. For\nexample, if row three were specified as a location this matching strategy\nwould only match developer metadata also associated on row three. Metadata\nassociated on other locations would not be considered.",
- "Indicates that a specified location should match that exact location as\nwell as any intersecting locations. For example, if row three were\nspecified as a location this matching strategy would match developer\nmetadata associated on row three as well as metadata associated on\nlocations that intersect row three. If, for instance, there was developer\nmetadata associated on column B, this matching strategy would also match\nthat location because column B intersects row three."
- ],
- "enum": [
- "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
- "EXACT_LOCATION",
- "INTERSECTING_LOCATION"
- ]
- },
- "metadataLocation": {
- "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy.",
- "$ref": "DeveloperMetadataLocation"
- },
- "locationType": {
- "enum": [
- "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
- "ROW",
- "COLUMN",
- "SHEET",
- "SPREADSHEET"
- ],
- "description": "Limits the selected developer metadata to those entries which are\nassociated with locations of the specified type. For example, when this\nfield is specified as ROW this lookup\nonly considers developer metadata associated on rows. If the field is left\nunspecified, all location types are considered. This field cannot be\nspecified as SPREADSHEET when\nthe locationMatchingStrategy\nis specified as INTERSECTING or when the\nmetadataLocation is specified as a\nnon-spreadsheet location: spreadsheet metadata cannot intersect any other\ndeveloper metadata location. This field also must be left unspecified when\nthe locationMatchingStrategy\nis specified as EXACT.",
- "type": "string",
- "enumDescriptions": [
- "Default value.",
- "Developer metadata associated on an entire row dimension.",
- "Developer metadata associated on an entire column dimension.",
- "Developer metadata associated on an entire sheet.",
- "Developer metadata associated on the entire spreadsheet."
- ]
- },
- "metadataKey": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.",
- "type": "string"
- },
- "visibility": {
- "enumDescriptions": [
- "Default value.",
- "Document-visible metadata is accessible from any developer project with\naccess to the document.",
- "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
- ],
- "enum": [
- "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
- "DOCUMENT",
- "PROJECT"
- ],
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered.",
- "type": "string"
- },
- "metadataId": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.",
- "format": "int32",
- "type": "integer"
- },
- "metadataValue": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
- "type": "string"
- }
- },
- "id": "DeveloperMetadataLookup"
- },
- "AutoFillRequest": {
- "type": "object",
- "properties": {
- "useAlternateSeries": {
- "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
- "type": "boolean"
- },
- "sourceAndDestination": {
- "$ref": "SourceAndDestination",
- "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data."
- },
- "range": {
- "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
- "$ref": "GridRange"
- }
- },
- "id": "AutoFillRequest",
- "description": "Fills in more data based on existing data."
- },
- "GradientRule": {
- "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
- "type": "object",
- "properties": {
- "midpoint": {
- "$ref": "InterpolationPoint",
- "description": "An optional midway interpolation point."
- },
- "minpoint": {
- "$ref": "InterpolationPoint",
- "description": "The starting interpolation point."
- },
- "maxpoint": {
- "$ref": "InterpolationPoint",
- "description": "The final interpolation point."
- }
- },
- "id": "GradientRule"
- },
- "ClearValuesRequest": {
- "description": "The request for clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {},
- "id": "ClearValuesRequest"
- },
- "SetBasicFilterRequest": {
- "properties": {
- "filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
- }
- },
- "id": "SetBasicFilterRequest",
- "description": "Sets the basic filter associated with a sheet.",
- "type": "object"
- },
- "InterpolationPoint": {
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "The default value, do not use.",
- "The interpolation point uses the minimum value in the\ncells over the range of the conditional format.",
- "The interpolation point uses the maximum value in the\ncells over the range of the conditional format.",
- "The interpolation point uses exactly the value in\nInterpolationPoint.value.",
- "The interpolation point is the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
- "The interpolation point is the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
- ],
- "enum": [
- "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
- "MIN",
- "MAX",
- "NUMBER",
- "PERCENT",
- "PERCENTILE"
- ],
- "description": "How the value should be interpreted.",
- "type": "string"
- },
- "value": {
- "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
- "type": "string"
- },
- "color": {
- "$ref": "Color",
- "description": "The color this interpolation point should use."
- }
- },
- "id": "InterpolationPoint",
- "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen."
- },
- "BatchClearValuesByDataFilterRequest": {
- "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "The DataFilters used to determine which ranges to clear.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "BatchClearValuesByDataFilterRequest"
- },
- "GetSpreadsheetByDataFilterRequest": {
- "description": "The request for retrieving a Spreadsheet.",
- "type": "object",
- "properties": {
- "includeGridData": {
- "type": "boolean",
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request."
- },
- "dataFilters": {
- "description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "GetSpreadsheetByDataFilterRequest"
- },
- "DeleteEmbeddedObjectRequest": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the embedded object to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteEmbeddedObjectRequest",
- "description": "Deletes the embedded object with the given ID."
- },
- "FindReplaceResponse": {
- "description": "The result of the find/replace.",
- "type": "object",
- "properties": {
- "rowsChanged": {
- "description": "The number of rows changed.",
- "format": "int32",
- "type": "integer"
- },
- "sheetsChanged": {
- "description": "The number of sheets changed.",
- "format": "int32",
- "type": "integer"
- },
- "formulasChanged": {
- "description": "The number of formula cells changed.",
- "format": "int32",
- "type": "integer"
- },
- "valuesChanged": {
- "description": "The number of non-formula cells changed.",
- "format": "int32",
- "type": "integer"
- },
- "occurrencesChanged": {
- "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "FindReplaceResponse"
- },
- "UpdateValuesByDataFilterResponse": {
- "description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
- "type": "object",
- "properties": {
- "updatedRange": {
- "description": "The range (in A1 notation) that updates were applied to.",
- "type": "string"
- },
- "updatedCells": {
- "description": "The number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "dataFilter": {
- "$ref": "DataFilter",
- "description": "The data filter that selected the range that was updated."
- },
- "updatedData": {
- "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`.",
- "$ref": "ValueRange"
- },
- "updatedRows": {
- "description": "The number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "updatedColumns": {
- "description": "The number of columns where at least one cell in the column was updated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "UpdateValuesByDataFilterResponse"
- },
- "DeleteSheetRequest": {
- "description": "Deletes the requested sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The ID of the sheet to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteSheetRequest"
- },
- "DuplicateFilterViewRequest": {
- "description": "Duplicates a particular filter view.",
- "type": "object",
- "properties": {
- "filterId": {
- "description": "The ID of the filter being duplicated.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DuplicateFilterViewRequest"
- },
- "MatchedValueRange": {
- "type": "object",
- "properties": {
- "valueRange": {
- "description": "The values matched by the DataFilter.",
- "$ref": "ValueRange"
- },
- "dataFilters": {
- "description": "The DataFilters from the request that matched the range of\nvalues.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- },
- "id": "MatchedValueRange",
- "description": "A value range that was matched by one or more data filers."
- },
- "DeveloperMetadataLocation": {
- "type": "object",
- "properties": {
- "dimensionRange": {
- "$ref": "DimensionRange",
- "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns."
- },
- "spreadsheet": {
- "description": "True when metadata is associated with an entire spreadsheet.",
- "type": "boolean"
- },
- "sheetId": {
- "description": "The ID of the sheet when metadata is associated with an entire sheet.",
- "format": "int32",
- "type": "integer"
- },
- "locationType": {
- "enumDescriptions": [
- "Default value.",
- "Developer metadata associated on an entire row dimension.",
- "Developer metadata associated on an entire column dimension.",
- "Developer metadata associated on an entire sheet.",
- "Developer metadata associated on the entire spreadsheet."
- ],
- "enum": [
- "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
- "ROW",
- "COLUMN",
- "SHEET",
- "SPREADSHEET"
- ],
- "description": "The type of location this object represents. This field is read-only.",
- "type": "string"
- }
- },
- "id": "DeveloperMetadataLocation",
- "description": "A location where metadata may be associated in a spreadsheet."
- },
- "UpdateConditionalFormatRuleResponse": {
- "properties": {
- "newIndex": {
- "description": "The index of the new rule.",
- "format": "int32",
- "type": "integer"
- },
- "oldIndex": {
- "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
- "format": "int32",
- "type": "integer"
- },
- "newRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
- },
- "oldRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
- }
- },
- "id": "UpdateConditionalFormatRuleResponse",
- "description": "The result of updating a conditional format rule.",
- "type": "object"
- },
- "ConditionValue": {
- "id": "ConditionValue",
- "description": "The value of the condition.",
- "type": "object",
- "properties": {
- "relativeDate": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The value is one year before today.",
- "The value is one month before today.",
- "The value is one week before today.",
- "The value is yesterday.",
- "The value is today.",
- "The value is tomorrow."
- ],
- "enum": [
- "RELATIVE_DATE_UNSPECIFIED",
- "PAST_YEAR",
- "PAST_MONTH",
- "PAST_WEEK",
- "YESTERDAY",
- "TODAY",
- "TOMORROW"
- ],
- "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
- "type": "string"
- },
- "userEnteredValue": {
- "description": "A value the condition is based on.\nThe value is parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=` or a '+').",
- "type": "string"
- }
- }
- },
- "DuplicateSheetRequest": {
- "description": "Duplicates the contents of a sheet.",
- "type": "object",
- "properties": {
- "insertSheetIndex": {
- "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
- "format": "int32",
- "type": "integer"
- },
- "newSheetName": {
- "type": "string",
- "description": "The name of the new sheet. If empty, a new name is chosen for you."
- },
- "sourceSheetId": {
- "description": "The sheet to duplicate.",
- "format": "int32",
- "type": "integer"
- },
- "newSheetId": {
- "type": "integer",
- "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
- "format": "int32"
- }
- },
- "id": "DuplicateSheetRequest"
- },
- "DateTimeRule": {
- "description": "Allows you to organize the date-time values in a source data column into\nbuckets based on selected parts of their date or time values. For example,\nconsider a pivot table showing sales transactions by date:\n\n +----------+--------------+\n | Date | SUM of Sales |\n +----------+--------------+\n | 1/1/2017 | $621.14 |\n | 2/3/2017 | $708.84 |\n | 5/8/2017 | $326.84 |\n ...\n +----------+--------------+\nApplying a date-time group rule with a DateTimeRuleType of YEAR_MONTH\nresults in the following pivot table.\n\n +--------------+--------------+\n | Grouped Date | SUM of Sales |\n +--------------+--------------+\n | 2017-Jan | $53,731.78 |\n | 2017-Feb | $83,475.32 |\n | 2017-Mar | $94,385.05 |\n ...\n +--------------+--------------+",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of date-time grouping to apply.",
- "type": "string",
- "enumDescriptions": [
- "The default type, do not use.",
- "Group dates by second, from 0 to 59.",
- "Group dates by minute, from 0 to 59.",
- "Group dates by hour using a 24-hour system, from 0 to 23.",
- "Group dates by hour and minute using a 24-hour system, for example 19:45.",
- "Group dates by hour and minute using a 12-hour system, for example 7:45\nPM. The AM/PM designation is translated based on the spreadsheet\nlocale.",
- "Group dates by day of week, for example Sunday. The days of the week will\nbe translated based on the spreadsheet locale.",
- "Group dates by day of year, from 1 to 366. Note that dates after Feb. 29\nfall in different buckets in leap years than in non-leap years.",
- "Group dates by day of month, from 1 to 31.",
- "Group dates by day and month, for example 22-Nov. The month is\ntranslated based on the spreadsheet locale.",
- "Group dates by month, for example Nov. The month is translated based\non the spreadsheet locale.",
- "Group dates by quarter, for example Q1 (which represents Jan-Mar).",
- "Group dates by year, for example 2008.",
- "Group dates by year and month, for example 2008-Nov. The month is\ntranslated based on the spreadsheet locale.",
- "Group dates by year and quarter, for example 2008 Q4.",
- "Group dates by year, month, and day, for example 2008-11-22."
- ],
- "enum": [
- "DATE_TIME_RULE_TYPE_UNSPECIFIED",
- "SECOND",
- "MINUTE",
- "HOUR",
- "HOUR_MINUTE",
- "HOUR_MINUTE_AMPM",
- "DAY_OF_WEEK",
- "DAY_OF_YEAR",
- "DAY_OF_MONTH",
- "DAY_MONTH",
- "MONTH",
- "QUARTER",
- "YEAR",
- "YEAR_MONTH",
- "YEAR_QUARTER",
- "YEAR_MONTH_DAY"
- ]
- }
- },
- "id": "DateTimeRule"
- },
- "TreemapChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/treemap\"\u003eTreemap chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "hideTooltips": {
- "description": "True to hide tooltips.",
- "type": "boolean"
- },
- "hintedLevels": {
- "description": "The number of additional data levels beyond the labeled levels to be shown\non the treemap chart. These levels are not interactive and are shown\nwithout their labels. Defaults to 0 if not specified.",
- "format": "int32",
- "type": "integer"
- },
- "minValue": {
- "description": "The minimum possible data value. Cells with values less than this will\nhave the same color as cells with this value. If not specified, defaults\nto the actual minimum value from color_data, or the minimum value from\nsize_data if color_data is not specified.",
- "format": "double",
- "type": "number"
- },
- "levels": {
- "description": "The number of data levels to show on the treemap chart. These levels are\ninteractive and are shown with their labels. Defaults to 2 if not\nspecified.",
- "format": "int32",
- "type": "integer"
- },
- "sizeData": {
- "description": "The data that determines the size of each treemap data cell. This data is\nexpected to be numeric. The cells corresponding to non-numeric or missing\ndata will not be rendered. If color_data is not specified, this data\nis used to determine data cell background colors as well.",
- "$ref": "ChartData"
- },
- "textFormat": {
- "$ref": "TextFormat",
- "description": "The text format for all labels on the chart."
- },
- "parentLabels": {
- "description": "The data the contains the treemap cells' parent labels.",
- "$ref": "ChartData"
- },
- "headerColor": {
- "$ref": "Color",
- "description": "The background color for header cells."
- },
- "labels": {
- "$ref": "ChartData",
- "description": "The data that contains the treemap cell labels."
- },
- "colorData": {
- "$ref": "ChartData",
- "description": "The data that determines the background color of each treemap data cell.\nThis field is optional. If not specified, size_data is used to\ndetermine background colors. If specified, the data is expected to be\nnumeric. color_scale will determine how the values in this data map to\ndata cell background colors."
- },
- "maxValue": {
- "description": "The maximum possible data value. Cells with values greater than this will\nhave the same color as cells with this value. If not specified, defaults\nto the actual maximum value from color_data, or the maximum value from\nsize_data if color_data is not specified.",
- "format": "double",
- "type": "number"
- },
- "colorScale": {
- "description": "The color scale for data cells in the treemap chart. Data cells are\nassigned colors based on their color values. These color values come from\ncolor_data, or from size_data if color_data is not specified.\nCells with color values less than or equal to min_value will\nhave minValueColor as their\nbackground color. Cells with color values greater than or equal to\nmax_value will have\nmaxValueColor as their background\ncolor. Cells with color values between min_value and max_value will\nhave background colors on a gradient between\nminValueColor and\nmaxValueColor, the midpoint of\nthe gradient being midValueColor.\nCells with missing or non-numeric color values will have\nnoDataColor as their background\ncolor.",
- "$ref": "TreemapChartColorScale"
- }
- },
- "id": "TreemapChartSpec"
- },
- "ExtendedValue": {
- "type": "object",
- "properties": {
- "errorValue": {
- "$ref": "ErrorValue",
- "description": "Represents an error.\nThis field is read-only."
- },
- "stringValue": {
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
- "type": "string"
- },
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
- },
- "formulaValue": {
- "description": "Represents a formula.",
- "type": "string"
- },
- "numberValue": {
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "ExtendedValue",
- "description": "The kinds of value that a cell in a spreadsheet can have."
- },
- "HistogramSeries": {
- "description": "A histogram series containing the series color and data.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data for this histogram series."
- },
- "barColor": {
- "$ref": "Color",
- "description": "The color of the column representing this series in each bucket.\nThis field is optional."
- }
- },
- "id": "HistogramSeries"
- },
- "BatchClearValuesResponse": {
- "type": "object",
- "properties": {
- "clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "spreadsheetId": {
- "type": "string",
- "description": "The spreadsheet the updates were applied to."
- }
- },
- "id": "BatchClearValuesResponse",
- "description": "The response when clearing a range of values in a spreadsheet."
- },
- "Spreadsheet": {
- "type": "object",
- "properties": {
- "properties": {
- "description": "Overall properties of a spreadsheet.",
- "$ref": "SpreadsheetProperties"
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- },
- "namedRanges": {
- "type": "array",
- "items": {
- "$ref": "NamedRange"
- },
- "description": "The named ranges defined in a spreadsheet."
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "sheets": {
- "description": "The sheets that are part of a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "Sheet"
- }
- },
- "spreadsheetUrl": {
- "description": "The url of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- }
- },
- "id": "Spreadsheet",
- "description": "Resource that represents a spreadsheet."
- },
- "BandedRange": {
- "description": "A banded (alternating colors) range in a sheet.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range over which these properties are applied."
- },
- "bandedRangeId": {
- "description": "The id of the banded range.",
- "format": "int32",
- "type": "integer"
- },
- "rowProperties": {
- "description": "Properties for row bands. These properties are applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
- },
- "columnProperties": {
- "$ref": "BandingProperties",
- "description": "Properties for column bands. These properties are applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
- }
- },
- "id": "BandedRange"
- },
- "AddChartRequest": {
- "properties": {
- "chart": {
- "$ref": "EmbeddedChart",
- "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of an embedded object that already exists.)"
- }
- },
- "id": "AddChartRequest",
- "description": "Adds a chart to a sheet in the spreadsheet.",
- "type": "object"
- },
- "HistogramRule": {
- "description": "Allows you to organize the numeric values in a source data column into\nbuckets of a constant size. All values from HistogramRule.start to\nHistogramRule.end are placed into groups of size\nHistogramRule.interval. In addition, all values below\nHistogramRule.start are placed in one group, and all values above\nHistogramRule.end are placed in another. Only\nHistogramRule.interval is required, though if HistogramRule.start\nand HistogramRule.end are both provided, HistogramRule.start must\nbe less than HistogramRule.end. For example, a pivot table showing\naverage purchase amount by age that has 50+ rows:\n\n +-----+-------------------+\n | Age | AVERAGE of Amount |\n +-----+-------------------+\n | 16 | $27.13 |\n | 17 | $5.24 |\n | 18 | $20.15 |\n ...\n +-----+-------------------+\ncould be turned into a pivot table that looks like the one below by\napplying a histogram group rule with a HistogramRule.start of 25,\nan HistogramRule.interval of 20, and an HistogramRule.end\nof 65.\n\n +-------------+-------------------+\n | Grouped Age | AVERAGE of Amount |\n +-------------+-------------------+\n | \u003c 25 | $19.34 |\n | 25-45 | $31.43 |\n | 45-65 | $35.87 |\n | \u003e 65 | $27.55 |\n +-------------+-------------------+\n | Grand Total | $29.12 |\n +-------------+-------------------+",
- "type": "object",
- "properties": {
- "start": {
- "description": "The minimum value at which items are placed into buckets\nof constant size. Values below start are lumped into a single bucket.\nThis field is optional.",
- "format": "double",
- "type": "number"
- },
- "end": {
- "description": "The maximum value at which items are placed into buckets\nof constant size. Values above end are lumped into a single bucket.\nThis field is optional.",
- "format": "double",
- "type": "number"
- },
- "interval": {
- "type": "number",
- "description": "The size of the buckets that are created. Must be positive.",
- "format": "double"
- }
- },
- "id": "HistogramRule"
- },
- "UpdateProtectedRangeRequest": {
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateProtectedRangeRequest"
- },
- "DataFilter": {
- "type": "object",
- "properties": {
- "a1Range": {
- "type": "string",
- "description": "Selects data that matches the specified A1 range."
- },
- "gridRange": {
- "$ref": "GridRange",
- "description": "Selects data that matches the range described by the GridRange."
- },
- "developerMetadataLookup": {
- "$ref": "DeveloperMetadataLookup",
- "description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup."
- }
- },
- "id": "DataFilter",
- "description": "Filter that describes what data should be selected or returned from a\nrequest."
- },
- "TextFormat": {
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
- "type": "object",
- "properties": {
- "underline": {
- "description": "True if the text is underlined.",
- "type": "boolean"
- },
- "bold": {
- "description": "True if the text is bold.",
- "type": "boolean"
- },
- "foregroundColor": {
- "$ref": "Color",
- "description": "The foreground color of the text."
- },
- "fontFamily": {
- "description": "The font family.",
- "type": "string"
- },
- "strikethrough": {
- "description": "True if the text has a strikethrough.",
- "type": "boolean"
- },
- "italic": {
- "description": "True if the text is italicized.",
- "type": "boolean"
- },
- "fontSize": {
- "description": "The size of the font.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextFormat"
- },
- "DeleteDuplicatesRequest": {
- "description": "Removes rows within this range that contain values in the specified columns\nthat are duplicates of values in any previous row. Rows with identical values\nbut different letter cases, formatting, or formulas are considered to be\nduplicates.\n\nThis request also removes duplicate rows hidden from view (for example, due\nto a filter). When removing duplicates, the first instance of each duplicate\nrow scanning from the top downwards is kept in the resulting range. Content\noutside of the specified range isn't removed, and rows considered duplicates\ndo not have to be adjacent to each other in the range.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range to remove duplicates rows from.",
- "$ref": "GridRange"
- },
- "comparisonColumns": {
- "type": "array",
- "items": {
- "$ref": "DimensionRange"
- },
- "description": "The columns in the range to analyze for duplicate values. If no columns are\nselected then all columns are analyzed for duplicates."
- }
- },
- "id": "DeleteDuplicatesRequest"
- },
- "AddSheetResponse": {
- "description": "The result of adding a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties of the newly added sheet.",
- "$ref": "SheetProperties"
- }
- },
- "id": "AddSheetResponse"
- },
- "PivotGroupRule": {
- "type": "object",
- "properties": {
- "histogramRule": {
- "$ref": "HistogramRule",
- "description": "A HistogramRule."
- },
- "dateTimeRule": {
- "$ref": "DateTimeRule",
- "description": "A DateTimeRule."
- },
- "manualRule": {
- "description": "A ManualRule.",
- "$ref": "ManualRule"
- }
- },
- "id": "PivotGroupRule",
- "description": "An optional setting on a PivotGroup that defines buckets for the values\nin the source data column rather than breaking out each individual value.\nOnly one PivotGroup with a group rule may be added for each column in\nthe source data, though on any given column you may add both a\nPivotGroup that has a rule and a PivotGroup that does not."
- },
- "AddFilterViewResponse": {
- "description": "The result of adding a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The newly added filter view.",
- "$ref": "FilterView"
- }
- },
- "id": "AddFilterViewResponse"
- },
- "IterativeCalculationSettings": {
- "id": "IterativeCalculationSettings",
- "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
- "type": "object",
- "properties": {
- "convergenceThreshold": {
- "type": "number",
- "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
- "format": "double"
- },
- "maxIterations": {
- "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "SpreadsheetProperties": {
- "properties": {
- "autoRecalc": {
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Volatile functions are updated on every change.",
- "Volatile functions are updated on every change and every minute.",
- "Volatile functions are updated on every change and hourly."
- ],
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ],
- "description": "The amount of time to wait before volatile functions are recalculated."
- },
- "defaultFormat": {
- "$ref": "CellFormat",
- "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if\nthe cell's format is equal to this default format. This field is read-only."
- },
- "title": {
- "description": "The title of the spreadsheet.",
- "type": "string"
- },
- "timeZone": {
- "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
- "type": "string"
- },
- "locale": {
- "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
- "type": "string"
- },
- "iterativeCalculationSettings": {
- "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors.",
- "$ref": "IterativeCalculationSettings"
- }
- },
- "id": "SpreadsheetProperties",
- "description": "Properties of a spreadsheet.",
- "type": "object"
- },
- "OverlayPosition": {
- "description": "The location an object is overlaid on top of a grid.",
- "type": "object",
- "properties": {
- "widthPixels": {
- "description": "The width of the object, in pixels. Defaults to 600.",
- "format": "int32",
- "type": "integer"
- },
- "offsetXPixels": {
- "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
- },
- "anchorCell": {
- "description": "The cell the object is anchored to.",
- "$ref": "GridCoordinate"
- },
- "offsetYPixels": {
- "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
- },
- "heightPixels": {
- "description": "The height of the object, in pixels. Defaults to 371.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "OverlayPosition"
- },
- "RepeatCellRequest": {
- "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "cell": {
- "description": "The data to write.",
- "$ref": "CellData"
- },
- "range": {
- "description": "The range to repeat the cell in.",
- "$ref": "GridRange"
- }
- },
- "id": "RepeatCellRequest"
- },
- "AddChartResponse": {
- "description": "The result of adding a chart to a spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "$ref": "EmbeddedChart",
- "description": "The newly added chart."
- }
- },
- "id": "AddChartResponse"
- },
- "InsertDimensionRequest": {
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
- "$ref": "DimensionRange"
- },
- "inheritFromBefore": {
- "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
- "type": "boolean"
- }
- },
- "id": "InsertDimensionRequest"
- },
- "UpdateSpreadsheetPropertiesRequest": {
- "description": "Updates properties of a spreadsheet.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "SpreadsheetProperties",
- "description": "The properties to update."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateSpreadsheetPropertiesRequest"
- },
- "ProtectedRange": {
- "properties": {
- "requestingUserCanEdit": {
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
- "type": "boolean"
- },
- "range": {
- "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "$ref": "GridRange"
- },
- "editors": {
- "$ref": "Editors",
- "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
- },
- "description": {
- "type": "string",
- "description": "The description of this protected range."
- },
- "unprotectedRanges": {
- "type": "array",
- "items": {
- "$ref": "GridRange"
- },
- "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets."
- },
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "protectedRangeId": {
- "description": "The ID of the protected range.\nThis field is read-only.",
- "format": "int32",
- "type": "integer"
- },
- "warningOnly": {
- "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
- "type": "boolean"
- }
- },
- "id": "ProtectedRange",
- "description": "A protected range.",
- "type": "object"
- },
- "BatchUpdateValuesRequest": {
- "type": "object",
- "properties": {
- "responseDateTimeRenderOption": {
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string",
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ]
- },
- "responseValueRenderOption": {
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string",
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ]
- },
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
- "type": "boolean"
- },
- "valueInputOption": {
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string",
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ]
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- },
- "description": "The new values to apply to the spreadsheet."
- }
- },
- "id": "BatchUpdateValuesRequest",
- "description": "The request for updating more than one range of values in a spreadsheet."
- },
- "DimensionProperties": {
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata associated with a single row or column.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "pixelSize": {
- "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "hiddenByFilter": {
- "type": "boolean",
- "description": "True if this dimension is being filtered.\nThis field is read-only."
- },
- "hiddenByUser": {
- "description": "True if this dimension is explicitly hidden.",
- "type": "boolean"
- }
- },
- "id": "DimensionProperties",
- "description": "Properties about a dimension."
- },
- "DimensionRange": {
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The sheet this span is on.",
- "format": "int32",
- "type": "integer"
- },
- "dimension": {
- "description": "The dimension of the span.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "startIndex": {
- "description": "The start (inclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "description": "The end (exclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DimensionRange",
- "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side."
- },
- "NamedRange": {
- "description": "A named range.",
- "type": "object",
- "properties": {
- "namedRangeId": {
- "description": "The ID of the named range.",
- "type": "string"
- },
- "range": {
- "description": "The range this represents.",
- "$ref": "GridRange"
- },
- "name": {
- "description": "The name of the named range.",
- "type": "string"
- }
- },
- "id": "NamedRange"
- },
- "CutPasteRequest": {
- "description": "Moves data from the source to the destination.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The source data to cut."
- },
- "pasteType": {
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ],
- "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
- },
- "destination": {
- "$ref": "GridCoordinate",
- "description": "The top-left coordinate where the data should be pasted."
- }
- },
- "id": "CutPasteRequest"
- },
- "ChartAxisViewWindowOptions": {
- "description": "The options that define a \"view window\" for a chart (such as the visible\nvalues in an axis).",
- "type": "object",
- "properties": {
- "viewWindowMin": {
- "type": "number",
- "description": "The minimum numeric value to be shown in this view window. If unset, will\nautomatically determine a minimum value that looks good for the data.",
- "format": "double"
- },
- "viewWindowMax": {
- "description": "The maximum numeric value to be shown in this view window. If unset, will\nautomatically determine a maximum value that looks good for the data.",
- "format": "double",
- "type": "number"
- },
- "viewWindowMode": {
- "enum": [
- "DEFAULT_VIEW_WINDOW_MODE",
- "VIEW_WINDOW_MODE_UNSUPPORTED",
- "EXPLICIT",
- "PRETTY"
- ],
- "description": "The view window's mode.",
- "type": "string",
- "enumDescriptions": [
- "The default view window mode used in the Sheets editor for this chart\ntype. In most cases, if set, the default mode is equivalent to\n`PRETTY`.",
- "Do not use. Represents that the currently set mode is not supported by\nthe API.",
- "Follows the min and max exactly if specified. If a value is unspecified,\nit will fall back to the `PRETTY` value.",
- "Chooses a min and max that make the chart look good. Both min and max are\nignored in this mode."
- ]
- }
- },
- "id": "ChartAxisViewWindowOptions"
- },
- "BasicChartSeries": {
- "id": "BasicChartSeries",
- "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
- "type": "object",
- "properties": {
- "lineStyle": {
- "description": "The line style of this series. Valid only if the\nchartType is AREA,\nLINE, or SCATTER.\nCOMBO charts are also supported if the\nseries chart type is\nAREA or LINE.",
- "$ref": "LineStyle"
- },
- "series": {
- "$ref": "ChartData",
- "description": "The data being visualized in this chart series."
- },
- "type": {
- "enumDescriptions": [
- "Default value, do not use.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
- "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter\nchart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area\nchart\u003c/a\u003e."
- ],
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO",
- "STEPPED_AREA"
- ],
- "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
- "type": "string"
- },
- "targetAxis": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ],
- "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
- "type": "string"
- },
- "color": {
- "$ref": "Color",
- "description": "The color for elements (i.e. bars, lines, points) associated with this\nseries. If empty, a default color is used."
- }
- }
- },
- "Borders": {
- "description": "The borders of the cell.",
- "type": "object",
- "properties": {
- "top": {
- "description": "The top border of the cell.",
- "$ref": "Border"
- },
- "left": {
- "description": "The left border of the cell.",
- "$ref": "Border"
- },
- "right": {
- "$ref": "Border",
- "description": "The right border of the cell."
- },
- "bottom": {
- "description": "The bottom border of the cell.",
- "$ref": "Border"
- }
- },
- "id": "Borders"
- },
- "AutoResizeDimensionsRequest": {
- "properties": {
- "dimensions": {
- "description": "The dimensions to automatically resize.",
- "$ref": "DimensionRange"
- }
- },
- "id": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
- "type": "object"
- },
- "ManualRule": {
- "description": "Allows you to manually organize the values in a source data column into\nbuckets with names of your choosing. For example, a pivot table that\naggregates population by state:\n\n +-------+-------------------+\n | State | SUM of Population |\n +-------+-------------------+\n | AK | 0.7 |\n | AL | 4.8 |\n | AR | 2.9 |\n ...\n +-------+-------------------+\ncould be turned into a pivot table that aggregates population by time zone\nby providing a list of groups (for example, groupName = 'Central',\nitems = ['AL', 'AR', 'IA', ...]) to a manual group rule.\nNote that a similar effect could be achieved by adding a time zone column\nto the source data and adjusting the pivot table.\n\n +-----------+-------------------+\n | Time Zone | SUM of Population |\n +-----------+-------------------+\n | Central | 106.3 |\n | Eastern | 151.9 |\n | Mountain | 17.4 |\n ...\n +-----------+-------------------+",
- "type": "object",
- "properties": {
- "groups": {
- "description": "The list of group names and the corresponding items from the source data\nthat map to each group name.",
- "type": "array",
- "items": {
- "$ref": "ManualRuleGroup"
- }
- }
- },
- "id": "ManualRule"
- },
- "UpdateBordersRequest": {
- "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
- "type": "object",
- "properties": {
- "bottom": {
- "$ref": "Border",
- "description": "The border to put at the bottom of the range."
- },
- "innerVertical": {
- "$ref": "Border",
- "description": "The vertical border to put within the range."
- },
- "right": {
- "description": "The border to put at the right of the range.",
- "$ref": "Border"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range whose borders should be updated."
- },
- "innerHorizontal": {
- "$ref": "Border",
- "description": "The horizontal border to put within the range."
- },
- "top": {
- "description": "The border to put at the top of the range.",
- "$ref": "Border"
- },
- "left": {
- "description": "The border to put at the left of the range.",
- "$ref": "Border"
- }
- },
- "id": "UpdateBordersRequest"
- },
- "CellFormat": {
- "type": "object",
- "properties": {
- "hyperlinkDisplayType": {
- "enumDescriptions": [
- "The default value: the hyperlink is rendered. Do not use this.",
- "A hyperlink should be explicitly rendered.",
- "A hyperlink should not be rendered."
- ],
- "enum": [
- "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
- "LINKED",
- "PLAIN_TEXT"
- ],
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "type": "string"
- },
- "horizontalAlignment": {
- "description": "The horizontal alignment of the value in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The horizontal alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ]
- },
- "textFormat": {
- "$ref": "TextFormat",
- "description": "The format of the text in the cell (unless overridden by a format run)."
- },
- "backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the cell."
- },
- "padding": {
- "description": "The padding of the cell.",
- "$ref": "Padding"
- },
- "verticalAlignment": {
- "description": "The vertical alignment of the value in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The vertical alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the top of the cell.",
- "The text is explicitly aligned to the middle of the cell.",
- "The text is explicitly aligned to the bottom of the cell."
- ],
- "enum": [
- "VERTICAL_ALIGN_UNSPECIFIED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
- ]
- },
- "borders": {
- "description": "The borders of the cell.",
- "$ref": "Borders"
- },
- "textDirection": {
- "enumDescriptions": [
- "The text direction is not specified. Do not use this.",
- "The text direction of left-to-right was set by the user.",
- "The text direction of right-to-left was set by the user."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ],
- "description": "The direction of the text in the cell.",
- "type": "string"
- },
- "textRotation": {
- "$ref": "TextRotation",
- "description": "The rotation applied to text in a cell"
- },
- "wrapStrategy": {
- "enum": [
- "WRAP_STRATEGY_UNSPECIFIED",
- "OVERFLOW_CELL",
- "LEGACY_WRAP",
- "CLIP",
- "WRAP"
- ],
- "description": "The wrap strategy for the value in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
- "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |",
- "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |",
- "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |"
- ]
- },
- "numberFormat": {
- "description": "A format describing how number values should be represented to the user.",
- "$ref": "NumberFormat"
- }
- },
- "id": "CellFormat",
- "description": "The format of a cell."
- },
- "ClearValuesResponse": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "clearedRange": {
- "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
- "type": "string"
- }
- },
- "id": "ClearValuesResponse"
- },
- "DeleteConditionalFormatRuleRequest": {
- "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
- "type": "object",
- "properties": {
- "index": {
- "description": "The zero-based index of the rule to be deleted.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet the rule is being deleted from.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteConditionalFormatRuleRequest"
- },
- "DeleteNamedRangeRequest": {
- "properties": {
- "namedRangeId": {
- "description": "The ID of the named range to delete.",
- "type": "string"
- }
- },
- "id": "DeleteNamedRangeRequest",
- "description": "Removes the named range with the given ID from the spreadsheet.",
- "type": "object"
- },
- "AddBandingResponse": {
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
- }
- },
- "id": "AddBandingResponse",
- "description": "The result of adding a banded range."
- },
- "WaterfallChartCustomSubtotal": {
- "description": "A custom subtotal column for a waterfall chart series.",
- "type": "object",
- "properties": {
- "subtotalIndex": {
- "description": "The 0-based index of a data point within the series. If\ndata_is_subtotal is true, the data point at this index is the\nsubtotal. Otherwise, the subtotal appears after the data point with\nthis index. A series can have multiple subtotals at arbitrary indices,\nbut subtotals do not affect the indices of the data points. For\nexample, if a series has three data points, their indices will always\nbe 0, 1, and 2, regardless of how many subtotals exist on the series or\nwhat data points they are associated with.",
- "format": "int32",
- "type": "integer"
- },
- "dataIsSubtotal": {
- "description": "True if the data point at subtotal_index is the subtotal. If false,\nthe subtotal will be computed and appear after the data point.",
- "type": "boolean"
- },
- "label": {
- "description": "A label for the subtotal column.",
- "type": "string"
- }
- },
- "id": "WaterfallChartCustomSubtotal"
- },
- "AddDimensionGroupResponse": {
- "description": "The result of adding a group.",
- "type": "object",
- "properties": {
- "dimensionGroups": {
- "description": "All groups of a dimension after adding a group to that dimension.",
- "type": "array",
- "items": {
- "$ref": "DimensionGroup"
- }
- }
- },
- "id": "AddDimensionGroupResponse"
- },
- "ChartData": {
- "description": "The data included in a domain or series.",
- "type": "object",
- "properties": {
- "sourceRange": {
- "description": "The source ranges of the data.",
- "$ref": "ChartSourceRange"
- }
- },
- "id": "ChartData"
- },
- "BatchGetValuesResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- },
- "valueRanges": {
- "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- }
- }
- },
- "id": "BatchGetValuesResponse"
- },
- "UpdateBandingRequest": {
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to update with the new properties."
- }
- },
- "id": "UpdateBandingRequest",
- "description": "Updates properties of the supplied banded range."
- },
- "Color": {
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well.\n\nNote: this proto does not carry information about the absolute color space\nthat should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,\nDCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color\nspace.\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [[Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object",
- "properties": {
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "green": {
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "alpha": {
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Color"
- },
- "ManualRuleGroup": {
- "id": "ManualRuleGroup",
- "description": "A group name and a list of items from the source data that should be placed\nin the group with this name.",
- "type": "object",
- "properties": {
- "groupName": {
- "$ref": "ExtendedValue",
- "description": "The group name, which must be a string. Each group in a given\nManualRule must have a unique group name."
- },
- "items": {
- "description": "The items in the source data that should be placed into this group. Each\nitem may be a string, number, or boolean. Items may appear in at most one\ngroup within a given ManualRule. Items that do not appear in any\ngroup will appear on their own.",
- "type": "array",
- "items": {
- "$ref": "ExtendedValue"
- }
- }
- }
- },
- "PivotGroup": {
- "description": "A single grouping (either row or column) in a pivot table.",
- "type": "object",
- "properties": {
- "repeatHeadings": {
- "description": "True if the headings in this pivot group should be repeated.\nThis is only valid for row groupings and is ignored by columns.\n\nBy default, we minimize repitition of headings by not showing higher\nlevel headings where they are the same. For example, even though the\nthird row below corresponds to \"Q1 Mar\", \"Q1\" is not shown because\nit is redundant with previous rows. Setting repeat_headings to true\nwould cause \"Q1\" to be repeated for \"Feb\" and \"Mar\".\n\n +--------------+\n | Q1 | Jan |\n | | Feb |\n | | Mar |\n +--------+-----+\n | Q1 Total |\n +--------------+",
- "type": "boolean"
- },
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
- "format": "int32",
- "type": "integer"
- },
- "sortOrder": {
- "description": "The order the values in this group should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ]
- },
- "valueBucket": {
- "$ref": "PivotGroupSortValueBucket",
- "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
- },
- "showTotals": {
- "description": "True if the pivot table should include the totals for this grouping.",
- "type": "boolean"
- },
- "valueMetadata": {
- "description": "Metadata about values in the grouping.",
- "type": "array",
- "items": {
- "$ref": "PivotGroupValueMetadata"
- }
- },
- "groupRule": {
- "$ref": "PivotGroupRule",
- "description": "The group rule to apply to this row/column group."
- },
- "label": {
- "description": "The labels to use for the row/column groups which can be customized. For\nexample, in the following pivot table, the row label is `Region` (which\ncould be renamed to `State`) and the column label is `Product` (which\ncould be renamed `Item`). Pivot tables created before December 2017 do\nnot have header labels. If you'd like to add header labels to an existing\npivot table, please delete the existing pivot table and then create a new\npivot table with same parameters.\n\n +--------------+---------+-------+\n | SUM of Units | Product | |\n | Region | Pen | Paper |\n +--------------+---------+-------+\n | New York | 345 | 98 |\n | Oregon | 234 | 123 |\n | Tennessee | 531 | 415 |\n +--------------+---------+-------+\n | Grand Total | 1110 | 636 |\n +--------------+---------+-------+",
- "type": "string"
- }
- },
- "id": "PivotGroup"
- },
- "TrimWhitespaceRequest": {
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range whose cells to trim."
- }
- },
- "id": "TrimWhitespaceRequest",
- "description": "Trims the whitespace (such as spaces, tabs, or new lines) in every cell in\nthe specified range. This request removes all whitespace from the start and\nend of each cell's text, and reduces any subsequence of remaining whitespace\ncharacters to a single space. If the resulting trimmed text starts with a '+'\nor '=' character, the text remains as a string value and isn't interpreted\nas a formula.",
- "type": "object"
- },
- "TrimWhitespaceResponse": {
- "description": "The result of trimming whitespace in cells.",
- "type": "object",
- "properties": {
- "cellsChangedCount": {
- "description": "The number of cells that were trimmed of whitespace.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TrimWhitespaceResponse"
- },
- "PivotTable": {
- "description": "A pivot table.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "An optional mapping of filters per source column offset.\n\nThe filters are applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
- "type": "object",
- "additionalProperties": {
- "$ref": "PivotFilterCriteria"
- }
- },
- "rows": {
- "description": "Each row grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
- },
- "valueLayout": {
- "enumDescriptions": [
- "Values are laid out horizontally (as columns).",
- "Values are laid out vertically (as rows)."
- ],
- "enum": [
- "HORIZONTAL",
- "VERTICAL"
- ],
- "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
- "type": "string"
- },
- "source": {
- "$ref": "GridRange",
- "description": "The range the pivot table is reading data from."
- },
- "columns": {
- "description": "Each column grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
- },
- "values": {
- "description": "A list of values to include in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotValue"
- }
- }
- },
- "id": "PivotTable"
- },
- "ChartSourceRange": {
- "description": "Source ranges for a chart.",
- "type": "object",
- "properties": {
- "sources": {
- "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be in order and contiguous across the domain\nand series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- }
- },
- "id": "ChartSourceRange"
- },
- "SearchDeveloperMetadataResponse": {
- "description": "A reply to a developer metadata search request.",
- "type": "object",
- "properties": {
- "matchedDeveloperMetadata": {
- "description": "The metadata matching the criteria of the search request.",
- "type": "array",
- "items": {
- "$ref": "MatchedDeveloperMetadata"
- }
- }
- },
- "id": "SearchDeveloperMetadataResponse"
- },
- "ValueRange": {
- "properties": {
- "majorDimension": {
- "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "values": {
- "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
- }
- },
- "id": "ValueRange",
- "description": "Data within a range of the spreadsheet.",
- "type": "object"
- },
- "AppendCellsRequest": {
- "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
- "type": "object",
- "properties": {
- "rows": {
- "description": "The data to append.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "sheetId": {
- "description": "The sheet ID to append the data to.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AppendCellsRequest"
- },
- "AddBandingRequest": {
- "description": "Adds a new banded range to the spreadsheet.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
- }
- },
- "id": "AddBandingRequest"
- },
- "Response": {
- "description": "A single response from an update.",
- "type": "object",
- "properties": {
- "addProtectedRange": {
- "description": "A reply from adding a protected range.",
- "$ref": "AddProtectedRangeResponse"
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetResponse",
- "description": "A reply from duplicating a sheet."
- },
- "updateEmbeddedObjectPosition": {
- "description": "A reply from updating an embedded object's position.",
- "$ref": "UpdateEmbeddedObjectPositionResponse"
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleResponse",
- "description": "A reply from deleting a conditional format rule."
- },
- "deleteDimensionGroup": {
- "$ref": "DeleteDimensionGroupResponse",
- "description": "A reply from deleting a dimension group."
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewResponse",
- "description": "A reply from duplicating a filter view."
- },
- "addDimensionGroup": {
- "description": "A reply from adding a dimension group.",
- "$ref": "AddDimensionGroupResponse"
- },
- "addChart": {
- "$ref": "AddChartResponse",
- "description": "A reply from adding a chart."
- },
- "updateDeveloperMetadata": {
- "description": "A reply from updating a developer metadata entry.",
- "$ref": "UpdateDeveloperMetadataResponse"
- },
- "findReplace": {
- "$ref": "FindReplaceResponse",
- "description": "A reply from doing a find/replace."
- },
- "addSheet": {
- "$ref": "AddSheetResponse",
- "description": "A reply from adding a sheet."
- },
- "updateConditionalFormatRule": {
- "description": "A reply from updating a conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleResponse"
- },
- "createDeveloperMetadata": {
- "$ref": "CreateDeveloperMetadataResponse",
- "description": "A reply from creating a developer metadata entry."
- },
- "addNamedRange": {
- "description": "A reply from adding a named range.",
- "$ref": "AddNamedRangeResponse"
- },
- "deleteDeveloperMetadata": {
- "$ref": "DeleteDeveloperMetadataResponse",
- "description": "A reply from deleting a developer metadata entry."
- },
- "trimWhitespace": {
- "description": "A reply from trimming whitespace.",
- "$ref": "TrimWhitespaceResponse"
- },
- "addFilterView": {
- "$ref": "AddFilterViewResponse",
- "description": "A reply from adding a filter view."
- },
- "deleteDuplicates": {
- "$ref": "DeleteDuplicatesResponse",
- "description": "A reply from removing rows containing duplicate values."
- },
- "addBanding": {
- "description": "A reply from adding a banded range.",
- "$ref": "AddBandingResponse"
- }
- },
- "id": "Response"
- },
- "EmbeddedChart": {
- "description": "A chart embedded in a sheet.",
- "type": "object",
- "properties": {
- "chartId": {
- "description": "The ID of the chart.",
- "format": "int32",
- "type": "integer"
- },
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The position of the chart."
- },
- "spec": {
- "description": "The specification of the chart.",
- "$ref": "ChartSpec"
- }
- },
- "id": "EmbeddedChart"
- },
- "TextFormatRun": {
- "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
- "type": "object",
- "properties": {
- "format": {
- "description": "The format of this run. Absent values inherit the cell's format.",
- "$ref": "TextFormat"
- },
- "startIndex": {
- "description": "The character index where this run starts.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextFormatRun"
- },
- "InsertRangeRequest": {
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "type": "object",
- "properties": {
- "shiftDimension": {
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ]
- },
- "range": {
- "description": "The range to insert new cells into.",
- "$ref": "GridRange"
- }
- },
- "id": "InsertRangeRequest"
- },
- "AddNamedRangeResponse": {
- "description": "The result of adding a named range.",
- "type": "object",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add."
- }
- },
- "id": "AddNamedRangeResponse"
- },
- "BatchUpdateValuesByDataFilterResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "totalUpdatedRows": {
- "description": "The total number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "responses": {
- "description": "The response for each range updated.",
- "type": "array",
- "items": {
- "$ref": "UpdateValuesByDataFilterResponse"
- }
- },
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdateValuesByDataFilterResponse"
- },
- "RowData": {
- "description": "Data about each cell in a row.",
- "type": "object",
- "properties": {
- "values": {
- "description": "The values in the row, one per column.",
- "type": "array",
- "items": {
- "$ref": "CellData"
- }
- }
- },
- "id": "RowData"
- },
- "Border": {
- "type": "object",
- "properties": {
- "style": {
- "enum": [
- "STYLE_UNSPECIFIED",
- "DOTTED",
- "DASHED",
- "SOLID",
- "SOLID_MEDIUM",
- "SOLID_THICK",
- "NONE",
- "DOUBLE"
- ],
- "description": "The style of the border.",
- "type": "string",
- "enumDescriptions": [
- "The style is not specified. Do not use this.",
- "The border is dotted.",
- "The border is dashed.",
- "The border is a thin solid line.",
- "The border is a medium solid line.",
- "The border is a thick solid line.",
- "No border.\nUsed only when updating a border in order to erase it.",
- "The border is two solid lines."
- ]
- },
- "color": {
- "$ref": "Color",
- "description": "The color of the border."
- },
- "width": {
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Border",
- "description": "A border along a cell."
- },
- "GridData": {
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "type": "object",
- "properties": {
- "columnMetadata": {
- "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- },
- "startColumn": {
- "description": "The first column this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- },
- "rowMetadata": {
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- },
- "rowData": {
- "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "startRow": {
- "description": "The first row this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridData"
- },
- "UpdateNamedRangeRequest": {
- "description": "Updates properties of the named range with the specified\nnamedRangeId.",
- "type": "object",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateNamedRangeRequest"
- },
- "FindReplaceRequest": {
- "id": "FindReplaceRequest",
- "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
- "type": "object",
- "properties": {
- "matchCase": {
- "description": "True if the search is case sensitive.",
- "type": "boolean"
- },
- "allSheets": {
- "description": "True to find/replace over all sheets.",
- "type": "boolean"
- },
- "includeFormulas": {
- "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
- "type": "boolean"
- },
- "matchEntireCell": {
- "type": "boolean",
- "description": "True if the find value should match the entire cell."
- },
- "find": {
- "description": "The value to search.",
- "type": "string"
- },
- "searchByRegex": {
- "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
- "type": "boolean"
- },
- "replacement": {
- "description": "The value to use as the replacement.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range to find/replace over."
- },
- "sheetId": {
- "description": "The sheet to find/replace over.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "AddSheetRequest": {
- "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)",
- "$ref": "SheetProperties"
- }
- },
- "id": "AddSheetRequest"
- },
- "UpdateCellsRequest": {
- "description": "Updates all cells in a range with new data.",
- "type": "object",
- "properties": {
- "start": {
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.",
- "$ref": "GridCoordinate"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
- },
- "rows": {
- "description": "The data to write.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateCellsRequest"
- },
- "RandomizeRangeRequest": {
- "description": "Randomizes the order of the rows in a range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to randomize."
- }
- },
- "id": "RandomizeRangeRequest"
- },
- "DeleteConditionalFormatRuleResponse": {
- "description": "The result of deleting a conditional format rule.",
- "type": "object",
- "properties": {
- "rule": {
- "description": "The rule that was deleted.",
- "$ref": "ConditionalFormatRule"
- }
- },
- "id": "DeleteConditionalFormatRuleResponse"
- },
- "DeleteRangeRequest": {
- "description": "Deletes a range of cells, shifting other cells into the deleted area.",
- "type": "object",
- "properties": {
- "shiftDimension": {
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells."
- },
- "range": {
- "description": "The range of cells to delete.",
- "$ref": "GridRange"
- }
- },
- "id": "DeleteRangeRequest"
- },
- "DeleteDuplicatesResponse": {
- "description": "The result of removing duplicates in a range.",
- "type": "object",
- "properties": {
- "duplicatesRemovedCount": {
- "description": "The number of duplicate rows removed.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteDuplicatesResponse"
- },
- "GridCoordinate": {
- "properties": {
- "sheetId": {
- "description": "The sheet this coordinate is on.",
- "format": "int32",
- "type": "integer"
- },
- "rowIndex": {
- "description": "The row index of the coordinate.",
- "format": "int32",
- "type": "integer"
- },
- "columnIndex": {
- "description": "The column index of the coordinate.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridCoordinate",
- "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
- "type": "object"
- },
- "UpdateSheetPropertiesRequest": {
- "description": "Updates properties of the sheet with the specified\nsheetId.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties to update."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateSheetPropertiesRequest"
- },
- "UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.",
- "$ref": "GridRange"
- }
- },
- "id": "UnmergeCellsRequest"
- },
- "GridProperties": {
- "description": "Properties of a grid.",
- "type": "object",
- "properties": {
- "rowGroupControlAfter": {
- "description": "True if the row grouping control toggle is shown after the group.",
- "type": "boolean"
- },
- "rowCount": {
- "description": "The number of rows in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "hideGridlines": {
- "description": "True if the grid isn't showing gridlines in the UI.",
- "type": "boolean"
- },
- "frozenRowCount": {
- "description": "The number of rows that are frozen in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "columnCount": {
- "type": "integer",
- "description": "The number of columns in the grid.",
- "format": "int32"
- },
- "frozenColumnCount": {
- "description": "The number of columns that are frozen in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "columnGroupControlAfter": {
- "description": "True if the column grouping control toggle is shown after the group.",
- "type": "boolean"
- }
- },
- "id": "GridProperties"
- },
- "SortSpec": {
- "id": "SortSpec",
- "description": "A sort order associated with a specific column or row.",
- "type": "object",
- "properties": {
- "dimensionIndex": {
- "description": "The dimension the sort should be applied to.",
- "format": "int32",
- "type": "integer"
- },
- "sortOrder": {
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The order data should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ]
- }
- }
- },
- "Sheet": {
- "properties": {
- "merges": {
- "description": "The ranges that are merged together.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "bandedRanges": {
- "description": "The banded (alternating colors) ranges on this sheet.",
- "type": "array",
- "items": {
- "$ref": "BandedRange"
- }
- },
- "charts": {
- "description": "The specifications of every chart on this sheet.",
- "type": "array",
- "items": {
- "$ref": "EmbeddedChart"
- }
- },
- "filterViews": {
- "description": "The filter views in this sheet.",
- "type": "array",
- "items": {
- "$ref": "FilterView"
- }
- },
- "rowGroups": {
- "description": "All row groups on this sheet, ordered by increasing range start index, then\nby group depth.",
- "type": "array",
- "items": {
- "$ref": "DimensionGroup"
- }
- },
- "data": {
- "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
- "type": "array",
- "items": {
- "$ref": "GridData"
- }
- },
- "properties": {
- "description": "The properties of the sheet.",
- "$ref": "SheetProperties"
- },
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ConditionalFormatRule"
- }
- },
- "columnGroups": {
- "type": "array",
- "items": {
- "$ref": "DimensionGroup"
- },
- "description": "All column groups on this sheet, ordered by increasing range start index,\nthen by group depth."
- },
- "protectedRanges": {
- "description": "The protected ranges in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ProtectedRange"
- }
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a sheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "basicFilter": {
- "$ref": "BasicFilter",
- "description": "The filter on this sheet, if any."
- }
- },
- "id": "Sheet",
- "description": "A sheet in a spreadsheet.",
- "type": "object"
- },
- "UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
- "type": "object",
- "properties": {
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The new position of the embedded object."
- }
- },
- "id": "UpdateEmbeddedObjectPositionResponse"
- },
- "BooleanRule": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "CellFormat",
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
- },
- "condition": {
- "description": "The condition of the rule. If the condition evaluates to true,\nthe format is applied.",
- "$ref": "BooleanCondition"
- }
- },
- "id": "BooleanRule",
- "description": "A rule that may or may not match, depending on the condition."
- },
- "FilterCriteria": {
- "id": "FilterCriteria",
- "description": "Criteria for showing/hiding rows in a filter or filter view.",
- "type": "object",
- "properties": {
- "hiddenValues": {
- "description": "Values that should be hidden.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "condition": {
- "$ref": "BooleanCondition",
- "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
- }
- }
- },
- "PivotGroupValueMetadata": {
- "description": "Metadata about a value in a pivot grouping.",
- "type": "object",
- "properties": {
- "value": {
- "$ref": "ExtendedValue",
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)"
- },
- "collapsed": {
- "description": "True if the data corresponding to the value is collapsed.",
- "type": "boolean"
- }
- },
- "id": "PivotGroupValueMetadata"
- },
- "WaterfallChartSpec": {
- "description": "A waterfall chart.",
- "type": "object",
- "properties": {
- "connectorLineStyle": {
- "description": "The line style for the connector lines.",
- "$ref": "LineStyle"
- },
- "domain": {
- "$ref": "WaterfallChartDomain",
- "description": "The domain data (horizontal axis) for the waterfall chart."
- },
- "firstValueIsTotal": {
- "description": "True to interpret the first value as a total.",
- "type": "boolean"
- },
- "stackedType": {
- "description": "The stacked type.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "Values corresponding to the same domain (horizontal axis) value will be\nstacked vertically.",
- "Series will spread out along the horizontal axis."
- ],
- "enum": [
- "WATERFALL_STACKED_TYPE_UNSPECIFIED",
- "STACKED",
- "SEQUENTIAL"
- ]
- },
- "hideConnectorLines": {
- "description": "True to hide connector lines between columns.",
- "type": "boolean"
- },
- "series": {
- "description": "The data this waterfall chart is visualizing.",
- "type": "array",
- "items": {
- "$ref": "WaterfallChartSeries"
- }
- }
- },
- "id": "WaterfallChartSpec"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Sheets",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "See, edit, create, and delete your spreadsheets in Google Drive"
- },
- "https://www.googleapis.com/auth/drive.file": {
- "description": "View and manage Google Drive files and folders that you have opened or created with this app"
- },
- "https://www.googleapis.com/auth/drive": {
- "description": "See, edit, create, and delete all of your Google Drive files"
- },
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "See and download all your Google Drive files"
- },
- "https://www.googleapis.com/auth/spreadsheets.readonly": {
- "description": "View your Google Spreadsheets"
- }
- }
- }
- },
- "rootUrl": "https://sheets.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "sheets",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Sheets API",
- "ownerName": "Google",
- "resources": {
- "spreadsheets": {
- "resources": {
- "developerMetadata": {
"methods": {
- "search": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
- "id": "sheets.spreadsheets.developerMetadata.search",
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
- "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.",
- "request": {
- "$ref": "SearchDeveloperMetadataRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "SearchDeveloperMetadataResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve metadata from.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ]
- },
"get": {
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.get",
+ "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
"response": {
- "$ref": "DeveloperMetadata"
+ "$ref": "ValueRange"
},
"parameterOrder": [
"spreadsheetId",
- "metadataId"
+ "range"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
],
"parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve metadata from.",
- "required": true,
- "type": "string",
- "location": "path"
+ "majorDimension": {
+ "location": "query",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then\nrequesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` returns\n`[[1,3],[2,4]]`.",
+ "type": "string"
},
- "metadataId": {
- "location": "path",
- "description": "The ID of the developer metadata to retrieve.",
- "format": "int32",
- "required": true,
- "type": "integer"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
- "id": "sheets.spreadsheets.developerMetadata.get",
- "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId."
- }
- }
- },
- "values": {
- "methods": {
- "get": {
- "parameters": {
"spreadsheetId": {
"required": true,
"type": "string",
@@ -5384,75 +273,47 @@
"description": "The ID of the spreadsheet to retrieve data from."
},
"range": {
- "location": "path",
- "description": "The A1 notation of the values to retrieve.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve."
},
"valueRenderOption": {
- "location": "query",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
],
"description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"dateTimeRenderOption": {
- "type": "string",
"location": "query",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
],
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]."
- },
- "majorDimension": {
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string",
- "location": "query",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get",
- "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
- "response": {
- "$ref": "ValueRange"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "GET"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}"
},
"batchUpdateByDataFilter": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
"response": {
"$ref": "BatchUpdateValuesByDataFilterResponse"
},
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"spreadsheetId": {
- "location": "path",
"description": "The ID of the spreadsheet to update.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -5461,60 +322,68 @@
"https://www.googleapis.com/auth/spreadsheets"
],
"flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
- "id": "sheets.spreadsheets.values.batchUpdateByDataFilter",
"path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "id": "sheets.spreadsheets.values.batchUpdateByDataFilter",
"description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges.",
"request": {
"$ref": "BatchUpdateValuesByDataFilterRequest"
}
},
"update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
"parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ },
+ "responseValueRenderOption": {
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ },
"valueInputOption": {
+ "type": "string",
"location": "query",
"enum": [
"INPUT_VALUE_OPTION_UNSPECIFIED",
"RAW",
"USER_ENTERED"
],
- "description": "How the input data should be interpreted.",
- "type": "string"
+ "description": "How the input data should be interpreted."
},
"responseDateTimeRenderOption": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "type": "string",
"location": "query",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string"
+ ]
},
"range": {
- "location": "path",
"description": "The A1 notation of the values to update.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"includeValuesInResponse": {
+ "type": "boolean",
"location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
- "type": "boolean"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "responseValueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than the range actually written, the\nresponse includes all values in the requested range (excluding trailing\nempty rows and columns)."
}
},
"scopes": [
@@ -5528,21 +397,9 @@
"description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
"request": {
"$ref": "ValueRange"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "UpdateValuesResponse"
}
},
"batchUpdate": {
- "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
- "request": {
- "$ref": "BatchUpdateValuesRequest"
- },
"response": {
"$ref": "BatchUpdateValuesResponse"
},
@@ -5550,45 +407,12 @@
"spreadsheetId"
],
"httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "id": "sheets.spreadsheets.values.batchUpdate"
- },
- "clear": {
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "id": "sheets.spreadsheets.values.clear",
- "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "ClearValuesRequest"
- },
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "POST",
"parameters": {
- "range": {
- "description": "The A1 notation of the values to clear.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"spreadsheetId": {
"description": "The ID of the spreadsheet to update.",
"required": true,
@@ -5596,14 +420,16 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateValuesRequest"
+ },
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges."
},
"batchGet": {
+ "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
"response": {
"$ref": "BatchGetValuesResponse"
},
@@ -5611,13 +437,14 @@
"spreadsheetId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
"parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string"
- },
"valueRenderOption": {
"location": "query",
"enum": [
@@ -5638,157 +465,196 @@
"type": "string"
},
"ranges": {
- "description": "The A1 notation of the values to retrieve.",
- "type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "The A1 notation of the values to retrieve.",
+ "type": "string"
},
"majorDimension": {
+ "location": "query",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` returns\n`[[1,3],[2,4]]`.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
"flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
"path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "id": "sheets.spreadsheets.values.batchGet",
- "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges."
+ "id": "sheets.spreadsheets.values.batchGet"
},
- "batchClearByDataFilter": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
+ "clear": {
+ "request": {
+ "$ref": "ClearValuesRequest"
+ },
+ "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
"response": {
- "$ref": "BatchClearValuesByDataFilterResponse"
+ "$ref": "ClearValuesResponse"
},
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"parameters": {
"spreadsheetId": {
+ "location": "path",
"description": "The ID of the spreadsheet to update.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to clear.",
+ "required": true,
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
- "id": "sheets.spreadsheets.values.batchClearByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear"
+ },
+ "batchClearByDataFilter": {
"description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.",
"request": {
"$ref": "BatchClearValuesByDataFilterRequest"
- }
- },
- "append": {
+ },
"response": {
- "$ref": "AppendValuesResponse"
+ "$ref": "BatchClearValuesByDataFilterResponse"
},
"parameterOrder": [
- "spreadsheetId",
- "range"
+ "spreadsheetId"
],
"httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "id": "sheets.spreadsheets.values.batchClearByDataFilter"
+ },
+ "append": {
"parameters": {
- "range": {
- "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "includeValuesInResponse": {
- "type": "boolean",
- "location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values."
- },
"spreadsheetId": {
+ "location": "path",
"description": "The ID of the spreadsheet to update.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"responseValueRenderOption": {
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
"location": "query",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
- ],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
+ ]
},
"insertDataOption": {
- "description": "How the input data should be inserted.",
- "type": "string",
- "location": "query",
"enum": [
"OVERWRITE",
"INSERT_ROWS"
- ]
+ ],
+ "description": "How the input data should be inserted.",
+ "type": "string",
+ "location": "query"
},
"valueInputOption": {
+ "type": "string",
"location": "query",
"enum": [
"INPUT_VALUE_OPTION_UNSPECIFIED",
"RAW",
"USER_ENTERED"
],
- "description": "How the input data should be interpreted.",
- "type": "string"
+ "description": "How the input data should be interpreted."
},
"responseDateTimeRenderOption": {
+ "type": "string",
"location": "query",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]."
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues are appended after the last row of the table.",
+ "required": true,
"type": "string"
+ },
+ "includeValuesInResponse": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values."
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
"path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
"id": "sheets.spreadsheets.values.append",
+ "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
"request": {
"$ref": "ValueRange"
},
- "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto."
+ "response": {
+ "$ref": "AppendValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "POST"
},
"batchGetByDataFilter": {
"flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
- "id": "sheets.spreadsheets.values.batchGetByDataFilter",
"path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
- "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.",
+ "id": "sheets.spreadsheets.values.batchGetByDataFilter",
"request": {
"$ref": "BatchGetValuesByDataFilterRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
+ "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.",
"response": {
"$ref": "BatchGetValuesByDataFilterResponse"
},
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"parameters": {
"spreadsheetId": {
"location": "path",
@@ -5796,14 +662,13 @@
"required": true,
"type": "string"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ]
+ }
},
"batchClear": {
+ "request": {
+ "$ref": "BatchClearValuesRequest"
+ },
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
"response": {
"$ref": "BatchClearValuesResponse"
},
@@ -5811,6 +676,11 @@
"spreadsheetId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"parameters": {
"spreadsheetId": {
"required": true,
@@ -5819,269 +689,5905 @@
"description": "The ID of the spreadsheet to update."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
"flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
"path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "BatchClearValuesRequest"
- }
+ "id": "sheets.spreadsheets.values.batchClear"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "prettyPrint": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://sheets.googleapis.com/",
+ "servicePath": "",
+ "description": "Reads and writes Google Sheets.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "revision": "20200312",
+ "documentationLink": "https://developers.google.com/sheets/",
+ "id": "sheets:v4",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "DeleteDeveloperMetadataResponse": {
+ "description": "The response from deleting developer metadata.",
+ "type": "object",
+ "properties": {
+ "deletedDeveloperMetadata": {
+ "description": "The metadata that was deleted.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ },
+ "id": "DeleteDeveloperMetadataResponse"
+ },
+ "SortRangeRequest": {
+ "description": "Sorts data in rows based on a sort order per column.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The range to sort.",
+ "$ref": "GridRange"
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "SortSpec"
+ }
+ }
+ },
+ "id": "SortRangeRequest"
+ },
+ "MergeCellsRequest": {
+ "description": "Merges all cells in the range.",
+ "type": "object",
+ "properties": {
+ "mergeType": {
+ "description": "How the cells should be merged.",
+ "type": "string",
+ "enumDescriptions": [
+ "Create a single merge from the range",
+ "Create a merge for each column in the range",
+ "Create a merge for each row in the range"
+ ],
+ "enum": [
+ "MERGE_ALL",
+ "MERGE_COLUMNS",
+ "MERGE_ROWS"
+ ]
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to merge."
+ }
+ },
+ "id": "MergeCellsRequest"
+ },
+ "MatchedDeveloperMetadata": {
+ "properties": {
+ "dataFilters": {
+ "description": "All filters matching the returned developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ },
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata matching the specified filters."
+ }
+ },
+ "id": "MatchedDeveloperMetadata",
+ "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
+ "type": "object"
+ },
+ "AddProtectedRangeRequest": {
+ "description": "Adds a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)",
+ "$ref": "ProtectedRange"
+ }
+ },
+ "id": "AddProtectedRangeRequest"
+ },
+ "DuplicateFilterViewResponse": {
+ "description": "The result of a filter view being duplicated.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly created filter."
+ }
+ },
+ "id": "DuplicateFilterViewResponse"
+ },
+ "DuplicateSheetResponse": {
+ "description": "The result of duplicating a sheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the duplicate sheet."
+ }
+ },
+ "id": "DuplicateSheetResponse"
+ },
+ "BatchUpdateSpreadsheetResponse": {
+ "id": "BatchUpdateSpreadsheetResponse",
+ "description": "The reply for batch updating a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "replies": {
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
+ "type": "array",
+ "items": {
+ "$ref": "Response"
+ }
+ },
+ "updatedSpreadsheet": {
+ "$ref": "Spreadsheet",
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ }
+ },
+ "AddFilterViewRequest": {
+ "description": "Adds a filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)"
+ }
+ },
+ "id": "AddFilterViewRequest"
+ },
+ "DataFilterValueRange": {
+ "properties": {
+ "dataFilter": {
+ "$ref": "DataFilter",
+ "description": "The data filter describing the location of the values in the spreadsheet."
+ },
+ "majorDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension of the values.",
+ "type": "string"
+ },
+ "values": {
+ "description": "The data to be written. If the provided values exceed any of the ranges\nmatched by the data filter then the request fails. If the provided values\nare less than the matched ranges only the specified values are written,\nexisting values in the matched ranges remain unaffected.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "DataFilterValueRange",
+ "description": "A range of values whose location is specified by a DataFilter.",
+ "type": "object"
+ },
+ "NumberFormat": {
+ "properties": {
+ "pattern": {
+ "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for\nmore information about the supported patterns.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "NUMBER_FORMAT_TYPE_UNSPECIFIED",
+ "TEXT",
+ "NUMBER",
+ "PERCENT",
+ "CURRENCY",
+ "DATE",
+ "TIME",
+ "DATE_TIME",
+ "SCIENTIFIC"
+ ],
+ "description": "The type of the number format.\nWhen writing, this field must be set.",
+ "type": "string",
+ "enumDescriptions": [
+ "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
+ "Text formatting, e.g `1000.12`",
+ "Number formatting, e.g, `1,000.12`",
+ "Percent formatting, e.g `10.12%`",
+ "Currency formatting, e.g `$1,000.12`",
+ "Date formatting, e.g `9/26/2008`",
+ "Time formatting, e.g `3:59:00 PM`",
+ "Date+Time formatting, e.g `9/26/08 15:59:00`",
+ "Scientific number formatting, e.g `1.01E+03`"
+ ]
+ }
+ },
+ "id": "NumberFormat",
+ "description": "The number format of a cell.",
+ "type": "object"
+ },
+ "OrgChartSpec": {
+ "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
+ "type": "object",
+ "properties": {
+ "tooltips": {
+ "$ref": "ChartData",
+ "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
+ },
+ "selectedNodeColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The color of the selected org chart nodes.\nIf selected_node_color is also set, this field takes precedence."
+ },
+ "selectedNodeColor": {
+ "description": "The color of the selected org chart nodes.",
+ "$ref": "Color"
+ },
+ "parentLabels": {
+ "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional.",
+ "$ref": "ChartData"
+ },
+ "labels": {
+ "$ref": "ChartData",
+ "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique."
+ },
+ "nodeSize": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The small org chart node size.",
+ "The medium org chart node size.",
+ "The large org chart node size."
+ ],
+ "enum": [
+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
+ "SMALL",
+ "MEDIUM",
+ "LARGE"
+ ],
+ "description": "The size of the org chart nodes.",
+ "type": "string"
+ },
+ "nodeColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The color of the org chart nodes.\nIf node_color is also set, this field takes precedence."
+ },
+ "nodeColor": {
+ "$ref": "Color",
+ "description": "The color of the org chart nodes."
+ }
+ },
+ "id": "OrgChartSpec"
+ },
+ "FilterView": {
+ "properties": {
+ "namedRangeId": {
+ "type": "string",
+ "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set."
+ },
+ "filterViewId": {
+ "description": "The ID of the filter view.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "criteria": {
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ }
+ },
+ "title": {
+ "description": "The name of the filter view.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "SortSpec"
+ }
+ }
+ },
+ "id": "FilterView",
+ "description": "A filter view.",
+ "type": "object"
+ },
+ "Slicer": {
+ "type": "object",
+ "properties": {
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The position of the slicer. Note that slicer can be positioned only on\nexisting sheet. Also, width and height of slicer can be automatically\nadjusted to keep it within permitted limits."
+ },
+ "spec": {
+ "$ref": "SlicerSpec",
+ "description": "The specification of the slicer."
+ },
+ "slicerId": {
+ "description": "The ID of the slicer.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Slicer",
+ "description": "A slicer in a sheet."
+ },
+ "SearchDeveloperMetadataRequest": {
+ "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ },
+ "description": "The data filters describing the criteria used to determine which\nDeveloperMetadata entries to return. DeveloperMetadata matching any of the\nspecified filters are included in the response."
+ }
+ },
+ "id": "SearchDeveloperMetadataRequest"
+ },
+ "BandingProperties": {
+ "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
+ "type": "object",
+ "properties": {
+ "headerColorStyle": {
+ "description": "The color of the first row or column. If this field is set, the first row\nor column is filled with this color and the colors alternate between\nfirst_band_color and second_band_color starting from the second\nrow or column. Otherwise, the first row or column is filled with\nfirst_band_color and the colors proceed to alternate as they normally\nwould. If header_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "footerColorStyle": {
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column is filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.\nIf footer_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "firstBandColorStyle": {
+ "description": "The first color that is alternating. (Required)\nIf first_band_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "secondBandColor": {
+ "$ref": "Color",
+ "description": "The second color that is alternating. (Required)"
+ },
+ "secondBandColorStyle": {
+ "description": "The second color that is alternating. (Required)\nIf second_band_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "footerColor": {
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column is filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.",
+ "$ref": "Color"
+ },
+ "headerColor": {
+ "description": "The color of the first row or column. If this field is set, the first row\nor column is filled with this color and the colors alternate between\nfirst_band_color and second_band_color starting from the second\nrow or column. Otherwise, the first row or column is filled with\nfirst_band_color and the colors proceed to alternate as they normally\nwould.",
+ "$ref": "Color"
+ },
+ "firstBandColor": {
+ "description": "The first color that is alternating. (Required)",
+ "$ref": "Color"
+ }
+ },
+ "id": "BandingProperties"
+ },
+ "AddProtectedRangeResponse": {
+ "description": "The result of adding a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The newly added protected range."
+ }
+ },
+ "id": "AddProtectedRangeResponse"
+ },
+ "BasicFilter": {
+ "description": "The default filter associated with a sheet.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the filter covers."
+ },
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object"
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "SortSpec"
+ }
+ }
+ },
+ "id": "BasicFilter"
+ },
+ "PivotValue": {
+ "type": "object",
+ "properties": {
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "A name to use for the value.",
+ "type": "string"
+ },
+ "formula": {
+ "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
+ "type": "string"
+ },
+ "calculatedDisplayType": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Shows the pivot values as percentage of the row total values.",
+ "Shows the pivot values as percentage of the column total values.",
+ "Shows the pivot values as percentage of the grand total values."
+ ],
+ "enum": [
+ "PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED",
+ "PERCENT_OF_ROW_TOTAL",
+ "PERCENT_OF_COLUMN_TOTAL",
+ "PERCENT_OF_GRAND_TOTAL"
+ ],
+ "description": "If specified, indicates that pivot values should be displayed as\nthe result of a calculation with another pivot value. For example, if\ncalculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the\npivot values are displayed as the percentage of the grand total. In\nthe Sheets UI, this is referred to as \"Show As\" in the value section of a\npivot table.",
+ "type": "string"
+ },
+ "summarizeFunction": {
+ "enum": [
+ "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
+ "SUM",
+ "COUNTA",
+ "COUNT",
+ "COUNTUNIQUE",
+ "AVERAGE",
+ "MAX",
+ "MIN",
+ "MEDIAN",
+ "PRODUCT",
+ "STDEV",
+ "STDEVP",
+ "VAR",
+ "VARP",
+ "CUSTOM"
+ ],
+ "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default, do not use.",
+ "Corresponds to the `SUM` function.",
+ "Corresponds to the `COUNTA` function.",
+ "Corresponds to the `COUNT` function.",
+ "Corresponds to the `COUNTUNIQUE` function.",
+ "Corresponds to the `AVERAGE` function.",
+ "Corresponds to the `MAX` function.",
+ "Corresponds to the `MIN` function.",
+ "Corresponds to the `MEDIAN` function.",
+ "Corresponds to the `PRODUCT` function.",
+ "Corresponds to the `STDEV` function.",
+ "Corresponds to the `STDEVP` function.",
+ "Corresponds to the `VAR` function.",
+ "Corresponds to the `VARP` function.",
+ "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
+ ]
+ }
+ },
+ "id": "PivotValue",
+ "description": "The definition of how a value in a pivot table should be calculated."
+ },
+ "ErrorValue": {
+ "description": "An error in a cell.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "The default error type, do not use this.",
+ "Corresponds to the `#ERROR!` error.",
+ "Corresponds to the `#NULL!` error.",
+ "Corresponds to the `#DIV/0` error.",
+ "Corresponds to the `#VALUE!` error.",
+ "Corresponds to the `#REF!` error.",
+ "Corresponds to the `#NAME?` error.",
+ "Corresponds to the `#NUM`! error.",
+ "Corresponds to the `#N/A` error.",
+ "Corresponds to the `Loading...` state."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ERROR",
+ "NULL_VALUE",
+ "DIVIDE_BY_ZERO",
+ "VALUE",
+ "REF",
+ "NAME",
+ "NUM",
+ "N_A",
+ "LOADING"
+ ],
+ "description": "The type of error.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
+ }
+ },
+ "id": "ErrorValue"
+ },
+ "CopySheetToAnotherSpreadsheetRequest": {
+ "type": "object",
+ "properties": {
+ "destinationSpreadsheetId": {
+ "type": "string",
+ "description": "The ID of the spreadsheet to copy the sheet to."
+ }
+ },
+ "id": "CopySheetToAnotherSpreadsheetRequest",
+ "description": "The request to copy a sheet across spreadsheets."
+ },
+ "CandlestickChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick\nchart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values.",
+ "$ref": "CandlestickDomain"
+ },
+ "data": {
+ "description": "The Candlestick chart data.\nOnly one CandlestickData is supported.",
+ "type": "array",
+ "items": {
+ "$ref": "CandlestickData"
+ }
+ }
+ },
+ "id": "CandlestickChartSpec"
+ },
+ "BatchClearValuesByDataFilterResponse": {
+ "id": "BatchClearValuesByDataFilterResponse",
+ "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation. If the requests are for an\nunbounded range or a ranger larger than the bounds of the sheet, this is\nthe actual ranges that were cleared, bounded to the sheet's limits.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TreemapChartColorScale": {
+ "description": "A color scale for a treemap chart.",
+ "type": "object",
+ "properties": {
+ "midValueColor": {
+ "description": "The background color for cells with a color value at the midpoint between\nminValue and\nmaxValue. Defaults to #efe6dc if not\nspecified.",
+ "$ref": "Color"
+ },
+ "maxValueColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background color for cells with a color value greater than or equal\nto maxValue. Defaults to #109618 if not\nspecified.\nIf max_value_color is also set, this field takes precedence."
+ },
+ "noDataColorStyle": {
+ "description": "The background color for cells that have no color data associated with\nthem. Defaults to #000000 if not specified.\nIf no_data_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "minValueColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background color for cells with a color value less than or equal to\nminValue. Defaults to #dc3912 if not\nspecified.\nIf min_value_color is also set, this field takes precedence."
+ },
+ "midValueColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background color for cells with a color value at the midpoint between\nminValue and\nmaxValue. Defaults to #efe6dc if not\nspecified.\nIf mid_value_color is also set, this field takes precedence."
+ },
+ "noDataColor": {
+ "$ref": "Color",
+ "description": "The background color for cells that have no color data associated with\nthem. Defaults to #000000 if not specified."
+ },
+ "minValueColor": {
+ "description": "The background color for cells with a color value less than or equal to\nminValue. Defaults to #dc3912 if not\nspecified.",
+ "$ref": "Color"
+ },
+ "maxValueColor": {
+ "$ref": "Color",
+ "description": "The background color for cells with a color value greater than or equal\nto maxValue. Defaults to #109618 if not\nspecified."
+ }
+ },
+ "id": "TreemapChartColorScale"
+ },
+ "EmbeddedObjectPosition": {
+ "id": "EmbeddedObjectPosition",
+ "description": "The position of an embedded object such as a chart.",
+ "type": "object",
+ "properties": {
+ "newSheet": {
+ "description": "If true, the embedded object is put on a new sheet whose ID\nis chosen for you. Used only when writing.",
+ "type": "boolean"
+ },
+ "sheetId": {
+ "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "overlayPosition": {
+ "description": "The position at which the object is overlaid on top of a grid.",
+ "$ref": "OverlayPosition"
+ }
+ }
+ },
+ "DeveloperMetadataLookup": {
+ "id": "DeveloperMetadataLookup",
+ "description": "Selects DeveloperMetadata that matches all of the specified fields. For\nexample, if only a metadata ID is specified this considers the\nDeveloperMetadata with that particular unique ID. If a metadata key is\nspecified, this considers all developer metadata with that key. If a\nkey, visibility, and location type are all specified, this considers all\ndeveloper metadata with that key and visibility that are associated with a\nlocation of that type. In general, this\nselects all DeveloperMetadata that matches the intersection of all the\nspecified fields; any field or combination of fields may be specified.",
+ "type": "object",
+ "properties": {
+ "locationType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Developer metadata associated on an entire row dimension.",
+ "Developer metadata associated on an entire column dimension.",
+ "Developer metadata associated on an entire sheet.",
+ "Developer metadata associated on the entire spreadsheet."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+ "ROW",
+ "COLUMN",
+ "SHEET",
+ "SPREADSHEET"
+ ],
+ "description": "Limits the selected developer metadata to those entries which are\nassociated with locations of the specified type. For example, when this\nfield is specified as ROW this lookup\nonly considers developer metadata associated on rows. If the field is left\nunspecified, all location types are considered. This field cannot be\nspecified as SPREADSHEET when\nthe locationMatchingStrategy\nis specified as INTERSECTING or when the\nmetadataLocation is specified as a\nnon-spreadsheet location: spreadsheet metadata cannot intersect any other\ndeveloper metadata location. This field also must be left unspecified when\nthe locationMatchingStrategy\nis specified as EXACT."
+ },
+ "metadataKey": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.",
+ "type": "string"
+ },
+ "visibility": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Document-visible metadata is accessible from any developer project with\naccess to the document.",
+ "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+ "DOCUMENT",
+ "PROJECT"
+ ],
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered."
+ },
+ "metadataId": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "metadataValue": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
+ "type": "string"
+ },
+ "metadataLocation": {
+ "$ref": "DeveloperMetadataLocation",
+ "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy."
+ },
+ "locationMatchingStrategy": {
+ "description": "Determines how this lookup matches the location. If this field is\nspecified as EXACT, only developer metadata associated on the exact\nlocation specified is matched. If this field is specified to INTERSECTING,\ndeveloper metadata associated on intersecting locations is also\nmatched. If left unspecified, this field assumes a default value of\nINTERSECTING.\nIf this field is specified, a metadataLocation\nmust also be specified.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Indicates that a specified location should be matched exactly. For\nexample, if row three were specified as a location this matching strategy\nwould only match developer metadata also associated on row three. Metadata\nassociated on other locations would not be considered.",
+ "Indicates that a specified location should match that exact location as\nwell as any intersecting locations. For example, if row three were\nspecified as a location this matching strategy would match developer\nmetadata associated on row three as well as metadata associated on\nlocations that intersect row three. If, for instance, there was developer\nmetadata associated on column B, this matching strategy would also match\nthat location because column B intersects row three."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
+ "EXACT_LOCATION",
+ "INTERSECTING_LOCATION"
+ ]
+ }
+ }
+ },
+ "AutoFillRequest": {
+ "description": "Fills in more data based on existing data.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range."
+ },
+ "useAlternateSeries": {
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
+ "type": "boolean"
+ },
+ "sourceAndDestination": {
+ "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.",
+ "$ref": "SourceAndDestination"
+ }
+ },
+ "id": "AutoFillRequest"
+ },
+ "GradientRule": {
+ "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
+ "type": "object",
+ "properties": {
+ "minpoint": {
+ "description": "The starting interpolation point.",
+ "$ref": "InterpolationPoint"
+ },
+ "maxpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "The final interpolation point."
+ },
+ "midpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "An optional midway interpolation point."
+ }
+ },
+ "id": "GradientRule"
+ },
+ "ClearValuesRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "ClearValuesRequest",
+ "description": "The request for clearing a range of values in a spreadsheet."
+ },
+ "SetBasicFilterRequest": {
+ "id": "SetBasicFilterRequest",
+ "description": "Sets the basic filter associated with a sheet.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The filter to set.",
+ "$ref": "BasicFilter"
+ }
+ }
+ },
+ "BatchClearValuesByDataFilterRequest": {
+ "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ },
+ "description": "The DataFilters used to determine which ranges to clear."
+ }
+ },
+ "id": "BatchClearValuesByDataFilterRequest"
+ },
+ "GetSpreadsheetByDataFilterRequest": {
+ "description": "The request for retrieving a Spreadsheet.",
+ "type": "object",
+ "properties": {
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
+ },
+ "dataFilters": {
+ "description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "GetSpreadsheetByDataFilterRequest"
+ },
+ "DeleteEmbeddedObjectRequest": {
+ "id": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes the embedded object with the given ID.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The ID of the embedded object to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "UpdateValuesByDataFilterResponse": {
+ "description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
+ "type": "object",
+ "properties": {
+ "updatedColumns": {
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "updatedRange": {
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
+ },
+ "updatedCells": {
+ "description": "The number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataFilter": {
+ "description": "The data filter that selected the range that was updated.",
+ "$ref": "DataFilter"
+ },
+ "updatedData": {
+ "$ref": "ValueRange",
+ "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`."
+ },
+ "updatedRows": {
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateValuesByDataFilterResponse"
+ },
+ "DeleteSheetRequest": {
+ "description": "Deletes the requested sheet.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The ID of the sheet to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteSheetRequest"
+ },
+ "DeveloperMetadataLocation": {
+ "description": "A location where metadata may be associated in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dimensionRange": {
+ "$ref": "DimensionRange",
+ "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns."
+ },
+ "spreadsheet": {
+ "description": "True when metadata is associated with an entire spreadsheet.",
+ "type": "boolean"
+ },
+ "sheetId": {
+ "description": "The ID of the sheet when metadata is associated with an entire sheet.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "locationType": {
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+ "ROW",
+ "COLUMN",
+ "SHEET",
+ "SPREADSHEET"
+ ],
+ "description": "The type of location this object represents. This field is read-only.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Developer metadata associated on an entire row dimension.",
+ "Developer metadata associated on an entire column dimension.",
+ "Developer metadata associated on an entire sheet.",
+ "Developer metadata associated on the entire spreadsheet."
+ ]
+ }
+ },
+ "id": "DeveloperMetadataLocation"
+ },
+ "MatchedValueRange": {
+ "description": "A value range that was matched by one or more data filers.",
+ "type": "object",
+ "properties": {
+ "valueRange": {
+ "$ref": "ValueRange",
+ "description": "The values matched by the DataFilter."
+ },
+ "dataFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ },
+ "description": "The DataFilters from the request that matched the range of\nvalues."
+ }
+ },
+ "id": "MatchedValueRange"
+ },
+ "DuplicateSheetRequest": {
+ "description": "Duplicates the contents of a sheet.",
+ "type": "object",
+ "properties": {
+ "newSheetId": {
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "insertSheetIndex": {
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newSheetName": {
+ "type": "string",
+ "description": "The name of the new sheet. If empty, a new name is chosen for you."
+ },
+ "sourceSheetId": {
+ "description": "The sheet to duplicate.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateSheetRequest"
+ },
+ "TreemapChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/treemap\"\u003eTreemap chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "hintedLevels": {
+ "description": "The number of additional data levels beyond the labeled levels to be shown\non the treemap chart. These levels are not interactive and are shown\nwithout their labels. Defaults to 0 if not specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minValue": {
+ "description": "The minimum possible data value. Cells with values less than this will\nhave the same color as cells with this value. If not specified, defaults\nto the actual minimum value from color_data, or the minimum value from\nsize_data if color_data is not specified.",
+ "format": "double",
+ "type": "number"
+ },
+ "levels": {
+ "description": "The number of data levels to show on the treemap chart. These levels are\ninteractive and are shown with their labels. Defaults to 2 if not\nspecified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sizeData": {
+ "$ref": "ChartData",
+ "description": "The data that determines the size of each treemap data cell. This data is\nexpected to be numeric. The cells corresponding to non-numeric or missing\ndata will not be rendered. If color_data is not specified, this data\nis used to determine data cell background colors as well."
+ },
+ "textFormat": {
+ "description": "The text format for all labels on the chart.",
+ "$ref": "TextFormat"
+ },
+ "headerColor": {
+ "$ref": "Color",
+ "description": "The background color for header cells."
+ },
+ "parentLabels": {
+ "$ref": "ChartData",
+ "description": "The data the contains the treemap cells' parent labels."
+ },
+ "labels": {
+ "description": "The data that contains the treemap cell labels.",
+ "$ref": "ChartData"
+ },
+ "colorData": {
+ "$ref": "ChartData",
+ "description": "The data that determines the background color of each treemap data cell.\nThis field is optional. If not specified, size_data is used to\ndetermine background colors. If specified, the data is expected to be\nnumeric. color_scale will determine how the values in this data map to\ndata cell background colors."
+ },
+ "colorScale": {
+ "$ref": "TreemapChartColorScale",
+ "description": "The color scale for data cells in the treemap chart. Data cells are\nassigned colors based on their color values. These color values come from\ncolor_data, or from size_data if color_data is not specified.\nCells with color values less than or equal to min_value will\nhave minValueColor as their\nbackground color. Cells with color values greater than or equal to\nmax_value will have\nmaxValueColor as their background\ncolor. Cells with color values between min_value and max_value will\nhave background colors on a gradient between\nminValueColor and\nmaxValueColor, the midpoint of\nthe gradient being midValueColor.\nCells with missing or non-numeric color values will have\nnoDataColor as their background\ncolor."
+ },
+ "maxValue": {
+ "description": "The maximum possible data value. Cells with values greater than this will\nhave the same color as cells with this value. If not specified, defaults\nto the actual maximum value from color_data, or the maximum value from\nsize_data if color_data is not specified.",
+ "format": "double",
+ "type": "number"
+ },
+ "headerColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background color for header cells.\nIf header_color is also set, this field takes precedence."
+ },
+ "hideTooltips": {
+ "description": "True to hide tooltips.",
+ "type": "boolean"
+ }
+ },
+ "id": "TreemapChartSpec"
+ },
+ "ExtendedValue": {
+ "id": "ExtendedValue",
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
+ "type": "object",
+ "properties": {
+ "errorValue": {
+ "$ref": "ErrorValue",
+ "description": "Represents an error.\nThis field is read-only."
+ },
+ "stringValue": {
+ "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
+ "type": "string"
+ },
+ "boolValue": {
+ "description": "Represents a boolean value.",
+ "type": "boolean"
+ },
+ "formulaValue": {
+ "description": "Represents a formula.",
+ "type": "string"
+ },
+ "numberValue": {
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "BatchClearValuesResponse": {
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation. If the requests are for an\nunbounded range or a ranger larger than the bounds of the sheet, this is\nthe actual ranges that were cleared, bounded to the sheet's limits.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchClearValuesResponse",
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "DataFilter": {
+ "description": "Filter that describes what data should be selected or returned from a\nrequest.",
+ "type": "object",
+ "properties": {
+ "developerMetadataLookup": {
+ "description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup.",
+ "$ref": "DeveloperMetadataLookup"
+ },
+ "a1Range": {
+ "description": "Selects data that matches the specified A1 range.",
+ "type": "string"
+ },
+ "gridRange": {
+ "$ref": "GridRange",
+ "description": "Selects data that matches the range described by the GridRange."
+ }
+ },
+ "id": "DataFilter"
+ },
+ "TextFormat": {
+ "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
+ "type": "object",
+ "properties": {
+ "bold": {
+ "description": "True if the text is bold.",
+ "type": "boolean"
+ },
+ "foregroundColor": {
+ "$ref": "Color",
+ "description": "The foreground color of the text."
+ },
+ "foregroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The foreground color of the text.\nIf foreground_color is also set, this field takes precedence."
+ },
+ "fontFamily": {
+ "description": "The font family.",
+ "type": "string"
+ },
+ "strikethrough": {
+ "description": "True if the text has a strikethrough.",
+ "type": "boolean"
+ },
+ "italic": {
+ "description": "True if the text is italicized.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the font.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "underline": {
+ "description": "True if the text is underlined.",
+ "type": "boolean"
+ }
+ },
+ "id": "TextFormat"
+ },
+ "DeleteDuplicatesRequest": {
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The range to remove duplicates rows from.",
+ "$ref": "GridRange"
+ },
+ "comparisonColumns": {
+ "description": "The columns in the range to analyze for duplicate values. If no columns are\nselected then all columns are analyzed for duplicates.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionRange"
+ }
+ }
+ },
+ "id": "DeleteDuplicatesRequest",
+ "description": "Removes rows within this range that contain values in the specified columns\nthat are duplicates of values in any previous row. Rows with identical values\nbut different letter cases, formatting, or formulas are considered to be\nduplicates.\n\nThis request also removes duplicate rows hidden from view (for example, due\nto a filter). When removing duplicates, the first instance of each duplicate\nrow scanning from the top downwards is kept in the resulting range. Content\noutside of the specified range isn't removed, and rows considered duplicates\ndo not have to be adjacent to each other in the range."
+ },
+ "RepeatCellRequest": {
+ "id": "RepeatCellRequest",
+ "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
+ "type": "object",
+ "properties": {
+ "cell": {
+ "$ref": "CellData",
+ "description": "The data to write."
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to repeat the cell in."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "ColorStyle": {
+ "id": "ColorStyle",
+ "description": "A color value.",
+ "type": "object",
+ "properties": {
+ "rgbColor": {
+ "$ref": "Color",
+ "description": "RGB color."
+ },
+ "themeColor": {
+ "enumDescriptions": [
+ "Unspecified theme color",
+ "Represents the primary text color",
+ "Represents the primary background color",
+ "Represents the first accent color",
+ "Represents the second accent color",
+ "Represents the third accent color",
+ "Represents the fourth accent color",
+ "Represents the fifth accent color",
+ "Represents the sixth accent color",
+ "Represents the color to use for hyperlinks"
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "TEXT",
+ "BACKGROUND",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "LINK"
+ ],
+ "description": "Theme color.",
+ "type": "string"
+ }
+ }
+ },
+ "UpdateSpreadsheetPropertiesRequest": {
+ "description": "Updates properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "The properties to update."
+ }
+ },
+ "id": "UpdateSpreadsheetPropertiesRequest"
+ },
+ "ProtectedRange": {
+ "description": "A protected range.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description of this protected range.",
+ "type": "string"
+ },
+ "unprotectedRanges": {
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "namedRangeId": {
+ "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "protectedRangeId": {
+ "description": "The ID of the protected range.\nThis field is read-only.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "warningOnly": {
+ "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
+ "type": "boolean"
+ },
+ "requestingUserCanEdit": {
+ "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "editors": {
+ "$ref": "Editors",
+ "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
+ },
+ "range": {
+ "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "ProtectedRange"
+ },
+ "DimensionProperties": {
+ "type": "object",
+ "properties": {
+ "pixelSize": {
+ "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hiddenByFilter": {
+ "description": "True if this dimension is being filtered.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "hiddenByUser": {
+ "description": "True if this dimension is explicitly hidden.",
+ "type": "boolean"
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a single row or column.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ },
+ "id": "DimensionProperties",
+ "description": "Properties about a dimension."
+ },
+ "NamedRange": {
+ "description": "A named range.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range this represents.",
+ "$ref": "GridRange"
+ },
+ "name": {
+ "description": "The name of the named range.",
+ "type": "string"
+ }
+ },
+ "id": "NamedRange"
+ },
+ "DimensionRange": {
+ "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension of the span."
+ },
+ "startIndex": {
+ "description": "The start (inclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endIndex": {
+ "description": "The end (exclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this span is on.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DimensionRange"
+ },
+ "ChartCustomNumberFormatOptions": {
+ "id": "ChartCustomNumberFormatOptions",
+ "description": "Custom number formatting options for chart attributes.",
+ "type": "object",
+ "properties": {
+ "prefix": {
+ "description": "Custom prefix to be prepended to the chart attribute.\nThis field is optional.",
+ "type": "string"
+ },
+ "suffix": {
+ "description": "Custom suffix to be appended to the chart attribute.\nThis field is optional.",
+ "type": "string"
+ }
+ }
+ },
+ "SpreadsheetTheme": {
+ "description": "Represents spreadsheet theme",
+ "type": "object",
+ "properties": {
+ "primaryFontFamily": {
+ "description": "/ Name of the primary font family.",
+ "type": "string"
+ },
+ "themeColors": {
+ "description": "The spreadsheet theme color pairs. To update you must provide all theme\ncolor pairs.",
+ "type": "array",
+ "items": {
+ "$ref": "ThemeColorPair"
+ }
+ }
+ },
+ "id": "SpreadsheetTheme"
+ },
+ "Borders": {
+ "description": "The borders of the cell.",
+ "type": "object",
+ "properties": {
+ "left": {
+ "$ref": "Border",
+ "description": "The left border of the cell."
+ },
+ "right": {
+ "description": "The right border of the cell.",
+ "$ref": "Border"
+ },
+ "bottom": {
+ "$ref": "Border",
+ "description": "The bottom border of the cell."
+ },
+ "top": {
+ "description": "The top border of the cell.",
+ "$ref": "Border"
+ }
+ },
+ "id": "Borders"
+ },
+ "ManualRule": {
+ "properties": {
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "ManualRuleGroup"
+ },
+ "description": "The list of group names and the corresponding items from the source data\nthat map to each group name."
+ }
+ },
+ "id": "ManualRule",
+ "description": "Allows you to manually organize the values in a source data column into\nbuckets with names of your choosing. For example, a pivot table that\naggregates population by state:\n\n +-------+-------------------+\n | State | SUM of Population |\n +-------+-------------------+\n | AK | 0.7 |\n | AL | 4.8 |\n | AR | 2.9 |\n ...\n +-------+-------------------+\ncould be turned into a pivot table that aggregates population by time zone\nby providing a list of groups (for example, groupName = 'Central',\nitems = ['AL', 'AR', 'IA', ...]) to a manual group rule.\nNote that a similar effect could be achieved by adding a time zone column\nto the source data and adjusting the pivot table.\n\n +-----------+-------------------+\n | Time Zone | SUM of Population |\n +-----------+-------------------+\n | Central | 106.3 |\n | Eastern | 151.9 |\n | Mountain | 17.4 |\n ...\n +-----------+-------------------+",
+ "type": "object"
+ },
+ "DeleteConditionalFormatRuleRequest": {
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "description": "The sheet the rule is being deleted from.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "index": {
+ "description": "The zero-based index of the rule to be deleted.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteConditionalFormatRuleRequest"
+ },
+ "DeleteNamedRangeRequest": {
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range to delete.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteNamedRangeRequest",
+ "description": "Removes the named range with the given ID from the spreadsheet.",
+ "type": "object"
+ },
+ "AddBandingResponse": {
+ "description": "The result of adding a banded range.",
+ "type": "object",
+ "properties": {
+ "bandedRange": {
+ "description": "The banded range that was added.",
+ "$ref": "BandedRange"
+ }
+ },
+ "id": "AddBandingResponse"
+ },
+ "AddDimensionGroupResponse": {
+ "type": "object",
+ "properties": {
+ "dimensionGroups": {
+ "description": "All groups of a dimension after adding a group to that dimension.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionGroup"
+ }
+ }
+ },
+ "id": "AddDimensionGroupResponse",
+ "description": "The result of adding a group."
+ },
+ "PivotGroup": {
+ "description": "A single grouping (either row or column) in a pivot table.",
+ "type": "object",
+ "properties": {
+ "sortOrder": {
+ "description": "The order the values in this group should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ]
+ },
+ "valueBucket": {
+ "$ref": "PivotGroupSortValueBucket",
+ "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
+ },
+ "showTotals": {
+ "type": "boolean",
+ "description": "True if the pivot table should include the totals for this grouping."
+ },
+ "valueMetadata": {
+ "description": "Metadata about values in the grouping.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroupValueMetadata"
+ }
+ },
+ "groupRule": {
+ "$ref": "PivotGroupRule",
+ "description": "The group rule to apply to this row/column group."
+ },
+ "label": {
+ "description": "The labels to use for the row/column groups which can be customized. For\nexample, in the following pivot table, the row label is `Region` (which\ncould be renamed to `State`) and the column label is `Product` (which\ncould be renamed `Item`). Pivot tables created before December 2017 do\nnot have header labels. If you'd like to add header labels to an existing\npivot table, please delete the existing pivot table and then create a new\npivot table with same parameters.\n\n +--------------+---------+-------+\n | SUM of Units | Product | |\n | Region | Pen | Paper |\n +--------------+---------+-------+\n | New York | 345 | 98 |\n | Oregon | 234 | 123 |\n | Tennessee | 531 | 415 |\n +--------------+---------+-------+\n | Grand Total | 1110 | 636 |\n +--------------+---------+-------+",
+ "type": "string"
+ },
+ "repeatHeadings": {
+ "description": "True if the headings in this pivot group should be repeated.\nThis is only valid for row groupings and is ignored by columns.\n\nBy default, we minimize repitition of headings by not showing higher\nlevel headings where they are the same. For example, even though the\nthird row below corresponds to \"Q1 Mar\", \"Q1\" is not shown because\nit is redundant with previous rows. Setting repeat_headings to true\nwould cause \"Q1\" to be repeated for \"Feb\" and \"Mar\".\n\n +--------------+\n | Q1 | Jan |\n | | Feb |\n | | Mar |\n +--------+-----+\n | Q1 Total |\n +--------------+",
+ "type": "boolean"
+ },
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PivotGroup"
+ },
+ "ManualRuleGroup": {
+ "type": "object",
+ "properties": {
+ "groupName": {
+ "$ref": "ExtendedValue",
+ "description": "The group name, which must be a string. Each group in a given\nManualRule must have a unique group name."
+ },
+ "items": {
+ "description": "The items in the source data that should be placed into this group. Each\nitem may be a string, number, or boolean. Items may appear in at most one\ngroup within a given ManualRule. Items that do not appear in any\ngroup will appear on their own.",
+ "type": "array",
+ "items": {
+ "$ref": "ExtendedValue"
+ }
+ }
+ },
+ "id": "ManualRuleGroup",
+ "description": "A group name and a list of items from the source data that should be placed\nin the group with this name."
+ },
+ "TrimWhitespaceResponse": {
+ "id": "TrimWhitespaceResponse",
+ "description": "The result of trimming whitespace in cells.",
+ "type": "object",
+ "properties": {
+ "cellsChangedCount": {
+ "description": "The number of cells that were trimmed of whitespace.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "PivotTable": {
+ "properties": {
+ "criteria": {
+ "description": "An optional mapping of filters per source column offset.\n\nThe filters are applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "PivotFilterCriteria"
+ }
+ },
+ "rows": {
+ "description": "Each row grouping in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroup"
+ }
+ },
+ "valueLayout": {
+ "enum": [
+ "HORIZONTAL",
+ "VERTICAL"
+ ],
+ "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
+ "type": "string",
+ "enumDescriptions": [
+ "Values are laid out horizontally (as columns).",
+ "Values are laid out vertically (as rows)."
+ ]
+ },
+ "values": {
+ "description": "A list of values to include in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotValue"
+ }
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The range the pivot table is reading data from."
+ },
+ "columns": {
+ "description": "Each column grouping in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroup"
+ }
+ }
+ },
+ "id": "PivotTable",
+ "description": "A pivot table.",
+ "type": "object"
+ },
+ "SearchDeveloperMetadataResponse": {
+ "description": "A reply to a developer metadata search request.",
+ "type": "object",
+ "properties": {
+ "matchedDeveloperMetadata": {
+ "description": "The metadata matching the criteria of the search request.",
+ "type": "array",
+ "items": {
+ "$ref": "MatchedDeveloperMetadata"
+ }
+ }
+ },
+ "id": "SearchDeveloperMetadataResponse"
+ },
+ "AppendCellsRequest": {
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "type": "object",
+ "properties": {
+ "rows": {
+ "description": "The data to append.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "sheetId": {
+ "description": "The sheet ID to append the data to.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AppendCellsRequest"
+ },
+ "TextFormatRun": {
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of this run. Absent values inherit the cell's format."
+ },
+ "startIndex": {
+ "description": "The character index where this run starts.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TextFormatRun"
+ },
+ "BatchUpdateValuesByDataFilterResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "totalUpdatedRows": {
+ "description": "The total number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "responses": {
+ "description": "The response for each range updated.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdateValuesByDataFilterResponse"
+ }
+ },
+ "totalUpdatedSheets": {
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedColumns": {
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "RowData": {
+ "description": "Data about each cell in a row.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The values in the row, one per column.",
+ "type": "array",
+ "items": {
+ "$ref": "CellData"
+ }
+ }
+ },
+ "id": "RowData"
+ },
+ "GridData": {
+ "properties": {
+ "columnMetadata": {
+ "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "startColumn": {
+ "description": "The first column this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowMetadata": {
+ "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "startRow": {
+ "type": "integer",
+ "description": "The first row this GridData refers to, zero-based.",
+ "format": "int32"
+ }
+ },
+ "id": "GridData",
+ "description": "Data in the grid, as well as metadata about the dimensions.",
+ "type": "object"
+ },
+ "Border": {
+ "description": "A border along a cell.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "The color of the border.",
+ "$ref": "Color"
+ },
+ "colorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The color of the border.\nIf color is also set, this field takes precedence."
+ },
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "style": {
+ "enumDescriptions": [
+ "The style is not specified. Do not use this.",
+ "The border is dotted.",
+ "The border is dashed.",
+ "The border is a thin solid line.",
+ "The border is a medium solid line.",
+ "The border is a thick solid line.",
+ "No border.\nUsed only when updating a border in order to erase it.",
+ "The border is two solid lines."
+ ],
+ "enum": [
+ "STYLE_UNSPECIFIED",
+ "DOTTED",
+ "DASHED",
+ "SOLID",
+ "SOLID_MEDIUM",
+ "SOLID_THICK",
+ "NONE",
+ "DOUBLE"
+ ],
+ "description": "The style of the border.",
+ "type": "string"
+ }
+ },
+ "id": "Border"
+ },
+ "FindReplaceRequest": {
+ "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
+ "type": "object",
+ "properties": {
+ "matchEntireCell": {
+ "description": "True if the find value should match the entire cell.",
+ "type": "boolean"
+ },
+ "searchByRegex": {
+ "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
+ "type": "boolean"
+ },
+ "find": {
+ "description": "The value to search.",
+ "type": "string"
+ },
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to find/replace over."
+ },
+ "sheetId": {
+ "description": "The sheet to find/replace over.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "allSheets": {
+ "description": "True to find/replace over all sheets.",
+ "type": "boolean"
+ },
+ "matchCase": {
+ "description": "True if the search is case sensitive.",
+ "type": "boolean"
+ },
+ "includeFormulas": {
+ "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
+ "type": "boolean"
+ }
+ },
+ "id": "FindReplaceRequest"
+ },
+ "UpdateNamedRangeRequest": {
+ "id": "UpdateNamedRangeRequest",
+ "description": "Updates properties of the named range with the specified\nnamedRangeId.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to update with the new properties."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "UpdateCellsRequest": {
+ "description": "Updates all cells in a range with new data.",
+ "type": "object",
+ "properties": {
+ "start": {
+ "$ref": "GridCoordinate",
+ "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written."
+ },
+ "range": {
+ "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared.",
+ "$ref": "GridRange"
+ },
+ "rows": {
+ "description": "The data to write.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateCellsRequest"
+ },
+ "RandomizeRangeRequest": {
+ "description": "Randomizes the order of the rows in a range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The range to randomize.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "RandomizeRangeRequest"
+ },
+ "DeleteRangeRequest": {
+ "properties": {
+ "range": {
+ "description": "The range of cells to delete.",
+ "$ref": "GridRange"
+ },
+ "shiftDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ }
+ },
+ "id": "DeleteRangeRequest",
+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
+ "type": "object"
+ },
+ "ThemeColorPair": {
+ "description": "A pair mapping a spreadsheet theme color type to the concrete color it\nrepresents.",
+ "type": "object",
+ "properties": {
+ "colorType": {
+ "description": "The type of the spreadsheet theme color.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color",
+ "Represents the primary text color",
+ "Represents the primary background color",
+ "Represents the first accent color",
+ "Represents the second accent color",
+ "Represents the third accent color",
+ "Represents the fourth accent color",
+ "Represents the fifth accent color",
+ "Represents the sixth accent color",
+ "Represents the color to use for hyperlinks"
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "TEXT",
+ "BACKGROUND",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "LINK"
+ ]
+ },
+ "color": {
+ "description": "The concrete color corresponding to the theme color type.",
+ "$ref": "ColorStyle"
+ }
+ },
+ "id": "ThemeColorPair"
+ },
+ "DeleteDuplicatesResponse": {
+ "description": "The result of removing duplicates in a range.",
+ "type": "object",
+ "properties": {
+ "duplicatesRemovedCount": {
+ "description": "The number of duplicate rows removed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteDuplicatesResponse"
+ },
+ "UnmergeCellsRequest": {
+ "description": "Unmerges cells in the given range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "UnmergeCellsRequest"
+ },
+ "UpdateEmbeddedObjectPositionResponse": {
+ "type": "object",
+ "properties": {
+ "position": {
+ "description": "The new position of the embedded object.",
+ "$ref": "EmbeddedObjectPosition"
+ }
+ },
+ "id": "UpdateEmbeddedObjectPositionResponse",
+ "description": "The result of updating an embedded object's position."
+ },
+ "SortSpec": {
+ "id": "SortSpec",
+ "description": "A sort order associated with a specific column or row.",
+ "type": "object",
+ "properties": {
+ "sortOrder": {
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The order data should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ]
+ },
+ "backgroundColor": {
+ "description": "The background fill color to sort by; cells with this fill color are sorted\nto the top. Mutually exclusive with foreground_color.",
+ "$ref": "Color"
+ },
+ "backgroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background fill color to sort by; cells with this fill color are sorted\nto the top. Mutually exclusive with foreground_color, and must be an\nRGB-type color. If background_color is also set, this field takes\nprecedence."
+ },
+ "foregroundColor": {
+ "description": "The foreground color to sort by; cells with this foreground color are\nsorted to the top. Mutually exclusive with background_color.",
+ "$ref": "Color"
+ },
+ "foregroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The foreground color to sort by; cells with this foreground color are\nsorted to the top. Mutually exclusive with background_color, and must\nbe an RGB-type color. If foreground_color is also set, this field takes\nprecedence."
+ },
+ "dimensionIndex": {
+ "description": "The dimension the sort should be applied to.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "BooleanRule": {
+ "description": "A rule that may or may not match, depending on the condition.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color.",
+ "$ref": "CellFormat"
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format is applied."
+ }
+ },
+ "id": "BooleanRule"
+ },
+ "WaterfallChartSpec": {
+ "id": "WaterfallChartSpec",
+ "description": "A waterfall chart.",
+ "type": "object",
+ "properties": {
+ "firstValueIsTotal": {
+ "description": "True to interpret the first value as a total.",
+ "type": "boolean"
+ },
+ "stackedType": {
+ "enum": [
+ "WATERFALL_STACKED_TYPE_UNSPECIFIED",
+ "STACKED",
+ "SEQUENTIAL"
+ ],
+ "description": "The stacked type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Values corresponding to the same domain (horizontal axis) value will be\nstacked vertically.",
+ "Series will spread out along the horizontal axis."
+ ]
+ },
+ "hideConnectorLines": {
+ "description": "True to hide connector lines between columns.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The data this waterfall chart is visualizing.",
+ "type": "array",
+ "items": {
+ "$ref": "WaterfallChartSeries"
+ }
+ },
+ "connectorLineStyle": {
+ "$ref": "LineStyle",
+ "description": "The line style for the connector lines."
+ },
+ "domain": {
+ "$ref": "WaterfallChartDomain",
+ "description": "The domain data (horizontal axis) for the waterfall chart."
+ }
+ }
+ },
+ "UpdateConditionalFormatRuleRequest": {
+ "type": "object",
+ "properties": {
+ "newIndex": {
+ "description": "The zero-based new index the rule should end up at.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rule": {
+ "description": "The rule that should replace the rule at the given index.",
+ "$ref": "ConditionalFormatRule"
+ },
+ "index": {
+ "description": "The zero-based index of the rule that should be replaced or moved.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index."
+ },
+ "BasicChartDomain": {
+ "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "BasicChartDomain"
+ },
+ "PasteDataRequest": {
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object",
+ "properties": {
+ "coordinate": {
+ "$ref": "GridCoordinate",
+ "description": "The coordinate at which the data should start being inserted."
+ },
+ "data": {
+ "description": "The data to insert.",
+ "type": "string"
+ },
+ "delimiter": {
+ "type": "string",
+ "description": "The delimiter in the data."
+ },
+ "type": {
+ "description": "How the data should be pasted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ]
+ },
+ "html": {
+ "description": "True if the data is HTML.",
+ "type": "boolean"
+ }
+ },
+ "id": "PasteDataRequest"
+ },
+ "UpdateDeveloperMetadataResponse": {
+ "description": "The response from updating developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The updated developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ },
+ "id": "UpdateDeveloperMetadataResponse"
+ },
+ "AppendDimensionRequest": {
+ "description": "Appends rows or columns to the end of a sheet.",
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "Whether rows or columns should be appended.",
+ "type": "string"
+ },
+ "length": {
+ "description": "The number of rows or columns to append.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet to append rows or columns to.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AppendDimensionRequest"
+ },
+ "AddNamedRangeRequest": {
+ "id": "AddNamedRangeRequest",
+ "description": "Adds a named range to the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ }
+ }
+ },
+ "CreateDeveloperMetadataResponse": {
+ "description": "The response from creating developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata that was created."
+ }
+ },
+ "id": "CreateDeveloperMetadataResponse"
+ },
+ "UpdateEmbeddedObjectPositionRequest": {
+ "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
+ "type": "object",
+ "properties": {
+ "newPosition": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
+ },
+ "fields": {
+ "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The ID of the object to moved.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateEmbeddedObjectPositionRequest"
+ },
+ "WaterfallChartColumnStyle": {
+ "id": "WaterfallChartColumnStyle",
+ "description": "Styles for a waterfall chart column.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the column."
+ },
+ "colorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The color of the column.\nIf color is also set, this field takes precedence."
+ },
+ "label": {
+ "description": "The label of the column's legend.",
+ "type": "string"
+ }
+ }
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "deleteRange": {
+ "$ref": "DeleteRangeRequest",
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells."
+ },
+ "deleteBanding": {
+ "$ref": "DeleteBandingRequest",
+ "description": "Removes a banded range"
+ },
+ "addFilterView": {
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
+ },
+ "deleteDuplicates": {
+ "description": "Removes rows containing duplicate values in specified columns of a cell\nrange.",
+ "$ref": "DeleteDuplicatesRequest"
+ },
+ "setDataValidation": {
+ "description": "Sets data validation for one or more cells.",
+ "$ref": "SetDataValidationRequest"
+ },
+ "updateBorders": {
+ "$ref": "UpdateBordersRequest",
+ "description": "Updates the borders in a range of cells."
+ },
+ "deleteConditionalFormatRule": {
+ "$ref": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes an existing conditional format rule."
+ },
+ "repeatCell": {
+ "description": "Repeats a single cell across a range.",
+ "$ref": "RepeatCellRequest"
+ },
+ "clearBasicFilter": {
+ "$ref": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter on a sheet."
+ },
+ "appendDimension": {
+ "description": "Appends dimensions to the end of a sheet.",
+ "$ref": "AppendDimensionRequest"
+ },
+ "updateSlicerSpec": {
+ "$ref": "UpdateSlicerSpecRequest",
+ "description": "Updates a slicer's specifications."
+ },
+ "createDeveloperMetadata": {
+ "$ref": "CreateDeveloperMetadataRequest",
+ "description": "Creates new developer metadata"
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates an existing conditional format rule."
+ },
+ "insertRange": {
+ "$ref": "InsertRangeRequest",
+ "description": "Inserts new cells in a sheet, shifting the existing cells."
+ },
+ "deleteDeveloperMetadata": {
+ "description": "Deletes developer metadata",
+ "$ref": "DeleteDeveloperMetadataRequest"
+ },
+ "moveDimension": {
+ "$ref": "MoveDimensionRequest",
+ "description": "Moves rows or columns to another location in a sheet."
+ },
+ "randomizeRange": {
+ "description": "Randomizes the order of the rows in a range.",
+ "$ref": "RandomizeRangeRequest"
+ },
+ "updateBanding": {
+ "description": "Updates a banded range",
+ "$ref": "UpdateBandingRequest"
+ },
+ "addProtectedRange": {
+ "description": "Adds a protected range.",
+ "$ref": "AddProtectedRangeRequest"
+ },
+ "deleteNamedRange": {
+ "$ref": "DeleteNamedRangeRequest",
+ "description": "Deletes a named range."
+ },
+ "duplicateSheet": {
+ "description": "Duplicates a sheet.",
+ "$ref": "DuplicateSheetRequest"
+ },
+ "deleteSheet": {
+ "description": "Deletes a sheet.",
+ "$ref": "DeleteSheetRequest"
+ },
+ "unmergeCells": {
+ "description": "Unmerges merged cells.",
+ "$ref": "UnmergeCellsRequest"
+ },
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionRequest",
+ "description": "Updates an embedded object's (e.g. chart, image) position."
+ },
+ "addDimensionGroup": {
+ "description": "Creates a group over the specified range.",
+ "$ref": "AddDimensionGroupRequest"
+ },
+ "updateDimensionProperties": {
+ "$ref": "UpdateDimensionPropertiesRequest",
+ "description": "Updates dimensions' properties."
+ },
+ "updateDeveloperMetadata": {
+ "description": "Updates an existing developer metadata entry",
+ "$ref": "UpdateDeveloperMetadataRequest"
+ },
+ "pasteData": {
+ "$ref": "PasteDataRequest",
+ "description": "Pastes data (HTML or delimited) into a sheet."
+ },
+ "updateDimensionGroup": {
+ "$ref": "UpdateDimensionGroupRequest",
+ "description": "Updates the state of the specified group."
+ },
+ "setBasicFilter": {
+ "$ref": "SetBasicFilterRequest",
+ "description": "Sets the basic filter on a sheet."
+ },
+ "addConditionalFormatRule": {
+ "$ref": "AddConditionalFormatRuleRequest",
+ "description": "Adds a new conditional format rule."
+ },
+ "updateCells": {
+ "$ref": "UpdateCellsRequest",
+ "description": "Updates many cells at once."
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeRequest",
+ "description": "Adds a named range."
+ },
+ "updateSpreadsheetProperties": {
+ "description": "Updates the spreadsheet's properties.",
+ "$ref": "UpdateSpreadsheetPropertiesRequest"
+ },
+ "trimWhitespace": {
+ "$ref": "TrimWhitespaceRequest",
+ "description": "Trims cells of whitespace (such as spaces, tabs, or new lines)."
+ },
+ "deleteEmbeddedObject": {
+ "$ref": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ },
+ "updateFilterView": {
+ "$ref": "UpdateFilterViewRequest",
+ "description": "Updates the properties of a filter view."
+ },
+ "addBanding": {
+ "$ref": "AddBandingRequest",
+ "description": "Adds a new banded range"
+ },
+ "appendCells": {
+ "$ref": "AppendCellsRequest",
+ "description": "Appends cells after the last row with data in a sheet."
+ },
+ "autoResizeDimensions": {
+ "$ref": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
+ },
+ "cutPaste": {
+ "description": "Cuts data from one area and pastes it to another.",
+ "$ref": "CutPasteRequest"
+ },
+ "mergeCells": {
+ "$ref": "MergeCellsRequest",
+ "description": "Merges cells together."
+ },
+ "updateNamedRange": {
+ "$ref": "UpdateNamedRangeRequest",
+ "description": "Updates a named range."
+ },
+ "updateSheetProperties": {
+ "description": "Updates a sheet's properties.",
+ "$ref": "UpdateSheetPropertiesRequest"
+ },
+ "deleteDimension": {
+ "$ref": "DeleteDimensionRequest",
+ "description": "Deletes rows or columns in a sheet."
+ },
+ "autoFill": {
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
+ },
+ "addSlicer": {
+ "$ref": "AddSlicerRequest",
+ "description": "Adds a slicer."
+ },
+ "sortRange": {
+ "$ref": "SortRangeRequest",
+ "description": "Sorts data in a range."
+ },
+ "deleteDimensionGroup": {
+ "$ref": "DeleteDimensionGroupRequest",
+ "description": "Deletes a group over the specified range."
+ },
+ "deleteProtectedRange": {
+ "$ref": "DeleteProtectedRangeRequest",
+ "description": "Deletes a protected range."
+ },
+ "duplicateFilterView": {
+ "description": "Duplicates a filter view.",
+ "$ref": "DuplicateFilterViewRequest"
+ },
+ "addChart": {
+ "$ref": "AddChartRequest",
+ "description": "Adds a chart."
+ },
+ "findReplace": {
+ "$ref": "FindReplaceRequest",
+ "description": "Finds and replaces occurrences of some text with other text."
+ },
+ "updateChartSpec": {
+ "$ref": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications."
+ },
+ "textToColumns": {
+ "description": "Converts a column of text into many columns of text.",
+ "$ref": "TextToColumnsRequest"
+ },
+ "updateProtectedRange": {
+ "$ref": "UpdateProtectedRangeRequest",
+ "description": "Updates a protected range."
+ },
+ "addSheet": {
+ "description": "Adds a sheet.",
+ "$ref": "AddSheetRequest"
+ },
+ "copyPaste": {
+ "description": "Copies data from one area and pastes it to another.",
+ "$ref": "CopyPasteRequest"
+ },
+ "deleteFilterView": {
+ "$ref": "DeleteFilterViewRequest",
+ "description": "Deletes a filter view from a sheet."
+ },
+ "insertDimension": {
+ "description": "Inserts new rows or columns in a sheet.",
+ "$ref": "InsertDimensionRequest"
+ }
+ },
+ "id": "Request"
+ },
+ "GridRange": {
+ "properties": {
+ "endRowIndex": {
+ "description": "The end row (exclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endColumnIndex": {
+ "description": "The end column (exclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startRowIndex": {
+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startColumnIndex": {
+ "description": "The start column (inclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this range is on.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GridRange",
+ "description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
+ "type": "object"
+ },
+ "WaterfallChartDomain": {
+ "description": "The domain of a waterfall chart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the WaterfallChartDomain."
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "WaterfallChartDomain"
+ },
+ "DeleteDimensionGroupRequest": {
+ "description": "Deletes a group over the specified range by decrementing the depth of the\ndimensions in the range.\n\nFor example, assume the sheet has a depth-1 group over B:E and a depth-2\ngroup over C:D. Deleting a group over D:E leaves the sheet with a\ndepth-1 group over B:D and a depth-2 group over C:C.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The range of the group to be deleted."
+ }
+ },
+ "id": "DeleteDimensionGroupRequest"
+ },
+ "BubbleChartSpec": {
+ "properties": {
+ "bubbleSizes": {
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional."
+ },
+ "bubbleOpacity": {
+ "description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.",
+ "format": "float",
+ "type": "number"
+ },
+ "bubbleBorderColorStyle": {
+ "description": "The bubble border color.\nIf bubble_border_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "bubbleTextStyle": {
+ "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported.",
+ "$ref": "TextFormat"
+ },
+ "groupIds": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble group IDs. All bubbles with the same group\nID are drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional."
+ },
+ "bubbleMinRadiusSize": {
+ "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bubbleMaxRadiusSize": {
+ "description": "The max radius size of the bubbles, in pixels.\nIf specified, the field must be a positive value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
+ },
+ "legendPosition": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "The legend is rendered inside the chart area."
+ ],
+ "enum": [
+ "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
+ ],
+ "description": "Where the legend of the chart should be drawn.",
+ "type": "string"
+ },
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
+ },
+ "bubbleBorderColor": {
+ "$ref": "Color",
+ "description": "The bubble border color."
+ },
+ "bubbleLabels": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble labels. These do not need to be unique."
+ }
+ },
+ "id": "BubbleChartSpec",
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
+ "type": "object"
+ },
+ "SetDataValidationRequest": {
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "DataValidationRule",
+ "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the data validation rule should apply to."
+ }
+ },
+ "id": "SetDataValidationRequest",
+ "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified."
+ },
+ "TextPosition": {
+ "description": "Position settings for text.",
+ "type": "object",
+ "properties": {
+ "horizontalAlignment": {
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "description": "Horizontal alignment setting for the piece of text.",
+ "type": "string"
+ }
+ },
+ "id": "TextPosition"
+ },
+ "BatchUpdateSpreadsheetRequest": {
+ "id": "BatchUpdateSpreadsheetRequest",
+ "description": "The request for updating any aspect of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "includeSpreadsheetInResponse": {
+ "description": "Determines if the update response should include the spreadsheet\nresource.",
+ "type": "boolean"
+ },
+ "responseRanges": {
+ "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_in_response is 'true'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "responseIncludeGridData": {
+ "description": "True if grid data should be returned. Meaningful only if\ninclude_spreadsheet_in_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
+ },
+ "requests": {
+ "type": "array",
+ "items": {
+ "$ref": "Request"
+ },
+ "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied."
+ }
+ }
+ },
+ "BasicChartAxis": {
+ "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
+ "type": "object",
+ "properties": {
+ "titleTextPosition": {
+ "$ref": "TextPosition",
+ "description": "The axis title text position."
+ },
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
+ },
+ "viewWindowOptions": {
+ "$ref": "ChartAxisViewWindowOptions",
+ "description": "The view window options for this axis."
+ },
+ "position": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ],
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The position of this axis.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
+ "type": "string"
+ }
+ },
+ "id": "BasicChartAxis"
+ },
+ "Padding": {
+ "properties": {
+ "right": {
+ "description": "The right padding of the cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bottom": {
+ "type": "integer",
+ "description": "The bottom padding of the cell.",
+ "format": "int32"
+ },
+ "top": {
+ "description": "The top padding of the cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "left": {
+ "description": "The left padding of the cell.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Padding",
+ "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
+ "type": "object"
+ },
+ "DeleteDimensionRequest": {
+ "description": "Deletes the dimensions from the sheet.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to delete from the sheet."
+ }
+ },
+ "id": "DeleteDimensionRequest"
+ },
+ "UpdateChartSpecRequest": {
+ "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
+ "type": "object",
+ "properties": {
+ "chartId": {
+ "description": "The ID of the chart to update.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spec": {
+ "$ref": "ChartSpec",
+ "description": "The specification to apply to the chart."
+ }
+ },
+ "id": "UpdateChartSpecRequest"
+ },
+ "DeleteFilterViewRequest": {
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "description": "The ID of the filter to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteFilterViewRequest",
+ "description": "Deletes a particular filter view."
+ },
+ "BatchGetValuesByDataFilterRequest": {
+ "type": "object",
+ "properties": {
+ "majorDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS`\nreturns `[[1,2],[3,4]]`, whereas a request that sets\n`majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.",
+ "type": "string"
+ },
+ "dataFilters": {
+ "description": "The data filters used to match the ranges of values to retrieve. Ranges\nthat match any of the specified data filters are included in the response.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ },
+ "valueRenderOption": {
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ],
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ]
+ },
+ "dateTimeRenderOption": {
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string",
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
+ "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
+ ]
+ }
+ },
+ "id": "BatchGetValuesByDataFilterRequest",
+ "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters."
+ },
+ "BatchUpdateValuesResponse": {
+ "id": "BatchUpdateValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "totalUpdatedColumns": {
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "totalUpdatedRows": {
+ "description": "The total number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "responses": {
+ "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdateValuesResponse"
+ }
+ },
+ "totalUpdatedSheets": {
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "BatchClearValuesRequest": {
+ "description": "The request for clearing more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "ranges": {
+ "description": "The ranges to clear, in A1 notation.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchClearValuesRequest"
+ },
+ "KeyValueFormat": {
+ "description": "Formatting options for key value.",
+ "type": "object",
+ "properties": {
+ "textFormat": {
+ "description": "Text formatting options for key value.",
+ "$ref": "TextFormat"
+ },
+ "position": {
+ "$ref": "TextPosition",
+ "description": "Specifies the horizontal text positioning of key value.\nThis field is optional. If not specified, default positioning is used."
+ }
+ },
+ "id": "KeyValueFormat"
+ },
+ "DeveloperMetadata": {
+ "id": "DeveloperMetadata",
+ "description": "Developer metadata associated with a location or object in a spreadsheet.\nDeveloper metadata may be used to associate arbitrary data with various\nparts of a spreadsheet and will remain associated at those locations as they\nmove around and the spreadsheet is edited. For example, if developer\nmetadata is associated with row 5 and another row is then subsequently\ninserted above row 5, that original metadata will still be associated with\nthe row it was first associated with (what is now row 6). If the associated\nobject is deleted its metadata is deleted too.",
+ "type": "object",
+ "properties": {
+ "metadataId": {
+ "description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be\nspecified when metadata is created, otherwise one will be randomly\ngenerated and assigned. Must be positive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "location": {
+ "$ref": "DeveloperMetadataLocation",
+ "description": "The location where the metadata is associated."
+ },
+ "visibility": {
+ "enumDescriptions": [
+ "Default value.",
+ "Document-visible metadata is accessible from any developer project with\naccess to the document.",
+ "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+ "DOCUMENT",
+ "PROJECT"
+ ],
+ "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
+ "type": "string"
+ },
+ "metadataValue": {
+ "description": "Data associated with the metadata's key.",
+ "type": "string"
+ },
+ "metadataKey": {
+ "description": "The metadata key. There may be multiple metadata in a spreadsheet with the\nsame key. Developer metadata must always have a key specified.",
+ "type": "string"
+ }
+ }
+ },
+ "BaselineValueFormat": {
+ "description": "Formatting options for baseline value.",
+ "type": "object",
+ "properties": {
+ "negativeColorStyle": {
+ "description": "Color to be used, in case baseline value represents a negative change for\nkey value. This field is optional.\nIf negative_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "textFormat": {
+ "description": "Text formatting options for baseline value.",
+ "$ref": "TextFormat"
+ },
+ "description": {
+ "description": "Description which is appended after the baseline value.\nThis field is optional.",
+ "type": "string"
+ },
+ "negativeColor": {
+ "$ref": "Color",
+ "description": "Color to be used, in case baseline value represents a negative change for\nkey value. This field is optional."
+ },
+ "positiveColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "Color to be used, in case baseline value represents a positive change for\nkey value. This field is optional.\nIf positive_color is also set, this field takes precedence."
+ },
+ "comparisonType": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Use absolute difference between key and baseline value.",
+ "Use percentage difference between key and baseline value."
+ ],
+ "enum": [
+ "COMPARISON_TYPE_UNDEFINED",
+ "ABSOLUTE_DIFFERENCE",
+ "PERCENTAGE_DIFFERENCE"
+ ],
+ "description": "The comparison type of key value with baseline value.",
+ "type": "string"
+ },
+ "position": {
+ "$ref": "TextPosition",
+ "description": "Specifies the horizontal text positioning of baseline value.\nThis field is optional. If not specified, default positioning is used."
+ },
+ "positiveColor": {
+ "description": "Color to be used, in case baseline value represents a positive change for\nkey value. This field is optional.",
+ "$ref": "Color"
+ }
+ },
+ "id": "BaselineValueFormat"
+ },
+ "DimensionGroup": {
+ "id": "DimensionGroup",
+ "description": "A group over an interval of rows or columns on a sheet, which can contain or\nbe contained within other groups. A group can be collapsed or expanded as a\nunit on the sheet.",
+ "type": "object",
+ "properties": {
+ "collapsed": {
+ "description": "This field is true if this group is collapsed. A collapsed group remains\ncollapsed if an overlapping group at a shallower depth is expanded.\n\nA true value does not imply that all dimensions within the group are\nhidden, since a dimension's visibility can change independently from this\ngroup property. However, when this property is updated, all dimensions\nwithin it are set to hidden if this field is true, or set to visible if\nthis field is false.",
+ "type": "boolean"
+ },
+ "range": {
+ "description": "The range over which this group exists.",
+ "$ref": "DimensionRange"
+ },
+ "depth": {
+ "description": "The depth of the group, representing how many groups have a range that\nwholly contains the range of this group.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "ClearBasicFilterRequest": {
+ "id": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter, if any exists on the sheet.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "type": "integer",
+ "description": "The sheet ID on which the basic filter should be cleared.",
+ "format": "int32"
+ }
+ }
+ },
+ "TextToColumnsRequest": {
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data range. This must span exactly one column."
+ },
+ "delimiterType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter.",
+ "Automatically detect columns."
+ ],
+ "enum": [
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM",
+ "AUTODETECT"
+ ],
+ "description": "The delimiter type to use."
+ },
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ "type": "string"
+ }
+ },
+ "id": "TextToColumnsRequest"
+ },
+ "DeleteBandingRequest": {
+ "description": "Removes the banded range with the given ID from the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "bandedRangeId": {
+ "description": "The ID of the banded range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteBandingRequest"
+ },
+ "AppendValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "updates": {
+ "description": "Information about the updates that were applied.",
+ "$ref": "UpdateValuesResponse"
+ },
+ "tableRange": {
+ "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "AppendValuesResponse"
+ },
+ "PivotFilterCriteria": {
+ "id": "PivotFilterCriteria",
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "type": "object",
+ "properties": {
+ "visibleValues": {
+ "description": "Values that should be included. Values not listed here are excluded.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "MoveDimensionRequest": {
+ "description": "Moves one or more rows or columns.",
+ "type": "object",
+ "properties": {
+ "destinationIndex": {
+ "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "source": {
+ "$ref": "DimensionRange",
+ "description": "The source dimensions to move."
+ }
+ },
+ "id": "MoveDimensionRequest"
+ },
+ "AddConditionalFormatRuleRequest": {
+ "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule to add."
+ },
+ "index": {
+ "description": "The zero-based index where the rule should be inserted.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AddConditionalFormatRuleRequest"
+ },
+ "ChartSpec": {
+ "description": "The specifications of a chart.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
+ },
+ "altText": {
+ "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
+ "type": "string"
+ },
+ "titleTextPosition": {
+ "description": "The title text position.\nThis field is optional.",
+ "$ref": "TextPosition"
+ },
+ "histogramChart": {
+ "$ref": "HistogramChartSpec",
+ "description": "A histogram chart specification."
+ },
+ "candlestickChart": {
+ "description": "A candlestick chart specification.",
+ "$ref": "CandlestickChartSpec"
+ },
+ "bubbleChart": {
+ "$ref": "BubbleChartSpec",
+ "description": "A bubble chart specification."
+ },
+ "waterfallChart": {
+ "$ref": "WaterfallChartSpec",
+ "description": "A waterfall chart specification."
+ },
+ "fontName": {
+ "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
+ "type": "string"
+ },
+ "maximized": {
+ "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
+ "type": "boolean"
+ },
+ "treemapChart": {
+ "$ref": "TreemapChartSpec",
+ "description": "A treemap chart specification."
+ },
+ "hiddenDimensionStrategy": {
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Charts will skip hidden rows and columns.",
+ "Charts will skip hidden rows only.",
+ "Charts will skip hidden columns only.",
+ "Charts will not skip any hidden rows or columns."
+ ],
+ "enum": [
+ "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
+ "SKIP_HIDDEN_ROWS_AND_COLUMNS",
+ "SKIP_HIDDEN_ROWS",
+ "SKIP_HIDDEN_COLUMNS",
+ "SHOW_ALL"
+ ]
+ },
+ "subtitleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The subtitle text format.\nStrikethrough and underline are not supported."
+ },
+ "subtitle": {
+ "description": "The subtitle of the chart.",
+ "type": "string"
+ },
+ "subtitleTextPosition": {
+ "$ref": "TextPosition",
+ "description": "The subtitle text position.\nThis field is optional."
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the entire chart.\nNot applicable to Org charts."
+ },
+ "backgroundColorStyle": {
+ "description": "The background color of the entire chart.\nNot applicable to Org charts.\nIf background_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "basicChart": {
+ "$ref": "BasicChartSpec",
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
+ },
+ "orgChart": {
+ "description": "An org chart specification.",
+ "$ref": "OrgChartSpec"
+ },
+ "scorecardChart": {
+ "$ref": "ScorecardChartSpec",
+ "description": "A scorecard chart specification."
+ },
+ "pieChart": {
+ "description": "A pie chart specification.",
+ "$ref": "PieChartSpec"
+ },
+ "titleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The title text format.\nStrikethrough and underline are not supported."
+ }
+ },
+ "id": "ChartSpec"
+ },
+ "CreateDeveloperMetadataRequest": {
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata to create.",
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "id": "CreateDeveloperMetadataRequest",
+ "description": "A request to create developer metadata."
+ },
+ "BatchGetValuesByDataFilterResponse": {
+ "type": "object",
+ "properties": {
+ "valueRanges": {
+ "description": "The requested values with the list of data filters that matched them.",
+ "type": "array",
+ "items": {
+ "$ref": "MatchedValueRange"
+ }
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet the data was retrieved from.",
+ "type": "string"
+ }
+ },
+ "id": "BatchGetValuesByDataFilterResponse",
+ "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters."
+ },
+ "LineStyle": {
+ "description": "Properties that describe the style of a line.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "LINE_DASH_TYPE_UNSPECIFIED",
+ "INVISIBLE",
+ "CUSTOM",
+ "SOLID",
+ "DOTTED",
+ "MEDIUM_DASHED",
+ "MEDIUM_DASHED_DOTTED",
+ "LONG_DASHED",
+ "LONG_DASHED_DOTTED"
+ ],
+ "description": "The dash type of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "No dash type, which is equivalent to a non-visible line.",
+ "A custom dash for a line. Modifying the exact custom dash style is\ncurrently unsupported.",
+ "A solid line.",
+ "A dotted line.",
+ "A dashed line where the dashes have \"medium\" length.",
+ "A line that alternates between a \"medium\" dash and a dot.",
+ "A dashed line where the dashes have \"long\" length.",
+ "A line that alternates between a \"long\" dash and a dot."
+ ]
+ },
+ "width": {
+ "description": "The thickness of the line, in px.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "LineStyle"
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "type": "object",
+ "properties": {
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ },
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickDomain."
+ }
+ },
+ "id": "CandlestickDomain"
+ },
+ "SheetProperties": {
+ "type": "object",
+ "properties": {
+ "hidden": {
+ "description": "True if the sheet is hidden in the UI, false if it's visible.",
+ "type": "boolean"
+ },
+ "gridProperties": {
+ "$ref": "GridProperties",
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
+ },
+ "sheetType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The sheet is a grid.",
+ "The sheet has no grid and instead has an object like a chart or image."
+ ],
+ "enum": [
+ "SHEET_TYPE_UNSPECIFIED",
+ "GRID",
+ "OBJECT"
+ ],
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set."
+ },
+ "tabColorStyle": {
+ "description": "The color of the tab in the UI.\nIf tab_color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
+ },
+ "tabColor": {
+ "$ref": "Color",
+ "description": "The color of the tab in the UI."
+ },
+ "index": {
+ "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet is added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request is ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rightToLeft": {
+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
+ "type": "boolean"
+ }
+ },
+ "id": "SheetProperties",
+ "description": "Properties of a sheet."
+ },
+ "UpdateDimensionPropertiesRequest": {
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The rows or columns to update.",
+ "$ref": "DimensionRange"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "description": "Properties to update.",
+ "$ref": "DimensionProperties"
+ }
+ },
+ "id": "UpdateDimensionPropertiesRequest"
+ },
+ "SourceAndDestination": {
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension that data should be filled into.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ },
+ "fillLength": {
+ "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The location of the data to use as the source of the autofill."
+ }
+ },
+ "id": "SourceAndDestination",
+ "description": "A combination of a source range and how to extend that source."
+ },
+ "SlicerSpec": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The title of the slicer.",
+ "type": "string"
+ },
+ "horizontalAlignment": {
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "description": "The horizontal alignment of title in the slicer.\nIf unspecified, defaults to `LEFT`",
+ "type": "string"
+ },
+ "textFormat": {
+ "$ref": "TextFormat",
+ "description": "The text format of title in the slicer."
+ },
+ "backgroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background color of the slicer.\nIf background_color is also set, this field takes precedence."
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the slicer."
+ },
+ "filterCriteria": {
+ "$ref": "FilterCriteria",
+ "description": "The filtering criteria of the slicer."
+ },
+ "dataRange": {
+ "$ref": "GridRange",
+ "description": "The data range of the slicer."
+ },
+ "applyToPivotTables": {
+ "description": "True if the filter should apply to pivot tables.\nIf not set, default to `True`.",
+ "type": "boolean"
+ },
+ "columnIndex": {
+ "description": "The column index in the data table on which the filter is applied to.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SlicerSpec",
+ "description": "The specifications of a slicer."
+ },
+ "CandlestickSeries": {
+ "id": "CandlestickSeries",
+ "description": "The series of a CandlestickData.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "The data of the CandlestickSeries.",
+ "$ref": "ChartData"
+ }
+ }
+ },
+ "HistogramChartSpec": {
+ "type": "object",
+ "properties": {
+ "showItemDividers": {
+ "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
+ "type": "array",
+ "items": {
+ "$ref": "HistogramSeries"
+ }
+ },
+ "legendPosition": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "The legend is rendered inside the chart area."
+ ],
+ "enum": [
+ "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
+ ],
+ "description": "The position of the chart legend."
+ },
+ "bucketSize": {
+ "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
+ "format": "double",
+ "type": "number"
+ },
+ "outlierPercentile": {
+ "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "HistogramChartSpec",
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly."
+ },
+ "UpdateValuesResponse": {
+ "id": "UpdateValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "updatedColumns": {
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "updatedRange": {
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
+ },
+ "updatedCells": {
+ "description": "The number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "updatedData": {
+ "$ref": "ValueRange",
+ "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
+ },
+ "updatedRows": {
+ "type": "integer",
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "format": "int32"
+ }
+ }
+ },
+ "PivotGroupSortValueBucket": {
+ "description": "Information about which values in a pivot group should be used for sorting.",
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
+ "type": "array",
+ "items": {
+ "$ref": "ExtendedValue"
+ }
+ },
+ "valuesIndex": {
+ "type": "integer",
+ "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
+ "format": "int32"
+ }
+ },
+ "id": "PivotGroupSortValueBucket"
+ },
+ "WaterfallChartSeries": {
+ "id": "WaterfallChartSeries",
+ "description": "A single series of data for a waterfall chart.",
+ "type": "object",
+ "properties": {
+ "positiveColumnsStyle": {
+ "description": "Styles for all columns in this series with positive values.",
+ "$ref": "WaterfallChartColumnStyle"
+ },
+ "data": {
+ "description": "The data being visualized in this series.",
+ "$ref": "ChartData"
+ },
+ "negativeColumnsStyle": {
+ "$ref": "WaterfallChartColumnStyle",
+ "description": "Styles for all columns in this series with negative values."
+ },
+ "hideTrailingSubtotal": {
+ "type": "boolean",
+ "description": "True to hide the subtotal column from the end of the series. By default,\na subtotal column will appear at the end of each series. Setting this\nfield to true will hide that subtotal column for this series."
+ },
+ "customSubtotals": {
+ "type": "array",
+ "items": {
+ "$ref": "WaterfallChartCustomSubtotal"
+ },
+ "description": "Custom subtotal columns appearing in this series. The order in which\nsubtotals are defined is not significant. Only one subtotal may be\ndefined for each data point."
+ },
+ "subtotalColumnsStyle": {
+ "$ref": "WaterfallChartColumnStyle",
+ "description": "Styles for all subtotal columns in this series."
+ }
+ }
+ },
+ "DeleteDeveloperMetadataRequest": {
+ "properties": {
+ "dataFilter": {
+ "description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete.",
+ "$ref": "DataFilter"
+ }
+ },
+ "id": "DeleteDeveloperMetadataRequest",
+ "description": "A request to delete developer metadata.",
+ "type": "object"
+ },
+ "CandlestickData": {
+ "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
+ "type": "object",
+ "properties": {
+ "openSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow."
+ },
+ "highSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line."
+ },
+ "lowSeries": {
+ "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line.",
+ "$ref": "CandlestickSeries"
+ },
+ "closeSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow."
+ }
+ },
+ "id": "CandlestickData"
+ },
+ "DeleteProtectedRangeRequest": {
+ "description": "Deletes the protected range with the given ID.",
+ "type": "object",
+ "properties": {
+ "protectedRangeId": {
+ "description": "The ID of the protected range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteProtectedRangeRequest"
+ },
+ "InterpolationPoint": {
+ "id": "InterpolationPoint",
+ "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "How the value should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "The interpolation point uses the minimum value in the\ncells over the range of the conditional format.",
+ "The interpolation point uses the maximum value in the\ncells over the range of the conditional format.",
+ "The interpolation point uses exactly the value in\nInterpolationPoint.value.",
+ "The interpolation point is the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
+ "The interpolation point is the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
+ ],
+ "enum": [
+ "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
+ "MIN",
+ "MAX",
+ "NUMBER",
+ "PERCENT",
+ "PERCENTILE"
+ ]
+ },
+ "value": {
+ "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color this interpolation point should use."
+ },
+ "colorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The color this interpolation point should use.\nIf color is also set, this field takes precedence."
+ }
+ }
+ },
+ "FindReplaceResponse": {
+ "type": "object",
+ "properties": {
+ "valuesChanged": {
+ "description": "The number of non-formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "occurrencesChanged": {
+ "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowsChanged": {
+ "type": "integer",
+ "description": "The number of rows changed.",
+ "format": "int32"
+ },
+ "sheetsChanged": {
+ "description": "The number of sheets changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "formulasChanged": {
+ "description": "The number of formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "FindReplaceResponse",
+ "description": "The result of the find/replace."
+ },
+ "DuplicateFilterViewRequest": {
+ "id": "DuplicateFilterViewRequest",
+ "description": "Duplicates a particular filter view.",
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "description": "The ID of the filter being duplicated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "UpdateConditionalFormatRuleResponse": {
+ "description": "The result of updating a conditional format rule.",
+ "type": "object",
+ "properties": {
+ "newIndex": {
+ "type": "integer",
+ "description": "The index of the new rule.",
+ "format": "int32"
+ },
+ "oldIndex": {
+ "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newRule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
+ },
+ "oldRule": {
+ "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule).",
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "id": "UpdateConditionalFormatRuleResponse"
+ },
+ "ConditionValue": {
+ "description": "The value of the condition.",
+ "type": "object",
+ "properties": {
+ "relativeDate": {
+ "enum": [
+ "RELATIVE_DATE_UNSPECIFIED",
+ "PAST_YEAR",
+ "PAST_MONTH",
+ "PAST_WEEK",
+ "YESTERDAY",
+ "TODAY",
+ "TOMORROW"
+ ],
+ "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The value is one year before today.",
+ "The value is one month before today.",
+ "The value is one week before today.",
+ "The value is yesterday.",
+ "The value is today.",
+ "The value is tomorrow."
+ ]
+ },
+ "userEnteredValue": {
+ "description": "A value the condition is based on.\nThe value is parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=` or a '+').",
+ "type": "string"
+ }
+ },
+ "id": "ConditionValue"
+ },
+ "DateTimeRule": {
+ "description": "Allows you to organize the date-time values in a source data column into\nbuckets based on selected parts of their date or time values. For example,\nconsider a pivot table showing sales transactions by date:\n\n +----------+--------------+\n | Date | SUM of Sales |\n +----------+--------------+\n | 1/1/2017 | $621.14 |\n | 2/3/2017 | $708.84 |\n | 5/8/2017 | $326.84 |\n ...\n +----------+--------------+\nApplying a date-time group rule with a DateTimeRuleType of YEAR_MONTH\nresults in the following pivot table.\n\n +--------------+--------------+\n | Grouped Date | SUM of Sales |\n +--------------+--------------+\n | 2017-Jan | $53,731.78 |\n | 2017-Feb | $83,475.32 |\n | 2017-Mar | $94,385.05 |\n ...\n +--------------+--------------+",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "DATE_TIME_RULE_TYPE_UNSPECIFIED",
+ "SECOND",
+ "MINUTE",
+ "HOUR",
+ "HOUR_MINUTE",
+ "HOUR_MINUTE_AMPM",
+ "DAY_OF_WEEK",
+ "DAY_OF_YEAR",
+ "DAY_OF_MONTH",
+ "DAY_MONTH",
+ "MONTH",
+ "QUARTER",
+ "YEAR",
+ "YEAR_MONTH",
+ "YEAR_QUARTER",
+ "YEAR_MONTH_DAY"
+ ],
+ "description": "The type of date-time grouping to apply.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default type, do not use.",
+ "Group dates by second, from 0 to 59.",
+ "Group dates by minute, from 0 to 59.",
+ "Group dates by hour using a 24-hour system, from 0 to 23.",
+ "Group dates by hour and minute using a 24-hour system, for example 19:45.",
+ "Group dates by hour and minute using a 12-hour system, for example 7:45\nPM. The AM/PM designation is translated based on the spreadsheet\nlocale.",
+ "Group dates by day of week, for example Sunday. The days of the week will\nbe translated based on the spreadsheet locale.",
+ "Group dates by day of year, from 1 to 366. Note that dates after Feb. 29\nfall in different buckets in leap years than in non-leap years.",
+ "Group dates by day of month, from 1 to 31.",
+ "Group dates by day and month, for example 22-Nov. The month is\ntranslated based on the spreadsheet locale.",
+ "Group dates by month, for example Nov. The month is translated based\non the spreadsheet locale.",
+ "Group dates by quarter, for example Q1 (which represents Jan-Mar).",
+ "Group dates by year, for example 2008.",
+ "Group dates by year and month, for example 2008-Nov. The month is\ntranslated based on the spreadsheet locale.",
+ "Group dates by year and quarter, for example 2008 Q4.",
+ "Group dates by year, month, and day, for example 2008-11-22."
+ ]
+ }
+ },
+ "id": "DateTimeRule"
+ },
+ "Spreadsheet": {
+ "properties": {
+ "properties": {
+ "description": "Overall properties of a spreadsheet.",
+ "$ref": "SpreadsheetProperties"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ },
+ "namedRanges": {
+ "description": "The named ranges defined in a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "NamedRange"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "sheets": {
+ "description": "The sheets that are part of a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "Sheet"
+ }
+ },
+ "spreadsheetUrl": {
+ "description": "The url of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ }
+ },
+ "id": "Spreadsheet",
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object"
+ },
+ "HistogramSeries": {
+ "type": "object",
+ "properties": {
+ "barColor": {
+ "$ref": "Color",
+ "description": "The color of the column representing this series in each bucket.\nThis field is optional."
+ },
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data for this histogram series."
+ },
+ "barColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The color of the column representing this series in each bucket.\nThis field is optional.\nIf bar_color is also set, this field takes precedence."
+ }
+ },
+ "id": "HistogramSeries",
+ "description": "A histogram series containing the series color and data."
+ },
+ "BandedRange": {
+ "description": "A banded (alternating colors) range in a sheet.",
+ "type": "object",
+ "properties": {
+ "rowProperties": {
+ "$ref": "BandingProperties",
+ "description": "Properties for row bands. These properties are applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
+ },
+ "columnProperties": {
+ "$ref": "BandingProperties",
+ "description": "Properties for column bands. These properties are applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
+ },
+ "range": {
+ "description": "The range over which these properties are applied.",
+ "$ref": "GridRange"
+ },
+ "bandedRangeId": {
+ "type": "integer",
+ "description": "The id of the banded range.",
+ "format": "int32"
+ }
+ },
+ "id": "BandedRange"
+ },
+ "AddChartRequest": {
+ "description": "Adds a chart to a sheet in the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "chart": {
+ "$ref": "EmbeddedChart",
+ "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of an embedded object that already exists.)"
+ }
+ },
+ "id": "AddChartRequest"
+ },
+ "HistogramRule": {
+ "description": "Allows you to organize the numeric values in a source data column into\nbuckets of a constant size. All values from HistogramRule.start to\nHistogramRule.end are placed into groups of size\nHistogramRule.interval. In addition, all values below\nHistogramRule.start are placed in one group, and all values above\nHistogramRule.end are placed in another. Only\nHistogramRule.interval is required, though if HistogramRule.start\nand HistogramRule.end are both provided, HistogramRule.start must\nbe less than HistogramRule.end. For example, a pivot table showing\naverage purchase amount by age that has 50+ rows:\n\n +-----+-------------------+\n | Age | AVERAGE of Amount |\n +-----+-------------------+\n | 16 | $27.13 |\n | 17 | $5.24 |\n | 18 | $20.15 |\n ...\n +-----+-------------------+\ncould be turned into a pivot table that looks like the one below by\napplying a histogram group rule with a HistogramRule.start of 25,\nan HistogramRule.interval of 20, and an HistogramRule.end\nof 65.\n\n +-------------+-------------------+\n | Grouped Age | AVERAGE of Amount |\n +-------------+-------------------+\n | \u003c 25 | $19.34 |\n | 25-45 | $31.43 |\n | 45-65 | $35.87 |\n | \u003e 65 | $27.55 |\n +-------------+-------------------+\n | Grand Total | $29.12 |\n +-------------+-------------------+",
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "The maximum value at which items are placed into buckets\nof constant size. Values above end are lumped into a single bucket.\nThis field is optional.",
+ "format": "double",
+ "type": "number"
+ },
+ "interval": {
+ "description": "The size of the buckets that are created. Must be positive.",
+ "format": "double",
+ "type": "number"
+ },
+ "start": {
+ "description": "The minimum value at which items are placed into buckets\nof constant size. Values below start are lumped into a single bucket.\nThis field is optional.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "HistogramRule"
+ },
+ "UpdateProtectedRangeRequest": {
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to update with the new properties."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateProtectedRangeRequest"
+ },
+ "AddSheetResponse": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the newly added sheet."
+ }
+ },
+ "id": "AddSheetResponse",
+ "description": "The result of adding a sheet."
+ },
+ "PivotGroupRule": {
+ "description": "An optional setting on a PivotGroup that defines buckets for the values\nin the source data column rather than breaking out each individual value.\nOnly one PivotGroup with a group rule may be added for each column in\nthe source data, though on any given column you may add both a\nPivotGroup that has a rule and a PivotGroup that does not.",
+ "type": "object",
+ "properties": {
+ "histogramRule": {
+ "description": "A HistogramRule.",
+ "$ref": "HistogramRule"
+ },
+ "dateTimeRule": {
+ "$ref": "DateTimeRule",
+ "description": "A DateTimeRule."
+ },
+ "manualRule": {
+ "description": "A ManualRule.",
+ "$ref": "ManualRule"
+ }
+ },
+ "id": "PivotGroupRule"
+ },
+ "AddFilterViewResponse": {
+ "properties": {
+ "filter": {
+ "description": "The newly added filter view.",
+ "$ref": "FilterView"
+ }
+ },
+ "id": "AddFilterViewResponse",
+ "description": "The result of adding a filter view.",
+ "type": "object"
+ },
+ "IterativeCalculationSettings": {
+ "properties": {
+ "convergenceThreshold": {
+ "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
+ "format": "double",
+ "type": "number"
+ },
+ "maxIterations": {
+ "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "IterativeCalculationSettings",
+ "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
+ "type": "object"
+ },
+ "ScorecardChartSpec": {
+ "description": "A scorecard chart. Scorecard charts are used to highlight key performance\nindicators, known as KPIs, on the spreadsheet. A scorecard chart can\nrepresent things like total sales, average cost, or a top selling item. You\ncan specify a single data value, or aggregate over a range of data.\nPercentage or absolute difference from a baseline value can be highlighted,\nlike changes over time.",
+ "type": "object",
+ "properties": {
+ "baselineValueData": {
+ "$ref": "ChartData",
+ "description": "The data for scorecard baseline value.\nThis field is optional."
+ },
+ "keyValueData": {
+ "$ref": "ChartData",
+ "description": "The data for scorecard key value."
+ },
+ "aggregateType": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Average aggregate function.",
+ "Count aggregate function.",
+ "Maximum aggregate function.",
+ "Median aggregate function.",
+ "Minimum aggregate function.",
+ "Sum aggregate function."
+ ],
+ "enum": [
+ "CHART_AGGREGATE_TYPE_UNSPECIFIED",
+ "AVERAGE",
+ "COUNT",
+ "MAX",
+ "MEDIAN",
+ "MIN",
+ "SUM"
+ ],
+ "description": "The aggregation type for key and baseline chart data in scorecard chart.\nThis field is optional.",
+ "type": "string"
+ },
+ "numberFormatSource": {
+ "description": "The number format source used in the scorecard chart.\nThis field is optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Inherit number formatting from data.",
+ "Apply custom formatting as specified by ChartCustomNumberFormatOptions."
+ ],
+ "enum": [
+ "CHART_NUMBER_FORMAT_SOURCE_UNDEFINED",
+ "FROM_DATA",
+ "CUSTOM"
+ ]
+ },
+ "keyValueFormat": {
+ "$ref": "KeyValueFormat",
+ "description": "Formatting options for key value."
+ },
+ "customFormatOptions": {
+ "description": "Custom formatting options for numeric key/baseline values in scorecard\nchart. This field is used only when number_format_source is set to\nCUSTOM. This field is optional.",
+ "$ref": "ChartCustomNumberFormatOptions"
+ },
+ "scaleFactor": {
+ "type": "number",
+ "description": "Value to scale scorecard key and baseline value. For example, a factor of\n10 can be used to divide all values in the chart by 10.\nThis field is optional.",
+ "format": "double"
+ },
+ "baselineValueFormat": {
+ "description": "Formatting options for baseline value.\nThis field is needed only if baseline_value_data is specified.",
+ "$ref": "BaselineValueFormat"
+ }
+ },
+ "id": "ScorecardChartSpec"
+ },
+ "SpreadsheetProperties": {
+ "description": "Properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetTheme": {
+ "$ref": "SpreadsheetTheme",
+ "description": "Theme applied to the spreadsheet."
+ },
+ "iterativeCalculationSettings": {
+ "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references result\nin calculation errors.",
+ "$ref": "IterativeCalculationSettings"
+ },
+ "defaultFormat": {
+ "$ref": "CellFormat",
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if\nthe cell's format is equal to this default format. This field is read-only."
+ },
+ "autoRecalc": {
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ],
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ],
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the spreadsheet.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
+ "type": "string"
+ }
+ },
+ "id": "SpreadsheetProperties"
+ },
+ "OverlayPosition": {
+ "type": "object",
+ "properties": {
+ "offsetYPixels": {
+ "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "heightPixels": {
+ "description": "The height of the object, in pixels. Defaults to 371.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "widthPixels": {
+ "description": "The width of the object, in pixels. Defaults to 600.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offsetXPixels": {
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "anchorCell": {
+ "$ref": "GridCoordinate",
+ "description": "The cell the object is anchored to."
+ }
+ },
+ "id": "OverlayPosition",
+ "description": "The location an object is overlaid on top of a grid."
+ },
+ "AddChartResponse": {
+ "description": "The result of adding a chart to a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "chart": {
+ "$ref": "EmbeddedChart",
+ "description": "The newly added chart."
+ }
+ },
+ "id": "AddChartResponse"
+ },
+ "InsertDimensionRequest": {
+ "properties": {
+ "inheritFromBefore": {
+ "type": "boolean",
+ "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green)."
+ },
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded."
+ }
+ },
+ "id": "InsertDimensionRequest",
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "type": "object"
+ },
+ "BatchUpdateValuesRequest": {
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "responseDateTimeRenderOption": {
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
+ "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
+ ],
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "type": "string"
+ },
+ "responseValueRenderOption": {
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ]
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses contains the updated\nvalues. If the range to write was larger than the range actually written,\nthe response includes all values in the requested range (excluding trailing\nempty rows and columns).",
+ "type": "boolean"
+ },
+ "valueInputOption": {
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
+ ],
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ]
+ },
+ "data": {
+ "description": "The new values to apply to the spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ }
+ },
+ "id": "BatchUpdateValuesRequest"
+ },
+ "CutPasteRequest": {
+ "description": "Moves data from the source to the destination.",
+ "type": "object",
+ "properties": {
+ "destination": {
+ "description": "The top-left coordinate where the data should be pasted.",
+ "$ref": "GridCoordinate"
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data to cut."
+ },
+ "pasteType": {
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
+ "type": "string"
+ }
+ },
+ "id": "CutPasteRequest"
+ },
+ "ChartAxisViewWindowOptions": {
+ "type": "object",
+ "properties": {
+ "viewWindowMax": {
+ "description": "The maximum numeric value to be shown in this view window. If unset, will\nautomatically determine a maximum value that looks good for the data.",
+ "format": "double",
+ "type": "number"
+ },
+ "viewWindowMode": {
+ "enumDescriptions": [
+ "The default view window mode used in the Sheets editor for this chart\ntype. In most cases, if set, the default mode is equivalent to\n`PRETTY`.",
+ "Do not use. Represents that the currently set mode is not supported by\nthe API.",
+ "Follows the min and max exactly if specified. If a value is unspecified,\nit will fall back to the `PRETTY` value.",
+ "Chooses a min and max that make the chart look good. Both min and max are\nignored in this mode."
+ ],
+ "enum": [
+ "DEFAULT_VIEW_WINDOW_MODE",
+ "VIEW_WINDOW_MODE_UNSUPPORTED",
+ "EXPLICIT",
+ "PRETTY"
+ ],
+ "description": "The view window's mode.",
+ "type": "string"
+ },
+ "viewWindowMin": {
+ "description": "The minimum numeric value to be shown in this view window. If unset, will\nautomatically determine a minimum value that looks good for the data.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "ChartAxisViewWindowOptions",
+ "description": "The options that define a \"view window\" for a chart (such as the visible\nvalues in an axis)."
+ },
+ "BasicChartSeries": {
+ "id": "BasicChartSeries",
+ "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
+ "type": "object",
+ "properties": {
+ "targetAxis": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ]
+ },
+ "lineStyle": {
+ "description": "The line style of this series. Valid only if the\nchartType is AREA,\nLINE, or SCATTER.\nCOMBO charts are also supported if the\nseries chart type is\nAREA or LINE.",
+ "$ref": "LineStyle"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
+ "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter\nchart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area\nchart\u003c/a\u003e."
+ ],
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ],
+ "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
+ "type": "string"
+ },
+ "colorStyle": {
+ "description": "The color for elements (such as bars, lines, and points) associated with\nthis series. If empty, a default color is used.\nIf color is also set, this field takes precedence.",
+ "$ref": "ColorStyle"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color for elements (such as bars, lines, and points) associated with\nthis series. If empty, a default color is used."
+ },
+ "series": {
+ "description": "The data being visualized in this chart series.",
+ "$ref": "ChartData"
+ }
+ }
+ },
+ "AutoResizeDimensionsRequest": {
+ "id": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "type": "object",
+ "properties": {
+ "dimensions": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to automatically resize."
+ }
+ }
+ },
+ "UpdateBordersRequest": {
+ "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
+ "type": "object",
+ "properties": {
+ "innerVertical": {
+ "description": "The vertical border to put within the range.",
+ "$ref": "Border"
+ },
+ "right": {
+ "$ref": "Border",
+ "description": "The border to put at the right of the range."
+ },
+ "range": {
+ "description": "The range whose borders should be updated.",
+ "$ref": "GridRange"
+ },
+ "innerHorizontal": {
+ "$ref": "Border",
+ "description": "The horizontal border to put within the range."
+ },
+ "top": {
+ "description": "The border to put at the top of the range.",
+ "$ref": "Border"
+ },
+ "left": {
+ "$ref": "Border",
+ "description": "The border to put at the left of the range."
+ },
+ "bottom": {
+ "$ref": "Border",
+ "description": "The border to put at the bottom of the range."
+ }
+ },
+ "id": "UpdateBordersRequest"
+ },
+ "CellFormat": {
+ "description": "The format of a cell.",
+ "type": "object",
+ "properties": {
+ "hyperlinkDisplayType": {
+ "enumDescriptions": [
+ "The default value: the hyperlink is rendered. Do not use this.",
+ "A hyperlink should be explicitly rendered.",
+ "A hyperlink should not be rendered."
+ ],
+ "enum": [
+ "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
+ "LINKED",
+ "PLAIN_TEXT"
+ ],
+ "description": "How a hyperlink, if it exists, should be displayed in the cell.",
+ "type": "string"
+ },
+ "horizontalAlignment": {
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "description": "The horizontal alignment of the value in the cell.",
+ "type": "string"
+ },
+ "backgroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background color of the cell.\nIf background_color is also set, this field takes precedence."
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the cell."
+ },
+ "padding": {
+ "$ref": "Padding",
+ "description": "The padding of the cell."
+ },
+ "borders": {
+ "$ref": "Borders",
+ "description": "The borders of the cell."
+ },
+ "textDirection": {
+ "type": "string",
+ "enumDescriptions": [
+ "The text direction is not specified. Do not use this.",
+ "The text direction of left-to-right was set by the user.",
+ "The text direction of right-to-left was set by the user."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The direction of the text in the cell."
+ },
+ "textRotation": {
+ "$ref": "TextRotation",
+ "description": "The rotation applied to text in a cell"
+ },
+ "numberFormat": {
+ "$ref": "NumberFormat",
+ "description": "A format describing how number values should be represented to the user."
+ },
+ "textFormat": {
+ "$ref": "TextFormat",
+ "description": "The format of the text in the cell (unless overridden by a format run)."
+ },
+ "verticalAlignment": {
+ "enumDescriptions": [
+ "The vertical alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the top of the cell.",
+ "The text is explicitly aligned to the middle of the cell.",
+ "The text is explicitly aligned to the bottom of the cell."
+ ],
+ "enum": [
+ "VERTICAL_ALIGN_UNSPECIFIED",
+ "TOP",
+ "MIDDLE",
+ "BOTTOM"
+ ],
+ "description": "The vertical alignment of the value in the cell.",
+ "type": "string"
+ },
+ "wrapStrategy": {
+ "enum": [
+ "WRAP_STRATEGY_UNSPECIFIED",
+ "OVERFLOW_CELL",
+ "LEGACY_WRAP",
+ "CLIP",
+ "WRAP"
+ ],
+ "description": "The wrap strategy for the value in the cell.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
+ "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |",
+ "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |",
+ "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |"
+ ]
+ }
+ },
+ "id": "CellFormat"
+ },
+ "ClearValuesResponse": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRange": {
+ "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
+ "type": "string"
+ }
+ },
+ "id": "ClearValuesResponse"
+ },
+ "WaterfallChartCustomSubtotal": {
+ "id": "WaterfallChartCustomSubtotal",
+ "description": "A custom subtotal column for a waterfall chart series.",
+ "type": "object",
+ "properties": {
+ "subtotalIndex": {
+ "description": "The 0-based index of a data point within the series. If\ndata_is_subtotal is true, the data point at this index is the\nsubtotal. Otherwise, the subtotal appears after the data point with\nthis index. A series can have multiple subtotals at arbitrary indices,\nbut subtotals do not affect the indices of the data points. For\nexample, if a series has three data points, their indices will always\nbe 0, 1, and 2, regardless of how many subtotals exist on the series or\nwhat data points they are associated with.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataIsSubtotal": {
+ "description": "True if the data point at subtotal_index is the subtotal. If false,\nthe subtotal will be computed and appear after the data point.",
+ "type": "boolean"
+ },
+ "label": {
+ "description": "A label for the subtotal column.",
+ "type": "string"
+ }
+ }
+ },
+ "ChartData": {
+ "description": "The data included in a domain or series.",
+ "type": "object",
+ "properties": {
+ "sourceRange": {
+ "$ref": "ChartSourceRange",
+ "description": "The source ranges of the data."
+ }
+ },
+ "id": "ChartData"
+ },
+ "BatchGetValuesResponse": {
+ "description": "The response when retrieving more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "valueRanges": {
+ "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet the data was retrieved from.",
+ "type": "string"
+ }
+ },
+ "id": "BatchGetValuesResponse"
+ },
+ "UpdateBandingRequest": {
+ "description": "Updates properties of the supplied banded range.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range to update with the new properties."
+ }
+ },
+ "id": "UpdateBandingRequest"
+ },
+ "Color": {
+ "id": "Color",
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well.\n\nNote: this proto does not carry information about the absolute color space\nthat should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,\nDCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color\nspace.\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [[Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
+ "properties": {
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "green": {
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "alpha": {
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "format": "float",
+ "type": "number"
+ }
+ }
+ },
+ "TrimWhitespaceRequest": {
+ "description": "Trims the whitespace (such as spaces, tabs, or new lines) in every cell in\nthe specified range. This request removes all whitespace from the start and\nend of each cell's text, and reduces any subsequence of remaining whitespace\ncharacters to a single space. If the resulting trimmed text starts with a '+'\nor '=' character, the text remains as a string value and isn't interpreted\nas a formula.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range whose cells to trim."
+ }
+ },
+ "id": "TrimWhitespaceRequest"
+ },
+ "ChartSourceRange": {
+ "properties": {
+ "sources": {
+ "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be in order and contiguous across the domain\nand series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ }
+ },
+ "id": "ChartSourceRange",
+ "description": "Source ranges for a chart.",
+ "type": "object"
+ },
+ "ValueRange": {
+ "description": "Data within a range of the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "majorDimension": {
+ "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "values": {
+ "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
}
}
},
- "sheets": {
- "methods": {
- "copyTo": {
- "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
- "request": {
- "$ref": "CopySheetToAnotherSpreadsheetRequest"
- },
- "response": {
- "$ref": "SheetProperties"
- },
- "parameterOrder": [
- "spreadsheetId",
- "sheetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "sheetId": {
- "description": "The ID of the sheet to copy.",
- "format": "int32",
- "required": true,
- "type": "integer",
- "location": "path"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet containing the sheet to copy.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "id": "sheets.spreadsheets.sheets.copyTo"
- }
+ "range": {
+ "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
+ "type": "string"
+ }
+ },
+ "id": "ValueRange"
+ },
+ "AddBandingRequest": {
+ "description": "Adds a new banded range to the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
+ }
+ },
+ "id": "AddBandingRequest"
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "type": "object",
+ "properties": {
+ "deleteDuplicates": {
+ "$ref": "DeleteDuplicatesResponse",
+ "description": "A reply from removing rows containing duplicate values."
+ },
+ "addFilterView": {
+ "$ref": "AddFilterViewResponse",
+ "description": "A reply from adding a filter view."
+ },
+ "addBanding": {
+ "$ref": "AddBandingResponse",
+ "description": "A reply from adding a banded range."
+ },
+ "addProtectedRange": {
+ "description": "A reply from adding a protected range.",
+ "$ref": "AddProtectedRangeResponse"
+ },
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetResponse",
+ "description": "A reply from duplicating a sheet."
+ },
+ "deleteConditionalFormatRule": {
+ "description": "A reply from deleting a conditional format rule.",
+ "$ref": "DeleteConditionalFormatRuleResponse"
+ },
+ "updateEmbeddedObjectPosition": {
+ "description": "A reply from updating an embedded object's position.",
+ "$ref": "UpdateEmbeddedObjectPositionResponse"
+ },
+ "addSlicer": {
+ "$ref": "AddSlicerResponse",
+ "description": "A reply from adding a slicer."
+ },
+ "deleteDimensionGroup": {
+ "$ref": "DeleteDimensionGroupResponse",
+ "description": "A reply from deleting a dimension group."
+ },
+ "duplicateFilterView": {
+ "$ref": "DuplicateFilterViewResponse",
+ "description": "A reply from duplicating a filter view."
+ },
+ "addDimensionGroup": {
+ "$ref": "AddDimensionGroupResponse",
+ "description": "A reply from adding a dimension group."
+ },
+ "addChart": {
+ "description": "A reply from adding a chart.",
+ "$ref": "AddChartResponse"
+ },
+ "updateDeveloperMetadata": {
+ "description": "A reply from updating a developer metadata entry.",
+ "$ref": "UpdateDeveloperMetadataResponse"
+ },
+ "findReplace": {
+ "$ref": "FindReplaceResponse",
+ "description": "A reply from doing a find/replace."
+ },
+ "addSheet": {
+ "$ref": "AddSheetResponse",
+ "description": "A reply from adding a sheet."
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleResponse",
+ "description": "A reply from updating a conditional format rule."
+ },
+ "createDeveloperMetadata": {
+ "description": "A reply from creating a developer metadata entry.",
+ "$ref": "CreateDeveloperMetadataResponse"
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeResponse",
+ "description": "A reply from adding a named range."
+ },
+ "deleteDeveloperMetadata": {
+ "$ref": "DeleteDeveloperMetadataResponse",
+ "description": "A reply from deleting a developer metadata entry."
+ },
+ "trimWhitespace": {
+ "description": "A reply from trimming whitespace.",
+ "$ref": "TrimWhitespaceResponse"
+ }
+ },
+ "id": "Response"
+ },
+ "EmbeddedChart": {
+ "id": "EmbeddedChart",
+ "description": "A chart embedded in a sheet.",
+ "type": "object",
+ "properties": {
+ "chartId": {
+ "description": "The ID of the chart.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The position of the chart."
+ },
+ "spec": {
+ "$ref": "ChartSpec",
+ "description": "The specification of the chart."
+ }
+ }
+ },
+ "InsertRangeRequest": {
+ "type": "object",
+ "properties": {
+ "shiftDimension": {
+ "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to insert new cells into."
+ }
+ },
+ "id": "InsertRangeRequest",
+ "description": "Inserts cells into a range, shifting the existing cells over or down."
+ },
+ "AddNamedRangeResponse": {
+ "description": "The result of adding a named range.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to add."
+ }
+ },
+ "id": "AddNamedRangeResponse"
+ },
+ "AddSheetRequest": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
+ }
+ },
+ "id": "AddSheetRequest",
+ "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet."
+ },
+ "DeleteConditionalFormatRuleResponse": {
+ "type": "object",
+ "properties": {
+ "rule": {
+ "description": "The rule that was deleted.",
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "id": "DeleteConditionalFormatRuleResponse",
+ "description": "The result of deleting a conditional format rule."
+ },
+ "AddSlicerRequest": {
+ "description": "Adds a slicer to a sheet in the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "slicer": {
+ "description": "The slicer that should be added to the spreadsheet, including\nthe position where it should be placed. The slicerId field is optional; if one is not set, an id\nwill be randomly generated. (It is an error to specify the ID\nof a slicer that already exists.)",
+ "$ref": "Slicer"
+ }
+ },
+ "id": "AddSlicerRequest"
+ },
+ "GridCoordinate": {
+ "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
+ "type": "object",
+ "properties": {
+ "rowIndex": {
+ "description": "The row index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnIndex": {
+ "description": "The column index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "type": "integer",
+ "description": "The sheet this coordinate is on.",
+ "format": "int32"
+ }
+ },
+ "id": "GridCoordinate"
+ },
+ "UpdateSheetPropertiesRequest": {
+ "description": "Updates properties of the sheet with the specified\nsheetId.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "description": "The properties to update.",
+ "$ref": "SheetProperties"
+ }
+ },
+ "id": "UpdateSheetPropertiesRequest"
+ },
+ "GridProperties": {
+ "properties": {
+ "rowCount": {
+ "description": "The number of rows in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hideGridlines": {
+ "description": "True if the grid isn't showing gridlines in the UI.",
+ "type": "boolean"
+ },
+ "frozenRowCount": {
+ "description": "The number of rows that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnCount": {
+ "description": "The number of columns in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frozenColumnCount": {
+ "description": "The number of columns that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnGroupControlAfter": {
+ "description": "True if the column grouping control toggle is shown after the group.",
+ "type": "boolean"
+ },
+ "rowGroupControlAfter": {
+ "description": "True if the row grouping control toggle is shown after the group.",
+ "type": "boolean"
+ }
+ },
+ "id": "GridProperties",
+ "description": "Properties of a grid.",
+ "type": "object"
+ },
+ "AddSlicerResponse": {
+ "description": "The result of adding a slicer to a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "slicer": {
+ "$ref": "Slicer",
+ "description": "The newly added slicer."
+ }
+ },
+ "id": "AddSlicerResponse"
+ },
+ "Sheet": {
+ "description": "A sheet in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "bandedRanges": {
+ "type": "array",
+ "items": {
+ "$ref": "BandedRange"
+ },
+ "description": "The banded (alternating colors) ranges on this sheet."
+ },
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "filterViews": {
+ "description": "The filter views in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "FilterView"
+ }
+ },
+ "slicers": {
+ "description": "The slicers on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "Slicer"
+ }
+ },
+ "rowGroups": {
+ "description": "All row groups on this sheet, ordered by increasing range start index, then\nby group depth.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionGroup"
+ }
+ },
+ "data": {
+ "description": "Data in the grid, if this is a grid sheet.\n\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
+ "type": "array",
+ "items": {
+ "$ref": "GridData"
+ }
+ },
+ "properties": {
+ "description": "The properties of the sheet.",
+ "$ref": "SheetProperties"
+ },
+ "columnGroups": {
+ "description": "All column groups on this sheet, ordered by increasing range start index,\nthen by group depth.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionGroup"
+ }
+ },
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ProtectedRange"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "basicFilter": {
+ "$ref": "BasicFilter",
+ "description": "The filter on this sheet, if any."
+ },
+ "merges": {
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ },
+ "description": "The ranges that are merged together."
+ }
+ },
+ "id": "Sheet"
+ },
+ "PivotGroupValueMetadata": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)",
+ "$ref": "ExtendedValue"
+ },
+ "collapsed": {
+ "description": "True if the data corresponding to the value is collapsed.",
+ "type": "boolean"
+ }
+ },
+ "id": "PivotGroupValueMetadata",
+ "description": "Metadata about a value in a pivot grouping."
+ },
+ "FilterCriteria": {
+ "description": "Criteria for showing/hiding rows in a filter or filter view.",
+ "type": "object",
+ "properties": {
+ "visibleForegroundColor": {
+ "$ref": "Color",
+ "description": "The foreground color to filter by; only cells with this foreground color\nare shown. Mutually exclusive with visible_background_color."
+ },
+ "visibleBackgroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The background fill color to filter by; only cells with this fill color are\nshown. This field is mutually exclusive with visible_foreground_color,\nand must be set to an RGB-type color. If visible_background_color is\nalso set, this field takes precedence."
+ },
+ "hiddenValues": {
+ "description": "Values that should be hidden.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "condition": {
+ "description": "A condition that must be true for values to be shown.\n(This does not override hidden_values -- if a value is listed there,\n it will still be hidden.)",
+ "$ref": "BooleanCondition"
+ },
+ "visibleBackgroundColor": {
+ "$ref": "Color",
+ "description": "The background fill color to filter by; only cells with this fill color are\nshown. Mutually exclusive with visible_foreground_color."
+ },
+ "visibleForegroundColorStyle": {
+ "$ref": "ColorStyle",
+ "description": "The foreground color to filter by; only cells with this foreground color\nare shown. This field is mutually exclusive with\nvisible_background_color, and must be set to an RGB-type color. If\nvisible_foreground_color is also set, this field takes precedence."
+ }
+ },
+ "id": "FilterCriteria"
+ },
+ "Editors": {
+ "properties": {
+ "users": {
+ "description": "The email addresses of users with edit access to the protected range.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "groups": {
+ "description": "The email addresses of groups with edit access to the protected range.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "domainUsersCanEdit": {
+ "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
+ "type": "boolean"
+ }
+ },
+ "id": "Editors",
+ "description": "The editors of a protected range.",
+ "type": "object"
+ },
+ "DataValidationRule": {
+ "description": "A data validation rule.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition that data in the cell must match."
+ },
+ "showCustomUi": {
+ "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
+ "type": "boolean"
+ },
+ "strict": {
+ "description": "True if invalid data should be rejected.",
+ "type": "boolean"
+ },
+ "inputMessage": {
+ "description": "A message to show the user when adding data to the cell.",
+ "type": "string"
+ }
+ },
+ "id": "DataValidationRule"
+ },
+ "TextRotation": {
+ "description": "The rotation applied to text in a cell.",
+ "type": "object",
+ "properties": {
+ "angle": {
+ "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the\ncounterclockwise direction, whereas for RTL they are in the clockwise\ndirection",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vertical": {
+ "type": "boolean",
+ "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |"
+ }
+ },
+ "id": "TextRotation"
+ },
+ "DeleteDimensionGroupResponse": {
+ "description": "The result of deleting a group.",
+ "type": "object",
+ "properties": {
+ "dimensionGroups": {
+ "description": "All groups of a dimension after deleting a group from that dimension.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionGroup"
+ }
+ }
+ },
+ "id": "DeleteDimensionGroupResponse"
+ },
+ "UpdateDeveloperMetadataRequest": {
+ "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask"
+ },
+ "developerMetadata": {
+ "description": "The value that all metadata matched by the data filters will be updated to.",
+ "$ref": "DeveloperMetadata"
+ },
+ "dataFilters": {
+ "description": "The filters matching the developer metadata entries to update.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "UpdateDeveloperMetadataRequest"
+ },
+ "PieChartSpec": {
+ "properties": {
+ "series": {
+ "description": "The data that covers the one and only series of the pie chart.",
+ "$ref": "ChartData"
+ },
+ "legendPosition": {
+ "description": "Where the legend of the pie chart should be drawn.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "Each pie slice has a label attached to it."
+ ],
+ "enum": [
+ "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "LABELED_LEGEND"
+ ]
+ },
+ "pieHole": {
+ "description": "The size of the hole in the pie chart.",
+ "format": "double",
+ "type": "number"
+ },
+ "domain": {
+ "description": "The data that covers the domain of the pie chart.",
+ "$ref": "ChartData"
+ },
+ "threeDimensional": {
+ "description": "True if the pie is three dimensional.",
+ "type": "boolean"
+ }
+ },
+ "id": "PieChartSpec",
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
+ "type": "object"
+ },
+ "UpdateFilterViewRequest": {
+ "description": "Updates properties of the filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The new properties of the filter view.",
+ "$ref": "FilterView"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateFilterViewRequest"
+ },
+ "UpdateSlicerSpecRequest": {
+ "description": "Updates a slicer's specifications.\n(This does not move or resize a slicer. To move or resize a slicer use\nUpdateEmbeddedObjectPositionRequest.",
+ "type": "object",
+ "properties": {
+ "spec": {
+ "$ref": "SlicerSpec",
+ "description": "The specification to apply to the slicer."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `SlicerSpec` is implied and should not be specified. A single \"*\"`\ncan be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "slicerId": {
+ "description": "The id of the slicer to update.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateSlicerSpecRequest"
+ },
+ "ConditionalFormatRule": {
+ "properties": {
+ "ranges": {
+ "description": "The ranges that are formatted if the condition is true.\nAll the ranges must be on the same grid.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "gradientRule": {
+ "$ref": "GradientRule",
+ "description": "The formatting will vary based on the gradients in the rule."
+ },
+ "booleanRule": {
+ "description": "The formatting is either \"on\" or \"off\" according to the rule.",
+ "$ref": "BooleanRule"
+ }
+ },
+ "id": "ConditionalFormatRule",
+ "description": "A rule describing a conditional format.",
+ "type": "object"
+ },
+ "CopyPasteRequest": {
+ "type": "object",
+ "properties": {
+ "pasteOrientation": {
+ "enumDescriptions": [
+ "Paste normally.",
+ "Paste transposed, where all rows become columns and vice versa."
+ ],
+ "enum": [
+ "NORMAL",
+ "TRANSPOSE"
+ ],
+ "description": "How that data should be oriented when pasting.",
+ "type": "string"
+ },
+ "source": {
+ "description": "The source range to copy.",
+ "$ref": "GridRange"
+ },
+ "pasteType": {
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "description": "What kind of data to paste.",
+ "type": "string"
+ },
+ "destination": {
+ "$ref": "GridRange",
+ "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
+ }
+ },
+ "id": "CopyPasteRequest",
+ "description": "Copies data from the source to the destination."
+ },
+ "BooleanCondition": {
+ "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of condition.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
+ "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
+ "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
+ "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
+ "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
+ "The cell's value must be in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
+ "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
+ "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
+ "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be TRUE/FALSE or in the list of condition values.\nSupported by data validation.\nRenders as a cell checkbox.\nSupports zero, one or two ConditionValues. No\nvalues indicates the cell must be TRUE or FALSE, where TRUE renders as\nchecked and FALSE renders as unchecked. One value indicates the cell\nwill render as checked when it contains that value and unchecked when it\nis blank. Two values indicate that the cell will render as checked when\nit contains the first value and unchecked when it contains the second\nvalue. For example, [\"Yes\",\"No\"] indicates that the cell will render a\nchecked box when it has the value \"Yes\" and an unchecked box when it has\nthe value \"No\"."
+ ],
+ "enum": [
+ "CONDITION_TYPE_UNSPECIFIED",
+ "NUMBER_GREATER",
+ "NUMBER_GREATER_THAN_EQ",
+ "NUMBER_LESS",
+ "NUMBER_LESS_THAN_EQ",
+ "NUMBER_EQ",
+ "NUMBER_NOT_EQ",
+ "NUMBER_BETWEEN",
+ "NUMBER_NOT_BETWEEN",
+ "TEXT_CONTAINS",
+ "TEXT_NOT_CONTAINS",
+ "TEXT_STARTS_WITH",
+ "TEXT_ENDS_WITH",
+ "TEXT_EQ",
+ "TEXT_IS_EMAIL",
+ "TEXT_IS_URL",
+ "DATE_EQ",
+ "DATE_BEFORE",
+ "DATE_AFTER",
+ "DATE_ON_OR_BEFORE",
+ "DATE_ON_OR_AFTER",
+ "DATE_BETWEEN",
+ "DATE_NOT_BETWEEN",
+ "DATE_IS_VALID",
+ "ONE_OF_RANGE",
+ "ONE_OF_LIST",
+ "BLANK",
+ "NOT_BLANK",
+ "CUSTOM_FORMULA",
+ "BOOLEAN"
+ ]
+ },
+ "values": {
+ "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionValue"
+ }
+ }
+ },
+ "id": "BooleanCondition"
+ },
+ "BasicChartSpec": {
+ "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
+ "type": "object",
+ "properties": {
+ "threeDimensional": {
+ "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
+ "type": "boolean"
+ },
+ "axis": {
+ "description": "The axis on the chart.",
+ "type": "array",
+ "items": {
+ "$ref": "BasicChartAxis"
+ }
+ },
+ "chartType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
+ "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter\nchart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area\nchart\u003c/a\u003e."
+ ],
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ],
+ "description": "The type of the chart."
+ },
+ "interpolateNulls": {
+ "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The data this chart is visualizing.",
+ "type": "array",
+ "items": {
+ "$ref": "BasicChartSeries"
+ }
+ },
+ "legendPosition": {
+ "enum": [
+ "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND"
+ ],
+ "description": "The position of the chart legend.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered."
+ ]
+ },
+ "compareMode": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Only the focused data element is highlighted and shown in the tooltip.",
+ "All data elements with the same category (e.g., domain value) are\nhighlighted and shown in the tooltip."
+ ],
+ "enum": [
+ "BASIC_CHART_COMPARE_MODE_UNSPECIFIED",
+ "DATUM",
+ "CATEGORY"
+ ],
+ "description": "The behavior of tooltips and data highlighting when hovering on data and\nchart area.",
+ "type": "string"
+ },
+ "domains": {
+ "description": "The domain of data this is charting.\nOnly a single domain is supported.",
+ "type": "array",
+ "items": {
+ "$ref": "BasicChartDomain"
}
+ },
+ "lineSmoothing": {
+ "description": "Gets whether all lines should be rendered smooth or straight by default.\nApplies to Line charts.",
+ "type": "boolean"
+ },
+ "headerCount": {
+ "description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)",
+ "format": "int32",
+ "type": "integer"
+ },
+ "stackedType": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Series are not stacked.",
+ "Series values are stacked, each value is rendered vertically beginning\nfrom the top of the value below it.",
+ "Vertical stacks are stretched to reach the top of the chart, with\nvalues laid out as percentages of each other."
+ ],
+ "enum": [
+ "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
+ "NOT_STACKED",
+ "STACKED",
+ "PERCENT_STACKED"
+ ],
+ "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, Combo, and Stepped Area charts.",
+ "type": "string"
}
},
- "methods": {
- "create": {
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "request": {
- "$ref": "Spreadsheet"
- },
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
+ "id": "BasicChartSpec"
+ },
+ "AddDimensionGroupRequest": {
+ "id": "AddDimensionGroupRequest",
+ "description": "Creates a group over the specified range.\n\nIf the requested range is a superset of the range of an existing group G,\nthen the depth of G is incremented and this new group G' has the\ndepth of that group. For example, a group [C:D, depth 1] + [B:E] results in\ngroups [B:E, depth 1] and [C:D, depth 2].\nIf the requested range is a subset of the range of an existing group G,\nthen the depth of the new group G' becomes one greater than the depth of G.\nFor example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1]\nand [C:D, depth 2].\nIf the requested range starts before and ends within, or starts within and\nends after, the range of an existing group G, then the range of the existing\ngroup G becomes the union of the ranges, and the new group G' has\ndepth one greater than the depth of G and range as the intersection of the\nranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E,\ndepth 1] and [C:D, depth 2].",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The range over which to create a group."
+ }
+ }
+ },
+ "CellData": {
+ "description": "Data about a specific cell.",
+ "type": "object",
+ "properties": {
+ "pivotTable": {
+ "$ref": "PivotTable",
+ "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
+ },
+ "userEnteredFormat": {
+ "$ref": "CellFormat",
+ "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
+ },
+ "note": {
+ "type": "string",
+ "description": "Any note on the cell."
+ },
+ "effectiveFormat": {
+ "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only.",
+ "$ref": "CellFormat"
+ },
+ "dataValidation": {
+ "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule.",
+ "$ref": "DataValidationRule"
+ },
+ "userEnteredValue": {
+ "$ref": "ExtendedValue",
+ "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
+ },
+ "effectiveValue": {
+ "$ref": "ExtendedValue",
+ "description": "The effective value of the cell. For cells with formulas, this is\nthe calculated value. For cells with literals, this is\nthe same as the user_entered_value.\nThis field is read-only."
+ },
+ "formattedValue": {
+ "type": "string",
+ "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only."
+ },
+ "textFormatRuns": {
+ "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs are erased.",
+ "type": "array",
+ "items": {
+ "$ref": "TextFormatRun"
+ }
+ },
+ "hyperlink": {
+ "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
+ "type": "string"
+ }
+ },
+ "id": "CellData"
+ },
+ "BatchUpdateValuesByDataFilterRequest": {
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "responseValueRenderOption": {
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
],
- "flatPath": "v4/spreadsheets",
- "path": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create"
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ]
},
- "batchUpdate": {
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate",
- "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.",
- "request": {
- "$ref": "BatchUpdateSpreadsheetRequest"
- },
- "response": {
- "$ref": "BatchUpdateSpreadsheetResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet to apply the updates to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate"
+ "includeValuesInResponse": {
+ "type": "boolean",
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses contains the updated\nvalues. If the range to write was larger than the range actually written,\nthe response includes all values in the requested range (excluding trailing\nempty rows and columns)."
},
- "get": {
- "path": "v4/spreadsheets/{spreadsheetId}",
- "id": "sheets.spreadsheets.get",
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "ranges": {
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "includeGridData": {
- "location": "query",
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- },
- "spreadsheetId": {
- "description": "The spreadsheet to request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
+ "valueInputOption": {
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
],
- "flatPath": "v4/spreadsheets/{spreadsheetId}"
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ]
},
- "getByDataFilter": {
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [
- "spreadsheetId"
+ "data": {
+ "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values are applied to\nall of those ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilterValueRange"
+ }
+ },
+ "responseDateTimeRenderOption": {
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
+ "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
],
- "parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet to request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
- "id": "sheets.spreadsheets.getByDataFilter",
- "request": {
- "$ref": "GetSpreadsheetByDataFilterRequest"
- },
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want."
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "type": "string"
}
- }
+ },
+ "id": "BatchUpdateValuesByDataFilterRequest"
+ },
+ "UpdateDimensionGroupRequest": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `dimensionGroup` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "dimensionGroup": {
+ "description": "The group whose state should be updated. The range and depth of the group\nshould specify a valid group on the sheet, and all other fields updated.",
+ "$ref": "DimensionGroup"
+ }
+ },
+ "id": "UpdateDimensionGroupRequest",
+ "description": "Updates the state of the specified group."
}
},
- "parameters": {
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "canonicalName": "Sheets",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/drive.file": {
+ "description": "View and manage Google Drive files and folders that you have opened or created with this app"
+ },
+ "https://www.googleapis.com/auth/drive": {
+ "description": "See, edit, create, and delete all of your Google Drive files"
+ },
+ "https://www.googleapis.com/auth/drive.readonly": {
+ "description": "See and download all your Google Drive files"
+ },
+ "https://www.googleapis.com/auth/spreadsheets.readonly": {
+ "description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "See, edit, create, and delete your spreadsheets in Google Drive"
+ }
+ }
}
},
- "version": "v4",
- "baseUrl": "https://sheets.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Reads and writes Google Sheets.",
- "basePath": "",
- "id": "sheets:v4",
- "documentationLink": "https://developers.google.com/sheets/",
- "revision": "20190929"
+ "rootUrl": "https://sheets.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "sheets"
}
diff --git a/inst/WORDLIST b/inst/WORDLIST
index d7f9eb54d..00fd7ea01 100644
--- a/inst/WORDLIST
+++ b/inst/WORDLIST
@@ -36,6 +36,7 @@ shortcodes
Shortcodes
targetted
tibble
+tibble's
tidyverse
tsv
unskipped
diff --git a/man/read_sheet.Rd b/man/read_sheet.Rd
index 12febbb89..099d57083 100644
--- a/man/read_sheet.Rd
+++ b/man/read_sheet.Rd
@@ -107,7 +107,7 @@ any wheels.
Shortcodes for column types:
\itemize{
-\item \verb{_} or \verb{-}: Skip. Data in a skipped column is still requested from the
+\item \verb{_} or \code{-}: Skip. Data in a skipped column is still requested from the
API (the high-level functions in this package are rectangle-oriented), but
is not parsed into the data frame output.
\item \verb{?}: Guess. A type is guessed for each cell and then a consensus type is
@@ -133,7 +133,7 @@ useful internally, but exposed for those who want direct access to, e.g.,
formulas and formats.
\item \code{L}: List, as in "list-column". Each cell is a length-1 atomic vector of
its discovered type.
-\item \emph{Still to come}: duration (code will be \verb{:}) and factor (code will be
+\item \emph{Still to come}: duration (code will be \code{:}) and factor (code will be
\code{f}).
}
}
diff --git a/man/request_generate.Rd b/man/request_generate.Rd
index 63ed9bade..16825f5be 100644
--- a/man/request_generate.Rd
+++ b/man/request_generate.Rd
@@ -62,8 +62,9 @@ req
\code{\link[gargle:request_develop]{gargle::request_develop()}}, \code{\link[gargle:request_build]{gargle::request_build()}},
\code{\link[gargle:request_make]{gargle::request_make()}}
-Other low-level API functions: \code{\link{request_make}()},
- \code{\link{sheets_has_token}()},
- \code{\link{sheets_token}()}
+Other low-level API functions:
+\code{\link{request_make}()},
+\code{\link{sheets_has_token}()},
+\code{\link{sheets_token}()}
}
\concept{low-level API functions}
diff --git a/man/request_make.Rd b/man/request_make.Rd
index 82924f043..45d7488cc 100644
--- a/man/request_make.Rd
+++ b/man/request_make.Rd
@@ -28,8 +28,9 @@ been created with \code{\link[=request_generate]{request_generate()}} or \code{\
output is processed with \code{process_response()}.
}
\seealso{
-Other low-level API functions: \code{\link{request_generate}()},
- \code{\link{sheets_has_token}()},
- \code{\link{sheets_token}()}
+Other low-level API functions:
+\code{\link{request_generate}()},
+\code{\link{sheets_has_token}()},
+\code{\link{sheets_token}()}
}
\concept{low-level API functions}
diff --git a/man/sheets_auth.Rd b/man/sheets_auth.Rd
index 820c4841c..b88d2901c 100644
--- a/man/sheets_auth.Rd
+++ b/man/sheets_auth.Rd
@@ -110,7 +110,8 @@ if (interactive()) {
}
}
\seealso{
-Other auth functions: \code{\link{sheets_auth_configure}()},
- \code{\link{sheets_deauth}()}
+Other auth functions:
+\code{\link{sheets_auth_configure}()},
+\code{\link{sheets_deauth}()}
}
\concept{auth functions}
diff --git a/man/sheets_auth_configure.Rd b/man/sheets_auth_configure.Rd
index 00f19a1fd..98a49dd2b 100644
--- a/man/sheets_auth_configure.Rd
+++ b/man/sheets_auth_configure.Rd
@@ -84,7 +84,8 @@ if (require(httr)) {
sheets_auth_configure(app = original_app, api_key = original_api_key)
}
\seealso{
-Other auth functions: \code{\link{sheets_auth}()},
- \code{\link{sheets_deauth}()}
+Other auth functions:
+\code{\link{sheets_auth}()},
+\code{\link{sheets_deauth}()}
}
\concept{auth functions}
diff --git a/man/sheets_deauth.Rd b/man/sheets_deauth.Rd
index 62739dcb9..5227f9fae 100644
--- a/man/sheets_deauth.Rd
+++ b/man/sheets_deauth.Rd
@@ -27,7 +27,8 @@ if (interactive()) {
}
}
\seealso{
-Other auth functions: \code{\link{sheets_auth_configure}()},
- \code{\link{sheets_auth}()}
+Other auth functions:
+\code{\link{sheets_auth_configure}()},
+\code{\link{sheets_auth}()}
}
\concept{auth functions}
diff --git a/man/sheets_has_token.Rd b/man/sheets_has_token.Rd
index eeb5faec8..1b99c66f7 100644
--- a/man/sheets_has_token.Rd
+++ b/man/sheets_has_token.Rd
@@ -17,8 +17,9 @@ requests.
sheets_has_token()
}
\seealso{
-Other low-level API functions: \code{\link{request_generate}()},
- \code{\link{request_make}()},
- \code{\link{sheets_token}()}
+Other low-level API functions:
+\code{\link{request_generate}()},
+\code{\link{request_make}()},
+\code{\link{sheets_token}()}
}
\concept{low-level API functions}
diff --git a/man/sheets_token.Rd b/man/sheets_token.Rd
index df2454dbd..a4e5f54d7 100644
--- a/man/sheets_token.Rd
+++ b/man/sheets_token.Rd
@@ -30,8 +30,9 @@ if (sheets_has_token()) {
}
}
\seealso{
-Other low-level API functions: \code{\link{request_generate}()},
- \code{\link{request_make}()},
- \code{\link{sheets_has_token}()}
+Other low-level API functions:
+\code{\link{request_generate}()},
+\code{\link{request_make}()},
+\code{\link{sheets_has_token}()}
}
\concept{low-level API functions}
diff --git a/tests/testthat/helper.R b/tests/testthat/helper.R
index 88eab4d8b..d9679b786 100644
--- a/tests/testthat/helper.R
+++ b/tests/testthat/helper.R
@@ -16,7 +16,7 @@ expect_error_free <- function(...) {
}
.test_sheets <- c(
- "googlesheets4-cell-tests" = "1vDfXo-16OhUilaG_EwvDd1Dm4_NI0UKORwSLLpycSS0"
+ "googlesheets4-cell-tests" = "1WRFIb11PJsNwx2tYBRn3uq8uHwWSI5ziSgbGjkOukmE"
)
test_sheet <- function(name = "googlesheets4-cell-tests") {
diff --git a/tests/testthat/ref/googlesheets4-cell-tests.rds b/tests/testthat/ref/googlesheets4-cell-tests.rds
index 330ce444d..3dda640d5 100644
Binary files a/tests/testthat/ref/googlesheets4-cell-tests.rds and b/tests/testthat/ref/googlesheets4-cell-tests.rds differ
diff --git a/tests/testthat/test-utils-sheet-geometry.R b/tests/testthat/test-utils-sheet-geometry.R
index 6dffbc201..541cb3218 100644
--- a/tests/testthat/test-utils-sheet-geometry.R
+++ b/tests/testthat/test-utils-sheet-geometry.R
@@ -14,6 +14,14 @@ cell_df <- tibble::tribble(
3, 2, "B3",
3, 3, "C3"
)
+# row and col should really be integer
+cell_df$row <- as.integer(cell_df$row)
+cell_df$col <- as.integer(cell_df$col)
+# cell has to be a list-column for the tibble::add_row() in insert_shims()
+# to work, with increased type-strictness coming to tibble v3.0
+# TODO: maybe use an even more realistic cell-type of object here, when the
+# helpers are better
+cell_df$cell <- as.list(cell_df$cell)
limitize <- function(df) {
cell_limits(c(min(df$row), min(df$col)), c(max(df$row), max(df$col)))