OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/drive": { |
| 6 "description": "View and manage the files in your Google Dri
ve" |
| 7 }, |
5 "https://www.googleapis.com/auth/drive.readonly": { | 8 "https://www.googleapis.com/auth/drive.readonly": { |
6 "description": "View the files in your Google Drive" | 9 "description": "View the files in your Google Drive" |
7 }, | 10 }, |
8 "https://www.googleapis.com/auth/spreadsheets.readonly": { | 11 "https://www.googleapis.com/auth/spreadsheets.readonly": { |
9 "description": "View your Google Spreadsheets" | 12 "description": "View your Google Spreadsheets" |
10 }, | 13 }, |
11 "https://www.googleapis.com/auth/drive": { | |
12 "description": "View and manage the files in your Google Dri
ve" | |
13 }, | |
14 "https://www.googleapis.com/auth/spreadsheets": { | 14 "https://www.googleapis.com/auth/spreadsheets": { |
15 "description": "View and manage your spreadsheets in Google
Drive" | 15 "description": "View and manage your spreadsheets in Google
Drive" |
16 } | 16 } |
17 } | 17 } |
18 } | 18 } |
19 }, | 19 }, |
20 "basePath": "", | 20 "basePath": "", |
21 "baseUrl": "https://sheets.googleapis.com/", | 21 "baseUrl": "https://sheets.googleapis.com/", |
22 "batchPath": "batch", | 22 "batchPath": "batch", |
23 "canonicalName": "Sheets", | 23 "canonicalName": "Sheets", |
24 "description": "Reads and writes Google Sheets.", | 24 "description": "Reads and writes Google Sheets.", |
25 "discoveryVersion": "v1", | 25 "discoveryVersion": "v1", |
26 "documentationLink": "https://developers.google.com/sheets/", | 26 "documentationLink": "https://developers.google.com/sheets/", |
27 "icons": { | 27 "icons": { |
28 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 28 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
29 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 29 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
30 }, | 30 }, |
31 "id": "sheets:v4", | 31 "id": "sheets:v4", |
32 "kind": "discovery#restDescription", | 32 "kind": "discovery#restDescription", |
33 "name": "sheets", | 33 "name": "sheets", |
34 "ownerDomain": "google.com", | 34 "ownerDomain": "google.com", |
35 "ownerName": "Google", | 35 "ownerName": "Google", |
36 "parameters": { | 36 "parameters": { |
37 "access_token": { | 37 "alt": { |
38 "description": "OAuth access token.", | 38 "default": "json", |
| 39 "description": "Data format for response.", |
| 40 "enum": [ |
| 41 "json", |
| 42 "media", |
| 43 "proto" |
| 44 ], |
| 45 "enumDescriptions": [ |
| 46 "Responses with Content-Type of application/json", |
| 47 "Media download with context-dependent Content-Type", |
| 48 "Responses with Content-Type of application/x-protobuf" |
| 49 ], |
39 "location": "query", | 50 "location": "query", |
40 "type": "string" | 51 "type": "string" |
41 }, | 52 }, |
42 "prettyPrint": { | |
43 "default": "true", | |
44 "description": "Returns response with indentations and line breaks."
, | |
45 "location": "query", | |
46 "type": "boolean" | |
47 }, | |
48 "key": { | 53 "key": { |
49 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 54 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
50 "location": "query", | 55 "location": "query", |
51 "type": "string" | 56 "type": "string" |
52 }, | 57 }, |
| 58 "access_token": { |
| 59 "description": "OAuth access token.", |
| 60 "location": "query", |
| 61 "type": "string" |
| 62 }, |
53 "quotaUser": { | 63 "quotaUser": { |
54 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 64 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
55 "location": "query", | 65 "location": "query", |
56 "type": "string" | 66 "type": "string" |
57 }, | 67 }, |
58 "pp": { | 68 "pp": { |
59 "default": "true", | 69 "default": "true", |
60 "description": "Pretty-print response.", | 70 "description": "Pretty-print response.", |
61 "location": "query", | 71 "location": "query", |
62 "type": "boolean" | 72 "type": "boolean" |
63 }, | 73 }, |
| 74 "oauth_token": { |
| 75 "description": "OAuth 2.0 token for the current user.", |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
| 79 "bearer_token": { |
| 80 "description": "OAuth bearer token.", |
| 81 "location": "query", |
| 82 "type": "string" |
| 83 }, |
| 84 "upload_protocol": { |
| 85 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 86 "location": "query", |
| 87 "type": "string" |
| 88 }, |
| 89 "prettyPrint": { |
| 90 "default": "true", |
| 91 "description": "Returns response with indentations and line breaks."
, |
| 92 "location": "query", |
| 93 "type": "boolean" |
| 94 }, |
64 "fields": { | 95 "fields": { |
65 "description": "Selector specifying which fields to include in a par
tial response.", | 96 "description": "Selector specifying which fields to include in a par
tial response.", |
66 "location": "query", | 97 "location": "query", |
67 "type": "string" | 98 "type": "string" |
68 }, | 99 }, |
69 "alt": { | 100 "uploadType": { |
70 "default": "json", | 101 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
71 "description": "Data format for response.", | |
72 "enum": [ | |
73 "json", | |
74 "media", | |
75 "proto" | |
76 ], | |
77 "enumDescriptions": [ | |
78 "Responses with Content-Type of application/json", | |
79 "Media download with context-dependent Content-Type", | |
80 "Responses with Content-Type of application/x-protobuf" | |
81 ], | |
82 "location": "query", | 102 "location": "query", |
83 "type": "string" | 103 "type": "string" |
84 }, | 104 }, |
85 "$.xgafv": { | 105 "$.xgafv": { |
86 "description": "V1 error format.", | 106 "description": "V1 error format.", |
87 "enum": [ | 107 "enum": [ |
88 "1", | 108 "1", |
89 "2" | 109 "2" |
90 ], | 110 ], |
91 "enumDescriptions": [ | 111 "enumDescriptions": [ |
92 "v1 error format", | 112 "v1 error format", |
93 "v2 error format" | 113 "v2 error format" |
94 ], | 114 ], |
95 "location": "query", | 115 "location": "query", |
96 "type": "string" | 116 "type": "string" |
97 }, | 117 }, |
98 "callback": { | 118 "callback": { |
99 "description": "JSONP", | 119 "description": "JSONP", |
100 "location": "query", | 120 "location": "query", |
101 "type": "string" | 121 "type": "string" |
102 }, | |
103 "oauth_token": { | |
104 "description": "OAuth 2.0 token for the current user.", | |
105 "location": "query", | |
106 "type": "string" | |
107 }, | |
108 "uploadType": { | |
109 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
110 "location": "query", | |
111 "type": "string" | |
112 }, | |
113 "bearer_token": { | |
114 "description": "OAuth bearer token.", | |
115 "location": "query", | |
116 "type": "string" | |
117 }, | |
118 "upload_protocol": { | |
119 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
120 "location": "query", | |
121 "type": "string" | |
122 } | 122 } |
123 }, | 123 }, |
124 "protocol": "rest", | 124 "protocol": "rest", |
125 "resources": { | 125 "resources": { |
126 "spreadsheets": { | 126 "spreadsheets": { |
127 "methods": { | 127 "methods": { |
128 "create": { | |
129 "description": "Creates a spreadsheet, returning the newly c
reated spreadsheet.", | |
130 "httpMethod": "POST", | |
131 "id": "sheets.spreadsheets.create", | |
132 "parameterOrder": [], | |
133 "parameters": {}, | |
134 "path": "v4/spreadsheets", | |
135 "request": { | |
136 "$ref": "Spreadsheet" | |
137 }, | |
138 "response": { | |
139 "$ref": "Spreadsheet" | |
140 }, | |
141 "scopes": [ | |
142 "https://www.googleapis.com/auth/drive", | |
143 "https://www.googleapis.com/auth/spreadsheets" | |
144 ] | |
145 }, | |
146 "get": { | 128 "get": { |
147 "description": "Returns the spreadsheet at the given ID.\nTh
e 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 fiel
d 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 recommen
ded to retrieve only the specific\nfields of the spreadsheet that you want.\n\nT
o retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMult
iple ranges can be specified. Limiting the range will\nreturn only the portions
of the spreadsheet that intersect the requested\nranges. Ranges are specified u
sing A1 notation.", | 129 "description": "Returns the spreadsheet at the given ID.\nTh
e 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 fiel
d 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 recommen
ded to retrieve only the specific\nfields of the spreadsheet that you want.\n\nT
o retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMult
iple ranges can be specified. Limiting the range will\nreturn only the portions
of the spreadsheet that intersect the requested\nranges. Ranges are specified u
sing A1 notation.", |
148 "httpMethod": "GET", | 130 "httpMethod": "GET", |
149 "id": "sheets.spreadsheets.get", | 131 "id": "sheets.spreadsheets.get", |
150 "parameterOrder": [ | 132 "parameterOrder": [ |
151 "spreadsheetId" | 133 "spreadsheetId" |
152 ], | 134 ], |
153 "parameters": { | 135 "parameters": { |
154 "spreadsheetId": { | |
155 "description": "The spreadsheet to request.", | |
156 "location": "path", | |
157 "required": true, | |
158 "type": "string" | |
159 }, | |
160 "ranges": { | 136 "ranges": { |
161 "description": "The ranges to retrieve from the spre
adsheet.", | 137 "description": "The ranges to retrieve from the spre
adsheet.", |
162 "location": "query", | 138 "location": "query", |
163 "repeated": true, | 139 "repeated": true, |
164 "type": "string" | 140 "type": "string" |
165 }, | 141 }, |
166 "includeGridData": { | 142 "includeGridData": { |
167 "description": "True if grid data should be returned
.\nThis parameter is ignored if a field mask was set in the request.", | 143 "description": "True if grid data should be returned
.\nThis parameter is ignored if a field mask was set in the request.", |
168 "location": "query", | 144 "location": "query", |
169 "type": "boolean" | 145 "type": "boolean" |
| 146 }, |
| 147 "spreadsheetId": { |
| 148 "description": "The spreadsheet to request.", |
| 149 "location": "path", |
| 150 "required": true, |
| 151 "type": "string" |
170 } | 152 } |
171 }, | 153 }, |
172 "path": "v4/spreadsheets/{spreadsheetId}", | 154 "path": "v4/spreadsheets/{spreadsheetId}", |
173 "response": { | 155 "response": { |
174 "$ref": "Spreadsheet" | 156 "$ref": "Spreadsheet" |
175 }, | 157 }, |
176 "scopes": [ | 158 "scopes": [ |
177 "https://www.googleapis.com/auth/drive", | 159 "https://www.googleapis.com/auth/drive", |
178 "https://www.googleapis.com/auth/drive.readonly", | 160 "https://www.googleapis.com/auth/drive.readonly", |
179 "https://www.googleapis.com/auth/spreadsheets", | 161 "https://www.googleapis.com/auth/spreadsheets", |
180 "https://www.googleapis.com/auth/spreadsheets.readonly" | 162 "https://www.googleapis.com/auth/spreadsheets.readonly" |
181 ] | 163 ] |
182 }, | 164 }, |
| 165 "create": { |
| 166 "description": "Creates a spreadsheet, returning the newly c
reated spreadsheet.", |
| 167 "httpMethod": "POST", |
| 168 "id": "sheets.spreadsheets.create", |
| 169 "parameterOrder": [], |
| 170 "parameters": {}, |
| 171 "path": "v4/spreadsheets", |
| 172 "request": { |
| 173 "$ref": "Spreadsheet" |
| 174 }, |
| 175 "response": { |
| 176 "$ref": "Spreadsheet" |
| 177 }, |
| 178 "scopes": [ |
| 179 "https://www.googleapis.com/auth/drive", |
| 180 "https://www.googleapis.com/auth/spreadsheets" |
| 181 ] |
| 182 }, |
183 "batchUpdate": { | 183 "batchUpdate": { |
184 "description": "Applies one or more updates to the spreadshe
et.\n\nEach request is validated before\nbeing applied. If any request is not va
lid then the entire request will\nfail and nothing will be applied.\n\nSome requ
ests 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 t
he 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 nat
ure of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exa
ctly your changes after this completes,\nhowever it is guaranteed that the updat
es in the request will be\napplied together atomically. Your changes may be alte
red with respect to\ncollaborator changes. If there are no collaborators, the sp
readsheet\nshould reflect your changes.", | 184 "description": "Applies one or more updates to the spreadshe
et.\n\nEach request is validated before\nbeing applied. If any request is not va
lid then the entire request will\nfail and nothing will be applied.\n\nSome requ
ests 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 t
he 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 nat
ure of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exa
ctly your changes after this completes,\nhowever it is guaranteed that the updat
es in the request will be\napplied together atomically. Your changes may be alte
red with respect to\ncollaborator changes. If there are no collaborators, the sp
readsheet\nshould reflect your changes.", |
185 "httpMethod": "POST", | 185 "httpMethod": "POST", |
186 "id": "sheets.spreadsheets.batchUpdate", | 186 "id": "sheets.spreadsheets.batchUpdate", |
187 "parameterOrder": [ | 187 "parameterOrder": [ |
188 "spreadsheetId" | 188 "spreadsheetId" |
189 ], | 189 ], |
190 "parameters": { | 190 "parameters": { |
191 "spreadsheetId": { | 191 "spreadsheetId": { |
192 "description": "The spreadsheet to apply the updates
to.", | 192 "description": "The spreadsheet to apply the updates
to.", |
(...skipping 11 matching lines...) Expand all Loading... |
204 }, | 204 }, |
205 "scopes": [ | 205 "scopes": [ |
206 "https://www.googleapis.com/auth/drive", | 206 "https://www.googleapis.com/auth/drive", |
207 "https://www.googleapis.com/auth/spreadsheets" | 207 "https://www.googleapis.com/auth/spreadsheets" |
208 ] | 208 ] |
209 } | 209 } |
210 }, | 210 }, |
211 "resources": { | 211 "resources": { |
212 "values": { | 212 "values": { |
213 "methods": { | 213 "methods": { |
214 "clear": { | 214 "append": { |
215 "description": "Clears values from a spreadsheet.\nT
he 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.", | 215 "description": "Appends values to a spreadsheet. The
input range is used to search for\nexisting data and find a \"table\" within th
at range. Values will be\nappended to the next row of the table, starting with t
he first column of\nthe table. See the\n[guide](/sheets/guides/values#appending_
values)\nand\n[sample code](/sheets/samples/writing#append_values)\nfor specific
details of how tables are detected and data is appended.\n\nThe caller must spe
cify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption`
only\ncontrols how the input data will be added to the sheet (column-wise or\nr
ow-wise), it does not influence what cell the data starts being written\nto.", |
216 "httpMethod": "POST", | 216 "httpMethod": "POST", |
217 "id": "sheets.spreadsheets.values.clear", | 217 "id": "sheets.spreadsheets.values.append", |
218 "parameterOrder": [ | 218 "parameterOrder": [ |
219 "spreadsheetId", | 219 "spreadsheetId", |
220 "range" | 220 "range" |
221 ], | 221 ], |
222 "parameters": { | 222 "parameters": { |
| 223 "range": { |
| 224 "description": "The A1 notation of a range t
o search for a logical table of data.\nValues will be appended after the last ro
w of the table.", |
| 225 "location": "path", |
| 226 "required": true, |
| 227 "type": "string" |
| 228 }, |
| 229 "includeValuesInResponse": { |
| 230 "description": "Determines if the update res
ponse should include the values\nof the cells that were appended. By default, re
sponses\ndo not include the updated values.", |
| 231 "location": "query", |
| 232 "type": "boolean" |
| 233 }, |
223 "spreadsheetId": { | 234 "spreadsheetId": { |
224 "description": "The ID of the spreadsheet to
update.", | 235 "description": "The ID of the spreadsheet to
update.", |
225 "location": "path", | 236 "location": "path", |
226 "required": true, | 237 "required": true, |
227 "type": "string" | 238 "type": "string" |
228 }, | 239 }, |
229 "range": { | 240 "responseValueRenderOption": { |
230 "description": "The A1 notation of the value
s to clear.", | 241 "description": "Determines how values in the
response should be rendered.\nThe default render option is ValueRenderOption.FO
RMATTED_VALUE.", |
231 "location": "path", | |
232 "required": true, | |
233 "type": "string" | |
234 } | |
235 }, | |
236 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:clear", | |
237 "request": { | |
238 "$ref": "ClearValuesRequest" | |
239 }, | |
240 "response": { | |
241 "$ref": "ClearValuesResponse" | |
242 }, | |
243 "scopes": [ | |
244 "https://www.googleapis.com/auth/drive", | |
245 "https://www.googleapis.com/auth/spreadsheets" | |
246 ] | |
247 }, | |
248 "batchGet": { | |
249 "description": "Returns one or more ranges of values
from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more
ranges.", | |
250 "httpMethod": "GET", | |
251 "id": "sheets.spreadsheets.values.batchGet", | |
252 "parameterOrder": [ | |
253 "spreadsheetId" | |
254 ], | |
255 "parameters": { | |
256 "spreadsheetId": { | |
257 "description": "The ID of the spreadsheet to
retrieve data from.", | |
258 "location": "path", | |
259 "required": true, | |
260 "type": "string" | |
261 }, | |
262 "ranges": { | |
263 "description": "The A1 notation of the value
s to retrieve.", | |
264 "location": "query", | |
265 "repeated": true, | |
266 "type": "string" | |
267 }, | |
268 "valueRenderOption": { | |
269 "description": "How values should be represe
nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA
LUE.", | |
270 "enum": [ | 242 "enum": [ |
271 "FORMATTED_VALUE", | 243 "FORMATTED_VALUE", |
272 "UNFORMATTED_VALUE", | 244 "UNFORMATTED_VALUE", |
273 "FORMULA" | 245 "FORMULA" |
274 ], | 246 ], |
275 "location": "query", | 247 "location": "query", |
276 "type": "string" | 248 "type": "string" |
277 }, | 249 }, |
278 "dateTimeRenderOption": { | 250 "insertDataOption": { |
279 "description": "How dates, times, and durati
ons should be represented in the output.\nThis is ignored if value_render_option
is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOpti
on.SERIAL_NUMBER].", | 251 "description": "How the input data should be
inserted.", |
| 252 "enum": [ |
| 253 "OVERWRITE", |
| 254 "INSERT_ROWS" |
| 255 ], |
| 256 "location": "query", |
| 257 "type": "string" |
| 258 }, |
| 259 "valueInputOption": { |
| 260 "description": "How the input data should be
interpreted.", |
| 261 "enum": [ |
| 262 "INPUT_VALUE_OPTION_UNSPECIFIED", |
| 263 "RAW", |
| 264 "USER_ENTERED" |
| 265 ], |
| 266 "location": "query", |
| 267 "type": "string" |
| 268 }, |
| 269 "responseDateTimeRenderOption": { |
| 270 "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].", |
280 "enum": [ | 271 "enum": [ |
281 "SERIAL_NUMBER", | 272 "SERIAL_NUMBER", |
282 "FORMATTED_STRING" | 273 "FORMATTED_STRING" |
283 ], | 274 ], |
284 "location": "query", | 275 "location": "query", |
285 "type": "string" | 276 "type": "string" |
286 }, | |
287 "majorDimension": { | |
288 "description": "The major dimension that res
ults 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]]`.", | |
289 "enum": [ | |
290 "DIMENSION_UNSPECIFIED", | |
291 "ROWS", | |
292 "COLUMNS" | |
293 ], | |
294 "location": "query", | |
295 "type": "string" | |
296 } | 277 } |
297 }, | 278 }, |
298 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hGet", | 279 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:append", |
| 280 "request": { |
| 281 "$ref": "ValueRange" |
| 282 }, |
299 "response": { | 283 "response": { |
300 "$ref": "BatchGetValuesResponse" | 284 "$ref": "AppendValuesResponse" |
301 }, | 285 }, |
302 "scopes": [ | 286 "scopes": [ |
303 "https://www.googleapis.com/auth/drive", | 287 "https://www.googleapis.com/auth/drive", |
304 "https://www.googleapis.com/auth/drive.readonly"
, | 288 "https://www.googleapis.com/auth/spreadsheets" |
305 "https://www.googleapis.com/auth/spreadsheets", | |
306 "https://www.googleapis.com/auth/spreadsheets.re
adonly" | |
307 ] | 289 ] |
308 }, | 290 }, |
309 "batchUpdate": { | 291 "batchClear": { |
310 "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.", | 292 "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\nf
ormatting, data validation, etc..) are kept.", |
311 "httpMethod": "POST", | 293 "httpMethod": "POST", |
312 "id": "sheets.spreadsheets.values.batchUpdate", | 294 "id": "sheets.spreadsheets.values.batchClear", |
313 "parameterOrder": [ | 295 "parameterOrder": [ |
314 "spreadsheetId" | 296 "spreadsheetId" |
315 ], | 297 ], |
316 "parameters": { | 298 "parameters": { |
317 "spreadsheetId": { | 299 "spreadsheetId": { |
318 "description": "The ID of the spreadsheet to
update.", | 300 "description": "The ID of the spreadsheet to
update.", |
319 "location": "path", | 301 "location": "path", |
320 "required": true, | 302 "required": true, |
321 "type": "string" | 303 "type": "string" |
322 } | 304 } |
323 }, | 305 }, |
324 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hUpdate", | 306 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hClear", |
325 "request": { | 307 "request": { |
326 "$ref": "BatchUpdateValuesRequest" | 308 "$ref": "BatchClearValuesRequest" |
327 }, | 309 }, |
328 "response": { | 310 "response": { |
329 "$ref": "BatchUpdateValuesResponse" | 311 "$ref": "BatchClearValuesResponse" |
330 }, | 312 }, |
331 "scopes": [ | 313 "scopes": [ |
332 "https://www.googleapis.com/auth/drive", | 314 "https://www.googleapis.com/auth/drive", |
333 "https://www.googleapis.com/auth/spreadsheets" | 315 "https://www.googleapis.com/auth/spreadsheets" |
334 ] | 316 ] |
335 }, | 317 }, |
336 "get": { | 318 "get": { |
337 "description": "Returns a range of values from a spr
eadsheet.\nThe caller must specify the spreadsheet ID and a range.", | 319 "description": "Returns a range of values from a spr
eadsheet.\nThe caller must specify the spreadsheet ID and a range.", |
338 "httpMethod": "GET", | 320 "httpMethod": "GET", |
339 "id": "sheets.spreadsheets.values.get", | 321 "id": "sheets.spreadsheets.values.get", |
340 "parameterOrder": [ | 322 "parameterOrder": [ |
341 "spreadsheetId", | 323 "spreadsheetId", |
342 "range" | 324 "range" |
343 ], | 325 ], |
344 "parameters": { | 326 "parameters": { |
345 "spreadsheetId": { | |
346 "description": "The ID of the spreadsheet to
retrieve data from.", | |
347 "location": "path", | |
348 "required": true, | |
349 "type": "string" | |
350 }, | |
351 "valueRenderOption": { | 327 "valueRenderOption": { |
352 "description": "How values should be represe
nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA
LUE.", | 328 "description": "How values should be represe
nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA
LUE.", |
353 "enum": [ | 329 "enum": [ |
354 "FORMATTED_VALUE", | 330 "FORMATTED_VALUE", |
355 "UNFORMATTED_VALUE", | 331 "UNFORMATTED_VALUE", |
356 "FORMULA" | 332 "FORMULA" |
357 ], | 333 ], |
358 "location": "query", | 334 "location": "query", |
359 "type": "string" | 335 "type": "string" |
360 }, | 336 }, |
361 "dateTimeRenderOption": { | 337 "dateTimeRenderOption": { |
362 "description": "How dates, times, and durati
ons should be represented in the output.\nThis is ignored if value_render_option
is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOpti
on.SERIAL_NUMBER].", | 338 "description": "How dates, times, and durati
ons should be represented in the output.\nThis is ignored if value_render_option
is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOpti
on.SERIAL_NUMBER].", |
363 "enum": [ | 339 "enum": [ |
364 "SERIAL_NUMBER", | 340 "SERIAL_NUMBER", |
365 "FORMATTED_STRING" | 341 "FORMATTED_STRING" |
366 ], | 342 ], |
367 "location": "query", | 343 "location": "query", |
368 "type": "string" | 344 "type": "string" |
369 }, | 345 }, |
370 "range": { | |
371 "description": "The A1 notation of the value
s to retrieve.", | |
372 "location": "path", | |
373 "required": true, | |
374 "type": "string" | |
375 }, | |
376 "majorDimension": { | 346 "majorDimension": { |
377 "description": "The major dimension that res
ults 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]]`.", | 347 "description": "The major dimension that res
ults 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]]`.", |
378 "enum": [ | 348 "enum": [ |
379 "DIMENSION_UNSPECIFIED", | 349 "DIMENSION_UNSPECIFIED", |
380 "ROWS", | 350 "ROWS", |
381 "COLUMNS" | 351 "COLUMNS" |
382 ], | 352 ], |
383 "location": "query", | 353 "location": "query", |
384 "type": "string" | 354 "type": "string" |
| 355 }, |
| 356 "spreadsheetId": { |
| 357 "description": "The ID of the spreadsheet to
retrieve data from.", |
| 358 "location": "path", |
| 359 "required": true, |
| 360 "type": "string" |
| 361 }, |
| 362 "range": { |
| 363 "description": "The A1 notation of the value
s to retrieve.", |
| 364 "location": "path", |
| 365 "required": true, |
| 366 "type": "string" |
385 } | 367 } |
386 }, | 368 }, |
387 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}", | 369 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}", |
388 "response": { | 370 "response": { |
389 "$ref": "ValueRange" | 371 "$ref": "ValueRange" |
390 }, | 372 }, |
391 "scopes": [ | 373 "scopes": [ |
392 "https://www.googleapis.com/auth/drive", | 374 "https://www.googleapis.com/auth/drive", |
393 "https://www.googleapis.com/auth/drive.readonly"
, | 375 "https://www.googleapis.com/auth/drive.readonly"
, |
394 "https://www.googleapis.com/auth/spreadsheets", | 376 "https://www.googleapis.com/auth/spreadsheets", |
395 "https://www.googleapis.com/auth/spreadsheets.re
adonly" | 377 "https://www.googleapis.com/auth/spreadsheets.re
adonly" |
396 ] | 378 ] |
397 }, | 379 }, |
398 "append": { | 380 "update": { |
399 "description": "Appends values to a spreadsheet. The
input range is used to search for\nexisting data and find a \"table\" within th
at range. Values will be\nappended to the next row of the table, starting with t
he first column of\nthe table. See the\n[guide](/sheets/guides/values#appending_
values)\nand\n[sample code](/sheets/samples/writing#append_values)\nfor specific
details of how tables are detected and data is appended.\n\nThe caller must spe
cify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption`
only\ncontrols how the input data will be added to the sheet (column-wise or\nr
ow-wise), it does not influence what cell the data starts being written\nto.", | 381 "description": "Sets values in a range of a spreadsh
eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption
.", |
400 "httpMethod": "POST", | 382 "httpMethod": "PUT", |
401 "id": "sheets.spreadsheets.values.append", | 383 "id": "sheets.spreadsheets.values.update", |
402 "parameterOrder": [ | 384 "parameterOrder": [ |
403 "spreadsheetId", | 385 "spreadsheetId", |
404 "range" | 386 "range" |
405 ], | 387 ], |
406 "parameters": { | 388 "parameters": { |
407 "responseValueRenderOption": { | |
408 "description": "Determines how values in the
response should be rendered.\nThe default render option is ValueRenderOption.FO
RMATTED_VALUE.", | |
409 "enum": [ | |
410 "FORMATTED_VALUE", | |
411 "UNFORMATTED_VALUE", | |
412 "FORMULA" | |
413 ], | |
414 "location": "query", | |
415 "type": "string" | |
416 }, | |
417 "valueInputOption": { | 389 "valueInputOption": { |
418 "description": "How the input data should be
interpreted.", | 390 "description": "How the input data should be
interpreted.", |
419 "enum": [ | 391 "enum": [ |
420 "INPUT_VALUE_OPTION_UNSPECIFIED", | 392 "INPUT_VALUE_OPTION_UNSPECIFIED", |
421 "RAW", | 393 "RAW", |
422 "USER_ENTERED" | 394 "USER_ENTERED" |
423 ], | 395 ], |
424 "location": "query", | 396 "location": "query", |
425 "type": "string" | 397 "type": "string" |
426 }, | 398 }, |
427 "responseDateTimeRenderOption": { | 399 "responseDateTimeRenderOption": { |
428 "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].", | 400 "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].", |
429 "enum": [ | 401 "enum": [ |
430 "SERIAL_NUMBER", | 402 "SERIAL_NUMBER", |
431 "FORMATTED_STRING" | 403 "FORMATTED_STRING" |
432 ], | 404 ], |
433 "location": "query", | 405 "location": "query", |
434 "type": "string" | 406 "type": "string" |
435 }, | 407 }, |
436 "includeValuesInResponse": { | 408 "includeValuesInResponse": { |
437 "description": "Determines if the update res
ponse should include the values\nof the cells that were appended. By default, re
sponses\ndo not include the updated values.", | 409 "description": "Determines if the update res
ponse should include the values\nof the cells that were updated. By default, res
ponses\ndo not include the updated values.\nIf the range to write was larger tha
n than the range actually written,\nthe response will include all values in the
requested range (excluding\ntrailing empty rows and columns).", |
438 "location": "query", | 410 "location": "query", |
439 "type": "boolean" | 411 "type": "boolean" |
440 }, | 412 }, |
| 413 "range": { |
| 414 "description": "The A1 notation of the value
s to update.", |
| 415 "location": "path", |
| 416 "required": true, |
| 417 "type": "string" |
| 418 }, |
441 "spreadsheetId": { | 419 "spreadsheetId": { |
442 "description": "The ID of the spreadsheet to
update.", | 420 "description": "The ID of the spreadsheet to
update.", |
443 "location": "path", | 421 "location": "path", |
444 "required": true, | 422 "required": true, |
445 "type": "string" | 423 "type": "string" |
446 }, | 424 }, |
447 "range": { | 425 "responseValueRenderOption": { |
448 "description": "The A1 notation of a range t
o search for a logical table of data.\nValues will be appended after the last ro
w of the table.", | 426 "description": "Determines how values in the
response should be rendered.\nThe default render option is ValueRenderOption.FO
RMATTED_VALUE.", |
449 "location": "path", | |
450 "required": true, | |
451 "type": "string" | |
452 }, | |
453 "insertDataOption": { | |
454 "description": "How the input data should be
inserted.", | |
455 "enum": [ | 427 "enum": [ |
456 "OVERWRITE", | 428 "FORMATTED_VALUE", |
457 "INSERT_ROWS" | 429 "UNFORMATTED_VALUE", |
| 430 "FORMULA" |
458 ], | 431 ], |
459 "location": "query", | 432 "location": "query", |
460 "type": "string" | 433 "type": "string" |
461 } | 434 } |
462 }, | 435 }, |
463 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:append", | 436 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}", |
464 "request": { | 437 "request": { |
465 "$ref": "ValueRange" | 438 "$ref": "ValueRange" |
466 }, | 439 }, |
467 "response": { | 440 "response": { |
468 "$ref": "AppendValuesResponse" | 441 "$ref": "UpdateValuesResponse" |
469 }, | 442 }, |
470 "scopes": [ | 443 "scopes": [ |
471 "https://www.googleapis.com/auth/drive", | 444 "https://www.googleapis.com/auth/drive", |
472 "https://www.googleapis.com/auth/spreadsheets" | 445 "https://www.googleapis.com/auth/spreadsheets" |
473 ] | 446 ] |
474 }, | 447 }, |
475 "update": { | 448 "batchUpdate": { |
476 "description": "Sets values in a range of a spreadsh
eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption
.", | 449 "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.", |
477 "httpMethod": "PUT", | 450 "httpMethod": "POST", |
478 "id": "sheets.spreadsheets.values.update", | 451 "id": "sheets.spreadsheets.values.batchUpdate", |
479 "parameterOrder": [ | 452 "parameterOrder": [ |
480 "spreadsheetId", | 453 "spreadsheetId" |
481 "range" | |
482 ], | 454 ], |
483 "parameters": { | 455 "parameters": { |
484 "responseValueRenderOption": { | 456 "spreadsheetId": { |
485 "description": "Determines how values in the
response should be rendered.\nThe default render option is ValueRenderOption.FO
RMATTED_VALUE.", | 457 "description": "The ID of the spreadsheet to
update.", |
| 458 "location": "path", |
| 459 "required": true, |
| 460 "type": "string" |
| 461 } |
| 462 }, |
| 463 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hUpdate", |
| 464 "request": { |
| 465 "$ref": "BatchUpdateValuesRequest" |
| 466 }, |
| 467 "response": { |
| 468 "$ref": "BatchUpdateValuesResponse" |
| 469 }, |
| 470 "scopes": [ |
| 471 "https://www.googleapis.com/auth/drive", |
| 472 "https://www.googleapis.com/auth/spreadsheets" |
| 473 ] |
| 474 }, |
| 475 "batchGet": { |
| 476 "description": "Returns one or more ranges of values
from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more
ranges.", |
| 477 "httpMethod": "GET", |
| 478 "id": "sheets.spreadsheets.values.batchGet", |
| 479 "parameterOrder": [ |
| 480 "spreadsheetId" |
| 481 ], |
| 482 "parameters": { |
| 483 "spreadsheetId": { |
| 484 "description": "The ID of the spreadsheet to
retrieve data from.", |
| 485 "location": "path", |
| 486 "required": true, |
| 487 "type": "string" |
| 488 }, |
| 489 "valueRenderOption": { |
| 490 "description": "How values should be represe
nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA
LUE.", |
486 "enum": [ | 491 "enum": [ |
487 "FORMATTED_VALUE", | 492 "FORMATTED_VALUE", |
488 "UNFORMATTED_VALUE", | 493 "UNFORMATTED_VALUE", |
489 "FORMULA" | 494 "FORMULA" |
490 ], | 495 ], |
491 "location": "query", | 496 "location": "query", |
492 "type": "string" | 497 "type": "string" |
493 }, | 498 }, |
494 "valueInputOption": { | 499 "dateTimeRenderOption": { |
495 "description": "How the input data should be
interpreted.", | 500 "description": "How dates, times, and durati
ons should be represented in the output.\nThis is ignored if value_render_option
is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOpti
on.SERIAL_NUMBER].", |
496 "enum": [ | |
497 "INPUT_VALUE_OPTION_UNSPECIFIED", | |
498 "RAW", | |
499 "USER_ENTERED" | |
500 ], | |
501 "location": "query", | |
502 "type": "string" | |
503 }, | |
504 "responseDateTimeRenderOption": { | |
505 "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].", | |
506 "enum": [ | 501 "enum": [ |
507 "SERIAL_NUMBER", | 502 "SERIAL_NUMBER", |
508 "FORMATTED_STRING" | 503 "FORMATTED_STRING" |
509 ], | 504 ], |
510 "location": "query", | 505 "location": "query", |
511 "type": "string" | 506 "type": "string" |
512 }, | 507 }, |
513 "includeValuesInResponse": { | 508 "ranges": { |
514 "description": "Determines if the update res
ponse should include the values\nof the cells that were updated. By default, res
ponses\ndo not include the updated values.\nIf the range to write was larger tha
n than the range actually written,\nthe response will include all values in the
requested range (excluding\ntrailing empty rows and columns).", | 509 "description": "The A1 notation of the value
s to retrieve.", |
515 "location": "query", | 510 "location": "query", |
516 "type": "boolean" | 511 "repeated": true, |
517 }, | |
518 "spreadsheetId": { | |
519 "description": "The ID of the spreadsheet to
update.", | |
520 "location": "path", | |
521 "required": true, | |
522 "type": "string" | 512 "type": "string" |
523 }, | 513 }, |
524 "range": { | 514 "majorDimension": { |
525 "description": "The A1 notation of the value
s to update.", | 515 "description": "The major dimension that res
ults 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]]`.", |
526 "location": "path", | 516 "enum": [ |
527 "required": true, | 517 "DIMENSION_UNSPECIFIED", |
| 518 "ROWS", |
| 519 "COLUMNS" |
| 520 ], |
| 521 "location": "query", |
528 "type": "string" | 522 "type": "string" |
529 } | 523 } |
530 }, | 524 }, |
531 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}", | 525 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hGet", |
532 "request": { | |
533 "$ref": "ValueRange" | |
534 }, | |
535 "response": { | 526 "response": { |
536 "$ref": "UpdateValuesResponse" | 527 "$ref": "BatchGetValuesResponse" |
537 }, | 528 }, |
538 "scopes": [ | 529 "scopes": [ |
539 "https://www.googleapis.com/auth/drive", | 530 "https://www.googleapis.com/auth/drive", |
540 "https://www.googleapis.com/auth/spreadsheets" | 531 "https://www.googleapis.com/auth/drive.readonly"
, |
| 532 "https://www.googleapis.com/auth/spreadsheets", |
| 533 "https://www.googleapis.com/auth/spreadsheets.re
adonly" |
541 ] | 534 ] |
542 }, | 535 }, |
543 "batchClear": { | 536 "clear": { |
544 "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\nf
ormatting, data validation, etc..) are kept.", | 537 "description": "Clears values from a spreadsheet.\nT
he 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.", |
545 "httpMethod": "POST", | 538 "httpMethod": "POST", |
546 "id": "sheets.spreadsheets.values.batchClear", | 539 "id": "sheets.spreadsheets.values.clear", |
547 "parameterOrder": [ | 540 "parameterOrder": [ |
548 "spreadsheetId" | 541 "spreadsheetId", |
| 542 "range" |
549 ], | 543 ], |
550 "parameters": { | 544 "parameters": { |
551 "spreadsheetId": { | 545 "spreadsheetId": { |
552 "description": "The ID of the spreadsheet to
update.", | 546 "description": "The ID of the spreadsheet to
update.", |
553 "location": "path", | 547 "location": "path", |
554 "required": true, | 548 "required": true, |
555 "type": "string" | 549 "type": "string" |
| 550 }, |
| 551 "range": { |
| 552 "description": "The A1 notation of the value
s to clear.", |
| 553 "location": "path", |
| 554 "required": true, |
| 555 "type": "string" |
556 } | 556 } |
557 }, | 557 }, |
558 "path": "v4/spreadsheets/{spreadsheetId}/values:batc
hClear", | 558 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran
ge}:clear", |
559 "request": { | 559 "request": { |
560 "$ref": "BatchClearValuesRequest" | 560 "$ref": "ClearValuesRequest" |
561 }, | 561 }, |
562 "response": { | 562 "response": { |
563 "$ref": "BatchClearValuesResponse" | 563 "$ref": "ClearValuesResponse" |
564 }, | 564 }, |
565 "scopes": [ | 565 "scopes": [ |
566 "https://www.googleapis.com/auth/drive", | 566 "https://www.googleapis.com/auth/drive", |
567 "https://www.googleapis.com/auth/spreadsheets" | 567 "https://www.googleapis.com/auth/spreadsheets" |
568 ] | 568 ] |
569 } | 569 } |
570 } | 570 } |
571 }, | 571 }, |
572 "sheets": { | 572 "sheets": { |
573 "methods": { | 573 "methods": { |
(...skipping 30 matching lines...) Expand all Loading... |
604 "scopes": [ | 604 "scopes": [ |
605 "https://www.googleapis.com/auth/drive", | 605 "https://www.googleapis.com/auth/drive", |
606 "https://www.googleapis.com/auth/spreadsheets" | 606 "https://www.googleapis.com/auth/spreadsheets" |
607 ] | 607 ] |
608 } | 608 } |
609 } | 609 } |
610 } | 610 } |
611 } | 611 } |
612 } | 612 } |
613 }, | 613 }, |
614 "revision": "20170117", | 614 "revision": "20170203", |
615 "rootUrl": "https://sheets.googleapis.com/", | 615 "rootUrl": "https://sheets.googleapis.com/", |
616 "schemas": { | 616 "schemas": { |
617 "AddNamedRangeResponse": { | 617 "BooleanRule": { |
618 "description": "The result of adding a named range.", | 618 "description": "A rule that may or may not match, depending on the c
ondition.", |
619 "id": "AddNamedRangeResponse", | 619 "id": "BooleanRule", |
620 "properties": { | 620 "properties": { |
621 "namedRange": { | 621 "format": { |
622 "$ref": "NamedRange", | 622 "$ref": "CellFormat", |
623 "description": "The named range to add." | 623 "description": "The format to apply.\nConditional formatting
can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou
nd color &\nbackground color." |
624 } | |
625 }, | |
626 "type": "object" | |
627 }, | |
628 "UpdateProtectedRangeRequest": { | |
629 "description": "Updates an existing protected range with the specifi
ed\nprotectedRangeId.", | |
630 "id": "UpdateProtectedRangeRequest", | |
631 "properties": { | |
632 "protectedRange": { | |
633 "$ref": "ProtectedRange", | |
634 "description": "The protected range to update with the new p
roperties." | |
635 }, | 624 }, |
636 "fields": { | 625 "condition": { |
637 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `protectedRange` is implied and should n
ot be specified.\nA single `\"*\"` can be used as short-hand for listing every f
ield.", | 626 "$ref": "BooleanCondition", |
638 "format": "google-fieldmask", | 627 "description": "The condition of the rule. If the condition
evaluates to true,\nthe format will be applied." |
639 "type": "string" | |
640 } | |
641 }, | |
642 "type": "object" | |
643 }, | |
644 "Padding": { | |
645 "description": "The amount of padding around the cell, in pixels.\nW
hen updating padding, every field must be specified.", | |
646 "id": "Padding", | |
647 "properties": { | |
648 "right": { | |
649 "description": "The right padding of the cell.", | |
650 "format": "int32", | |
651 "type": "integer" | |
652 }, | |
653 "left": { | |
654 "description": "The left padding of the cell.", | |
655 "format": "int32", | |
656 "type": "integer" | |
657 }, | |
658 "top": { | |
659 "description": "The top padding of the cell.", | |
660 "format": "int32", | |
661 "type": "integer" | |
662 }, | |
663 "bottom": { | |
664 "description": "The bottom padding of the cell.", | |
665 "format": "int32", | |
666 "type": "integer" | |
667 } | |
668 }, | |
669 "type": "object" | |
670 }, | |
671 "MergeCellsRequest": { | |
672 "description": "Merges all cells in the range.", | |
673 "id": "MergeCellsRequest", | |
674 "properties": { | |
675 "mergeType": { | |
676 "description": "How the cells should be merged.", | |
677 "enum": [ | |
678 "MERGE_ALL", | |
679 "MERGE_COLUMNS", | |
680 "MERGE_ROWS" | |
681 ], | |
682 "enumDescriptions": [ | |
683 "Create a single merge from the range", | |
684 "Create a merge for each column in the range", | |
685 "Create a merge for each row in the range" | |
686 ], | |
687 "type": "string" | |
688 }, | |
689 "range": { | |
690 "$ref": "GridRange", | |
691 "description": "The range of cells to merge." | |
692 } | |
693 }, | |
694 "type": "object" | |
695 }, | |
696 "AddSheetResponse": { | |
697 "description": "The result of adding a sheet.", | |
698 "id": "AddSheetResponse", | |
699 "properties": { | |
700 "properties": { | |
701 "$ref": "SheetProperties", | |
702 "description": "The properties of the newly added sheet." | |
703 } | 628 } |
704 }, | 629 }, |
705 "type": "object" | 630 "type": "object" |
706 }, | 631 }, |
707 "PivotGroupValueMetadata": { | 632 "PivotGroupValueMetadata": { |
708 "description": "Metadata about a value in a pivot grouping.", | 633 "description": "Metadata about a value in a pivot grouping.", |
709 "id": "PivotGroupValueMetadata", | 634 "id": "PivotGroupValueMetadata", |
710 "properties": { | 635 "properties": { |
711 "value": { | 636 "value": { |
712 "$ref": "ExtendedValue", | 637 "$ref": "ExtendedValue", |
713 "description": "The calculated value the metadata correspond
s to.\n(Note that formulaValue is not valid,\n because the values will be calcul
ated.)" | 638 "description": "The calculated value the metadata correspond
s to.\n(Note that formulaValue is not valid,\n because the values will be calcul
ated.)" |
714 }, | 639 }, |
715 "collapsed": { | 640 "collapsed": { |
716 "description": "True if the data corresponding to the value
is collapsed.", | 641 "description": "True if the data corresponding to the value
is collapsed.", |
717 "type": "boolean" | 642 "type": "boolean" |
718 } | 643 } |
719 }, | 644 }, |
720 "type": "object" | 645 "type": "object" |
721 }, | 646 }, |
722 "UpdateEmbeddedObjectPositionResponse": { | 647 "FilterCriteria": { |
723 "description": "The result of updating an embedded object's position
.", | 648 "description": "Criteria for showing/hiding rows in a filter or filt
er view.", |
724 "id": "UpdateEmbeddedObjectPositionResponse", | 649 "id": "FilterCriteria", |
725 "properties": { | 650 "properties": { |
726 "position": { | 651 "hiddenValues": { |
727 "$ref": "EmbeddedObjectPosition", | 652 "description": "Values that should be hidden.", |
728 "description": "The new position of the embedded object." | 653 "items": { |
| 654 "type": "string" |
| 655 }, |
| 656 "type": "array" |
| 657 }, |
| 658 "condition": { |
| 659 "$ref": "BooleanCondition", |
| 660 "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.)" |
729 } | 661 } |
730 }, | 662 }, |
731 "type": "object" | 663 "type": "object" |
732 }, | 664 }, |
733 "ClearValuesResponse": { | 665 "Editors": { |
734 "description": "The response when clearing a range of values in a sp
readsheet.", | 666 "description": "The editors of a protected range.", |
735 "id": "ClearValuesResponse", | 667 "id": "Editors", |
736 "properties": { | 668 "properties": { |
737 "spreadsheetId": { | 669 "users": { |
738 "description": "The spreadsheet the updates were applied to.
", | 670 "description": "The email addresses of users with edit acces
s to the protected range.", |
739 "type": "string" | 671 "items": { |
| 672 "type": "string" |
| 673 }, |
| 674 "type": "array" |
740 }, | 675 }, |
741 "clearedRange": { | 676 "groups": { |
742 "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 bound
s of the sheet, this will be the actual range\n that was cleared, bounded to the
sheet's limits.)", | 677 "description": "The email addresses of groups with edit acce
ss to the protected range.", |
743 "type": "string" | 678 "items": { |
| 679 "type": "string" |
| 680 }, |
| 681 "type": "array" |
| 682 }, |
| 683 "domainUsersCanEdit": { |
| 684 "description": "True if anyone in the document's domain has
edit access to the protected\nrange. Domain protection is only supported on doc
uments within a domain.", |
| 685 "type": "boolean" |
744 } | 686 } |
745 }, | 687 }, |
746 "type": "object" | 688 "type": "object" |
747 }, | 689 }, |
748 "UpdateConditionalFormatRuleRequest": { | 690 "UpdateConditionalFormatRuleRequest": { |
749 "description": "Updates a conditional format rule at the given index
,\nor moves a conditional format rule to another index.", | 691 "description": "Updates a conditional format rule at the given index
,\nor moves a conditional format rule to another index.", |
750 "id": "UpdateConditionalFormatRuleRequest", | 692 "id": "UpdateConditionalFormatRuleRequest", |
751 "properties": { | 693 "properties": { |
752 "sheetId": { | 694 "sheetId": { |
753 "description": "The sheet of the rule to move. Required if
new_index is set,\nunused otherwise.", | 695 "description": "The sheet of the rule to move. Required if
new_index is set,\nunused otherwise.", |
754 "format": "int32", | 696 "format": "int32", |
755 "type": "integer" | 697 "type": "integer" |
756 }, | 698 }, |
| 699 "newIndex": { |
| 700 "description": "The zero-based new index the rule should end
up at.", |
| 701 "format": "int32", |
| 702 "type": "integer" |
| 703 }, |
757 "rule": { | 704 "rule": { |
758 "$ref": "ConditionalFormatRule", | 705 "$ref": "ConditionalFormatRule", |
759 "description": "The rule that should replace the rule at the
given index." | 706 "description": "The rule that should replace the rule at the
given index." |
760 }, | 707 }, |
761 "index": { | 708 "index": { |
762 "description": "The zero-based index of the rule that should
be replaced or moved.", | 709 "description": "The zero-based index of the rule that should
be replaced or moved.", |
763 "format": "int32", | 710 "format": "int32", |
764 "type": "integer" | 711 "type": "integer" |
765 }, | 712 } |
766 "newIndex": { | 713 }, |
767 "description": "The zero-based new index the rule should end
up at.", | 714 "type": "object" |
| 715 }, |
| 716 "BasicChartDomain": { |
| 717 "description": "The domain of a chart.\nFor example, if charting sto
ck prices over time, this would be the date.", |
| 718 "id": "BasicChartDomain", |
| 719 "properties": { |
| 720 "domain": { |
| 721 "$ref": "ChartData", |
| 722 "description": "The data of the domain. For example, if char
ting stock prices over time,\nthis is the data representing the dates." |
| 723 } |
| 724 }, |
| 725 "type": "object" |
| 726 }, |
| 727 "DataValidationRule": { |
| 728 "description": "A data validation rule.", |
| 729 "id": "DataValidationRule", |
| 730 "properties": { |
| 731 "condition": { |
| 732 "$ref": "BooleanCondition", |
| 733 "description": "The condition that data in the cell must mat
ch." |
| 734 }, |
| 735 "showCustomUi": { |
| 736 "description": "True if the UI should be customized based on
the kind of condition.\nIf true, \"List\" conditions will show a dropdown.", |
| 737 "type": "boolean" |
| 738 }, |
| 739 "strict": { |
| 740 "description": "True if invalid data should be rejected.", |
| 741 "type": "boolean" |
| 742 }, |
| 743 "inputMessage": { |
| 744 "description": "A message to show the user when adding data
to the cell.", |
| 745 "type": "string" |
| 746 } |
| 747 }, |
| 748 "type": "object" |
| 749 }, |
| 750 "PasteDataRequest": { |
| 751 "description": "Inserts data into the spreadsheet starting at the sp
ecified coordinate.", |
| 752 "id": "PasteDataRequest", |
| 753 "properties": { |
| 754 "coordinate": { |
| 755 "$ref": "GridCoordinate", |
| 756 "description": "The coordinate at which the data should star
t being inserted." |
| 757 }, |
| 758 "data": { |
| 759 "description": "The data to insert.", |
| 760 "type": "string" |
| 761 }, |
| 762 "delimiter": { |
| 763 "description": "The delimiter in the data.", |
| 764 "type": "string" |
| 765 }, |
| 766 "type": { |
| 767 "description": "How the data should be pasted.", |
| 768 "enum": [ |
| 769 "PASTE_NORMAL", |
| 770 "PASTE_VALUES", |
| 771 "PASTE_FORMAT", |
| 772 "PASTE_NO_BORDERS", |
| 773 "PASTE_FORMULA", |
| 774 "PASTE_DATA_VALIDATION", |
| 775 "PASTE_CONDITIONAL_FORMATTING" |
| 776 ], |
| 777 "enumDescriptions": [ |
| 778 "Paste values, formulas, formats, and merges.", |
| 779 "Paste the values ONLY without formats, formulas, or mer
ges.", |
| 780 "Paste the format and data validation only.", |
| 781 "Like PASTE_NORMAL but without borders.", |
| 782 "Paste the formulas only.", |
| 783 "Paste the data validation only.", |
| 784 "Paste the conditional formatting rules only." |
| 785 ], |
| 786 "type": "string" |
| 787 }, |
| 788 "html": { |
| 789 "description": "True if the data is HTML.", |
| 790 "type": "boolean" |
| 791 } |
| 792 }, |
| 793 "type": "object" |
| 794 }, |
| 795 "AppendDimensionRequest": { |
| 796 "description": "Appends rows or columns to the end of a sheet.", |
| 797 "id": "AppendDimensionRequest", |
| 798 "properties": { |
| 799 "dimension": { |
| 800 "description": "Whether rows or columns should be appended."
, |
| 801 "enum": [ |
| 802 "DIMENSION_UNSPECIFIED", |
| 803 "ROWS", |
| 804 "COLUMNS" |
| 805 ], |
| 806 "enumDescriptions": [ |
| 807 "The default value, do not use.", |
| 808 "Operates on the rows of a sheet.", |
| 809 "Operates on the columns of a sheet." |
| 810 ], |
| 811 "type": "string" |
| 812 }, |
| 813 "length": { |
| 814 "description": "The number of rows or columns to append.", |
768 "format": "int32", | 815 "format": "int32", |
769 "type": "integer" | 816 "type": "integer" |
770 } | 817 }, |
771 }, | 818 "sheetId": { |
772 "type": "object" | 819 "description": "The sheet to append rows or columns to.", |
773 }, | |
774 "TextFormat": { | |
775 "description": "The format of a run of text in a cell.\nAbsent value
s indicate that the field isn't specified.", | |
776 "id": "TextFormat", | |
777 "properties": { | |
778 "bold": { | |
779 "description": "True if the text is bold.", | |
780 "type": "boolean" | |
781 }, | |
782 "italic": { | |
783 "description": "True if the text is italicized.", | |
784 "type": "boolean" | |
785 }, | |
786 "foregroundColor": { | |
787 "$ref": "Color", | |
788 "description": "The foreground color of the text." | |
789 }, | |
790 "fontFamily": { | |
791 "description": "The font family.", | |
792 "type": "string" | |
793 }, | |
794 "strikethrough": { | |
795 "description": "True if the text has a strikethrough.", | |
796 "type": "boolean" | |
797 }, | |
798 "fontSize": { | |
799 "description": "The size of the font.", | |
800 "format": "int32", | 820 "format": "int32", |
801 "type": "integer" | 821 "type": "integer" |
802 }, | 822 } |
803 "underline": { | 823 }, |
804 "description": "True if the text is underlined.", | 824 "type": "object" |
805 "type": "boolean" | 825 }, |
806 } | 826 "AddNamedRangeRequest": { |
807 }, | 827 "description": "Adds a named range to the spreadsheet.", |
808 "type": "object" | 828 "id": "AddNamedRangeRequest", |
809 }, | 829 "properties": { |
810 "UpdateChartSpecRequest": { | 830 "namedRange": { |
811 "description": "Updates a chart's specifications.\n(This does not mo
ve or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPosit
ionRequest.)", | 831 "$ref": "NamedRange", |
812 "id": "UpdateChartSpecRequest", | 832 "description": "The named range to add. The namedRangeId\nfi
eld 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.)" |
813 "properties": { | 833 } |
814 "chartId": { | 834 }, |
815 "description": "The ID of the chart to update.", | 835 "type": "object" |
| 836 }, |
| 837 "UpdateEmbeddedObjectPositionRequest": { |
| 838 "description": "Update an embedded object's position (such as a movi
ng or resizing a\nchart or image).", |
| 839 "id": "UpdateEmbeddedObjectPositionRequest", |
| 840 "properties": { |
| 841 "fields": { |
| 842 "description": "The fields of OverlayPosition\nthat should b
e 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 `newPos
ition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"
` can be used as short-hand for listing every field.", |
| 843 "format": "google-fieldmask", |
| 844 "type": "string" |
| 845 }, |
| 846 "objectId": { |
| 847 "description": "The ID of the object to moved.", |
816 "format": "int32", | 848 "format": "int32", |
817 "type": "integer" | 849 "type": "integer" |
818 }, | 850 }, |
819 "spec": { | 851 "newPosition": { |
820 "$ref": "ChartSpec", | 852 "$ref": "EmbeddedObjectPosition", |
821 "description": "The specification to apply to the chart." | 853 "description": "An explicit position to move the embedded ob
ject to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be creat
ed.\nIf newPosition.newSheet is set to true,\na new sheet will be created with a
n ID that will be chosen for you." |
822 } | 854 } |
823 }, | 855 }, |
824 "type": "object" | 856 "type": "object" |
825 }, | 857 }, |
826 "GridCoordinate": { | 858 "PieChartSpec": { |
827 "description": "A coordinate in a sheet.\nAll indexes are zero-based
.", | 859 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart
\">pie chart</a>.", |
828 "id": "GridCoordinate", | 860 "id": "PieChartSpec", |
829 "properties": { | 861 "properties": { |
830 "sheetId": { | 862 "domain": { |
831 "description": "The sheet this coordinate is on.", | 863 "$ref": "ChartData", |
832 "format": "int32", | 864 "description": "The data that covers the domain of the pie c
hart." |
833 "type": "integer" | 865 }, |
834 }, | 866 "threeDimensional": { |
835 "rowIndex": { | 867 "description": "True if the pie is three dimensional.", |
836 "description": "The row index of the coordinate.", | 868 "type": "boolean" |
837 "format": "int32", | 869 }, |
838 "type": "integer" | 870 "series": { |
839 }, | 871 "$ref": "ChartData", |
840 "columnIndex": { | 872 "description": "The data that covers the one and only series
of the pie chart." |
841 "description": "The column index of the coordinate.", | 873 }, |
842 "format": "int32", | 874 "legendPosition": { |
843 "type": "integer" | 875 "description": "Where the legend of the pie chart should be
drawn.", |
844 } | 876 "enum": [ |
845 }, | 877 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED", |
846 "type": "object" | 878 "BOTTOM_LEGEND", |
847 }, | 879 "LEFT_LEGEND", |
848 "DeleteFilterViewRequest": { | 880 "RIGHT_LEGEND", |
849 "description": "Deletes a particular filter view.", | 881 "TOP_LEGEND", |
850 "id": "DeleteFilterViewRequest", | 882 "NO_LEGEND", |
851 "properties": { | 883 "LABELED_LEGEND" |
852 "filterId": { | 884 ], |
853 "description": "The ID of the filter to delete.", | 885 "enumDescriptions": [ |
854 "format": "int32", | 886 "Default value, do not use.", |
855 "type": "integer" | 887 "The legend is rendered on the bottom of the chart.", |
856 } | 888 "The legend is rendered on the left of the chart.", |
857 }, | 889 "The legend is rendered on the right of the chart.", |
858 "type": "object" | 890 "The legend is rendered on the top of the chart.", |
859 }, | 891 "No legend is rendered.", |
860 "BatchUpdateValuesResponse": { | 892 "Each pie slice has a label attached to it." |
861 "description": "The response when updating a range of values in a sp
readsheet.", | 893 ], |
862 "id": "BatchUpdateValuesResponse", | 894 "type": "string" |
863 "properties": { | 895 }, |
864 "totalUpdatedSheets": { | 896 "pieHole": { |
865 "description": "The total number of sheets where at least on
e cell in the sheet was\nupdated.", | 897 "description": "The size of the hole in the pie chart.", |
866 "format": "int32", | 898 "format": "double", |
867 "type": "integer" | 899 "type": "number" |
868 }, | 900 } |
869 "totalUpdatedColumns": { | 901 }, |
870 "description": "The total number of columns where at least o
ne cell in the column was\nupdated.", | 902 "type": "object" |
871 "format": "int32", | 903 }, |
872 "type": "integer" | 904 "UpdateFilterViewRequest": { |
873 }, | 905 "description": "Updates properties of the filter view.", |
874 "responses": { | 906 "id": "UpdateFilterViewRequest", |
875 "description": "One UpdateValuesResponse per requested range
, in the same order as\nthe requests appeared.", | 907 "properties": { |
| 908 "filter": { |
| 909 "$ref": "FilterView", |
| 910 "description": "The new properties of the filter view." |
| 911 }, |
| 912 "fields": { |
| 913 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `filter` is implied and should not be sp
ecified.\nA single `\"*\"` can be used as short-hand for listing every field.", |
| 914 "format": "google-fieldmask", |
| 915 "type": "string" |
| 916 } |
| 917 }, |
| 918 "type": "object" |
| 919 }, |
| 920 "ConditionalFormatRule": { |
| 921 "description": "A rule describing a conditional format.", |
| 922 "id": "ConditionalFormatRule", |
| 923 "properties": { |
| 924 "booleanRule": { |
| 925 "$ref": "BooleanRule", |
| 926 "description": "The formatting is either \"on\" or \"off\" a
ccording to the rule." |
| 927 }, |
| 928 "ranges": { |
| 929 "description": "The ranges that will be formatted if the con
dition is true.\nAll the ranges must be on the same grid.", |
876 "items": { | 930 "items": { |
877 "$ref": "UpdateValuesResponse" | 931 "$ref": "GridRange" |
878 }, | 932 }, |
879 "type": "array" | 933 "type": "array" |
880 }, | 934 }, |
881 "totalUpdatedCells": { | 935 "gradientRule": { |
882 "description": "The total number of cells updated.", | 936 "$ref": "GradientRule", |
883 "format": "int32", | 937 "description": "The formatting will vary based on the gradie
nts in the rule." |
884 "type": "integer" | 938 } |
885 }, | 939 }, |
886 "spreadsheetId": { | 940 "type": "object" |
887 "description": "The spreadsheet the updates were applied to.
", | 941 }, |
888 "type": "string" | 942 "CopyPasteRequest": { |
889 }, | 943 "description": "Copies data from the source to the destination.", |
890 "totalUpdatedRows": { | 944 "id": "CopyPasteRequest", |
891 "description": "The total number of rows where at least one
cell in the row was updated.", | 945 "properties": { |
892 "format": "int32", | 946 "destination": { |
893 "type": "integer" | 947 "$ref": "GridRange", |
894 } | 948 "description": "The location to paste to. If the range cover
s 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 t
he destination range)." |
895 }, | 949 }, |
896 "type": "object" | 950 "pasteOrientation": { |
897 }, | 951 "description": "How that data should be oriented when pastin
g.", |
898 "UpdateNamedRangeRequest": { | |
899 "description": "Updates properties of the named range with the speci
fied\nnamedRangeId.", | |
900 "id": "UpdateNamedRangeRequest", | |
901 "properties": { | |
902 "fields": { | |
903 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `namedRange` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", | |
904 "format": "google-fieldmask", | |
905 "type": "string" | |
906 }, | |
907 "namedRange": { | |
908 "$ref": "NamedRange", | |
909 "description": "The named range to update with the new prope
rties." | |
910 } | |
911 }, | |
912 "type": "object" | |
913 }, | |
914 "UpdateValuesResponse": { | |
915 "description": "The response when updating a range of values in a sp
readsheet.", | |
916 "id": "UpdateValuesResponse", | |
917 "properties": { | |
918 "updatedColumns": { | |
919 "description": "The number of columns where at least one cel
l in the column was updated.", | |
920 "format": "int32", | |
921 "type": "integer" | |
922 }, | |
923 "updatedCells": { | |
924 "description": "The number of cells updated.", | |
925 "format": "int32", | |
926 "type": "integer" | |
927 }, | |
928 "updatedData": { | |
929 "$ref": "ValueRange", | |
930 "description": "The values of the cells after updates were a
pplied.\nThis is only included if the request's `includeValuesInResponse` field\
nwas `true`." | |
931 }, | |
932 "updatedRange": { | |
933 "description": "The range (in A1 notation) that updates were
applied to.", | |
934 "type": "string" | |
935 }, | |
936 "spreadsheetId": { | |
937 "description": "The spreadsheet the updates were applied to.
", | |
938 "type": "string" | |
939 }, | |
940 "updatedRows": { | |
941 "description": "The number of rows where at least one cell i
n the row was updated.", | |
942 "format": "int32", | |
943 "type": "integer" | |
944 } | |
945 }, | |
946 "type": "object" | |
947 }, | |
948 "SpreadsheetProperties": { | |
949 "description": "Properties of a spreadsheet.", | |
950 "id": "SpreadsheetProperties", | |
951 "properties": { | |
952 "timeZone": { | |
953 "description": "The time zone of the spreadsheet, in CLDR fo
rmat such as\n`America/New_York`. If the time zone isn't recognized, this may\nb
e a custom time zone such as `GMT-07:00`.", | |
954 "type": "string" | |
955 }, | |
956 "autoRecalc": { | |
957 "description": "The amount of time to wait before volatile f
unctions are recalculated.", | |
958 "enum": [ | 952 "enum": [ |
959 "RECALCULATION_INTERVAL_UNSPECIFIED", | 953 "NORMAL", |
960 "ON_CHANGE", | 954 "TRANSPOSE" |
961 "MINUTE", | |
962 "HOUR" | |
963 ], | 955 ], |
964 "enumDescriptions": [ | 956 "enumDescriptions": [ |
965 "Default value. This value must not be used.", | 957 "Paste normally.", |
966 "Volatile functions are updated on every change.", | 958 "Paste transposed, where all rows become columns and vic
e versa." |
967 "Volatile functions are updated on every change and ever
y minute.", | 959 ], |
968 "Volatile functions are updated on every change and hour
ly." | 960 "type": "string" |
969 ], | 961 }, |
970 "type": "string" | |
971 }, | |
972 "locale": { | |
973 "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.", | |
974 "type": "string" | |
975 }, | |
976 "title": { | |
977 "description": "The title of the spreadsheet.", | |
978 "type": "string" | |
979 }, | |
980 "defaultFormat": { | |
981 "$ref": "CellFormat", | |
982 "description": "The default format of all cells in the sprea
dsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal
to this default format.\nThis field is read-only." | |
983 } | |
984 }, | |
985 "type": "object" | |
986 }, | |
987 "CellData": { | |
988 "description": "Data about a specific cell.", | |
989 "id": "CellData", | |
990 "properties": { | |
991 "hyperlink": { | |
992 "description": "A hyperlink this cell points to, if any.\nTh
is field is read-only. (To set it, use a `=HYPERLINK` formula.)", | |
993 "type": "string" | |
994 }, | |
995 "effectiveFormat": { | |
996 "$ref": "CellFormat", | |
997 "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." | |
998 }, | |
999 "note": { | |
1000 "description": "Any note on the cell.", | |
1001 "type": "string" | |
1002 }, | |
1003 "formattedValue": { | |
1004 "description": "The formatted value of the cell.\nThis is th
e value as it's shown to the user.\nThis field is read-only.", | |
1005 "type": "string" | |
1006 }, | |
1007 "userEnteredValue": { | |
1008 "$ref": "ExtendedValue", | |
1009 "description": "The value the user entered in the cell. e.g,
`1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represente
d as doubles in\nserial number format." | |
1010 }, | |
1011 "dataValidation": { | |
1012 "$ref": "DataValidationRule", | |
1013 "description": "A data validation rule on the cell, if any.\
n\nWhen writing, the new data validation rule will overwrite any prior rule." | |
1014 }, | |
1015 "userEnteredFormat": { | |
1016 "$ref": "CellFormat", | |
1017 "description": "The format the user entered for the cell.\n\
nWhen writing, the new format will be merged with the existing format." | |
1018 }, | |
1019 "pivotTable": { | |
1020 "$ref": "PivotTable", | |
1021 "description": "A pivot table anchored at this cell. The siz
e of pivot table itself\nis computed dynamically based on its data, grouping, fi
lters, values,\netc. Only the top-left cell of the pivot table contains the pivo
t table\ndefinition. The other cells will contain the calculated values of the\n
results of the pivot in their effective_value fields." | |
1022 }, | |
1023 "textFormatRuns": { | |
1024 "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 nex
t\nrun. Properties of a run will continue unless explicitly changed\nin a subseq
uent run (and properties of the first run will continue\nthe properties of the c
ell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any
prior runs. When writing a\nnew user_entered_value, previous runs will be eras
ed.", | |
1025 "items": { | |
1026 "$ref": "TextFormatRun" | |
1027 }, | |
1028 "type": "array" | |
1029 }, | |
1030 "effectiveValue": { | |
1031 "$ref": "ExtendedValue", | |
1032 "description": "The effective value of the cell. For cells w
ith formulas, this will be\nthe calculated value. For cells with literals, this
will be\nthe same as the user_entered_value.\nThis field is read-only." | |
1033 } | |
1034 }, | |
1035 "type": "object" | |
1036 }, | |
1037 "UnmergeCellsRequest": { | |
1038 "description": "Unmerges cells in the given range.", | |
1039 "id": "UnmergeCellsRequest", | |
1040 "properties": { | |
1041 "range": { | |
1042 "$ref": "GridRange", | |
1043 "description": "The range within which all cells should be u
nmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range m
ust not partially span any merge." | |
1044 } | |
1045 }, | |
1046 "type": "object" | |
1047 }, | |
1048 "TextToColumnsRequest": { | |
1049 "description": "Splits a column of text into multiple columns,\nbase
d on a delimiter in each cell.", | |
1050 "id": "TextToColumnsRequest", | |
1051 "properties": { | |
1052 "source": { | 962 "source": { |
1053 "$ref": "GridRange", | 963 "$ref": "GridRange", |
1054 "description": "The source data range. This must span exact
ly one column." | 964 "description": "The source range to copy." |
1055 }, | 965 }, |
1056 "delimiter": { | 966 "pasteType": { |
1057 "description": "The delimiter to use. Used only if delimiter
Type is\nCUSTOM.", | 967 "description": "What kind of data to paste.", |
1058 "type": "string" | |
1059 }, | |
1060 "delimiterType": { | |
1061 "description": "The delimiter type to use.", | |
1062 "enum": [ | 968 "enum": [ |
1063 "DELIMITER_TYPE_UNSPECIFIED", | 969 "PASTE_NORMAL", |
1064 "COMMA", | 970 "PASTE_VALUES", |
1065 "SEMICOLON", | 971 "PASTE_FORMAT", |
1066 "PERIOD", | 972 "PASTE_NO_BORDERS", |
1067 "SPACE", | 973 "PASTE_FORMULA", |
1068 "CUSTOM" | 974 "PASTE_DATA_VALIDATION", |
| 975 "PASTE_CONDITIONAL_FORMATTING" |
1069 ], | 976 ], |
1070 "enumDescriptions": [ | 977 "enumDescriptions": [ |
1071 "Default value. This value must not be used.", | 978 "Paste values, formulas, formats, and merges.", |
1072 "\",\"", | 979 "Paste the values ONLY without formats, formulas, or mer
ges.", |
1073 "\";\"", | 980 "Paste the format and data validation only.", |
1074 "\".\"", | 981 "Like PASTE_NORMAL but without borders.", |
1075 "\" \"", | 982 "Paste the formulas only.", |
1076 "A custom value as defined in delimiter." | 983 "Paste the data validation only.", |
1077 ], | 984 "Paste the conditional formatting rules only." |
1078 "type": "string" | 985 ], |
1079 } | 986 "type": "string" |
1080 }, | 987 } |
1081 "type": "object" | 988 }, |
1082 }, | 989 "type": "object" |
1083 "AddProtectedRangeResponse": { | 990 }, |
1084 "description": "The result of adding a new protected range.", | 991 "Request": { |
1085 "id": "AddProtectedRangeResponse", | 992 "description": "A single kind of update to apply to a spreadsheet.", |
1086 "properties": { | 993 "id": "Request", |
1087 "protectedRange": { | 994 "properties": { |
1088 "$ref": "ProtectedRange", | 995 "appendDimension": { |
1089 "description": "The newly added protected range." | 996 "$ref": "AppendDimensionRequest", |
1090 } | 997 "description": "Appends dimensions to the end of a sheet." |
1091 }, | 998 }, |
1092 "type": "object" | 999 "updateConditionalFormatRule": { |
1093 }, | 1000 "$ref": "UpdateConditionalFormatRuleRequest", |
| 1001 "description": "Updates an existing conditional format rule.
" |
| 1002 }, |
| 1003 "insertRange": { |
| 1004 "$ref": "InsertRangeRequest", |
| 1005 "description": "Inserts new cells in a sheet, shifting the e
xisting cells." |
| 1006 }, |
| 1007 "moveDimension": { |
| 1008 "$ref": "MoveDimensionRequest", |
| 1009 "description": "Moves rows or columns to another location in
a sheet." |
| 1010 }, |
| 1011 "updateBanding": { |
| 1012 "$ref": "UpdateBandingRequest", |
| 1013 "description": "Updates a banded range" |
| 1014 }, |
| 1015 "deleteNamedRange": { |
| 1016 "$ref": "DeleteNamedRangeRequest", |
| 1017 "description": "Deletes a named range." |
| 1018 }, |
| 1019 "addProtectedRange": { |
| 1020 "$ref": "AddProtectedRangeRequest", |
| 1021 "description": "Adds a protected range." |
| 1022 }, |
| 1023 "duplicateSheet": { |
| 1024 "$ref": "DuplicateSheetRequest", |
| 1025 "description": "Duplicates a sheet." |
| 1026 }, |
| 1027 "deleteSheet": { |
| 1028 "$ref": "DeleteSheetRequest", |
| 1029 "description": "Deletes a sheet." |
| 1030 }, |
| 1031 "unmergeCells": { |
| 1032 "$ref": "UnmergeCellsRequest", |
| 1033 "description": "Unmerges merged cells." |
| 1034 }, |
| 1035 "updateEmbeddedObjectPosition": { |
| 1036 "$ref": "UpdateEmbeddedObjectPositionRequest", |
| 1037 "description": "Updates an embedded object's (e.g. chart, im
age) position." |
| 1038 }, |
| 1039 "updateDimensionProperties": { |
| 1040 "$ref": "UpdateDimensionPropertiesRequest", |
| 1041 "description": "Updates dimensions' properties." |
| 1042 }, |
| 1043 "pasteData": { |
| 1044 "$ref": "PasteDataRequest", |
| 1045 "description": "Pastes data (HTML or delimited) into a sheet
." |
| 1046 }, |
| 1047 "setBasicFilter": { |
| 1048 "$ref": "SetBasicFilterRequest", |
| 1049 "description": "Sets the basic filter on a sheet." |
| 1050 }, |
| 1051 "addConditionalFormatRule": { |
| 1052 "$ref": "AddConditionalFormatRuleRequest", |
| 1053 "description": "Adds a new conditional format rule." |
| 1054 }, |
| 1055 "updateCells": { |
| 1056 "$ref": "UpdateCellsRequest", |
| 1057 "description": "Updates many cells at once." |
| 1058 }, |
| 1059 "addNamedRange": { |
| 1060 "$ref": "AddNamedRangeRequest", |
| 1061 "description": "Adds a named range." |
| 1062 }, |
| 1063 "updateSpreadsheetProperties": { |
| 1064 "$ref": "UpdateSpreadsheetPropertiesRequest", |
| 1065 "description": "Updates the spreadsheet's properties." |
| 1066 }, |
| 1067 "deleteEmbeddedObject": { |
| 1068 "$ref": "DeleteEmbeddedObjectRequest", |
| 1069 "description": "Deletes an embedded object (e.g, chart, imag
e) in a sheet." |
| 1070 }, |
| 1071 "updateFilterView": { |
| 1072 "$ref": "UpdateFilterViewRequest", |
| 1073 "description": "Updates the properties of a filter view." |
| 1074 }, |
| 1075 "addBanding": { |
| 1076 "$ref": "AddBandingRequest", |
| 1077 "description": "Adds a new banded range" |
| 1078 }, |
| 1079 "autoResizeDimensions": { |
| 1080 "$ref": "AutoResizeDimensionsRequest", |
| 1081 "description": "Automatically resizes one or more dimensions
based on the contents\nof the cells in that dimension." |
| 1082 }, |
| 1083 "appendCells": { |
| 1084 "$ref": "AppendCellsRequest", |
| 1085 "description": "Appends cells after the last row with data i
n a sheet." |
| 1086 }, |
| 1087 "cutPaste": { |
| 1088 "$ref": "CutPasteRequest", |
| 1089 "description": "Cuts data from one area and pastes it to ano
ther." |
| 1090 }, |
| 1091 "mergeCells": { |
| 1092 "$ref": "MergeCellsRequest", |
| 1093 "description": "Merges cells together." |
| 1094 }, |
| 1095 "updateNamedRange": { |
| 1096 "$ref": "UpdateNamedRangeRequest", |
| 1097 "description": "Updates a named range." |
| 1098 }, |
| 1099 "updateSheetProperties": { |
| 1100 "$ref": "UpdateSheetPropertiesRequest", |
| 1101 "description": "Updates a sheet's properties." |
| 1102 }, |
| 1103 "autoFill": { |
| 1104 "$ref": "AutoFillRequest", |
| 1105 "description": "Automatically fills in more data based on ex
isting data." |
| 1106 }, |
| 1107 "deleteDimension": { |
| 1108 "$ref": "DeleteDimensionRequest", |
| 1109 "description": "Deletes rows or columns in a sheet." |
| 1110 }, |
| 1111 "sortRange": { |
| 1112 "$ref": "SortRangeRequest", |
| 1113 "description": "Sorts data in a range." |
| 1114 }, |
| 1115 "deleteProtectedRange": { |
| 1116 "$ref": "DeleteProtectedRangeRequest", |
| 1117 "description": "Deletes a protected range." |
| 1118 }, |
| 1119 "duplicateFilterView": { |
| 1120 "$ref": "DuplicateFilterViewRequest", |
| 1121 "description": "Duplicates a filter view." |
| 1122 }, |
| 1123 "addChart": { |
| 1124 "$ref": "AddChartRequest", |
| 1125 "description": "Adds a chart." |
| 1126 }, |
| 1127 "findReplace": { |
| 1128 "$ref": "FindReplaceRequest", |
| 1129 "description": "Finds and replaces occurrences of some text
with other text." |
| 1130 }, |
| 1131 "textToColumns": { |
| 1132 "$ref": "TextToColumnsRequest", |
| 1133 "description": "Converts a column of text into many columns
of text." |
| 1134 }, |
| 1135 "updateChartSpec": { |
| 1136 "$ref": "UpdateChartSpecRequest", |
| 1137 "description": "Updates a chart's specifications." |
| 1138 }, |
| 1139 "addSheet": { |
| 1140 "$ref": "AddSheetRequest", |
| 1141 "description": "Adds a sheet." |
| 1142 }, |
| 1143 "updateProtectedRange": { |
| 1144 "$ref": "UpdateProtectedRangeRequest", |
| 1145 "description": "Updates a protected range." |
| 1146 }, |
| 1147 "deleteFilterView": { |
| 1148 "$ref": "DeleteFilterViewRequest", |
| 1149 "description": "Deletes a filter view from a sheet." |
| 1150 }, |
| 1151 "copyPaste": { |
| 1152 "$ref": "CopyPasteRequest", |
| 1153 "description": "Copies data from one area and pastes it to a
nother." |
| 1154 }, |
| 1155 "insertDimension": { |
| 1156 "$ref": "InsertDimensionRequest", |
| 1157 "description": "Inserts new rows or columns in a sheet." |
| 1158 }, |
| 1159 "deleteRange": { |
| 1160 "$ref": "DeleteRangeRequest", |
| 1161 "description": "Deletes a range of cells from a sheet, shift
ing the remaining cells." |
| 1162 }, |
| 1163 "deleteBanding": { |
| 1164 "$ref": "DeleteBandingRequest", |
| 1165 "description": "Removes a banded range" |
| 1166 }, |
| 1167 "addFilterView": { |
| 1168 "$ref": "AddFilterViewRequest", |
| 1169 "description": "Adds a filter view." |
| 1170 }, |
| 1171 "updateBorders": { |
| 1172 "$ref": "UpdateBordersRequest", |
| 1173 "description": "Updates the borders in a range of cells." |
| 1174 }, |
| 1175 "setDataValidation": { |
| 1176 "$ref": "SetDataValidationRequest", |
| 1177 "description": "Sets data validation for one or more cells." |
| 1178 }, |
| 1179 "deleteConditionalFormatRule": { |
| 1180 "$ref": "DeleteConditionalFormatRuleRequest", |
| 1181 "description": "Deletes an existing conditional format rule.
" |
| 1182 }, |
| 1183 "repeatCell": { |
| 1184 "$ref": "RepeatCellRequest", |
| 1185 "description": "Repeats a single cell across a range." |
| 1186 }, |
| 1187 "clearBasicFilter": { |
| 1188 "$ref": "ClearBasicFilterRequest", |
| 1189 "description": "Clears the basic filter on a sheet." |
| 1190 } |
| 1191 }, |
| 1192 "type": "object" |
| 1193 }, |
1094 "BooleanCondition": { | 1194 "BooleanCondition": { |
1095 "description": "A condition that can evaluate to true or false.\nBoo
leanConditions are used by conditional formatting,\ndata validation, and the cri
teria in filters.", | 1195 "description": "A condition that can evaluate to true or false.\nBoo
leanConditions are used by conditional formatting,\ndata validation, and the cri
teria in filters.", |
1096 "id": "BooleanCondition", | 1196 "id": "BooleanCondition", |
1097 "properties": { | 1197 "properties": { |
1098 "values": { | |
1099 "description": "The values of the condition. The number of s
upported values depends\non the condition type. Some support zero values,\nothe
rs one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary numbe
r of values.", | |
1100 "items": { | |
1101 "$ref": "ConditionValue" | |
1102 }, | |
1103 "type": "array" | |
1104 }, | |
1105 "type": { | 1198 "type": { |
1106 "description": "The type of condition.", | 1199 "description": "The type of condition.", |
1107 "enum": [ | 1200 "enum": [ |
1108 "CONDITION_TYPE_UNSPECIFIED", | 1201 "CONDITION_TYPE_UNSPECIFIED", |
1109 "NUMBER_GREATER", | 1202 "NUMBER_GREATER", |
1110 "NUMBER_GREATER_THAN_EQ", | 1203 "NUMBER_GREATER_THAN_EQ", |
1111 "NUMBER_LESS", | 1204 "NUMBER_LESS", |
1112 "NUMBER_LESS_THAN_EQ", | 1205 "NUMBER_LESS_THAN_EQ", |
1113 "NUMBER_EQ", | 1206 "NUMBER_EQ", |
1114 "NUMBER_NOT_EQ", | 1207 "NUMBER_NOT_EQ", |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1160 "The cell's value must be between the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", | 1253 "The cell's value must be between the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", |
1161 "The cell's value must be outside the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", | 1254 "The cell's value must be outside the dates of the two c
ondition values.\nSupported by data validation.\nRequires exactly two ConditionV
alues.", |
1162 "The cell's value must be a date.\nSupported by data val
idation.\nRequires no ConditionValues.", | 1255 "The cell's value must be a date.\nSupported by data val
idation.\nRequires no ConditionValues.", |
1163 "The cell's value must be listed in the grid in conditio
n value's range.\nSupported by data validation.\nRequires a single ConditionValu
e,\nand the value must be a valid range in A1 notation.", | 1256 "The cell's value must be listed in the grid in conditio
n value's range.\nSupported by data validation.\nRequires a single ConditionValu
e,\nand the value must be a valid range in A1 notation.", |
1164 "The cell's value must in the list of condition values.\
nSupported by data validation.\nSupports any number of condition values,\none pe
r item in the list.\nFormulas are not supported in the values.", | 1257 "The cell's value must in the list of condition values.\
nSupported by data validation.\nSupports any number of condition values,\none pe
r item in the list.\nFormulas are not supported in the values.", |
1165 "The cell's value must be empty.\nSupported by condition
al formatting and filters.\nRequires no ConditionValues.", | 1258 "The cell's value must be empty.\nSupported by condition
al formatting and filters.\nRequires no ConditionValues.", |
1166 "The cell's value must not be empty.\nSupported by condi
tional formatting and filters.\nRequires no ConditionValues.", | 1259 "The cell's value must not be empty.\nSupported by condi
tional formatting and filters.\nRequires no ConditionValues.", |
1167 "The condition's formula must evaluate to true.\nSupport
ed by data validation, conditional formatting and filters.\nRequires a single Co
nditionValue." | 1260 "The condition's formula must evaluate to true.\nSupport
ed by data validation, conditional formatting and filters.\nRequires a single Co
nditionValue." |
1168 ], | 1261 ], |
1169 "type": "string" | 1262 "type": "string" |
1170 } | 1263 }, |
1171 }, | 1264 "values": { |
1172 "type": "object" | 1265 "description": "The values of the condition. The number of s
upported values depends\non the condition type. Some support zero values,\nothe
rs one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary numbe
r of values.", |
1173 }, | 1266 "items": { |
1174 "DeleteProtectedRangeRequest": { | 1267 "$ref": "ConditionValue" |
1175 "description": "Deletes the protected range with the given ID.", | 1268 }, |
1176 "id": "DeleteProtectedRangeRequest", | 1269 "type": "array" |
1177 "properties": { | 1270 } |
1178 "protectedRangeId": { | 1271 }, |
1179 "description": "The ID of the protected range to delete.", | 1272 "type": "object" |
1180 "format": "int32", | 1273 }, |
1181 "type": "integer" | 1274 "GridRange": { |
1182 } | 1275 "description": "A range on a sheet.\nAll indexes are zero-based.\nIn
dexes are half open, e.g the start index is inclusive\nand the end index is excl
usive -- [start_index, end_index).\nMissing indexes indicate the range is unboun
ded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `She
et1!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!A
3: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\n
The start index must always be less than or equal to the end index.\nIf the star
t index equals the end index, then the range is empty.\nEmpty ranges are typical
ly not meaningful and are usually rendered in the\nUI as `#REF!`.", |
1183 }, | 1276 "id": "GridRange", |
1184 "type": "object" | 1277 "properties": { |
1185 }, | 1278 "endRowIndex": { |
1186 "BasicChartDomain": { | 1279 "description": "The end row (exclusive) of the range, or not
set if unbounded.", |
1187 "description": "The domain of a chart.\nFor example, if charting sto
ck prices over time, this would be the date.", | 1280 "format": "int32", |
1188 "id": "BasicChartDomain", | 1281 "type": "integer" |
1189 "properties": { | 1282 }, |
1190 "domain": { | 1283 "endColumnIndex": { |
1191 "$ref": "ChartData", | 1284 "description": "The end column (exclusive) of the range, or
not set if unbounded.", |
1192 "description": "The data of the domain. For example, if char
ting stock prices over time,\nthis is the data representing the dates." | 1285 "format": "int32", |
1193 } | 1286 "type": "integer" |
1194 }, | 1287 }, |
1195 "type": "object" | 1288 "startRowIndex": { |
1196 }, | 1289 "description": "The start row (inclusive) of the range, or n
ot set if unbounded.", |
1197 "DimensionRange": { | 1290 "format": "int32", |
1198 "description": "A range along a single dimension on a sheet.\nAll in
dexes 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.", | 1291 "type": "integer" |
1199 "id": "DimensionRange", | 1292 }, |
1200 "properties": { | 1293 "startColumnIndex": { |
| 1294 "description": "The start column (inclusive) of the range, o
r not set if unbounded.", |
| 1295 "format": "int32", |
| 1296 "type": "integer" |
| 1297 }, |
1201 "sheetId": { | 1298 "sheetId": { |
1202 "description": "The sheet this span is on.", | 1299 "description": "The sheet this range is on.", |
1203 "format": "int32", | 1300 "format": "int32", |
1204 "type": "integer" | 1301 "type": "integer" |
1205 }, | 1302 } |
1206 "endIndex": { | 1303 }, |
1207 "description": "The end (exclusive) of the span, or not set
if unbounded.", | 1304 "type": "object" |
1208 "format": "int32", | 1305 }, |
1209 "type": "integer" | 1306 "BasicChartSpec": { |
1210 }, | 1307 "description": "The specification for a basic chart. See BasicChart
Type for the list\nof charts this supports.", |
1211 "startIndex": { | 1308 "id": "BasicChartSpec", |
1212 "description": "The start (inclusive) of the span, or not se
t if unbounded.", | 1309 "properties": { |
1213 "format": "int32", | 1310 "domains": { |
1214 "type": "integer" | 1311 "description": "The domain of data this is charting.\nOnly a
single domain is currently supported.", |
1215 }, | 1312 "items": { |
1216 "dimension": { | 1313 "$ref": "BasicChartDomain" |
1217 "description": "The dimension of the span.", | 1314 }, |
| 1315 "type": "array" |
| 1316 }, |
| 1317 "headerCount": { |
| 1318 "description": "The number of rows or columns in the data th
at are \"headers\".\nIf not set, Google Sheets will guess how many rows are head
ers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis
title\n inferred from the header values.)", |
| 1319 "format": "int32", |
| 1320 "type": "integer" |
| 1321 }, |
| 1322 "axis": { |
| 1323 "description": "The axis on the chart.", |
| 1324 "items": { |
| 1325 "$ref": "BasicChartAxis" |
| 1326 }, |
| 1327 "type": "array" |
| 1328 }, |
| 1329 "chartType": { |
| 1330 "description": "The type of the chart.", |
1218 "enum": [ | 1331 "enum": [ |
1219 "DIMENSION_UNSPECIFIED", | 1332 "BASIC_CHART_TYPE_UNSPECIFIED", |
1220 "ROWS", | 1333 "BAR", |
1221 "COLUMNS" | 1334 "LINE", |
| 1335 "AREA", |
| 1336 "COLUMN", |
| 1337 "SCATTER", |
| 1338 "COMBO" |
1222 ], | 1339 ], |
1223 "enumDescriptions": [ | 1340 "enumDescriptions": [ |
1224 "The default value, do not use.", | 1341 "Default value, do not use.", |
1225 "Operates on the rows of a sheet.", | 1342 "A <a href=\"/chart/interactive/docs/gallery/barchart\">
bar chart</a>.", |
1226 "Operates on the columns of a sheet." | 1343 "A <a href=\"/chart/interactive/docs/gallery/linechart\"
>line chart</a>.", |
1227 ], | 1344 "An <a href=\"/chart/interactive/docs/gallery/areachart\
">area chart</a>.", |
1228 "type": "string" | 1345 "A <a href=\"/chart/interactive/docs/gallery/columnchart
\">column chart</a>.", |
1229 } | 1346 "A <a href=\"/chart/interactive/docs/gallery/scatterchar
t\">scatter chart</a>.", |
1230 }, | 1347 "A <a href=\"/chart/interactive/docs/gallery/combochart\
">combo chart</a>." |
1231 "type": "object" | 1348 ], |
1232 }, | 1349 "type": "string" |
1233 "Response": { | 1350 }, |
1234 "description": "A single response from an update.", | 1351 "series": { |
1235 "id": "Response", | 1352 "description": "The data this chart is visualizing.", |
1236 "properties": { | 1353 "items": { |
1237 "updateEmbeddedObjectPosition": { | 1354 "$ref": "BasicChartSeries" |
1238 "$ref": "UpdateEmbeddedObjectPositionResponse", | 1355 }, |
1239 "description": "A reply from updating an embedded object's p
osition." | 1356 "type": "array" |
1240 }, | 1357 }, |
1241 "addFilterView": { | 1358 "legendPosition": { |
1242 "$ref": "AddFilterViewResponse", | 1359 "description": "The position of the chart legend.", |
1243 "description": "A reply from adding a filter view." | 1360 "enum": [ |
1244 }, | 1361 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED", |
1245 "addSheet": { | 1362 "BOTTOM_LEGEND", |
1246 "$ref": "AddSheetResponse", | 1363 "LEFT_LEGEND", |
1247 "description": "A reply from adding a sheet." | 1364 "RIGHT_LEGEND", |
1248 }, | 1365 "TOP_LEGEND", |
1249 "findReplace": { | 1366 "NO_LEGEND" |
1250 "$ref": "FindReplaceResponse", | 1367 ], |
1251 "description": "A reply from doing a find/replace." | 1368 "enumDescriptions": [ |
1252 }, | 1369 "Default value, do not use.", |
1253 "addProtectedRange": { | 1370 "The legend is rendered on the bottom of the chart.", |
1254 "$ref": "AddProtectedRangeResponse", | 1371 "The legend is rendered on the left of the chart.", |
1255 "description": "A reply from adding a protected range." | 1372 "The legend is rendered on the right of the chart.", |
1256 }, | 1373 "The legend is rendered on the top of the chart.", |
1257 "updateConditionalFormatRule": { | 1374 "No legend is rendered." |
1258 "$ref": "UpdateConditionalFormatRuleResponse", | 1375 ], |
1259 "description": "A reply from updating a conditional format r
ule." | 1376 "type": "string" |
1260 }, | 1377 } |
1261 "addChart": { | 1378 }, |
1262 "$ref": "AddChartResponse", | 1379 "type": "object" |
1263 "description": "A reply from adding a chart." | 1380 }, |
1264 }, | 1381 "SetDataValidationRequest": { |
1265 "deleteConditionalFormatRule": { | 1382 "description": "Sets a data validation rule to every cell in the ran
ge.\nTo clear validation in a range, call this with no rule specified.", |
1266 "$ref": "DeleteConditionalFormatRuleResponse", | 1383 "id": "SetDataValidationRequest", |
1267 "description": "A reply from deleting a conditional format r
ule." | |
1268 }, | |
1269 "addBanding": { | |
1270 "$ref": "AddBandingResponse", | |
1271 "description": "A reply from adding a banded range." | |
1272 }, | |
1273 "duplicateSheet": { | |
1274 "$ref": "DuplicateSheetResponse", | |
1275 "description": "A reply from duplicating a sheet." | |
1276 }, | |
1277 "duplicateFilterView": { | |
1278 "$ref": "DuplicateFilterViewResponse", | |
1279 "description": "A reply from duplicating a filter view." | |
1280 }, | |
1281 "addNamedRange": { | |
1282 "$ref": "AddNamedRangeResponse", | |
1283 "description": "A reply from adding a named range." | |
1284 } | |
1285 }, | |
1286 "type": "object" | |
1287 }, | |
1288 "AddConditionalFormatRuleRequest": { | |
1289 "description": "Adds a new conditional format rule at the given inde
x.\nAll subsequent rules' indexes are incremented.", | |
1290 "id": "AddConditionalFormatRuleRequest", | |
1291 "properties": { | 1384 "properties": { |
1292 "rule": { | 1385 "rule": { |
1293 "$ref": "ConditionalFormatRule", | 1386 "$ref": "DataValidationRule", |
1294 "description": "The rule to add." | 1387 "description": "The data validation rule to set on each cell
in the range,\nor empty to clear the data validation in the range." |
1295 }, | |
1296 "index": { | |
1297 "description": "The zero-based index where the rule should b
e inserted.", | |
1298 "format": "int32", | |
1299 "type": "integer" | |
1300 } | |
1301 }, | |
1302 "type": "object" | |
1303 }, | |
1304 "FilterView": { | |
1305 "description": "A filter view.", | |
1306 "id": "FilterView", | |
1307 "properties": { | |
1308 "title": { | |
1309 "description": "The name of the filter view.", | |
1310 "type": "string" | |
1311 }, | |
1312 "namedRangeId": { | |
1313 "description": "The named range this filter view is backed b
y, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.", | |
1314 "type": "string" | |
1315 }, | |
1316 "sortSpecs": { | |
1317 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", | |
1318 "items": { | |
1319 "$ref": "SortSpec" | |
1320 }, | |
1321 "type": "array" | |
1322 }, | 1388 }, |
1323 "range": { | 1389 "range": { |
1324 "$ref": "GridRange", | 1390 "$ref": "GridRange", |
1325 "description": "The range this filter view covers.\n\nWhen w
riting, only one of range or named_range_id\nmay be set." | 1391 "description": "The range the data validation rule should ap
ply to." |
1326 }, | 1392 } |
1327 "criteria": { | 1393 }, |
1328 "additionalProperties": { | 1394 "type": "object" |
1329 "$ref": "FilterCriteria" | 1395 }, |
1330 }, | 1396 "CellData": { |
1331 "description": "The criteria for showing/hiding values per c
olumn.\nThe map's key is the column index, and the value is the criteria for\nth
at column.", | 1397 "description": "Data about a specific cell.", |
1332 "type": "object" | 1398 "id": "CellData", |
1333 }, | 1399 "properties": { |
1334 "filterViewId": { | 1400 "pivotTable": { |
1335 "description": "The ID of the filter view.", | 1401 "$ref": "PivotTable", |
1336 "format": "int32", | 1402 "description": "A pivot table anchored at this cell. The siz
e of pivot table itself\nis computed dynamically based on its data, grouping, fi
lters, values,\netc. Only the top-left cell of the pivot table contains the pivo
t table\ndefinition. The other cells will contain the calculated values of the\n
results of the pivot in their effective_value fields." |
1337 "type": "integer" | 1403 }, |
1338 } | 1404 "userEnteredFormat": { |
1339 }, | 1405 "$ref": "CellFormat", |
1340 "type": "object" | 1406 "description": "The format the user entered for the cell.\n\
nWhen writing, the new format will be merged with the existing format." |
1341 }, | 1407 }, |
1342 "SortRangeRequest": { | 1408 "note": { |
1343 "description": "Sorts data in rows based on a sort order per column.
", | 1409 "description": "Any note on the cell.", |
1344 "id": "SortRangeRequest", | 1410 "type": "string" |
1345 "properties": { | 1411 }, |
1346 "range": { | 1412 "effectiveFormat": { |
1347 "$ref": "GridRange", | 1413 "$ref": "CellFormat", |
1348 "description": "The range to sort." | 1414 "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." |
1349 }, | 1415 }, |
1350 "sortSpecs": { | 1416 "userEnteredValue": { |
1351 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", | 1417 "$ref": "ExtendedValue", |
1352 "items": { | 1418 "description": "The value the user entered in the cell. e.g,
`1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represente
d as doubles in\nserial number format." |
1353 "$ref": "SortSpec" | 1419 }, |
1354 }, | 1420 "dataValidation": { |
1355 "type": "array" | 1421 "$ref": "DataValidationRule", |
1356 } | 1422 "description": "A data validation rule on the cell, if any.\
n\nWhen writing, the new data validation rule will overwrite any prior rule." |
1357 }, | 1423 }, |
1358 "type": "object" | 1424 "effectiveValue": { |
1359 }, | 1425 "$ref": "ExtendedValue", |
1360 "AddBandingResponse": { | 1426 "description": "The effective value of the cell. For cells w
ith formulas, this will be\nthe calculated value. For cells with literals, this
will be\nthe same as the user_entered_value.\nThis field is read-only." |
1361 "description": "The result of adding a banded range.", | 1427 }, |
1362 "id": "AddBandingResponse", | 1428 "formattedValue": { |
1363 "properties": { | 1429 "description": "The formatted value of the cell.\nThis is th
e value as it's shown to the user.\nThis field is read-only.", |
1364 "bandedRange": { | 1430 "type": "string" |
1365 "$ref": "BandedRange", | 1431 }, |
1366 "description": "The banded range that was added." | 1432 "textFormatRuns": { |
1367 } | 1433 "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 nex
t\nrun. Properties of a run will continue unless explicitly changed\nin a subseq
uent run (and properties of the first run will continue\nthe properties of the c
ell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any
prior runs. When writing a\nnew user_entered_value, previous runs will be eras
ed.", |
1368 }, | 1434 "items": { |
1369 "type": "object" | 1435 "$ref": "TextFormatRun" |
1370 }, | 1436 }, |
1371 "TextFormatRun": { | 1437 "type": "array" |
1372 "description": "A run of a text format. The format of this run conti
nues until the start\nindex of the next run.\nWhen updating, all fields must be
set.", | 1438 }, |
1373 "id": "TextFormatRun", | 1439 "hyperlink": { |
1374 "properties": { | 1440 "description": "A hyperlink this cell points to, if any.\nTh
is field is read-only. (To set it, use a `=HYPERLINK` formula.)", |
1375 "startIndex": { | 1441 "type": "string" |
1376 "description": "The character index where this run starts.", | 1442 } |
1377 "format": "int32", | 1443 }, |
1378 "type": "integer" | 1444 "type": "object" |
| 1445 }, |
| 1446 "BatchUpdateSpreadsheetRequest": { |
| 1447 "description": "The request for updating any aspect of a spreadsheet
.", |
| 1448 "id": "BatchUpdateSpreadsheetRequest", |
| 1449 "properties": { |
| 1450 "includeSpreadsheetInResponse": { |
| 1451 "description": "Determines if the update response should inc
lude the spreadsheet\nresource.", |
| 1452 "type": "boolean" |
| 1453 }, |
| 1454 "responseRanges": { |
| 1455 "description": "Limits the ranges included in the response s
preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.", |
| 1456 "items": { |
| 1457 "type": "string" |
| 1458 }, |
| 1459 "type": "array" |
| 1460 }, |
| 1461 "responseIncludeGridData": { |
| 1462 "description": "True if grid data should be returned. Meanin
gful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is igno
red if a field mask was set in the request.", |
| 1463 "type": "boolean" |
| 1464 }, |
| 1465 "requests": { |
| 1466 "description": "A list of updates to apply to the spreadshee
t.", |
| 1467 "items": { |
| 1468 "$ref": "Request" |
| 1469 }, |
| 1470 "type": "array" |
| 1471 } |
| 1472 }, |
| 1473 "type": "object" |
| 1474 }, |
| 1475 "BasicChartAxis": { |
| 1476 "description": "An axis of the chart.\nA chart may not have more tha
n one axis per\naxis position.", |
| 1477 "id": "BasicChartAxis", |
| 1478 "properties": { |
| 1479 "position": { |
| 1480 "description": "The position of this axis.", |
| 1481 "enum": [ |
| 1482 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED", |
| 1483 "BOTTOM_AXIS", |
| 1484 "LEFT_AXIS", |
| 1485 "RIGHT_AXIS" |
| 1486 ], |
| 1487 "enumDescriptions": [ |
| 1488 "Default value, do not use.", |
| 1489 "The axis rendered at the bottom of a chart.\nFor most c
harts, this is the standard major axis.\nFor bar charts, this is a minor axis.", |
| 1490 "The axis rendered at the left of a chart.\nFor most cha
rts, this is a minor axis.\nFor bar charts, this is the standard major axis.", |
| 1491 "The axis rendered at the right of a chart.\nFor most ch
arts, this is a minor axis.\nFor bar charts, this is an unusual major axis." |
| 1492 ], |
| 1493 "type": "string" |
| 1494 }, |
| 1495 "title": { |
| 1496 "description": "The title of this axis. If set, this overrid
es any title inferred\nfrom headers of the data.", |
| 1497 "type": "string" |
1379 }, | 1498 }, |
1380 "format": { | 1499 "format": { |
1381 "$ref": "TextFormat", | 1500 "$ref": "TextFormat", |
1382 "description": "The format of this run. Absent values inher
it the cell's format." | 1501 "description": "The format of the title.\nOnly valid if the
axis is not associated with the domain." |
1383 } | 1502 } |
1384 }, | 1503 }, |
1385 "type": "object" | 1504 "type": "object" |
1386 }, | 1505 }, |
1387 "UpdateFilterViewRequest": { | 1506 "Padding": { |
1388 "description": "Updates properties of the filter view.", | 1507 "description": "The amount of padding around the cell, in pixels.\nW
hen updating padding, every field must be specified.", |
1389 "id": "UpdateFilterViewRequest", | 1508 "id": "Padding", |
1390 "properties": { | 1509 "properties": { |
1391 "filter": { | 1510 "left": { |
1392 "$ref": "FilterView", | 1511 "description": "The left padding of the cell.", |
1393 "description": "The new properties of the filter view." | 1512 "format": "int32", |
1394 }, | 1513 "type": "integer" |
1395 "fields": { | 1514 }, |
1396 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `filter` is implied and should not be sp
ecified.\nA single `\"*\"` can be used as short-hand for listing every field.", | 1515 "right": { |
1397 "format": "google-fieldmask", | 1516 "description": "The right padding of the cell.", |
1398 "type": "string" | 1517 "format": "int32", |
1399 } | 1518 "type": "integer" |
1400 }, | 1519 }, |
1401 "type": "object" | 1520 "bottom": { |
1402 }, | 1521 "description": "The bottom padding of the cell.", |
1403 "UpdateConditionalFormatRuleResponse": { | 1522 "format": "int32", |
1404 "description": "The result of updating a conditional format rule.", | 1523 "type": "integer" |
1405 "id": "UpdateConditionalFormatRuleResponse", | 1524 }, |
1406 "properties": { | 1525 "top": { |
1407 "oldIndex": { | 1526 "description": "The top padding of the cell.", |
1408 "description": "The old index of the rule. Not set if a rule
was replaced\n(because it is the same as new_index).", | 1527 "format": "int32", |
1409 "format": "int32", | 1528 "type": "integer" |
1410 "type": "integer" | 1529 } |
1411 }, | 1530 }, |
1412 "newRule": { | 1531 "type": "object" |
1413 "$ref": "ConditionalFormatRule", | |
1414 "description": "The new rule that replaced the old rule (if
replacing),\nor the rule that was moved (if moved)" | |
1415 }, | |
1416 "oldRule": { | |
1417 "$ref": "ConditionalFormatRule", | |
1418 "description": "The old (deleted) rule. Not set if a rule wa
s moved\n(because it is the same as new_rule)." | |
1419 }, | |
1420 "newIndex": { | |
1421 "description": "The index of the new rule.", | |
1422 "format": "int32", | |
1423 "type": "integer" | |
1424 } | |
1425 }, | |
1426 "type": "object" | |
1427 }, | |
1428 "FilterCriteria": { | |
1429 "description": "Criteria for showing/hiding rows in a filter or filt
er view.", | |
1430 "id": "FilterCriteria", | |
1431 "properties": { | |
1432 "condition": { | |
1433 "$ref": "BooleanCondition", | |
1434 "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.)" | |
1435 }, | |
1436 "hiddenValues": { | |
1437 "description": "Values that should be hidden.", | |
1438 "items": { | |
1439 "type": "string" | |
1440 }, | |
1441 "type": "array" | |
1442 } | |
1443 }, | |
1444 "type": "object" | |
1445 }, | 1532 }, |
1446 "DeleteDimensionRequest": { | 1533 "DeleteDimensionRequest": { |
1447 "description": "Deletes the dimensions from the sheet.", | 1534 "description": "Deletes the dimensions from the sheet.", |
1448 "id": "DeleteDimensionRequest", | 1535 "id": "DeleteDimensionRequest", |
1449 "properties": { | 1536 "properties": { |
1450 "range": { | 1537 "range": { |
1451 "$ref": "DimensionRange", | 1538 "$ref": "DimensionRange", |
1452 "description": "The dimensions to delete from the sheet." | 1539 "description": "The dimensions to delete from the sheet." |
1453 } | 1540 } |
1454 }, | 1541 }, |
1455 "type": "object" | 1542 "type": "object" |
1456 }, | 1543 }, |
1457 "PivotTable": { | 1544 "UpdateChartSpecRequest": { |
1458 "description": "A pivot table.", | 1545 "description": "Updates a chart's specifications.\n(This does not mo
ve or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPosit
ionRequest.)", |
1459 "id": "PivotTable", | 1546 "id": "UpdateChartSpecRequest", |
1460 "properties": { | 1547 "properties": { |
1461 "valueLayout": { | 1548 "spec": { |
1462 "description": "Whether values should be listed horizontally
(as columns)\nor vertically (as rows).", | 1549 "$ref": "ChartSpec", |
| 1550 "description": "The specification to apply to the chart." |
| 1551 }, |
| 1552 "chartId": { |
| 1553 "description": "The ID of the chart to update.", |
| 1554 "format": "int32", |
| 1555 "type": "integer" |
| 1556 } |
| 1557 }, |
| 1558 "type": "object" |
| 1559 }, |
| 1560 "DeleteFilterViewRequest": { |
| 1561 "description": "Deletes a particular filter view.", |
| 1562 "id": "DeleteFilterViewRequest", |
| 1563 "properties": { |
| 1564 "filterId": { |
| 1565 "description": "The ID of the filter to delete.", |
| 1566 "format": "int32", |
| 1567 "type": "integer" |
| 1568 } |
| 1569 }, |
| 1570 "type": "object" |
| 1571 }, |
| 1572 "BatchUpdateValuesResponse": { |
| 1573 "description": "The response when updating a range of values in a sp
readsheet.", |
| 1574 "id": "BatchUpdateValuesResponse", |
| 1575 "properties": { |
| 1576 "totalUpdatedRows": { |
| 1577 "description": "The total number of rows where at least one
cell in the row was updated.", |
| 1578 "format": "int32", |
| 1579 "type": "integer" |
| 1580 }, |
| 1581 "responses": { |
| 1582 "description": "One UpdateValuesResponse per requested range
, in the same order as\nthe requests appeared.", |
| 1583 "items": { |
| 1584 "$ref": "UpdateValuesResponse" |
| 1585 }, |
| 1586 "type": "array" |
| 1587 }, |
| 1588 "totalUpdatedSheets": { |
| 1589 "description": "The total number of sheets where at least on
e cell in the sheet was\nupdated.", |
| 1590 "format": "int32", |
| 1591 "type": "integer" |
| 1592 }, |
| 1593 "totalUpdatedCells": { |
| 1594 "description": "The total number of cells updated.", |
| 1595 "format": "int32", |
| 1596 "type": "integer" |
| 1597 }, |
| 1598 "totalUpdatedColumns": { |
| 1599 "description": "The total number of columns where at least o
ne cell in the column was\nupdated.", |
| 1600 "format": "int32", |
| 1601 "type": "integer" |
| 1602 }, |
| 1603 "spreadsheetId": { |
| 1604 "description": "The spreadsheet the updates were applied to.
", |
| 1605 "type": "string" |
| 1606 } |
| 1607 }, |
| 1608 "type": "object" |
| 1609 }, |
| 1610 "SortRangeRequest": { |
| 1611 "description": "Sorts data in rows based on a sort order per column.
", |
| 1612 "id": "SortRangeRequest", |
| 1613 "properties": { |
| 1614 "range": { |
| 1615 "$ref": "GridRange", |
| 1616 "description": "The range to sort." |
| 1617 }, |
| 1618 "sortSpecs": { |
| 1619 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", |
| 1620 "items": { |
| 1621 "$ref": "SortSpec" |
| 1622 }, |
| 1623 "type": "array" |
| 1624 } |
| 1625 }, |
| 1626 "type": "object" |
| 1627 }, |
| 1628 "MergeCellsRequest": { |
| 1629 "description": "Merges all cells in the range.", |
| 1630 "id": "MergeCellsRequest", |
| 1631 "properties": { |
| 1632 "mergeType": { |
| 1633 "description": "How the cells should be merged.", |
1463 "enum": [ | 1634 "enum": [ |
1464 "HORIZONTAL", | 1635 "MERGE_ALL", |
1465 "VERTICAL" | 1636 "MERGE_COLUMNS", |
| 1637 "MERGE_ROWS" |
1466 ], | 1638 ], |
1467 "enumDescriptions": [ | 1639 "enumDescriptions": [ |
1468 "Values are laid out horizontally (as columns).", | 1640 "Create a single merge from the range", |
1469 "Values are laid out vertically (as rows)." | 1641 "Create a merge for each column in the range", |
1470 ], | 1642 "Create a merge for each row in the range" |
1471 "type": "string" | 1643 ], |
1472 }, | 1644 "type": "string" |
1473 "columns": { | 1645 }, |
1474 "description": "Each column grouping in the pivot table.", | 1646 "range": { |
1475 "items": { | |
1476 "$ref": "PivotGroup" | |
1477 }, | |
1478 "type": "array" | |
1479 }, | |
1480 "source": { | |
1481 "$ref": "GridRange", | 1647 "$ref": "GridRange", |
1482 "description": "The range the pivot table is reading data fr
om." | 1648 "description": "The range of cells to merge." |
1483 }, | 1649 } |
1484 "rows": { | 1650 }, |
1485 "description": "Each row grouping in the pivot table.", | 1651 "type": "object" |
1486 "items": { | 1652 }, |
1487 "$ref": "PivotGroup" | 1653 "AddProtectedRangeRequest": { |
1488 }, | 1654 "description": "Adds a new protected range.", |
1489 "type": "array" | 1655 "id": "AddProtectedRangeRequest", |
1490 }, | 1656 "properties": { |
1491 "values": { | 1657 "protectedRange": { |
1492 "description": "A list of values to include in the pivot tab
le.", | 1658 "$ref": "ProtectedRange", |
1493 "items": { | 1659 "description": "The protected range to be added. The\nprotec
tedRangeId field is optional; if\none is not set, an id will be randomly generat
ed. (It is an error to\nspecify the ID of a range that already exists.)" |
1494 "$ref": "PivotValue" | 1660 } |
1495 }, | 1661 }, |
1496 "type": "array" | 1662 "type": "object" |
1497 }, | 1663 }, |
1498 "criteria": { | 1664 "BatchClearValuesRequest": { |
1499 "additionalProperties": { | 1665 "description": "The request for clearing more than one range of valu
es in a spreadsheet.", |
1500 "$ref": "PivotFilterCriteria" | 1666 "id": "BatchClearValuesRequest", |
1501 }, | 1667 "properties": { |
1502 "description": "An optional mapping of filters per source co
lumn offset.\n\nThe filters will be applied before aggregating data into the piv
ot 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 th
e source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, where
as the key `1` is for column `D`.", | 1668 "ranges": { |
1503 "type": "object" | 1669 "description": "The ranges to clear, in A1 notation.", |
1504 } | 1670 "items": { |
1505 }, | 1671 "type": "string" |
1506 "type": "object" | 1672 }, |
1507 }, | 1673 "type": "array" |
1508 "DataValidationRule": { | 1674 } |
1509 "description": "A data validation rule.", | 1675 }, |
1510 "id": "DataValidationRule", | 1676 "type": "object" |
1511 "properties": { | 1677 }, |
1512 "condition": { | 1678 "DuplicateFilterViewResponse": { |
1513 "$ref": "BooleanCondition", | 1679 "description": "The result of a filter view being duplicated.", |
1514 "description": "The condition that data in the cell must mat
ch." | 1680 "id": "DuplicateFilterViewResponse", |
1515 }, | 1681 "properties": { |
1516 "inputMessage": { | 1682 "filter": { |
1517 "description": "A message to show the user when adding data
to the cell.", | 1683 "$ref": "FilterView", |
1518 "type": "string" | 1684 "description": "The newly created filter." |
1519 }, | 1685 } |
1520 "showCustomUi": { | 1686 }, |
1521 "description": "True if the UI should be customized based on
the kind of condition.\nIf true, \"List\" conditions will show a dropdown.", | 1687 "type": "object" |
1522 "type": "boolean" | 1688 }, |
1523 }, | 1689 "DuplicateSheetResponse": { |
1524 "strict": { | 1690 "description": "The result of duplicating a sheet.", |
1525 "description": "True if invalid data should be rejected.", | 1691 "id": "DuplicateSheetResponse", |
1526 "type": "boolean" | 1692 "properties": { |
1527 } | |
1528 }, | |
1529 "type": "object" | |
1530 }, | |
1531 "UpdateSpreadsheetPropertiesRequest": { | |
1532 "description": "Updates properties of a spreadsheet.", | |
1533 "id": "UpdateSpreadsheetPropertiesRequest", | |
1534 "properties": { | |
1535 "fields": { | |
1536 "description": "The fields that should be updated. At least
one field must be specified.\nThe root 'properties' is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", | |
1537 "format": "google-fieldmask", | |
1538 "type": "string" | |
1539 }, | |
1540 "properties": { | 1693 "properties": { |
1541 "$ref": "SpreadsheetProperties", | 1694 "$ref": "SheetProperties", |
1542 "description": "The properties to update." | 1695 "description": "The properties of the duplicate sheet." |
1543 } | |
1544 }, | |
1545 "type": "object" | |
1546 }, | |
1547 "ChartSourceRange": { | |
1548 "description": "Source ranges for a chart.", | |
1549 "id": "ChartSourceRange", | |
1550 "properties": { | |
1551 "sources": { | |
1552 "description": "The ranges of data for a series or domain.\n
Exactly 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 rang
e, then the source\nrange at a given offset must be contiguous across the domain
and series.\n\nFor example, these are valid configurations:\n\n domain sourc
es: 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 sourc
es: C1:C5, E10:E12", | |
1553 "items": { | |
1554 "$ref": "GridRange" | |
1555 }, | |
1556 "type": "array" | |
1557 } | |
1558 }, | |
1559 "type": "object" | |
1560 }, | |
1561 "BatchUpdateValuesRequest": { | |
1562 "description": "The request for updating more than one range of valu
es in a spreadsheet.", | |
1563 "id": "BatchUpdateValuesRequest", | |
1564 "properties": { | |
1565 "valueInputOption": { | |
1566 "description": "How the input data should be interpreted.", | |
1567 "enum": [ | |
1568 "INPUT_VALUE_OPTION_UNSPECIFIED", | |
1569 "RAW", | |
1570 "USER_ENTERED" | |
1571 ], | |
1572 "enumDescriptions": [ | |
1573 "Default input value. This value must not be used.", | |
1574 "The values the user has entered will not be parsed and
will be stored\nas-is.", | |
1575 "The values will be parsed as if the user typed them int
o 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 int
o a cell via the Google Sheets UI." | |
1576 ], | |
1577 "type": "string" | |
1578 }, | |
1579 "data": { | |
1580 "description": "The new values to apply to the spreadsheet."
, | |
1581 "items": { | |
1582 "$ref": "ValueRange" | |
1583 }, | |
1584 "type": "array" | |
1585 }, | |
1586 "responseValueRenderOption": { | |
1587 "description": "Determines how values in the response should
be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", | |
1588 "enum": [ | |
1589 "FORMATTED_VALUE", | |
1590 "UNFORMATTED_VALUE", | |
1591 "FORMULA" | |
1592 ], | |
1593 "enumDescriptions": [ | |
1594 "Values will be calculated & formatted in the reply acco
rding to the\ncell's formatting. Formatting is based on the spreadsheet's local
e,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` i
s `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", | |
1595 "Values will be calculated, but not formatted in the rep
ly.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,
\nthen `A2` would return the number `1.23`.", | |
1596 "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\"`." | |
1597 ], | |
1598 "type": "string" | |
1599 }, | |
1600 "responseDateTimeRenderOption": { | |
1601 "description": "Determines how dates, times, and durations i
n the response should be\nrendered. This is ignored if response_value_render_opt
ion is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderO
ption.SERIAL_NUMBER].", | |
1602 "enum": [ | |
1603 "SERIAL_NUMBER", | |
1604 "FORMATTED_STRING" | |
1605 ], | |
1606 "enumDescriptions": [ | |
1607 "Instructs date, time, datetime, and duration fields to
be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3
.\nDays are counted from December 31st 1899 and are incremented by 1,\nand times
are fractions of a day. For example, January 1st 1900 at noon\nwould be 1.5, 1
because it's 1 day offset from December 31st 1899,\nand .5 because noon is half
a day. February 1st 1900 at 3pm would\nbe 32.625. This correctly treats the ye
ar 1900 as not a leap year.", | |
1608 "Instructs date, time, datetime, and duration fields to
be output\nas strings in their given number format (which is dependent\non the s
preadsheet locale)." | |
1609 ], | |
1610 "type": "string" | |
1611 }, | |
1612 "includeValuesInResponse": { | |
1613 "description": "Determines if the update response should inc
lude the values\nof the cells that were updated. By default, responses\ndo not i
nclude the updated values. The `updatedData` field within\neach of the BatchUpda
teValuesResponse.responses will contain\nthe updated values. If the range to wri
te was larger than than the range\nactually written, the response will include a
ll values in the requested\nrange (excluding trailing empty rows and columns).", | |
1614 "type": "boolean" | |
1615 } | 1696 } |
1616 }, | 1697 }, |
1617 "type": "object" | 1698 "type": "object" |
1618 }, | 1699 }, |
1619 "ClearBasicFilterRequest": { | 1700 "ClearBasicFilterRequest": { |
1620 "description": "Clears the basic filter, if any exists on the sheet.
", | 1701 "description": "Clears the basic filter, if any exists on the sheet.
", |
1621 "id": "ClearBasicFilterRequest", | 1702 "id": "ClearBasicFilterRequest", |
1622 "properties": { | 1703 "properties": { |
1623 "sheetId": { | 1704 "sheetId": { |
1624 "description": "The sheet ID on which the basic filter shoul
d be cleared.", | 1705 "description": "The sheet ID on which the basic filter shoul
d be cleared.", |
1625 "format": "int32", | 1706 "format": "int32", |
1626 "type": "integer" | 1707 "type": "integer" |
1627 } | 1708 } |
1628 }, | 1709 }, |
1629 "type": "object" | 1710 "type": "object" |
1630 }, | 1711 }, |
1631 "BatchClearValuesResponse": { | 1712 "TextToColumnsRequest": { |
1632 "description": "The response when updating a range of values in a sp
readsheet.", | 1713 "description": "Splits a column of text into multiple columns,\nbase
d on a delimiter in each cell.", |
1633 "id": "BatchClearValuesResponse", | 1714 "id": "TextToColumnsRequest", |
1634 "properties": { | 1715 "properties": { |
| 1716 "delimiter": { |
| 1717 "description": "The delimiter to use. Used only if delimiter
Type is\nCUSTOM.", |
| 1718 "type": "string" |
| 1719 }, |
| 1720 "source": { |
| 1721 "$ref": "GridRange", |
| 1722 "description": "The source data range. This must span exact
ly one column." |
| 1723 }, |
| 1724 "delimiterType": { |
| 1725 "description": "The delimiter type to use.", |
| 1726 "enum": [ |
| 1727 "DELIMITER_TYPE_UNSPECIFIED", |
| 1728 "COMMA", |
| 1729 "SEMICOLON", |
| 1730 "PERIOD", |
| 1731 "SPACE", |
| 1732 "CUSTOM" |
| 1733 ], |
| 1734 "enumDescriptions": [ |
| 1735 "Default value. This value must not be used.", |
| 1736 "\",\"", |
| 1737 "\";\"", |
| 1738 "\".\"", |
| 1739 "\" \"", |
| 1740 "A custom value as defined in delimiter." |
| 1741 ], |
| 1742 "type": "string" |
| 1743 } |
| 1744 }, |
| 1745 "type": "object" |
| 1746 }, |
| 1747 "DeleteBandingRequest": { |
| 1748 "description": "Removes the banded range with the given ID from the
spreadsheet.", |
| 1749 "id": "DeleteBandingRequest", |
| 1750 "properties": { |
| 1751 "bandedRangeId": { |
| 1752 "description": "The ID of the banded range to delete.", |
| 1753 "format": "int32", |
| 1754 "type": "integer" |
| 1755 } |
| 1756 }, |
| 1757 "type": "object" |
| 1758 }, |
| 1759 "BatchUpdateSpreadsheetResponse": { |
| 1760 "description": "The reply for batch updating a spreadsheet.", |
| 1761 "id": "BatchUpdateSpreadsheetResponse", |
| 1762 "properties": { |
| 1763 "replies": { |
| 1764 "description": "The reply of the updates. This maps 1:1 wit
h the updates, although\nreplies to some requests may be empty.", |
| 1765 "items": { |
| 1766 "$ref": "Response" |
| 1767 }, |
| 1768 "type": "array" |
| 1769 }, |
| 1770 "updatedSpreadsheet": { |
| 1771 "$ref": "Spreadsheet", |
| 1772 "description": "The spreadsheet after updates were applied.
This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo
nse] is `true`." |
| 1773 }, |
1635 "spreadsheetId": { | 1774 "spreadsheetId": { |
1636 "description": "The spreadsheet the updates were applied to.
", | 1775 "description": "The spreadsheet the updates were applied to.
", |
1637 "type": "string" | 1776 "type": "string" |
1638 }, | 1777 } |
1639 "clearedRanges": { | 1778 }, |
1640 "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 bo
unds of the sheet, this will be the actual ranges\n that were cleared, bounded t
o the sheet's limits.)", | 1779 "type": "object" |
1641 "items": { | 1780 }, |
1642 "type": "string" | 1781 "AppendValuesResponse": { |
1643 }, | 1782 "description": "The response when updating a range of values in a sp
readsheet.", |
1644 "type": "array" | 1783 "id": "AppendValuesResponse", |
1645 } | 1784 "properties": { |
1646 }, | 1785 "updates": { |
1647 "type": "object" | 1786 "$ref": "UpdateValuesResponse", |
1648 }, | 1787 "description": "Information about the updates that were appl
ied." |
1649 "ConditionalFormatRule": { | 1788 }, |
1650 "description": "A rule describing a conditional format.", | 1789 "tableRange": { |
1651 "id": "ConditionalFormatRule", | 1790 "description": "The range (in A1 notation) of the table that
values are being appended to\n(before the values were appended).\nEmpty if no t
able was found.", |
1652 "properties": { | 1791 "type": "string" |
1653 "gradientRule": { | 1792 }, |
1654 "$ref": "GradientRule", | 1793 "spreadsheetId": { |
1655 "description": "The formatting will vary based on the gradie
nts in the rule." | 1794 "description": "The spreadsheet the updates were applied to.
", |
1656 }, | 1795 "type": "string" |
1657 "booleanRule": { | 1796 } |
1658 "$ref": "BooleanRule", | 1797 }, |
1659 "description": "The formatting is either \"on\" or \"off\" a
ccording to the rule." | 1798 "type": "object" |
1660 }, | 1799 }, |
1661 "ranges": { | 1800 "MoveDimensionRequest": { |
1662 "description": "The ranges that will be formatted if the con
dition is true.\nAll the ranges must be on the same grid.", | 1801 "description": "Moves one or more rows or columns.", |
1663 "items": { | 1802 "id": "MoveDimensionRequest", |
1664 "$ref": "GridRange" | 1803 "properties": { |
1665 }, | 1804 "source": { |
1666 "type": "array" | 1805 "$ref": "DimensionRange", |
1667 } | 1806 "description": "The source dimensions to move." |
1668 }, | 1807 }, |
1669 "type": "object" | 1808 "destinationIndex": { |
1670 }, | 1809 "description": "The zero-based start index of where to move
the source data to,\nbased on the coordinates *before* the source data is remove
d\nfrom the grid. Existing data will be shifted down or right\n(depending on th
e dimension) to make room for the moved dimensions.\nThe source dimensions are r
emoved from the grid, so the\nthe data may end up in a different index than spec
ified.\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`.", |
1671 "UpdateBordersRequest": { | 1810 "format": "int32", |
1672 "description": "Updates the borders of a range.\nIf a field is not s
et in the request, that means the border remains as-is.\nFor example, with two s
ubsequent 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 bord
ers of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a borde
r, explicitly set the style to\nNONE.", | 1811 "type": "integer" |
1673 "id": "UpdateBordersRequest", | 1812 } |
1674 "properties": { | 1813 }, |
1675 "right": { | 1814 "type": "object" |
1676 "$ref": "Border", | |
1677 "description": "The border to put at the right of the range.
" | |
1678 }, | |
1679 "innerVertical": { | |
1680 "$ref": "Border", | |
1681 "description": "The vertical border to put within the range.
" | |
1682 }, | |
1683 "top": { | |
1684 "$ref": "Border", | |
1685 "description": "The border to put at the top of the range." | |
1686 }, | |
1687 "innerHorizontal": { | |
1688 "$ref": "Border", | |
1689 "description": "The horizontal border to put within the rang
e." | |
1690 }, | |
1691 "range": { | |
1692 "$ref": "GridRange", | |
1693 "description": "The range whose borders should be updated." | |
1694 }, | |
1695 "bottom": { | |
1696 "$ref": "Border", | |
1697 "description": "The border to put at the bottom of the range
." | |
1698 }, | |
1699 "left": { | |
1700 "$ref": "Border", | |
1701 "description": "The border to put at the left of the range." | |
1702 } | |
1703 }, | |
1704 "type": "object" | |
1705 }, | 1815 }, |
1706 "PivotFilterCriteria": { | 1816 "PivotFilterCriteria": { |
1707 "description": "Criteria for showing/hiding rows in a pivot table.", | 1817 "description": "Criteria for showing/hiding rows in a pivot table.", |
1708 "id": "PivotFilterCriteria", | 1818 "id": "PivotFilterCriteria", |
1709 "properties": { | 1819 "properties": { |
1710 "visibleValues": { | 1820 "visibleValues": { |
1711 "description": "Values that should be included. Values not
listed here are excluded.", | 1821 "description": "Values that should be included. Values not
listed here are excluded.", |
1712 "items": { | 1822 "items": { |
1713 "type": "string" | 1823 "type": "string" |
1714 }, | 1824 }, |
1715 "type": "array" | 1825 "type": "array" |
1716 } | 1826 } |
1717 }, | 1827 }, |
1718 "type": "object" | 1828 "type": "object" |
1719 }, | 1829 }, |
1720 "Borders": { | 1830 "AddFilterViewRequest": { |
1721 "description": "The borders of the cell.", | 1831 "description": "Adds a filter view.", |
1722 "id": "Borders", | 1832 "id": "AddFilterViewRequest", |
1723 "properties": { | 1833 "properties": { |
1724 "left": { | 1834 "filter": { |
1725 "$ref": "Border", | 1835 "$ref": "FilterView", |
1726 "description": "The left border of the cell." | 1836 "description": "The filter to add. The filterViewId\nfield i
s optional; if one is not set, an id will be randomly generated. (It\nis an erro
r to specify the ID of a filter that already exists.)" |
1727 }, | |
1728 "right": { | |
1729 "$ref": "Border", | |
1730 "description": "The right border of the cell." | |
1731 }, | |
1732 "top": { | |
1733 "$ref": "Border", | |
1734 "description": "The top border of the cell." | |
1735 }, | |
1736 "bottom": { | |
1737 "$ref": "Border", | |
1738 "description": "The bottom border of the cell." | |
1739 } | 1837 } |
1740 }, | 1838 }, |
1741 "type": "object" | 1839 "type": "object" |
1742 }, | 1840 }, |
1743 "EmbeddedChart": { | 1841 "AddConditionalFormatRuleRequest": { |
1744 "description": "A chart embedded in a sheet.", | 1842 "description": "Adds a new conditional format rule at the given inde
x.\nAll subsequent rules' indexes are incremented.", |
1745 "id": "EmbeddedChart", | 1843 "id": "AddConditionalFormatRuleRequest", |
1746 "properties": { | 1844 "properties": { |
1747 "chartId": { | 1845 "rule": { |
1748 "description": "The ID of the chart.", | 1846 "$ref": "ConditionalFormatRule", |
| 1847 "description": "The rule to add." |
| 1848 }, |
| 1849 "index": { |
| 1850 "description": "The zero-based index where the rule should b
e inserted.", |
1749 "format": "int32", | 1851 "format": "int32", |
1750 "type": "integer" | 1852 "type": "integer" |
1751 }, | |
1752 "position": { | |
1753 "$ref": "EmbeddedObjectPosition", | |
1754 "description": "The position of the chart." | |
1755 }, | |
1756 "spec": { | |
1757 "$ref": "ChartSpec", | |
1758 "description": "The specification of the chart." | |
1759 } | 1853 } |
1760 }, | 1854 }, |
1761 "type": "object" | 1855 "type": "object" |
1762 }, | 1856 }, |
1763 "Color": { | 1857 "ChartSpec": { |
1764 "description": "Represents a color in the RGBA color space. This rep
resentation is designed\nfor simplicity of conversion to/from color representati
ons in various\nlanguages over compactness; for example, the fields of this repr
esentation\ncan be trivially provided to the constructor of \"java.awt.Color\" i
n Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:bl
ue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily format
ted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples
:\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.getG
reen();\n float blue = (float) color.getBlue();\n float denominator
= 255.0;\n Color.Builder resultBuilder =\n Color\n
.newBuilder()\n .setRed(red / denominator)\n .setGr
een(green / denominator)\n .setBlue(blue / denominator);\n i
nt alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlp
ha(\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 = [protoco
lor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n
alpha = [alpha_wrapper value];\n }\n return [UIColor color
WithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* to
Proto(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 [resu
lt setRed:red];\n [result setGreen:green];\n [result setBlue:blu
e];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWi
thValue(alpha)];\n }\n [result autorelease];\n return re
sult;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var prot
oToCssColor = 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 = M
ath.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(', rgbPara
ms, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(
red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8)
| blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros
= 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0
; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n re
sultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n
// ...", | 1858 "description": "The specifications of a chart.", |
1765 "id": "Color", | 1859 "id": "ChartSpec", |
1766 "properties": { | 1860 "properties": { |
1767 "green": { | 1861 "pieChart": { |
1768 "description": "The amount of green in the color as a value
in the interval [0, 1].", | 1862 "$ref": "PieChartSpec", |
1769 "format": "float", | 1863 "description": "A pie chart specification." |
1770 "type": "number" | |
1771 }, | 1864 }, |
1772 "blue": { | 1865 "basicChart": { |
1773 "description": "The amount of blue in the color as a value i
n the interval [0, 1].", | 1866 "$ref": "BasicChartSpec", |
1774 "format": "float", | 1867 "description": "A basic chart specification, can be one of m
any kinds of charts.\nSee BasicChartType for the list of all\ncharts this suppor
ts." |
1775 "type": "number" | |
1776 }, | 1868 }, |
1777 "red": { | 1869 "hiddenDimensionStrategy": { |
1778 "description": "The amount of red in the color as a value in
the interval [0, 1].", | 1870 "description": "Determines how the charts will use hidden ro
ws or columns.", |
1779 "format": "float", | 1871 "enum": [ |
1780 "type": "number" | 1872 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED", |
| 1873 "SKIP_HIDDEN_ROWS_AND_COLUMNS", |
| 1874 "SKIP_HIDDEN_ROWS", |
| 1875 "SKIP_HIDDEN_COLUMNS", |
| 1876 "SHOW_ALL" |
| 1877 ], |
| 1878 "enumDescriptions": [ |
| 1879 "Default value, do not use.", |
| 1880 "Charts will skip hidden rows and columns.", |
| 1881 "Charts will skip hidden rows only.", |
| 1882 "Charts will skip hidden columns only.", |
| 1883 "Charts will not skip any hidden rows or columns." |
| 1884 ], |
| 1885 "type": "string" |
1781 }, | 1886 }, |
1782 "alpha": { | 1887 "title": { |
1783 "description": "The fraction of this color that should be ap
plied 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\n
This 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 betwee
n a default value and the value being unset.\nIf omitted, this color object is t
o be rendered as a solid color\n(as if the alpha value had been explicitly given
with a value of 1.0).", | 1888 "description": "The title of the chart.", |
1784 "format": "float", | 1889 "type": "string" |
1785 "type": "number" | |
1786 } | 1890 } |
1787 }, | 1891 }, |
1788 "type": "object" | 1892 "type": "object" |
1789 }, | 1893 }, |
1790 "AddSheetRequest": { | 1894 "NumberFormat": { |
1791 "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\nEmb
eddedObjectPosition.newSheet.", | 1895 "description": "The number format of a cell.", |
1792 "id": "AddSheetRequest", | 1896 "id": "NumberFormat", |
1793 "properties": { | 1897 "properties": { |
1794 "properties": { | 1898 "type": { |
1795 "$ref": "SheetProperties", | 1899 "description": "The type of the number format.\nWhen writing
, this field must be set.", |
1796 "description": "The properties the new sheet should have.\nA
ll 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.)" | 1900 "enum": [ |
| 1901 "NUMBER_FORMAT_TYPE_UNSPECIFIED", |
| 1902 "TEXT", |
| 1903 "NUMBER", |
| 1904 "PERCENT", |
| 1905 "CURRENCY", |
| 1906 "DATE", |
| 1907 "TIME", |
| 1908 "DATE_TIME", |
| 1909 "SCIENTIFIC" |
| 1910 ], |
| 1911 "enumDescriptions": [ |
| 1912 "The number format is not specified\nand is based on the
contents of the cell.\nDo not explicitly use this.", |
| 1913 "Text formatting, e.g `1000.12`", |
| 1914 "Number formatting, e.g, `1,000.12`", |
| 1915 "Percent formatting, e.g `10.12%`", |
| 1916 "Currency formatting, e.g `$1,000.12`", |
| 1917 "Date formatting, e.g `9/26/2008`", |
| 1918 "Time formatting, e.g `3:59:00 PM`", |
| 1919 "Date+Time formatting, e.g `9/26/08 15:59:00`", |
| 1920 "Scientific number formatting, e.g `1.01E+03`" |
| 1921 ], |
| 1922 "type": "string" |
| 1923 }, |
| 1924 "pattern": { |
| 1925 "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/guides/formats
) for more\ninformation about the supported patterns.", |
| 1926 "type": "string" |
1797 } | 1927 } |
1798 }, | 1928 }, |
1799 "type": "object" | 1929 "type": "object" |
1800 }, | 1930 }, |
1801 "AddProtectedRangeRequest": { | 1931 "SheetProperties": { |
1802 "description": "Adds a new protected range.", | 1932 "description": "Properties of a sheet.", |
1803 "id": "AddProtectedRangeRequest", | 1933 "id": "SheetProperties", |
1804 "properties": { | 1934 "properties": { |
1805 "protectedRange": { | 1935 "sheetType": { |
1806 "$ref": "ProtectedRange", | 1936 "description": "The type of sheet. Defaults to GRID.\nThis f
ield cannot be changed once set.", |
1807 "description": "The protected range to be added. The\nprotec
tedRangeId field is optional; if\none is not set, an id will be randomly generat
ed. (It is an error to\nspecify the ID of a range that already exists.)" | 1937 "enum": [ |
| 1938 "SHEET_TYPE_UNSPECIFIED", |
| 1939 "GRID", |
| 1940 "OBJECT" |
| 1941 ], |
| 1942 "enumDescriptions": [ |
| 1943 "Default value, do not use.", |
| 1944 "The sheet is a grid.", |
| 1945 "The sheet has no grid and instead has an object like a
chart or image." |
| 1946 ], |
| 1947 "type": "string" |
| 1948 }, |
| 1949 "gridProperties": { |
| 1950 "$ref": "GridProperties", |
| 1951 "description": "Additional properties of the sheet if this s
heet 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 p
roperties on non-grid sheets." |
| 1952 }, |
| 1953 "title": { |
| 1954 "description": "The name of the sheet.", |
| 1955 "type": "string" |
| 1956 }, |
| 1957 "index": { |
| 1958 "description": "The index of the sheet within the spreadshee
t.\nWhen adding or updating sheet properties, if this field\nis excluded then th
e sheet will be added or moved to the end\nof the sheet list. When updating shee
t indices or inserting\nsheets, movement is considered in \"before the move\" in
dexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ah
ead of S2 the index would have to be set to 2. A sheet\nindex update request wil
l be 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.", |
| 1959 "format": "int32", |
| 1960 "type": "integer" |
| 1961 }, |
| 1962 "tabColor": { |
| 1963 "$ref": "Color", |
| 1964 "description": "The color of the tab in the UI." |
| 1965 }, |
| 1966 "sheetId": { |
| 1967 "description": "The ID of the sheet. Must be non-negative.\n
This field cannot be changed once set.", |
| 1968 "format": "int32", |
| 1969 "type": "integer" |
| 1970 }, |
| 1971 "rightToLeft": { |
| 1972 "description": "True if the sheet is an RTL sheet instead of
an LTR sheet.", |
| 1973 "type": "boolean" |
| 1974 }, |
| 1975 "hidden": { |
| 1976 "description": "True if the sheet is hidden in the UI, false
if it's visible.", |
| 1977 "type": "boolean" |
1808 } | 1978 } |
1809 }, | 1979 }, |
1810 "type": "object" | 1980 "type": "object" |
1811 }, | 1981 }, |
1812 "ValueRange": { | 1982 "UpdateDimensionPropertiesRequest": { |
1813 "description": "Data within a range of the spreadsheet.", | 1983 "description": "Updates properties of dimensions within the specifie
d range.", |
1814 "id": "ValueRange", | 1984 "id": "UpdateDimensionPropertiesRequest", |
1815 "properties": { | 1985 "properties": { |
1816 "values": { | 1986 "properties": { |
1817 "description": "The data that was read or to be written. Th
is is an array of arrays,\nthe outer array representing all the data and each in
ner array\nrepresenting a major dimension. Each item in the inner array\ncorresp
onds with one cell.\n\nFor output, empty trailing rows and columns will not be i
ncluded.\n\nFor input, supported value types are: bool, string, and double.\nNul
l values will be skipped.\nTo set a cell to an empty value, set the string value
to an empty string.", | 1987 "$ref": "DimensionProperties", |
1818 "items": { | 1988 "description": "Properties to update." |
1819 "items": { | |
1820 "type": "any" | |
1821 }, | |
1822 "type": "array" | |
1823 }, | |
1824 "type": "array" | |
1825 }, | 1989 }, |
1826 "range": { | 1990 "range": { |
1827 "description": "The range the values cover, in A1 notation.\
nFor output, this range indicates the entire requested range,\neven though the v
alues will exclude trailing rows and columns.\nWhen appending values, this field
represents the range to search for a\ntable, after which values will be appende
d.", | 1991 "$ref": "DimensionRange", |
| 1992 "description": "The rows or columns to update." |
| 1993 }, |
| 1994 "fields": { |
| 1995 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `properties` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", |
| 1996 "format": "google-fieldmask", |
1828 "type": "string" | 1997 "type": "string" |
| 1998 } |
| 1999 }, |
| 2000 "type": "object" |
| 2001 }, |
| 2002 "SourceAndDestination": { |
| 2003 "description": "A combination of a source range and how to extend th
at source.", |
| 2004 "id": "SourceAndDestination", |
| 2005 "properties": { |
| 2006 "fillLength": { |
| 2007 "description": "The number of rows or columns that data shou
ld be filled into.\nPositive numbers expand beyond the last row or last column\n
of the source. Negative numbers expand before the first row\nor first column of
the source.", |
| 2008 "format": "int32", |
| 2009 "type": "integer" |
1829 }, | 2010 }, |
1830 "majorDimension": { | 2011 "source": { |
1831 "description": "The major dimension of the values.\n\nFor ou
tput, 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 `r
ange=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, w
ith `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 defaul
ts to ROWS.", | 2012 "$ref": "GridRange", |
| 2013 "description": "The location of the data to use as the sourc
e of the autofill." |
| 2014 }, |
| 2015 "dimension": { |
| 2016 "description": "The dimension that data should be filled int
o.", |
1832 "enum": [ | 2017 "enum": [ |
1833 "DIMENSION_UNSPECIFIED", | 2018 "DIMENSION_UNSPECIFIED", |
1834 "ROWS", | 2019 "ROWS", |
1835 "COLUMNS" | 2020 "COLUMNS" |
1836 ], | 2021 ], |
1837 "enumDescriptions": [ | 2022 "enumDescriptions": [ |
1838 "The default value, do not use.", | 2023 "The default value, do not use.", |
1839 "Operates on the rows of a sheet.", | 2024 "Operates on the rows of a sheet.", |
1840 "Operates on the columns of a sheet." | 2025 "Operates on the columns of a sheet." |
1841 ], | 2026 ], |
1842 "type": "string" | 2027 "type": "string" |
1843 } | 2028 } |
1844 }, | 2029 }, |
1845 "type": "object" | 2030 "type": "object" |
1846 }, | 2031 }, |
1847 "FindReplaceResponse": { | 2032 "FilterView": { |
1848 "description": "The result of the find/replace.", | 2033 "description": "A filter view.", |
1849 "id": "FindReplaceResponse", | 2034 "id": "FilterView", |
1850 "properties": { | 2035 "properties": { |
1851 "valuesChanged": { | 2036 "namedRangeId": { |
1852 "description": "The number of non-formula cells changed.", | 2037 "description": "The named range this filter view is backed b
y, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.", |
1853 "format": "int32", | 2038 "type": "string" |
1854 "type": "integer" | 2039 }, |
1855 }, | 2040 "filterViewId": { |
1856 "rowsChanged": { | 2041 "description": "The ID of the filter view.", |
1857 "description": "The number of rows changed.", | 2042 "format": "int32", |
1858 "format": "int32", | 2043 "type": "integer" |
1859 "type": "integer" | 2044 }, |
1860 }, | 2045 "criteria": { |
1861 "occurrencesChanged": { | 2046 "additionalProperties": { |
1862 "description": "The number of occurrences (possibly multiple
within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"G
oogle Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -> `\"Googlo
Shoots\"`.", | 2047 "$ref": "FilterCriteria" |
1863 "format": "int32", | 2048 }, |
1864 "type": "integer" | 2049 "description": "The criteria for showing/hiding values per c
olumn.\nThe map's key is the column index, and the value is the criteria for\nth
at column.", |
1865 }, | 2050 "type": "object" |
1866 "formulasChanged": { | 2051 }, |
1867 "description": "The number of formula cells changed.", | 2052 "title": { |
1868 "format": "int32", | 2053 "description": "The name of the filter view.", |
1869 "type": "integer" | 2054 "type": "string" |
1870 }, | 2055 }, |
1871 "sheetsChanged": { | 2056 "range": { |
1872 "description": "The number of sheets changed.", | 2057 "$ref": "GridRange", |
1873 "format": "int32", | 2058 "description": "The range this filter view covers.\n\nWhen w
riting, only one of range or named_range_id\nmay be set." |
1874 "type": "integer" | 2059 }, |
1875 } | 2060 "sortSpecs": { |
1876 }, | 2061 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", |
1877 "type": "object" | 2062 "items": { |
1878 }, | 2063 "$ref": "SortSpec" |
1879 "AppendValuesResponse": { | 2064 }, |
| 2065 "type": "array" |
| 2066 } |
| 2067 }, |
| 2068 "type": "object" |
| 2069 }, |
| 2070 "BandingProperties": { |
| 2071 "description": "Properties referring a single dimension (either row
or column). If both\nBandedRange.row_properties and BandedRange.column_propertie
s are\nset, the fill colors are applied to cells according to the following rule
s:\n\n* header_color and footer_color take priority over band colors.\n* first_b
and_color takes priority over second_band_color.\n* row_properties takes priorit
y over column_properties.\n\nFor example, the first row color takes priority ove
r the first column\ncolor, but the first column color takes priority over the se
cond 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.", |
| 2072 "id": "BandingProperties", |
| 2073 "properties": { |
| 2074 "firstBandColor": { |
| 2075 "$ref": "Color", |
| 2076 "description": "The first color that is alternating. (Requir
ed)" |
| 2077 }, |
| 2078 "secondBandColor": { |
| 2079 "$ref": "Color", |
| 2080 "description": "The second color that is alternating. (Requi
red)" |
| 2081 }, |
| 2082 "footerColor": { |
| 2083 "$ref": "Color", |
| 2084 "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\ncol
umn." |
| 2085 }, |
| 2086 "headerColor": { |
| 2087 "$ref": "Color", |
| 2088 "description": "The color of the first row or column. If thi
s 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\n
from the second row or column. Otherwise, the first row or column will be\nfille
d with first_band_color and the colors will proceed to alternate\nas they normal
ly would." |
| 2089 } |
| 2090 }, |
| 2091 "type": "object" |
| 2092 }, |
| 2093 "AddProtectedRangeResponse": { |
| 2094 "description": "The result of adding a new protected range.", |
| 2095 "id": "AddProtectedRangeResponse", |
| 2096 "properties": { |
| 2097 "protectedRange": { |
| 2098 "$ref": "ProtectedRange", |
| 2099 "description": "The newly added protected range." |
| 2100 } |
| 2101 }, |
| 2102 "type": "object" |
| 2103 }, |
| 2104 "BasicFilter": { |
| 2105 "description": "The default filter associated with a sheet.", |
| 2106 "id": "BasicFilter", |
| 2107 "properties": { |
| 2108 "range": { |
| 2109 "$ref": "GridRange", |
| 2110 "description": "The range the filter covers." |
| 2111 }, |
| 2112 "criteria": { |
| 2113 "additionalProperties": { |
| 2114 "$ref": "FilterCriteria" |
| 2115 }, |
| 2116 "description": "The criteria for showing/hiding values per c
olumn.\nThe map's key is the column index, and the value is the criteria for\nth
at column.", |
| 2117 "type": "object" |
| 2118 }, |
| 2119 "sortSpecs": { |
| 2120 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", |
| 2121 "items": { |
| 2122 "$ref": "SortSpec" |
| 2123 }, |
| 2124 "type": "array" |
| 2125 } |
| 2126 }, |
| 2127 "type": "object" |
| 2128 }, |
| 2129 "UpdateValuesResponse": { |
1880 "description": "The response when updating a range of values in a sp
readsheet.", | 2130 "description": "The response when updating a range of values in a sp
readsheet.", |
1881 "id": "AppendValuesResponse", | 2131 "id": "UpdateValuesResponse", |
1882 "properties": { | 2132 "properties": { |
| 2133 "updatedColumns": { |
| 2134 "description": "The number of columns where at least one cel
l in the column was updated.", |
| 2135 "format": "int32", |
| 2136 "type": "integer" |
| 2137 }, |
1883 "spreadsheetId": { | 2138 "spreadsheetId": { |
1884 "description": "The spreadsheet the updates were applied to.
", | 2139 "description": "The spreadsheet the updates were applied to.
", |
1885 "type": "string" | 2140 "type": "string" |
1886 }, | 2141 }, |
1887 "tableRange": { | 2142 "updatedRange": { |
1888 "description": "The range (in A1 notation) of the table that
values are being appended to\n(before the values were appended).\nEmpty if no t
able was found.", | 2143 "description": "The range (in A1 notation) that updates were
applied to.", |
1889 "type": "string" | 2144 "type": "string" |
1890 }, | 2145 }, |
1891 "updates": { | 2146 "updatedCells": { |
1892 "$ref": "UpdateValuesResponse", | 2147 "description": "The number of cells updated.", |
1893 "description": "Information about the updates that were appl
ied." | 2148 "format": "int32", |
1894 } | 2149 "type": "integer" |
1895 }, | 2150 }, |
1896 "type": "object" | 2151 "updatedRows": { |
1897 }, | 2152 "description": "The number of rows where at least one cell i
n the row was updated.", |
1898 "CellFormat": { | 2153 "format": "int32", |
1899 "description": "The format of a cell.", | 2154 "type": "integer" |
1900 "id": "CellFormat", | 2155 }, |
1901 "properties": { | 2156 "updatedData": { |
1902 "horizontalAlignment": { | 2157 "$ref": "ValueRange", |
1903 "description": "The horizontal alignment of the value in the
cell.", | 2158 "description": "The values of the cells after updates were a
pplied.\nThis is only included if the request's `includeValuesInResponse` field\
nwas `true`." |
| 2159 } |
| 2160 }, |
| 2161 "type": "object" |
| 2162 }, |
| 2163 "PivotValue": { |
| 2164 "description": "The definition of how a value in a pivot table shoul
d be calculated.", |
| 2165 "id": "PivotValue", |
| 2166 "properties": { |
| 2167 "name": { |
| 2168 "description": "A name to use for the value. This is only us
ed if formula was set.\nOtherwise, the column name is used.", |
| 2169 "type": "string" |
| 2170 }, |
| 2171 "formula": { |
| 2172 "description": "A custom formula to calculate the value. Th
e formula must start\nwith an `=` character.", |
| 2173 "type": "string" |
| 2174 }, |
| 2175 "summarizeFunction": { |
| 2176 "description": "A function to summarize the value.\nIf formu
la is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffse
t is set, then `CUSTOM`\nis not supported.", |
1904 "enum": [ | 2177 "enum": [ |
1905 "HORIZONTAL_ALIGN_UNSPECIFIED", | 2178 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED", |
1906 "LEFT", | 2179 "SUM", |
1907 "CENTER", | 2180 "COUNTA", |
1908 "RIGHT" | 2181 "COUNT", |
| 2182 "COUNTUNIQUE", |
| 2183 "AVERAGE", |
| 2184 "MAX", |
| 2185 "MIN", |
| 2186 "MEDIAN", |
| 2187 "PRODUCT", |
| 2188 "STDEV", |
| 2189 "STDEVP", |
| 2190 "VAR", |
| 2191 "VARP", |
| 2192 "CUSTOM" |
1909 ], | 2193 ], |
1910 "enumDescriptions": [ | 2194 "enumDescriptions": [ |
1911 "The horizontal alignment is not specified. Do not use t
his.", | 2195 "The default, do not use.", |
1912 "The text is explicitly aligned to the left of the cell.
", | 2196 "Corresponds to the `SUM` function.", |
1913 "The text is explicitly aligned to the center of the cel
l.", | 2197 "Corresponds to the `COUNTA` function.", |
1914 "The text is explicitly aligned to the right of the cell
." | 2198 "Corresponds to the `COUNT` function.", |
1915 ], | 2199 "Corresponds to the `COUNTUNIQUE` function.", |
1916 "type": "string" | 2200 "Corresponds to the `AVERAGE` function.", |
1917 }, | 2201 "Corresponds to the `MAX` function.", |
1918 "hyperlinkDisplayType": { | 2202 "Corresponds to the `MIN` function.", |
1919 "description": "How a hyperlink, if it exists, should be dis
played in the cell.", | 2203 "Corresponds to the `MEDIAN` function.", |
| 2204 "Corresponds to the `PRODUCT` function.", |
| 2205 "Corresponds to the `STDEV` function.", |
| 2206 "Corresponds to the `STDEVP` function.", |
| 2207 "Corresponds to the `VAR` function.", |
| 2208 "Corresponds to the `VARP` function.", |
| 2209 "Indicates the formula should be used as-is.\nOnly valid
if PivotValue.formula was set." |
| 2210 ], |
| 2211 "type": "string" |
| 2212 }, |
| 2213 "sourceColumnOffset": { |
| 2214 "description": "The column offset of the source range that t
his value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColu
mnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1`
would\nrefer to column `D`.", |
| 2215 "format": "int32", |
| 2216 "type": "integer" |
| 2217 } |
| 2218 }, |
| 2219 "type": "object" |
| 2220 }, |
| 2221 "ErrorValue": { |
| 2222 "description": "An error in a cell.", |
| 2223 "id": "ErrorValue", |
| 2224 "properties": { |
| 2225 "type": { |
| 2226 "description": "The type of error.", |
1920 "enum": [ | 2227 "enum": [ |
1921 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED", | 2228 "ERROR_TYPE_UNSPECIFIED", |
1922 "LINKED", | 2229 "ERROR", |
1923 "PLAIN_TEXT" | 2230 "NULL_VALUE", |
| 2231 "DIVIDE_BY_ZERO", |
| 2232 "VALUE", |
| 2233 "REF", |
| 2234 "NAME", |
| 2235 "NUM", |
| 2236 "N_A", |
| 2237 "LOADING" |
1924 ], | 2238 ], |
1925 "enumDescriptions": [ | 2239 "enumDescriptions": [ |
1926 "The default value: the hyperlink is rendered. Do not us
e this.", | 2240 "The default error type, do not use this.", |
1927 "A hyperlink should be explicitly rendered.", | 2241 "Corresponds to the `#ERROR!` error.", |
1928 "A hyperlink should not be rendered." | 2242 "Corresponds to the `#NULL!` error.", |
1929 ], | 2243 "Corresponds to the `#DIV/0` error.", |
1930 "type": "string" | 2244 "Corresponds to the `#VALUE!` error.", |
1931 }, | 2245 "Corresponds to the `#REF!` error.", |
1932 "borders": { | 2246 "Corresponds to the `#NAME?` error.", |
1933 "$ref": "Borders", | 2247 "Corresponds to the `#NUM`! error.", |
1934 "description": "The borders of the cell." | 2248 "Corresponds to the `#N/A` error.", |
1935 }, | 2249 "Corresponds to the `Loading...` state." |
1936 "textDirection": { | 2250 ], |
1937 "description": "The direction of the text in the cell.", | 2251 "type": "string" |
1938 "enum": [ | 2252 }, |
1939 "TEXT_DIRECTION_UNSPECIFIED", | 2253 "message": { |
1940 "LEFT_TO_RIGHT", | 2254 "description": "A message with more information about the er
ror\n(in the spreadsheet's locale).", |
1941 "RIGHT_TO_LEFT" | 2255 "type": "string" |
1942 ], | 2256 } |
1943 "enumDescriptions": [ | 2257 }, |
1944 "The text direction is not specified. Do not use this.", | 2258 "type": "object" |
1945 "The text direction of left-to-right was set by the user
.", | 2259 }, |
1946 "The text direction of right-to-left was set by the user
." | 2260 "CopySheetToAnotherSpreadsheetRequest": { |
1947 ], | 2261 "description": "The request to copy a sheet across spreadsheets.", |
1948 "type": "string" | 2262 "id": "CopySheetToAnotherSpreadsheetRequest", |
1949 }, | 2263 "properties": { |
1950 "textFormat": { | 2264 "destinationSpreadsheetId": { |
1951 "$ref": "TextFormat", | 2265 "description": "The ID of the spreadsheet to copy the sheet
to.", |
1952 "description": "The format of the text in the cell (unless o
verridden by a format run)." | 2266 "type": "string" |
1953 }, | 2267 } |
1954 "padding": { | 2268 }, |
1955 "$ref": "Padding", | 2269 "type": "object" |
1956 "description": "The padding of the cell." | |
1957 }, | |
1958 "numberFormat": { | |
1959 "$ref": "NumberFormat", | |
1960 "description": "A format describing how number values should
be represented to the user." | |
1961 }, | |
1962 "wrapStrategy": { | |
1963 "description": "The wrap strategy for the value in the cell.
", | |
1964 "enum": [ | |
1965 "WRAP_STRATEGY_UNSPECIFIED", | |
1966 "OVERFLOW_CELL", | |
1967 "LEGACY_WRAP", | |
1968 "CLIP", | |
1969 "WRAP" | |
1970 ], | |
1971 "enumDescriptions": [ | |
1972 "The default value, do not use.", | |
1973 "Lines that are longer than the cell width will be writt
en 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 n
ext line unless the user manually inserts a new line.\nExample:\n\n | First s
entence. |\n | Manual newline that is very long. <- Text continues into next
cell\n | Next newline. |", | |
1974 "This wrap strategy represents the old Google Sheets wra
p strategy where\nwords that are longer than a line are clipped rather than brok
en. This\nstrategy is not supported on all platforms and is being phased out.\nE
xample:\n\n | Cell has a |\n | loooooooooo| <- Word is clipped.\n | wor
d. |", | |
1975 "Lines that are longer than the cell width will be clipp
ed.\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| <- Te
xt is clipped\n | Next newline. |", | |
1976 "Words that are longer than a line are wrapped at the ch
aracter level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooo
oooooo| <- Word is broken.\n | ong word. |" | |
1977 ], | |
1978 "type": "string" | |
1979 }, | |
1980 "backgroundColor": { | |
1981 "$ref": "Color", | |
1982 "description": "The background color of the cell." | |
1983 }, | |
1984 "verticalAlignment": { | |
1985 "description": "The vertical alignment of the value in the c
ell.", | |
1986 "enum": [ | |
1987 "VERTICAL_ALIGN_UNSPECIFIED", | |
1988 "TOP", | |
1989 "MIDDLE", | |
1990 "BOTTOM" | |
1991 ], | |
1992 "enumDescriptions": [ | |
1993 "The vertical alignment is not specified. Do not use th
is.", | |
1994 "The text is explicitly aligned to the top of the cell."
, | |
1995 "The text is explicitly aligned to the middle of the cel
l.", | |
1996 "The text is explicitly aligned to the bottom of the cel
l." | |
1997 ], | |
1998 "type": "string" | |
1999 } | |
2000 }, | |
2001 "type": "object" | |
2002 }, | |
2003 "MoveDimensionRequest": { | |
2004 "description": "Moves one or more rows or columns.", | |
2005 "id": "MoveDimensionRequest", | |
2006 "properties": { | |
2007 "source": { | |
2008 "$ref": "DimensionRange", | |
2009 "description": "The source dimensions to move." | |
2010 }, | |
2011 "destinationIndex": { | |
2012 "description": "The zero-based start index of where to move
the source data to,\nbased on the coordinates *before* the source data is remove
d\nfrom the grid. Existing data will be shifted down or right\n(depending on th
e dimension) to make room for the moved dimensions.\nThe source dimensions are r
emoved from the grid, so the\nthe data may end up in a different index than spec
ified.\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`.", | |
2013 "format": "int32", | |
2014 "type": "integer" | |
2015 } | |
2016 }, | |
2017 "type": "object" | |
2018 }, | |
2019 "BasicChartAxis": { | |
2020 "description": "An axis of the chart.\nA chart may not have more tha
n one axis per\naxis position.", | |
2021 "id": "BasicChartAxis", | |
2022 "properties": { | |
2023 "position": { | |
2024 "description": "The position of this axis.", | |
2025 "enum": [ | |
2026 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED", | |
2027 "BOTTOM_AXIS", | |
2028 "LEFT_AXIS", | |
2029 "RIGHT_AXIS" | |
2030 ], | |
2031 "enumDescriptions": [ | |
2032 "Default value, do not use.", | |
2033 "The axis rendered at the bottom of a chart.\nFor most c
harts, this is the standard major axis.\nFor bar charts, this is a minor axis.", | |
2034 "The axis rendered at the left of a chart.\nFor most cha
rts, this is a minor axis.\nFor bar charts, this is the standard major axis.", | |
2035 "The axis rendered at the right of a chart.\nFor most ch
arts, this is a minor axis.\nFor bar charts, this is an unusual major axis." | |
2036 ], | |
2037 "type": "string" | |
2038 }, | |
2039 "title": { | |
2040 "description": "The title of this axis. If set, this overrid
es any title inferred\nfrom headers of the data.", | |
2041 "type": "string" | |
2042 }, | |
2043 "format": { | |
2044 "$ref": "TextFormat", | |
2045 "description": "The format of the title.\nOnly valid if the
axis is not associated with the domain." | |
2046 } | |
2047 }, | |
2048 "type": "object" | |
2049 }, | 2270 }, |
2050 "PivotGroupSortValueBucket": { | 2271 "PivotGroupSortValueBucket": { |
2051 "description": "Information about which values in a pivot group shou
ld be used for sorting.", | 2272 "description": "Information about which values in a pivot group shou
ld be used for sorting.", |
2052 "id": "PivotGroupSortValueBucket", | 2273 "id": "PivotGroupSortValueBucket", |
2053 "properties": { | 2274 "properties": { |
| 2275 "valuesIndex": { |
| 2276 "description": "The offset in the PivotTable.values list whi
ch the values in this\ngrouping should be sorted by.", |
| 2277 "format": "int32", |
| 2278 "type": "integer" |
| 2279 }, |
2054 "buckets": { | 2280 "buckets": { |
2055 "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\n
to 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 indicat
e that the row should be sorted according\nto the \"Grand Total\" over the colum
n groups. If a single value is listed,\nthis would correspond to using the \"Tot
al\" of that bucket.", | 2281 "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\n
to 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 indicat
e that the row should be sorted according\nto the \"Grand Total\" over the colum
n groups. If a single value is listed,\nthis would correspond to using the \"Tot
al\" of that bucket.", |
2056 "items": { | 2282 "items": { |
2057 "$ref": "ExtendedValue" | 2283 "$ref": "ExtendedValue" |
2058 }, | 2284 }, |
2059 "type": "array" | 2285 "type": "array" |
2060 }, | |
2061 "valuesIndex": { | |
2062 "description": "The offset in the PivotTable.values list whi
ch the values in this\ngrouping should be sorted by.", | |
2063 "format": "int32", | |
2064 "type": "integer" | |
2065 } | |
2066 }, | |
2067 "type": "object" | |
2068 }, | |
2069 "DimensionProperties": { | |
2070 "description": "Properties about a dimension.", | |
2071 "id": "DimensionProperties", | |
2072 "properties": { | |
2073 "hiddenByUser": { | |
2074 "description": "True if this dimension is explicitly hidden.
", | |
2075 "type": "boolean" | |
2076 }, | |
2077 "pixelSize": { | |
2078 "description": "The height (if a row) or width (if a column)
of the dimension in pixels.", | |
2079 "format": "int32", | |
2080 "type": "integer" | |
2081 }, | |
2082 "hiddenByFilter": { | |
2083 "description": "True if this dimension is being filtered.\nT
his field is read-only.", | |
2084 "type": "boolean" | |
2085 } | 2286 } |
2086 }, | 2287 }, |
2087 "type": "object" | 2288 "type": "object" |
2088 }, | 2289 }, |
2089 "EmbeddedObjectPosition": { | 2290 "EmbeddedObjectPosition": { |
2090 "description": "The position of an embedded object such as a chart."
, | 2291 "description": "The position of an embedded object such as a chart."
, |
2091 "id": "EmbeddedObjectPosition", | 2292 "id": "EmbeddedObjectPosition", |
2092 "properties": { | 2293 "properties": { |
| 2294 "newSheet": { |
| 2295 "description": "If true, the embedded object will be put on
a new sheet whose ID\nis chosen for you. Used only when writing.", |
| 2296 "type": "boolean" |
| 2297 }, |
2093 "sheetId": { | 2298 "sheetId": { |
2094 "description": "The sheet this is on. Set only if the embedd
ed object\nis on its own sheet. Must be non-negative.", | 2299 "description": "The sheet this is on. Set only if the embedd
ed object\nis on its own sheet. Must be non-negative.", |
2095 "format": "int32", | 2300 "format": "int32", |
2096 "type": "integer" | 2301 "type": "integer" |
2097 }, | 2302 }, |
2098 "overlayPosition": { | 2303 "overlayPosition": { |
2099 "$ref": "OverlayPosition", | 2304 "$ref": "OverlayPosition", |
2100 "description": "The position at which the object is overlaid
on top of a grid." | 2305 "description": "The position at which the object is overlaid
on top of a grid." |
2101 }, | |
2102 "newSheet": { | |
2103 "description": "If true, the embedded object will be put on
a new sheet whose ID\nis chosen for you. Used only when writing.", | |
2104 "type": "boolean" | |
2105 } | 2306 } |
2106 }, | 2307 }, |
2107 "type": "object" | 2308 "type": "object" |
| 2309 }, |
| 2310 "DeleteProtectedRangeRequest": { |
| 2311 "description": "Deletes the protected range with the given ID.", |
| 2312 "id": "DeleteProtectedRangeRequest", |
| 2313 "properties": { |
| 2314 "protectedRangeId": { |
| 2315 "description": "The ID of the protected range to delete.", |
| 2316 "format": "int32", |
| 2317 "type": "integer" |
| 2318 } |
| 2319 }, |
| 2320 "type": "object" |
| 2321 }, |
| 2322 "AutoFillRequest": { |
| 2323 "description": "Fills in more data based on existing data.", |
| 2324 "id": "AutoFillRequest", |
| 2325 "properties": { |
| 2326 "useAlternateSeries": { |
| 2327 "description": "True if we should generate data with the \"a
lternate\" series.\nThis differs based on the type and amount of source data.", |
| 2328 "type": "boolean" |
| 2329 }, |
| 2330 "sourceAndDestination": { |
| 2331 "$ref": "SourceAndDestination", |
| 2332 "description": "The source and destination areas to autofill
.\nThis explicitly lists the source of the autofill and where to\nextend that da
ta." |
| 2333 }, |
| 2334 "range": { |
| 2335 "$ref": "GridRange", |
| 2336 "description": "The range to autofill. This will examine the
range and detect\nthe location that has data and automatically fill that data\n
in to the rest of the range." |
| 2337 } |
| 2338 }, |
| 2339 "type": "object" |
| 2340 }, |
| 2341 "GradientRule": { |
| 2342 "description": "A rule that applies a gradient color scale format, b
ased 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.", |
| 2343 "id": "GradientRule", |
| 2344 "properties": { |
| 2345 "midpoint": { |
| 2346 "$ref": "InterpolationPoint", |
| 2347 "description": "An optional midway interpolation point." |
| 2348 }, |
| 2349 "minpoint": { |
| 2350 "$ref": "InterpolationPoint", |
| 2351 "description": "The starting interpolation point." |
| 2352 }, |
| 2353 "maxpoint": { |
| 2354 "$ref": "InterpolationPoint", |
| 2355 "description": "The final interpolation point." |
| 2356 } |
| 2357 }, |
| 2358 "type": "object" |
| 2359 }, |
| 2360 "ClearValuesRequest": { |
| 2361 "description": "The request for clearing a range of values in a spre
adsheet.", |
| 2362 "id": "ClearValuesRequest", |
| 2363 "properties": {}, |
| 2364 "type": "object" |
| 2365 }, |
| 2366 "SetBasicFilterRequest": { |
| 2367 "description": "Sets the basic filter associated with a sheet.", |
| 2368 "id": "SetBasicFilterRequest", |
| 2369 "properties": { |
| 2370 "filter": { |
| 2371 "$ref": "BasicFilter", |
| 2372 "description": "The filter to set." |
| 2373 } |
| 2374 }, |
| 2375 "type": "object" |
2108 }, | 2376 }, |
2109 "InterpolationPoint": { | 2377 "InterpolationPoint": { |
2110 "description": "A single interpolation point on a gradient condition
al format.\nThese pin the gradient color scale according to the color,\ntype and
value chosen.", | 2378 "description": "A single interpolation point on a gradient condition
al format.\nThese pin the gradient color scale according to the color,\ntype and
value chosen.", |
2111 "id": "InterpolationPoint", | 2379 "id": "InterpolationPoint", |
2112 "properties": { | 2380 "properties": { |
2113 "value": { | |
2114 "description": "The value this interpolation point uses. Ma
y be a formula.\nUnused if type is MIN or\nMAX.", | |
2115 "type": "string" | |
2116 }, | |
2117 "color": { | 2381 "color": { |
2118 "$ref": "Color", | 2382 "$ref": "Color", |
2119 "description": "The color this interpolation point should us
e." | 2383 "description": "The color this interpolation point should us
e." |
2120 }, | 2384 }, |
2121 "type": { | 2385 "type": { |
2122 "description": "How the value should be interpreted.", | 2386 "description": "How the value should be interpreted.", |
2123 "enum": [ | 2387 "enum": [ |
2124 "INTERPOLATION_POINT_TYPE_UNSPECIFIED", | 2388 "INTERPOLATION_POINT_TYPE_UNSPECIFIED", |
2125 "MIN", | 2389 "MIN", |
2126 "MAX", | 2390 "MAX", |
2127 "NUMBER", | 2391 "NUMBER", |
2128 "PERCENT", | 2392 "PERCENT", |
2129 "PERCENTILE" | 2393 "PERCENTILE" |
2130 ], | 2394 ], |
2131 "enumDescriptions": [ | 2395 "enumDescriptions": [ |
2132 "The default value, do not use.", | 2396 "The default value, do not use.", |
2133 "The interpolation point will use the minimum value in t
he\ncells over the range of the conditional format.", | 2397 "The interpolation point will use the minimum value in t
he\ncells over the range of the conditional format.", |
2134 "The interpolation point will use the maximum value in t
he\ncells over the range of the conditional format.", | 2398 "The interpolation point will use the maximum value in t
he\ncells over the range of the conditional format.", |
2135 "The interpolation point will use exactly the value in\n
InterpolationPoint.value.", | 2399 "The interpolation point will use exactly the value in\n
InterpolationPoint.value.", |
2136 "The interpolation point will be the given percentage ov
er\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(FLA
TTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored whe
n flattening).", | 2400 "The interpolation point will be the given percentage ov
er\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(FLA
TTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored whe
n flattening).", |
2137 "The interpolation point will be the given percentile\no
ver 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 er
rors in the range are ignored when flattening)." | 2401 "The interpolation point will be the given percentile\no
ver 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 er
rors in the range are ignored when flattening)." |
2138 ], | 2402 ], |
2139 "type": "string" | 2403 "type": "string" |
| 2404 }, |
| 2405 "value": { |
| 2406 "description": "The value this interpolation point uses. Ma
y be a formula.\nUnused if type is MIN or\nMAX.", |
| 2407 "type": "string" |
2140 } | 2408 } |
2141 }, | 2409 }, |
2142 "type": "object" | 2410 "type": "object" |
2143 }, | 2411 }, |
2144 "ErrorValue": { | 2412 "DeleteEmbeddedObjectRequest": { |
2145 "description": "An error in a cell.", | 2413 "description": "Deletes the embedded object with the given ID.", |
2146 "id": "ErrorValue", | 2414 "id": "DeleteEmbeddedObjectRequest", |
2147 "properties": { | 2415 "properties": { |
2148 "type": { | 2416 "objectId": { |
2149 "description": "The type of error.", | 2417 "description": "The ID of the embedded object to delete.", |
2150 "enum": [ | 2418 "format": "int32", |
2151 "ERROR_TYPE_UNSPECIFIED", | 2419 "type": "integer" |
2152 "ERROR", | |
2153 "NULL_VALUE", | |
2154 "DIVIDE_BY_ZERO", | |
2155 "VALUE", | |
2156 "REF", | |
2157 "NAME", | |
2158 "NUM", | |
2159 "N_A", | |
2160 "LOADING" | |
2161 ], | |
2162 "enumDescriptions": [ | |
2163 "The default error type, do not use this.", | |
2164 "Corresponds to the `#ERROR!` error.", | |
2165 "Corresponds to the `#NULL!` error.", | |
2166 "Corresponds to the `#DIV/0` error.", | |
2167 "Corresponds to the `#VALUE!` error.", | |
2168 "Corresponds to the `#REF!` error.", | |
2169 "Corresponds to the `#NAME?` error.", | |
2170 "Corresponds to the `#NUM`! error.", | |
2171 "Corresponds to the `#N/A` error.", | |
2172 "Corresponds to the `Loading...` state." | |
2173 ], | |
2174 "type": "string" | |
2175 }, | |
2176 "message": { | |
2177 "description": "A message with more information about the er
ror\n(in the spreadsheet's locale).", | |
2178 "type": "string" | |
2179 } | 2420 } |
2180 }, | 2421 }, |
2181 "type": "object" | 2422 "type": "object" |
| 2423 }, |
| 2424 "FindReplaceResponse": { |
| 2425 "description": "The result of the find/replace.", |
| 2426 "id": "FindReplaceResponse", |
| 2427 "properties": { |
| 2428 "valuesChanged": { |
| 2429 "description": "The number of non-formula cells changed.", |
| 2430 "format": "int32", |
| 2431 "type": "integer" |
| 2432 }, |
| 2433 "occurrencesChanged": { |
| 2434 "description": "The number of occurrences (possibly multiple
within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"G
oogle Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -> `\"Googlo
Shoots\"`.", |
| 2435 "format": "int32", |
| 2436 "type": "integer" |
| 2437 }, |
| 2438 "rowsChanged": { |
| 2439 "description": "The number of rows changed.", |
| 2440 "format": "int32", |
| 2441 "type": "integer" |
| 2442 }, |
| 2443 "sheetsChanged": { |
| 2444 "description": "The number of sheets changed.", |
| 2445 "format": "int32", |
| 2446 "type": "integer" |
| 2447 }, |
| 2448 "formulasChanged": { |
| 2449 "description": "The number of formula cells changed.", |
| 2450 "format": "int32", |
| 2451 "type": "integer" |
| 2452 } |
| 2453 }, |
| 2454 "type": "object" |
2182 }, | 2455 }, |
2183 "DuplicateFilterViewRequest": { | 2456 "DuplicateFilterViewRequest": { |
2184 "description": "Duplicates a particular filter view.", | 2457 "description": "Duplicates a particular filter view.", |
2185 "id": "DuplicateFilterViewRequest", | 2458 "id": "DuplicateFilterViewRequest", |
2186 "properties": { | 2459 "properties": { |
2187 "filterId": { | 2460 "filterId": { |
2188 "description": "The ID of the filter being duplicated.", | 2461 "description": "The ID of the filter being duplicated.", |
2189 "format": "int32", | 2462 "format": "int32", |
2190 "type": "integer" | 2463 "type": "integer" |
2191 } | 2464 } |
2192 }, | 2465 }, |
2193 "type": "object" | 2466 "type": "object" |
2194 }, | 2467 }, |
2195 "BatchUpdateSpreadsheetRequest": { | 2468 "DeleteSheetRequest": { |
2196 "description": "The request for updating any aspect of a spreadsheet
.", | 2469 "description": "Deletes the requested sheet.", |
2197 "id": "BatchUpdateSpreadsheetRequest", | 2470 "id": "DeleteSheetRequest", |
2198 "properties": { | |
2199 "includeSpreadsheetInResponse": { | |
2200 "description": "Determines if the update response should inc
lude the spreadsheet\nresource.", | |
2201 "type": "boolean" | |
2202 }, | |
2203 "requests": { | |
2204 "description": "A list of updates to apply to the spreadshee
t.", | |
2205 "items": { | |
2206 "$ref": "Request" | |
2207 }, | |
2208 "type": "array" | |
2209 }, | |
2210 "responseRanges": { | |
2211 "description": "Limits the ranges included in the response s
preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.", | |
2212 "items": { | |
2213 "type": "string" | |
2214 }, | |
2215 "type": "array" | |
2216 }, | |
2217 "responseIncludeGridData": { | |
2218 "description": "True if grid data should be returned. Meanin
gful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is igno
red if a field mask was set in the request.", | |
2219 "type": "boolean" | |
2220 } | |
2221 }, | |
2222 "type": "object" | |
2223 }, | |
2224 "SheetProperties": { | |
2225 "description": "Properties of a sheet.", | |
2226 "id": "SheetProperties", | |
2227 "properties": { | |
2228 "title": { | |
2229 "description": "The name of the sheet.", | |
2230 "type": "string" | |
2231 }, | |
2232 "index": { | |
2233 "description": "The index of the sheet within the spreadshee
t.\nWhen adding or updating sheet properties, if this field\nis excluded then th
e sheet will be added or moved to the end\nof the sheet list. When updating shee
t indices or inserting\nsheets, movement is considered in \"before the move\" in
dexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ah
ead of S2 the index would have to be set to 2. A sheet\nindex update request wil
l be 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.", | |
2234 "format": "int32", | |
2235 "type": "integer" | |
2236 }, | |
2237 "hidden": { | |
2238 "description": "True if the sheet is hidden in the UI, false
if it's visible.", | |
2239 "type": "boolean" | |
2240 }, | |
2241 "gridProperties": { | |
2242 "$ref": "GridProperties", | |
2243 "description": "Additional properties of the sheet if this s
heet 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 p
roperties on non-grid sheets." | |
2244 }, | |
2245 "sheetId": { | |
2246 "description": "The ID of the sheet. Must be non-negative.\n
This field cannot be changed once set.", | |
2247 "format": "int32", | |
2248 "type": "integer" | |
2249 }, | |
2250 "rightToLeft": { | |
2251 "description": "True if the sheet is an RTL sheet instead of
an LTR sheet.", | |
2252 "type": "boolean" | |
2253 }, | |
2254 "tabColor": { | |
2255 "$ref": "Color", | |
2256 "description": "The color of the tab in the UI." | |
2257 }, | |
2258 "sheetType": { | |
2259 "description": "The type of sheet. Defaults to GRID.\nThis f
ield cannot be changed once set.", | |
2260 "enum": [ | |
2261 "SHEET_TYPE_UNSPECIFIED", | |
2262 "GRID", | |
2263 "OBJECT" | |
2264 ], | |
2265 "enumDescriptions": [ | |
2266 "Default value, do not use.", | |
2267 "The sheet is a grid.", | |
2268 "The sheet has no grid and instead has an object like a
chart or image." | |
2269 ], | |
2270 "type": "string" | |
2271 } | |
2272 }, | |
2273 "type": "object" | |
2274 }, | |
2275 "ClearValuesRequest": { | |
2276 "description": "The request for clearing a range of values in a spre
adsheet.", | |
2277 "id": "ClearValuesRequest", | |
2278 "properties": {}, | |
2279 "type": "object" | |
2280 }, | |
2281 "ProtectedRange": { | |
2282 "description": "A protected range.", | |
2283 "id": "ProtectedRange", | |
2284 "properties": { | |
2285 "unprotectedRanges": { | |
2286 "description": "The list of unprotected ranges within a prot
ected sheet.\nUnprotected ranges are only supported on protected sheets.", | |
2287 "items": { | |
2288 "$ref": "GridRange" | |
2289 }, | |
2290 "type": "array" | |
2291 }, | |
2292 "description": { | |
2293 "description": "The description of this protected range.", | |
2294 "type": "string" | |
2295 }, | |
2296 "namedRangeId": { | |
2297 "description": "The named range this protected range is back
ed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.
", | |
2298 "type": "string" | |
2299 }, | |
2300 "requestingUserCanEdit": { | |
2301 "description": "True if the user who requested this protecte
d range can edit the\nprotected area.\nThis field is read-only.", | |
2302 "type": "boolean" | |
2303 }, | |
2304 "editors": { | |
2305 "$ref": "Editors", | |
2306 "description": "The users and groups with edit access to the
protected range.\nThis field is only visible to users with edit access to the p
rotected\nrange and the document.\nEditors are not supported with warning_only p
rotection." | |
2307 }, | |
2308 "protectedRangeId": { | |
2309 "description": "The ID of the protected range.\nThis field i
s read-only.", | |
2310 "format": "int32", | |
2311 "type": "integer" | |
2312 }, | |
2313 "warningOnly": { | |
2314 "description": "True if this protected range will show a war
ning 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\n
to confirm the edit.\n\nWhen writing: if this field is true, then editors is ign
ored.\nAdditionally, if this field is changed from true to false and the\n`edito
rs` field is not set (nor included in the field mask), then\nthe editors will be
set to all the editors in the document.", | |
2315 "type": "boolean" | |
2316 }, | |
2317 "range": { | |
2318 "$ref": "GridRange", | |
2319 "description": "The range that is being protected.\nThe rang
e 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." | |
2320 } | |
2321 }, | |
2322 "type": "object" | |
2323 }, | |
2324 "DeleteConditionalFormatRuleRequest": { | |
2325 "description": "Deletes a conditional format rule at the given index
.\nAll subsequent rules' indexes are decremented.", | |
2326 "id": "DeleteConditionalFormatRuleRequest", | |
2327 "properties": { | 2471 "properties": { |
2328 "sheetId": { | 2472 "sheetId": { |
2329 "description": "The sheet the rule is being deleted from.", | 2473 "description": "The ID of the sheet to delete.", |
2330 "format": "int32", | |
2331 "type": "integer" | |
2332 }, | |
2333 "index": { | |
2334 "description": "The zero-based index of the rule to be delet
ed.", | |
2335 "format": "int32", | 2474 "format": "int32", |
2336 "type": "integer" | 2475 "type": "integer" |
2337 } | 2476 } |
2338 }, | 2477 }, |
2339 "type": "object" | 2478 "type": "object" |
2340 }, | 2479 }, |
2341 "DeleteRangeRequest": { | 2480 "UpdateConditionalFormatRuleResponse": { |
2342 "description": "Deletes a range of cells, shifting other cells into
the deleted area.", | 2481 "description": "The result of updating a conditional format rule.", |
2343 "id": "DeleteRangeRequest", | 2482 "id": "UpdateConditionalFormatRuleResponse", |
2344 "properties": { | 2483 "properties": { |
2345 "shiftDimension": { | 2484 "newIndex": { |
2346 "description": "The dimension from which deleted cells will
be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace th
e deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the
deleted cells.", | 2485 "description": "The index of the new rule.", |
2347 "enum": [ | 2486 "format": "int32", |
2348 "DIMENSION_UNSPECIFIED", | 2487 "type": "integer" |
2349 "ROWS", | |
2350 "COLUMNS" | |
2351 ], | |
2352 "enumDescriptions": [ | |
2353 "The default value, do not use.", | |
2354 "Operates on the rows of a sheet.", | |
2355 "Operates on the columns of a sheet." | |
2356 ], | |
2357 "type": "string" | |
2358 }, | 2488 }, |
2359 "range": { | 2489 "oldIndex": { |
2360 "$ref": "GridRange", | 2490 "description": "The old index of the rule. Not set if a rule
was replaced\n(because it is the same as new_index).", |
2361 "description": "The range of cells to delete." | 2491 "format": "int32", |
| 2492 "type": "integer" |
| 2493 }, |
| 2494 "newRule": { |
| 2495 "$ref": "ConditionalFormatRule", |
| 2496 "description": "The new rule that replaced the old rule (if
replacing),\nor the rule that was moved (if moved)" |
| 2497 }, |
| 2498 "oldRule": { |
| 2499 "$ref": "ConditionalFormatRule", |
| 2500 "description": "The old (deleted) rule. Not set if a rule wa
s moved\n(because it is the same as new_rule)." |
2362 } | 2501 } |
2363 }, | 2502 }, |
2364 "type": "object" | 2503 "type": "object" |
2365 }, | 2504 }, |
2366 "InsertRangeRequest": { | 2505 "DuplicateSheetRequest": { |
2367 "description": "Inserts cells into a range, shifting the existing ce
lls over or down.", | 2506 "description": "Duplicates the contents of a sheet.", |
2368 "id": "InsertRangeRequest", | 2507 "id": "DuplicateSheetRequest", |
2369 "properties": { | 2508 "properties": { |
2370 "shiftDimension": { | 2509 "insertSheetIndex": { |
2371 "description": "The dimension which will be shifted when ins
erting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existi
ng cells will be shifted right.", | 2510 "description": "The zero-based index where the new sheet sho
uld be inserted.\nThe index of all sheets after this are incremented.", |
2372 "enum": [ | 2511 "format": "int32", |
2373 "DIMENSION_UNSPECIFIED", | 2512 "type": "integer" |
2374 "ROWS", | 2513 }, |
2375 "COLUMNS" | 2514 "newSheetName": { |
2376 ], | 2515 "description": "The name of the new sheet. If empty, a new
name is chosen for you.", |
2377 "enumDescriptions": [ | |
2378 "The default value, do not use.", | |
2379 "Operates on the rows of a sheet.", | |
2380 "Operates on the columns of a sheet." | |
2381 ], | |
2382 "type": "string" | 2516 "type": "string" |
2383 }, | 2517 }, |
2384 "range": { | 2518 "sourceSheetId": { |
2385 "$ref": "GridRange", | 2519 "description": "The sheet to duplicate.", |
2386 "description": "The range to insert new cells into." | 2520 "format": "int32", |
| 2521 "type": "integer" |
| 2522 }, |
| 2523 "newSheetId": { |
| 2524 "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.", |
| 2525 "format": "int32", |
| 2526 "type": "integer" |
2387 } | 2527 } |
2388 }, | 2528 }, |
2389 "type": "object" | 2529 "type": "object" |
2390 }, | |
2391 "ChartSpec": { | |
2392 "description": "The specifications of a chart.", | |
2393 "id": "ChartSpec", | |
2394 "properties": { | |
2395 "hiddenDimensionStrategy": { | |
2396 "description": "Determines how the charts will use hidden ro
ws or columns.", | |
2397 "enum": [ | |
2398 "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED", | |
2399 "SKIP_HIDDEN_ROWS_AND_COLUMNS", | |
2400 "SKIP_HIDDEN_ROWS", | |
2401 "SKIP_HIDDEN_COLUMNS", | |
2402 "SHOW_ALL" | |
2403 ], | |
2404 "enumDescriptions": [ | |
2405 "Default value, do not use.", | |
2406 "Charts will skip hidden rows and columns.", | |
2407 "Charts will skip hidden rows only.", | |
2408 "Charts will skip hidden columns only.", | |
2409 "Charts will not skip any hidden rows or columns." | |
2410 ], | |
2411 "type": "string" | |
2412 }, | |
2413 "basicChart": { | |
2414 "$ref": "BasicChartSpec", | |
2415 "description": "A basic chart specification, can be one of m
any kinds of charts.\nSee BasicChartType for the list of all\ncharts this suppor
ts." | |
2416 }, | |
2417 "title": { | |
2418 "description": "The title of the chart.", | |
2419 "type": "string" | |
2420 }, | |
2421 "pieChart": { | |
2422 "$ref": "PieChartSpec", | |
2423 "description": "A pie chart specification." | |
2424 } | |
2425 }, | |
2426 "type": "object" | |
2427 }, | |
2428 "SourceAndDestination": { | |
2429 "description": "A combination of a source range and how to extend th
at source.", | |
2430 "id": "SourceAndDestination", | |
2431 "properties": { | |
2432 "source": { | |
2433 "$ref": "GridRange", | |
2434 "description": "The location of the data to use as the sourc
e of the autofill." | |
2435 }, | |
2436 "fillLength": { | |
2437 "description": "The number of rows or columns that data shou
ld be filled into.\nPositive numbers expand beyond the last row or last column\n
of the source. Negative numbers expand before the first row\nor first column of
the source.", | |
2438 "format": "int32", | |
2439 "type": "integer" | |
2440 }, | |
2441 "dimension": { | |
2442 "description": "The dimension that data should be filled int
o.", | |
2443 "enum": [ | |
2444 "DIMENSION_UNSPECIFIED", | |
2445 "ROWS", | |
2446 "COLUMNS" | |
2447 ], | |
2448 "enumDescriptions": [ | |
2449 "The default value, do not use.", | |
2450 "Operates on the rows of a sheet.", | |
2451 "Operates on the columns of a sheet." | |
2452 ], | |
2453 "type": "string" | |
2454 } | |
2455 }, | |
2456 "type": "object" | |
2457 }, | 2530 }, |
2458 "ConditionValue": { | 2531 "ConditionValue": { |
2459 "description": "The value of the condition.", | 2532 "description": "The value of the condition.", |
2460 "id": "ConditionValue", | 2533 "id": "ConditionValue", |
2461 "properties": { | 2534 "properties": { |
2462 "relativeDate": { | 2535 "relativeDate": { |
2463 "description": "A relative date (based on the current date).
\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDA
TE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey ar
e supported only in conditional formatting and\nconditional filters.", | 2536 "description": "A relative date (based on the current date).
\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDA
TE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey ar
e supported only in conditional formatting and\nconditional filters.", |
2464 "enum": [ | 2537 "enum": [ |
2465 "RELATIVE_DATE_UNSPECIFIED", | 2538 "RELATIVE_DATE_UNSPECIFIED", |
2466 "PAST_YEAR", | 2539 "PAST_YEAR", |
(...skipping 14 matching lines...) Expand all Loading... |
2481 ], | 2554 ], |
2482 "type": "string" | 2555 "type": "string" |
2483 }, | 2556 }, |
2484 "userEnteredValue": { | 2557 "userEnteredValue": { |
2485 "description": "A value the condition is based on.\nThe valu
e will be parsed as if the user typed into a cell.\nFormulas are supported (and
must begin with an `=`).", | 2558 "description": "A value the condition is based on.\nThe valu
e will be parsed as if the user typed into a cell.\nFormulas are supported (and
must begin with an `=`).", |
2486 "type": "string" | 2559 "type": "string" |
2487 } | 2560 } |
2488 }, | 2561 }, |
2489 "type": "object" | 2562 "type": "object" |
2490 }, | 2563 }, |
2491 "PasteDataRequest": { | 2564 "ExtendedValue": { |
2492 "description": "Inserts data into the spreadsheet starting at the sp
ecified coordinate.", | 2565 "description": "The kinds of value that a cell in a spreadsheet can
have.", |
2493 "id": "PasteDataRequest", | 2566 "id": "ExtendedValue", |
2494 "properties": { | 2567 "properties": { |
| 2568 "errorValue": { |
| 2569 "$ref": "ErrorValue", |
| 2570 "description": "Represents an error.\nThis field is read-onl
y." |
| 2571 }, |
| 2572 "stringValue": { |
| 2573 "description": "Represents a string value.\nLeading single q
uotes are not included. For example, if the user typed\n`'123` into the UI, this
would be represented as a `stringValue` of\n`\"123\"`.", |
| 2574 "type": "string" |
| 2575 }, |
| 2576 "boolValue": { |
| 2577 "description": "Represents a boolean value.", |
| 2578 "type": "boolean" |
| 2579 }, |
| 2580 "formulaValue": { |
| 2581 "description": "Represents a formula.", |
| 2582 "type": "string" |
| 2583 }, |
| 2584 "numberValue": { |
| 2585 "description": "Represents a double value.\nNote: Dates, Tim
es and DateTimes are represented as doubles in\n\"serial number\" format.", |
| 2586 "format": "double", |
| 2587 "type": "number" |
| 2588 } |
| 2589 }, |
| 2590 "type": "object" |
| 2591 }, |
| 2592 "BatchClearValuesResponse": { |
| 2593 "description": "The response when updating a range of values in a sp
readsheet.", |
| 2594 "id": "BatchClearValuesResponse", |
| 2595 "properties": { |
| 2596 "clearedRanges": { |
| 2597 "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 bo
unds of the sheet, this will be the actual ranges\n that were cleared, bounded t
o the sheet's limits.)", |
| 2598 "items": { |
| 2599 "type": "string" |
| 2600 }, |
| 2601 "type": "array" |
| 2602 }, |
| 2603 "spreadsheetId": { |
| 2604 "description": "The spreadsheet the updates were applied to.
", |
| 2605 "type": "string" |
| 2606 } |
| 2607 }, |
| 2608 "type": "object" |
| 2609 }, |
| 2610 "Spreadsheet": { |
| 2611 "description": "Resource that represents a spreadsheet.", |
| 2612 "id": "Spreadsheet", |
| 2613 "properties": { |
| 2614 "properties": { |
| 2615 "$ref": "SpreadsheetProperties", |
| 2616 "description": "Overall properties of a spreadsheet." |
| 2617 }, |
| 2618 "spreadsheetId": { |
| 2619 "description": "The ID of the spreadsheet.\nThis field is re
ad-only.", |
| 2620 "type": "string" |
| 2621 }, |
| 2622 "sheets": { |
| 2623 "description": "The sheets that are part of a spreadsheet.", |
| 2624 "items": { |
| 2625 "$ref": "Sheet" |
| 2626 }, |
| 2627 "type": "array" |
| 2628 }, |
| 2629 "namedRanges": { |
| 2630 "description": "The named ranges defined in a spreadsheet.", |
| 2631 "items": { |
| 2632 "$ref": "NamedRange" |
| 2633 }, |
| 2634 "type": "array" |
| 2635 }, |
| 2636 "spreadsheetUrl": { |
| 2637 "description": "The url of the spreadsheet.\nThis field is r
ead-only.", |
| 2638 "type": "string" |
| 2639 } |
| 2640 }, |
| 2641 "type": "object" |
| 2642 }, |
| 2643 "AddChartRequest": { |
| 2644 "description": "Adds a chart to a sheet in the spreadsheet.", |
| 2645 "id": "AddChartRequest", |
| 2646 "properties": { |
| 2647 "chart": { |
| 2648 "$ref": "EmbeddedChart", |
| 2649 "description": "The chart that should be added to the spread
sheet, 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 a chart that already exists.)" |
| 2650 } |
| 2651 }, |
| 2652 "type": "object" |
| 2653 }, |
| 2654 "BandedRange": { |
| 2655 "description": "A banded (alternating colors) range in a sheet.", |
| 2656 "id": "BandedRange", |
| 2657 "properties": { |
| 2658 "rowProperties": { |
| 2659 "$ref": "BandingProperties", |
| 2660 "description": "Properties for row bands. These properties w
ill be applied on a row-by-row\nbasis throughout all the rows in the range. At l
east one of\nrow_properties or column_properties must be specified." |
| 2661 }, |
| 2662 "columnProperties": { |
| 2663 "$ref": "BandingProperties", |
| 2664 "description": "Properties for column bands. These propertie
s will be applied on a column-\nby-column basis throughout all the columns in th
e range. At least one of\nrow_properties or column_properties must be specified.
" |
| 2665 }, |
| 2666 "range": { |
| 2667 "$ref": "GridRange", |
| 2668 "description": "The range over which these properties are ap
plied." |
| 2669 }, |
| 2670 "bandedRangeId": { |
| 2671 "description": "The id of the banded range.", |
| 2672 "format": "int32", |
| 2673 "type": "integer" |
| 2674 } |
| 2675 }, |
| 2676 "type": "object" |
| 2677 }, |
| 2678 "UpdateProtectedRangeRequest": { |
| 2679 "description": "Updates an existing protected range with the specifi
ed\nprotectedRangeId.", |
| 2680 "id": "UpdateProtectedRangeRequest", |
| 2681 "properties": { |
| 2682 "protectedRange": { |
| 2683 "$ref": "ProtectedRange", |
| 2684 "description": "The protected range to update with the new p
roperties." |
| 2685 }, |
| 2686 "fields": { |
| 2687 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `protectedRange` is implied and should n
ot be specified.\nA single `\"*\"` can be used as short-hand for listing every f
ield.", |
| 2688 "format": "google-fieldmask", |
| 2689 "type": "string" |
| 2690 } |
| 2691 }, |
| 2692 "type": "object" |
| 2693 }, |
| 2694 "TextFormat": { |
| 2695 "description": "The format of a run of text in a cell.\nAbsent value
s indicate that the field isn't specified.", |
| 2696 "id": "TextFormat", |
| 2697 "properties": { |
| 2698 "foregroundColor": { |
| 2699 "$ref": "Color", |
| 2700 "description": "The foreground color of the text." |
| 2701 }, |
| 2702 "bold": { |
| 2703 "description": "True if the text is bold.", |
| 2704 "type": "boolean" |
| 2705 }, |
| 2706 "fontFamily": { |
| 2707 "description": "The font family.", |
| 2708 "type": "string" |
| 2709 }, |
| 2710 "italic": { |
| 2711 "description": "True if the text is italicized.", |
| 2712 "type": "boolean" |
| 2713 }, |
| 2714 "strikethrough": { |
| 2715 "description": "True if the text has a strikethrough.", |
| 2716 "type": "boolean" |
| 2717 }, |
| 2718 "fontSize": { |
| 2719 "description": "The size of the font.", |
| 2720 "format": "int32", |
| 2721 "type": "integer" |
| 2722 }, |
| 2723 "underline": { |
| 2724 "description": "True if the text is underlined.", |
| 2725 "type": "boolean" |
| 2726 } |
| 2727 }, |
| 2728 "type": "object" |
| 2729 }, |
| 2730 "AddSheetResponse": { |
| 2731 "description": "The result of adding a sheet.", |
| 2732 "id": "AddSheetResponse", |
| 2733 "properties": { |
| 2734 "properties": { |
| 2735 "$ref": "SheetProperties", |
| 2736 "description": "The properties of the newly added sheet." |
| 2737 } |
| 2738 }, |
| 2739 "type": "object" |
| 2740 }, |
| 2741 "AddFilterViewResponse": { |
| 2742 "description": "The result of adding a filter view.", |
| 2743 "id": "AddFilterViewResponse", |
| 2744 "properties": { |
| 2745 "filter": { |
| 2746 "$ref": "FilterView", |
| 2747 "description": "The newly added filter view." |
| 2748 } |
| 2749 }, |
| 2750 "type": "object" |
| 2751 }, |
| 2752 "IterativeCalculationSettings": { |
| 2753 "description": "Settings to control how circular dependencies are re
solved with iterative\ncalculation.", |
| 2754 "id": "IterativeCalculationSettings", |
| 2755 "properties": { |
| 2756 "convergenceThreshold": { |
| 2757 "description": "When iterative calculation is enabled, the t
hreshold value such that\ncalculation rounds stop when succesive results differ
by less.", |
| 2758 "format": "double", |
| 2759 "type": "number" |
| 2760 }, |
| 2761 "maxIterations": { |
| 2762 "description": "When iterative calculation is enabled, the m
aximum number of calculation\nrounds to perform during iterative calculation.", |
| 2763 "format": "int32", |
| 2764 "type": "integer" |
| 2765 } |
| 2766 }, |
| 2767 "type": "object" |
| 2768 }, |
| 2769 "OverlayPosition": { |
| 2770 "description": "The location an object is overlaid on top of a grid.
", |
| 2771 "id": "OverlayPosition", |
| 2772 "properties": { |
| 2773 "offsetXPixels": { |
| 2774 "description": "The horizontal offset, in pixels, that the o
bject is offset\nfrom the anchor cell.", |
| 2775 "format": "int32", |
| 2776 "type": "integer" |
| 2777 }, |
| 2778 "anchorCell": { |
| 2779 "$ref": "GridCoordinate", |
| 2780 "description": "The cell the object is anchored to." |
| 2781 }, |
| 2782 "offsetYPixels": { |
| 2783 "description": "The vertical offset, in pixels, that the obj
ect is offset\nfrom the anchor cell.", |
| 2784 "format": "int32", |
| 2785 "type": "integer" |
| 2786 }, |
| 2787 "heightPixels": { |
| 2788 "description": "The height of the object, in pixels. Default
s to 371.", |
| 2789 "format": "int32", |
| 2790 "type": "integer" |
| 2791 }, |
| 2792 "widthPixels": { |
| 2793 "description": "The width of the object, in pixels. Defaults
to 600.", |
| 2794 "format": "int32", |
| 2795 "type": "integer" |
| 2796 } |
| 2797 }, |
| 2798 "type": "object" |
| 2799 }, |
| 2800 "SpreadsheetProperties": { |
| 2801 "description": "Properties of a spreadsheet.", |
| 2802 "id": "SpreadsheetProperties", |
| 2803 "properties": { |
| 2804 "locale": { |
| 2805 "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.", |
| 2806 "type": "string" |
| 2807 }, |
| 2808 "iterativeCalculationSettings": { |
| 2809 "$ref": "IterativeCalculationSettings", |
| 2810 "description": "Determines whether and how circular referenc
es are resolved with iterative\ncalculation. Absence of this field means that c
ircular references will\nresult in calculation errors." |
| 2811 }, |
| 2812 "autoRecalc": { |
| 2813 "description": "The amount of time to wait before volatile f
unctions are recalculated.", |
| 2814 "enum": [ |
| 2815 "RECALCULATION_INTERVAL_UNSPECIFIED", |
| 2816 "ON_CHANGE", |
| 2817 "MINUTE", |
| 2818 "HOUR" |
| 2819 ], |
| 2820 "enumDescriptions": [ |
| 2821 "Default value. This value must not be used.", |
| 2822 "Volatile functions are updated on every change.", |
| 2823 "Volatile functions are updated on every change and ever
y minute.", |
| 2824 "Volatile functions are updated on every change and hour
ly." |
| 2825 ], |
| 2826 "type": "string" |
| 2827 }, |
| 2828 "defaultFormat": { |
| 2829 "$ref": "CellFormat", |
| 2830 "description": "The default format of all cells in the sprea
dsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal
to this default format.\nThis field is read-only." |
| 2831 }, |
| 2832 "timeZone": { |
| 2833 "description": "The time zone of the spreadsheet, in CLDR fo
rmat such as\n`America/New_York`. If the time zone isn't recognized, this may\nb
e a custom time zone such as `GMT-07:00`.", |
| 2834 "type": "string" |
| 2835 }, |
| 2836 "title": { |
| 2837 "description": "The title of the spreadsheet.", |
| 2838 "type": "string" |
| 2839 } |
| 2840 }, |
| 2841 "type": "object" |
| 2842 }, |
| 2843 "RepeatCellRequest": { |
| 2844 "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; othe
rs are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges wil
l 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 `=A
2`, 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, us
e the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.
", |
| 2845 "id": "RepeatCellRequest", |
| 2846 "properties": { |
| 2847 "range": { |
| 2848 "$ref": "GridRange", |
| 2849 "description": "The range to repeat the cell in." |
| 2850 }, |
| 2851 "fields": { |
| 2852 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `cell` is implied and should not be spec
ified.\nA single `\"*\"` can be used as short-hand for listing every field.", |
| 2853 "format": "google-fieldmask", |
| 2854 "type": "string" |
| 2855 }, |
| 2856 "cell": { |
| 2857 "$ref": "CellData", |
| 2858 "description": "The data to write." |
| 2859 } |
| 2860 }, |
| 2861 "type": "object" |
| 2862 }, |
| 2863 "AddChartResponse": { |
| 2864 "description": "The result of adding a chart to a spreadsheet.", |
| 2865 "id": "AddChartResponse", |
| 2866 "properties": { |
| 2867 "chart": { |
| 2868 "$ref": "EmbeddedChart", |
| 2869 "description": "The newly added chart." |
| 2870 } |
| 2871 }, |
| 2872 "type": "object" |
| 2873 }, |
| 2874 "InsertDimensionRequest": { |
| 2875 "description": "Inserts rows or columns in a sheet at a particular i
ndex.", |
| 2876 "id": "InsertDimensionRequest", |
| 2877 "properties": { |
| 2878 "inheritFromBefore": { |
| 2879 "description": "Whether dimension properties should be exten
ded 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 grea
ter 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 in
serting 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 befor
e the insertion point\nwas red), whereas if `inheritFromBefore` is false, the tw
o new rows will\nbe green (because the row after the insertion point was green).
", |
| 2880 "type": "boolean" |
| 2881 }, |
| 2882 "range": { |
| 2883 "$ref": "DimensionRange", |
| 2884 "description": "The dimensions to insert. Both the start an
d end indexes must be bounded." |
| 2885 } |
| 2886 }, |
| 2887 "type": "object" |
| 2888 }, |
| 2889 "UpdateSpreadsheetPropertiesRequest": { |
| 2890 "description": "Updates properties of a spreadsheet.", |
| 2891 "id": "UpdateSpreadsheetPropertiesRequest", |
| 2892 "properties": { |
| 2893 "properties": { |
| 2894 "$ref": "SpreadsheetProperties", |
| 2895 "description": "The properties to update." |
| 2896 }, |
| 2897 "fields": { |
| 2898 "description": "The fields that should be updated. At least
one field must be specified.\nThe root 'properties' is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", |
| 2899 "format": "google-fieldmask", |
| 2900 "type": "string" |
| 2901 } |
| 2902 }, |
| 2903 "type": "object" |
| 2904 }, |
| 2905 "BatchUpdateValuesRequest": { |
| 2906 "description": "The request for updating more than one range of valu
es in a spreadsheet.", |
| 2907 "id": "BatchUpdateValuesRequest", |
| 2908 "properties": { |
| 2909 "responseValueRenderOption": { |
| 2910 "description": "Determines how values in the response should
be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", |
| 2911 "enum": [ |
| 2912 "FORMATTED_VALUE", |
| 2913 "UNFORMATTED_VALUE", |
| 2914 "FORMULA" |
| 2915 ], |
| 2916 "enumDescriptions": [ |
| 2917 "Values will be calculated & formatted in the reply acco
rding to the\ncell's formatting. Formatting is based on the spreadsheet's local
e,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` i
s `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", |
| 2918 "Values will be calculated, but not formatted in the rep
ly.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,
\nthen `A2` would return the number `1.23`.", |
| 2919 "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\"`." |
| 2920 ], |
| 2921 "type": "string" |
| 2922 }, |
| 2923 "includeValuesInResponse": { |
| 2924 "description": "Determines if the update response should inc
lude the values\nof the cells that were updated. By default, responses\ndo not i
nclude the updated values. The `updatedData` field within\neach of the BatchUpda
teValuesResponse.responses will contain\nthe updated values. If the range to wri
te was larger than than the range\nactually written, the response will include a
ll values in the requested\nrange (excluding trailing empty rows and columns).", |
| 2925 "type": "boolean" |
| 2926 }, |
| 2927 "valueInputOption": { |
| 2928 "description": "How the input data should be interpreted.", |
| 2929 "enum": [ |
| 2930 "INPUT_VALUE_OPTION_UNSPECIFIED", |
| 2931 "RAW", |
| 2932 "USER_ENTERED" |
| 2933 ], |
| 2934 "enumDescriptions": [ |
| 2935 "Default input value. This value must not be used.", |
| 2936 "The values the user has entered will not be parsed and
will be stored\nas-is.", |
| 2937 "The values will be parsed as if the user typed them int
o 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 int
o a cell via the Google Sheets UI." |
| 2938 ], |
| 2939 "type": "string" |
| 2940 }, |
2495 "data": { | 2941 "data": { |
2496 "description": "The data to insert.", | 2942 "description": "The new values to apply to the spreadsheet."
, |
2497 "type": "string" | 2943 "items": { |
2498 }, | 2944 "$ref": "ValueRange" |
2499 "coordinate": { | 2945 }, |
2500 "$ref": "GridCoordinate", | 2946 "type": "array" |
2501 "description": "The coordinate at which the data should star
t being inserted." | 2947 }, |
2502 }, | 2948 "responseDateTimeRenderOption": { |
2503 "delimiter": { | 2949 "description": "Determines how dates, times, and durations i
n the response should be\nrendered. This is ignored if response_value_render_opt
ion is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderO
ption.SERIAL_NUMBER].", |
2504 "description": "The delimiter in the data.", | 2950 "enum": [ |
2505 "type": "string" | 2951 "SERIAL_NUMBER", |
2506 }, | 2952 "FORMATTED_STRING" |
2507 "type": { | 2953 ], |
2508 "description": "How the data should be pasted.", | 2954 "enumDescriptions": [ |
| 2955 "Instructs date, time, datetime, and duration fields to
be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3
.\nDays are counted from December 31st 1899 and are incremented by 1,\nand times
are fractions of a day. For example, January 1st 1900 at noon\nwould be 1.5, 1
because it's 1 day offset from December 31st 1899,\nand .5 because noon is half
a day. February 1st 1900 at 3pm would\nbe 32.625. This correctly treats the ye
ar 1900 as not a leap year.", |
| 2956 "Instructs date, time, datetime, and duration fields to
be output\nas strings in their given number format (which is dependent\non the s
preadsheet locale)." |
| 2957 ], |
| 2958 "type": "string" |
| 2959 } |
| 2960 }, |
| 2961 "type": "object" |
| 2962 }, |
| 2963 "ProtectedRange": { |
| 2964 "description": "A protected range.", |
| 2965 "id": "ProtectedRange", |
| 2966 "properties": { |
| 2967 "unprotectedRanges": { |
| 2968 "description": "The list of unprotected ranges within a prot
ected sheet.\nUnprotected ranges are only supported on protected sheets.", |
| 2969 "items": { |
| 2970 "$ref": "GridRange" |
| 2971 }, |
| 2972 "type": "array" |
| 2973 }, |
| 2974 "namedRangeId": { |
| 2975 "description": "The named range this protected range is back
ed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.
", |
| 2976 "type": "string" |
| 2977 }, |
| 2978 "protectedRangeId": { |
| 2979 "description": "The ID of the protected range.\nThis field i
s read-only.", |
| 2980 "format": "int32", |
| 2981 "type": "integer" |
| 2982 }, |
| 2983 "warningOnly": { |
| 2984 "description": "True if this protected range will show a war
ning 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\n
to confirm the edit.\n\nWhen writing: if this field is true, then editors is ign
ored.\nAdditionally, if this field is changed from true to false and the\n`edito
rs` field is not set (nor included in the field mask), then\nthe editors will be
set to all the editors in the document.", |
| 2985 "type": "boolean" |
| 2986 }, |
| 2987 "requestingUserCanEdit": { |
| 2988 "description": "True if the user who requested this protecte
d range can edit the\nprotected area.\nThis field is read-only.", |
| 2989 "type": "boolean" |
| 2990 }, |
| 2991 "editors": { |
| 2992 "$ref": "Editors", |
| 2993 "description": "The users and groups with edit access to the
protected range.\nThis field is only visible to users with edit access to the p
rotected\nrange and the document.\nEditors are not supported with warning_only p
rotection." |
| 2994 }, |
| 2995 "range": { |
| 2996 "$ref": "GridRange", |
| 2997 "description": "The range that is being protected.\nThe rang
e 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." |
| 2998 }, |
| 2999 "description": { |
| 3000 "description": "The description of this protected range.", |
| 3001 "type": "string" |
| 3002 } |
| 3003 }, |
| 3004 "type": "object" |
| 3005 }, |
| 3006 "DimensionProperties": { |
| 3007 "description": "Properties about a dimension.", |
| 3008 "id": "DimensionProperties", |
| 3009 "properties": { |
| 3010 "hiddenByFilter": { |
| 3011 "description": "True if this dimension is being filtered.\nT
his field is read-only.", |
| 3012 "type": "boolean" |
| 3013 }, |
| 3014 "hiddenByUser": { |
| 3015 "description": "True if this dimension is explicitly hidden.
", |
| 3016 "type": "boolean" |
| 3017 }, |
| 3018 "pixelSize": { |
| 3019 "description": "The height (if a row) or width (if a column)
of the dimension in pixels.", |
| 3020 "format": "int32", |
| 3021 "type": "integer" |
| 3022 } |
| 3023 }, |
| 3024 "type": "object" |
| 3025 }, |
| 3026 "NamedRange": { |
| 3027 "description": "A named range.", |
| 3028 "id": "NamedRange", |
| 3029 "properties": { |
| 3030 "namedRangeId": { |
| 3031 "description": "The ID of the named range.", |
| 3032 "type": "string" |
| 3033 }, |
| 3034 "range": { |
| 3035 "$ref": "GridRange", |
| 3036 "description": "The range this represents." |
| 3037 }, |
| 3038 "name": { |
| 3039 "description": "The name of the named range.", |
| 3040 "type": "string" |
| 3041 } |
| 3042 }, |
| 3043 "type": "object" |
| 3044 }, |
| 3045 "DimensionRange": { |
| 3046 "description": "A range along a single dimension on a sheet.\nAll in
dexes 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.", |
| 3047 "id": "DimensionRange", |
| 3048 "properties": { |
| 3049 "startIndex": { |
| 3050 "description": "The start (inclusive) of the span, or not se
t if unbounded.", |
| 3051 "format": "int32", |
| 3052 "type": "integer" |
| 3053 }, |
| 3054 "endIndex": { |
| 3055 "description": "The end (exclusive) of the span, or not set
if unbounded.", |
| 3056 "format": "int32", |
| 3057 "type": "integer" |
| 3058 }, |
| 3059 "sheetId": { |
| 3060 "description": "The sheet this span is on.", |
| 3061 "format": "int32", |
| 3062 "type": "integer" |
| 3063 }, |
| 3064 "dimension": { |
| 3065 "description": "The dimension of the span.", |
| 3066 "enum": [ |
| 3067 "DIMENSION_UNSPECIFIED", |
| 3068 "ROWS", |
| 3069 "COLUMNS" |
| 3070 ], |
| 3071 "enumDescriptions": [ |
| 3072 "The default value, do not use.", |
| 3073 "Operates on the rows of a sheet.", |
| 3074 "Operates on the columns of a sheet." |
| 3075 ], |
| 3076 "type": "string" |
| 3077 } |
| 3078 }, |
| 3079 "type": "object" |
| 3080 }, |
| 3081 "CutPasteRequest": { |
| 3082 "description": "Moves data from the source to the destination.", |
| 3083 "id": "CutPasteRequest", |
| 3084 "properties": { |
| 3085 "source": { |
| 3086 "$ref": "GridRange", |
| 3087 "description": "The source data to cut." |
| 3088 }, |
| 3089 "pasteType": { |
| 3090 "description": "What kind of data to paste. All the source
data will be cut, regardless\nof what is pasted.", |
2509 "enum": [ | 3091 "enum": [ |
2510 "PASTE_NORMAL", | 3092 "PASTE_NORMAL", |
2511 "PASTE_VALUES", | 3093 "PASTE_VALUES", |
2512 "PASTE_FORMAT", | 3094 "PASTE_FORMAT", |
2513 "PASTE_NO_BORDERS", | 3095 "PASTE_NO_BORDERS", |
2514 "PASTE_FORMULA", | 3096 "PASTE_FORMULA", |
2515 "PASTE_DATA_VALIDATION", | 3097 "PASTE_DATA_VALIDATION", |
2516 "PASTE_CONDITIONAL_FORMATTING" | 3098 "PASTE_CONDITIONAL_FORMATTING" |
2517 ], | 3099 ], |
2518 "enumDescriptions": [ | 3100 "enumDescriptions": [ |
2519 "Paste values, formulas, formats, and merges.", | 3101 "Paste values, formulas, formats, and merges.", |
2520 "Paste the values ONLY without formats, formulas, or mer
ges.", | 3102 "Paste the values ONLY without formats, formulas, or mer
ges.", |
2521 "Paste the format and data validation only.", | 3103 "Paste the format and data validation only.", |
2522 "Like PASTE_NORMAL but without borders.", | 3104 "Like PASTE_NORMAL but without borders.", |
2523 "Paste the formulas only.", | 3105 "Paste the formulas only.", |
2524 "Paste the data validation only.", | 3106 "Paste the data validation only.", |
2525 "Paste the conditional formatting rules only." | 3107 "Paste the conditional formatting rules only." |
2526 ], | 3108 ], |
2527 "type": "string" | 3109 "type": "string" |
2528 }, | 3110 }, |
2529 "html": { | 3111 "destination": { |
2530 "description": "True if the data is HTML.", | 3112 "$ref": "GridCoordinate", |
2531 "type": "boolean" | 3113 "description": "The top-left coordinate where the data shoul
d be pasted." |
2532 } | 3114 } |
2533 }, | 3115 }, |
2534 "type": "object" | 3116 "type": "object" |
2535 }, | 3117 }, |
2536 "FindReplaceRequest": { | 3118 "Borders": { |
2537 "description": "Finds and replaces data in cells over a range, sheet
, or all sheets.", | 3119 "description": "The borders of the cell.", |
2538 "id": "FindReplaceRequest", | 3120 "id": "Borders", |
2539 "properties": { | 3121 "properties": { |
2540 "find": { | 3122 "top": { |
2541 "description": "The value to search.", | 3123 "$ref": "Border", |
2542 "type": "string" | 3124 "description": "The top border of the cell." |
2543 }, | 3125 }, |
2544 "replacement": { | 3126 "left": { |
2545 "description": "The value to use as the replacement.", | 3127 "$ref": "Border", |
2546 "type": "string" | 3128 "description": "The left border of the cell." |
2547 }, | 3129 }, |
2548 "searchByRegex": { | 3130 "right": { |
2549 "description": "True if the find value is a regex.\nThe regu
lar expression and replacement should follow Java regex rules\nat https://docs.o
racle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement strin
g is allowed to refer to capturing groups.\nFor example, if one cell has the con
tents `\"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.", | 3131 "$ref": "Border", |
2550 "type": "boolean" | 3132 "description": "The right border of the cell." |
2551 }, | 3133 }, |
2552 "sheetId": { | 3134 "bottom": { |
2553 "description": "The sheet to find/replace over.", | 3135 "$ref": "Border", |
2554 "format": "int32", | 3136 "description": "The bottom border of the cell." |
2555 "type": "integer" | 3137 } |
2556 }, | 3138 }, |
2557 "allSheets": { | 3139 "type": "object" |
2558 "description": "True to find/replace over all sheets.", | |
2559 "type": "boolean" | |
2560 }, | |
2561 "matchCase": { | |
2562 "description": "True if the search is case sensitive.", | |
2563 "type": "boolean" | |
2564 }, | |
2565 "includeFormulas": { | |
2566 "description": "True if the search should include cells with
formulas.\nFalse to skip cells with formulas.", | |
2567 "type": "boolean" | |
2568 }, | |
2569 "range": { | |
2570 "$ref": "GridRange", | |
2571 "description": "The range to find/replace over." | |
2572 }, | |
2573 "matchEntireCell": { | |
2574 "description": "True if the find value should match the enti
re cell.", | |
2575 "type": "boolean" | |
2576 } | |
2577 }, | |
2578 "type": "object" | |
2579 }, | |
2580 "SortSpec": { | |
2581 "description": "A sort order associated with a specific column or ro
w.", | |
2582 "id": "SortSpec", | |
2583 "properties": { | |
2584 "sortOrder": { | |
2585 "description": "The order data should be sorted.", | |
2586 "enum": [ | |
2587 "SORT_ORDER_UNSPECIFIED", | |
2588 "ASCENDING", | |
2589 "DESCENDING" | |
2590 ], | |
2591 "enumDescriptions": [ | |
2592 "Default value, do not use this.", | |
2593 "Sort ascending.", | |
2594 "Sort descending." | |
2595 ], | |
2596 "type": "string" | |
2597 }, | |
2598 "dimensionIndex": { | |
2599 "description": "The dimension the sort should be applied to.
", | |
2600 "format": "int32", | |
2601 "type": "integer" | |
2602 } | |
2603 }, | |
2604 "type": "object" | |
2605 }, | |
2606 "CopySheetToAnotherSpreadsheetRequest": { | |
2607 "description": "The request to copy a sheet across spreadsheets.", | |
2608 "id": "CopySheetToAnotherSpreadsheetRequest", | |
2609 "properties": { | |
2610 "destinationSpreadsheetId": { | |
2611 "description": "The ID of the spreadsheet to copy the sheet
to.", | |
2612 "type": "string" | |
2613 } | |
2614 }, | |
2615 "type": "object" | |
2616 }, | |
2617 "NumberFormat": { | |
2618 "description": "The number format of a cell.", | |
2619 "id": "NumberFormat", | |
2620 "properties": { | |
2621 "pattern": { | |
2622 "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/guides/formats
) for more\ninformation about the supported patterns.", | |
2623 "type": "string" | |
2624 }, | |
2625 "type": { | |
2626 "description": "The type of the number format.\nWhen writing
, this field must be set.", | |
2627 "enum": [ | |
2628 "NUMBER_FORMAT_TYPE_UNSPECIFIED", | |
2629 "TEXT", | |
2630 "NUMBER", | |
2631 "PERCENT", | |
2632 "CURRENCY", | |
2633 "DATE", | |
2634 "TIME", | |
2635 "DATE_TIME", | |
2636 "SCIENTIFIC" | |
2637 ], | |
2638 "enumDescriptions": [ | |
2639 "The number format is not specified\nand is based on the
contents of the cell.\nDo not explicitly use this.", | |
2640 "Text formatting, e.g `1000.12`", | |
2641 "Number formatting, e.g, `1,000.12`", | |
2642 "Percent formatting, e.g `10.12%`", | |
2643 "Currency formatting, e.g `$1,000.12`", | |
2644 "Date formatting, e.g `9/26/2008`", | |
2645 "Time formatting, e.g `3:59:00 PM`", | |
2646 "Date+Time formatting, e.g `9/26/08 15:59:00`", | |
2647 "Scientific number formatting, e.g `1.01E+03`" | |
2648 ], | |
2649 "type": "string" | |
2650 } | |
2651 }, | |
2652 "type": "object" | |
2653 }, | |
2654 "BatchClearValuesRequest": { | |
2655 "description": "The request for clearing more than one range of valu
es in a spreadsheet.", | |
2656 "id": "BatchClearValuesRequest", | |
2657 "properties": { | |
2658 "ranges": { | |
2659 "description": "The ranges to clear, in A1 notation.", | |
2660 "items": { | |
2661 "type": "string" | |
2662 }, | |
2663 "type": "array" | |
2664 } | |
2665 }, | |
2666 "type": "object" | |
2667 }, | |
2668 "UpdateDimensionPropertiesRequest": { | |
2669 "description": "Updates properties of dimensions within the specifie
d range.", | |
2670 "id": "UpdateDimensionPropertiesRequest", | |
2671 "properties": { | |
2672 "fields": { | |
2673 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `properties` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", | |
2674 "format": "google-fieldmask", | |
2675 "type": "string" | |
2676 }, | |
2677 "range": { | |
2678 "$ref": "DimensionRange", | |
2679 "description": "The rows or columns to update." | |
2680 }, | |
2681 "properties": { | |
2682 "$ref": "DimensionProperties", | |
2683 "description": "Properties to update." | |
2684 } | |
2685 }, | |
2686 "type": "object" | |
2687 }, | |
2688 "Editors": { | |
2689 "description": "The editors of a protected range.", | |
2690 "id": "Editors", | |
2691 "properties": { | |
2692 "users": { | |
2693 "description": "The email addresses of users with edit acces
s to the protected range.", | |
2694 "items": { | |
2695 "type": "string" | |
2696 }, | |
2697 "type": "array" | |
2698 }, | |
2699 "groups": { | |
2700 "description": "The email addresses of groups with edit acce
ss to the protected range.", | |
2701 "items": { | |
2702 "type": "string" | |
2703 }, | |
2704 "type": "array" | |
2705 }, | |
2706 "domainUsersCanEdit": { | |
2707 "description": "True if anyone in the document's domain has
edit access to the protected\nrange. Domain protection is only supported on doc
uments within a domain.", | |
2708 "type": "boolean" | |
2709 } | |
2710 }, | |
2711 "type": "object" | |
2712 }, | |
2713 "Spreadsheet": { | |
2714 "description": "Resource that represents a spreadsheet.", | |
2715 "id": "Spreadsheet", | |
2716 "properties": { | |
2717 "spreadsheetId": { | |
2718 "description": "The ID of the spreadsheet.\nThis field is re
ad-only.", | |
2719 "type": "string" | |
2720 }, | |
2721 "properties": { | |
2722 "$ref": "SpreadsheetProperties", | |
2723 "description": "Overall properties of a spreadsheet." | |
2724 }, | |
2725 "spreadsheetUrl": { | |
2726 "description": "The url of the spreadsheet.\nThis field is r
ead-only.", | |
2727 "type": "string" | |
2728 }, | |
2729 "sheets": { | |
2730 "description": "The sheets that are part of a spreadsheet.", | |
2731 "items": { | |
2732 "$ref": "Sheet" | |
2733 }, | |
2734 "type": "array" | |
2735 }, | |
2736 "namedRanges": { | |
2737 "description": "The named ranges defined in a spreadsheet.", | |
2738 "items": { | |
2739 "$ref": "NamedRange" | |
2740 }, | |
2741 "type": "array" | |
2742 } | |
2743 }, | |
2744 "type": "object" | |
2745 }, | |
2746 "GridData": { | |
2747 "description": "Data in the grid, as well as metadata about the dime
nsions.", | |
2748 "id": "GridData", | |
2749 "properties": { | |
2750 "columnMetadata": { | |
2751 "description": "Metadata about the requested columns in the
grid, starting with the column\nin start_column.", | |
2752 "items": { | |
2753 "$ref": "DimensionProperties" | |
2754 }, | |
2755 "type": "array" | |
2756 }, | |
2757 "rowData": { | |
2758 "description": "The data in the grid, one entry per row,\nst
arting with the row in startRow.\nThe values in RowData will correspond to colum
ns starting\nat start_column.", | |
2759 "items": { | |
2760 "$ref": "RowData" | |
2761 }, | |
2762 "type": "array" | |
2763 }, | |
2764 "startRow": { | |
2765 "description": "The first row this GridData refers to, zero-
based.", | |
2766 "format": "int32", | |
2767 "type": "integer" | |
2768 }, | |
2769 "rowMetadata": { | |
2770 "description": "Metadata about the requested rows in the gri
d, starting with the row\nin start_row.", | |
2771 "items": { | |
2772 "$ref": "DimensionProperties" | |
2773 }, | |
2774 "type": "array" | |
2775 }, | |
2776 "startColumn": { | |
2777 "description": "The first column this GridData refers to, ze
ro-based.", | |
2778 "format": "int32", | |
2779 "type": "integer" | |
2780 } | |
2781 }, | |
2782 "type": "object" | |
2783 }, | |
2784 "PivotValue": { | |
2785 "description": "The definition of how a value in a pivot table shoul
d be calculated.", | |
2786 "id": "PivotValue", | |
2787 "properties": { | |
2788 "formula": { | |
2789 "description": "A custom formula to calculate the value. Th
e formula must start\nwith an `=` character.", | |
2790 "type": "string" | |
2791 }, | |
2792 "sourceColumnOffset": { | |
2793 "description": "The column offset of the source range that t
his value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColu
mnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1`
would\nrefer to column `D`.", | |
2794 "format": "int32", | |
2795 "type": "integer" | |
2796 }, | |
2797 "summarizeFunction": { | |
2798 "description": "A function to summarize the value.\nIf formu
la is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffse
t is set, then `CUSTOM`\nis not supported.", | |
2799 "enum": [ | |
2800 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED", | |
2801 "SUM", | |
2802 "COUNTA", | |
2803 "COUNT", | |
2804 "COUNTUNIQUE", | |
2805 "AVERAGE", | |
2806 "MAX", | |
2807 "MIN", | |
2808 "MEDIAN", | |
2809 "PRODUCT", | |
2810 "STDEV", | |
2811 "STDEVP", | |
2812 "VAR", | |
2813 "VARP", | |
2814 "CUSTOM" | |
2815 ], | |
2816 "enumDescriptions": [ | |
2817 "The default, do not use.", | |
2818 "Corresponds to the `SUM` function.", | |
2819 "Corresponds to the `COUNTA` function.", | |
2820 "Corresponds to the `COUNT` function.", | |
2821 "Corresponds to the `COUNTUNIQUE` function.", | |
2822 "Corresponds to the `AVERAGE` function.", | |
2823 "Corresponds to the `MAX` function.", | |
2824 "Corresponds to the `MIN` function.", | |
2825 "Corresponds to the `MEDIAN` function.", | |
2826 "Corresponds to the `PRODUCT` function.", | |
2827 "Corresponds to the `STDEV` function.", | |
2828 "Corresponds to the `STDEVP` function.", | |
2829 "Corresponds to the `VAR` function.", | |
2830 "Corresponds to the `VARP` function.", | |
2831 "Indicates the formula should be used as-is.\nOnly valid
if PivotValue.formula was set." | |
2832 ], | |
2833 "type": "string" | |
2834 }, | |
2835 "name": { | |
2836 "description": "A name to use for the value. This is only us
ed if formula was set.\nOtherwise, the column name is used.", | |
2837 "type": "string" | |
2838 } | |
2839 }, | |
2840 "type": "object" | |
2841 }, | |
2842 "DeleteBandingRequest": { | |
2843 "description": "Removes the banded range with the given ID from the
spreadsheet.", | |
2844 "id": "DeleteBandingRequest", | |
2845 "properties": { | |
2846 "bandedRangeId": { | |
2847 "description": "The ID of the banded range to delete.", | |
2848 "format": "int32", | |
2849 "type": "integer" | |
2850 } | |
2851 }, | |
2852 "type": "object" | |
2853 }, | |
2854 "BasicFilter": { | |
2855 "description": "The default filter associated with a sheet.", | |
2856 "id": "BasicFilter", | |
2857 "properties": { | |
2858 "criteria": { | |
2859 "additionalProperties": { | |
2860 "$ref": "FilterCriteria" | |
2861 }, | |
2862 "description": "The criteria for showing/hiding values per c
olumn.\nThe map's key is the column index, and the value is the criteria for\nth
at column.", | |
2863 "type": "object" | |
2864 }, | |
2865 "range": { | |
2866 "$ref": "GridRange", | |
2867 "description": "The range the filter covers." | |
2868 }, | |
2869 "sortSpecs": { | |
2870 "description": "The sort order per column. Later specificati
ons are used when values\nare equal in the earlier specifications.", | |
2871 "items": { | |
2872 "$ref": "SortSpec" | |
2873 }, | |
2874 "type": "array" | |
2875 } | |
2876 }, | |
2877 "type": "object" | |
2878 }, | |
2879 "DuplicateSheetRequest": { | |
2880 "description": "Duplicates the contents of a sheet.", | |
2881 "id": "DuplicateSheetRequest", | |
2882 "properties": { | |
2883 "sourceSheetId": { | |
2884 "description": "The sheet to duplicate.", | |
2885 "format": "int32", | |
2886 "type": "integer" | |
2887 }, | |
2888 "newSheetId": { | |
2889 "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.", | |
2890 "format": "int32", | |
2891 "type": "integer" | |
2892 }, | |
2893 "insertSheetIndex": { | |
2894 "description": "The zero-based index where the new sheet sho
uld be inserted.\nThe index of all sheets after this are incremented.", | |
2895 "format": "int32", | |
2896 "type": "integer" | |
2897 }, | |
2898 "newSheetName": { | |
2899 "description": "The name of the new sheet. If empty, a new
name is chosen for you.", | |
2900 "type": "string" | |
2901 } | |
2902 }, | |
2903 "type": "object" | |
2904 }, | |
2905 "AddFilterViewResponse": { | |
2906 "description": "The result of adding a filter view.", | |
2907 "id": "AddFilterViewResponse", | |
2908 "properties": { | |
2909 "filter": { | |
2910 "$ref": "FilterView", | |
2911 "description": "The newly added filter view." | |
2912 } | |
2913 }, | |
2914 "type": "object" | |
2915 }, | |
2916 "DuplicateSheetResponse": { | |
2917 "description": "The result of duplicating a sheet.", | |
2918 "id": "DuplicateSheetResponse", | |
2919 "properties": { | |
2920 "properties": { | |
2921 "$ref": "SheetProperties", | |
2922 "description": "The properties of the duplicate sheet." | |
2923 } | |
2924 }, | |
2925 "type": "object" | |
2926 }, | |
2927 "Border": { | |
2928 "description": "A border along a cell.", | |
2929 "id": "Border", | |
2930 "properties": { | |
2931 "style": { | |
2932 "description": "The style of the border.", | |
2933 "enum": [ | |
2934 "STYLE_UNSPECIFIED", | |
2935 "DOTTED", | |
2936 "DASHED", | |
2937 "SOLID", | |
2938 "SOLID_MEDIUM", | |
2939 "SOLID_THICK", | |
2940 "NONE", | |
2941 "DOUBLE" | |
2942 ], | |
2943 "enumDescriptions": [ | |
2944 "The style is not specified. Do not use this.", | |
2945 "The border is dotted.", | |
2946 "The border is dashed.", | |
2947 "The border is a thin solid line.", | |
2948 "The border is a medium solid line.", | |
2949 "The border is a thick solid line.", | |
2950 "No border.\nUsed only when updating a border in order t
o erase it.", | |
2951 "The border is two solid lines." | |
2952 ], | |
2953 "type": "string" | |
2954 }, | |
2955 "width": { | |
2956 "description": "The width of the border, in pixels.\nDepreca
ted; the width is determined by the \"style\" field.", | |
2957 "format": "int32", | |
2958 "type": "integer" | |
2959 }, | |
2960 "color": { | |
2961 "$ref": "Color", | |
2962 "description": "The color of the border." | |
2963 } | |
2964 }, | |
2965 "type": "object" | |
2966 }, | |
2967 "AddNamedRangeRequest": { | |
2968 "description": "Adds a named range to the spreadsheet.", | |
2969 "id": "AddNamedRangeRequest", | |
2970 "properties": { | |
2971 "namedRange": { | |
2972 "$ref": "NamedRange", | |
2973 "description": "The named range to add. The namedRangeId\nfi
eld 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.)" | |
2974 } | |
2975 }, | |
2976 "type": "object" | |
2977 }, | |
2978 "AddChartResponse": { | |
2979 "description": "The result of adding a chart to a spreadsheet.", | |
2980 "id": "AddChartResponse", | |
2981 "properties": { | |
2982 "chart": { | |
2983 "$ref": "EmbeddedChart", | |
2984 "description": "The newly added chart." | |
2985 } | |
2986 }, | |
2987 "type": "object" | |
2988 }, | |
2989 "AddBandingRequest": { | |
2990 "description": "Adds a new banded range to the spreadsheet.", | |
2991 "id": "AddBandingRequest", | |
2992 "properties": { | |
2993 "bandedRange": { | |
2994 "$ref": "BandedRange", | |
2995 "description": "The banded range to add. The bandedRangeId\n
field 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.)" | |
2996 } | |
2997 }, | |
2998 "type": "object" | |
2999 }, | |
3000 "AppendCellsRequest": { | |
3001 "description": "Adds new cells after the last row with data in a she
et,\ninserting new rows into the sheet if necessary.", | |
3002 "id": "AppendCellsRequest", | |
3003 "properties": { | |
3004 "sheetId": { | |
3005 "description": "The sheet ID to append the data to.", | |
3006 "format": "int32", | |
3007 "type": "integer" | |
3008 }, | |
3009 "rows": { | |
3010 "description": "The data to append.", | |
3011 "items": { | |
3012 "$ref": "RowData" | |
3013 }, | |
3014 "type": "array" | |
3015 }, | |
3016 "fields": { | |
3017 "description": "The fields of CellData that should be update
d.\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 list
ing every field.", | |
3018 "format": "google-fieldmask", | |
3019 "type": "string" | |
3020 } | |
3021 }, | |
3022 "type": "object" | |
3023 }, | |
3024 "RowData": { | |
3025 "description": "Data about each cell in a row.", | |
3026 "id": "RowData", | |
3027 "properties": { | |
3028 "values": { | |
3029 "description": "The values in the row, one per column.", | |
3030 "items": { | |
3031 "$ref": "CellData" | |
3032 }, | |
3033 "type": "array" | |
3034 } | |
3035 }, | |
3036 "type": "object" | |
3037 }, | 3140 }, |
3038 "BasicChartSeries": { | 3141 "BasicChartSeries": { |
3039 "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\".", | 3142 "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\".", |
3040 "id": "BasicChartSeries", | 3143 "id": "BasicChartSeries", |
3041 "properties": { | 3144 "properties": { |
3042 "series": { | 3145 "series": { |
3043 "$ref": "ChartData", | 3146 "$ref": "ChartData", |
3044 "description": "The data being visualized in this chart seri
es." | 3147 "description": "The data being visualized in this chart seri
es." |
3045 }, | 3148 }, |
3046 "targetAxis": { | |
3047 "description": "The minor axis that will specify the range o
f values for this series.\nFor example, if charting stocks over time, the \"Volu
me\" series\nmay want to be pinned to the right with the prices pinned to the le
ft,\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.", | |
3048 "enum": [ | |
3049 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED", | |
3050 "BOTTOM_AXIS", | |
3051 "LEFT_AXIS", | |
3052 "RIGHT_AXIS" | |
3053 ], | |
3054 "enumDescriptions": [ | |
3055 "Default value, do not use.", | |
3056 "The axis rendered at the bottom of a chart.\nFor most c
harts, this is the standard major axis.\nFor bar charts, this is a minor axis.", | |
3057 "The axis rendered at the left of a chart.\nFor most cha
rts, this is a minor axis.\nFor bar charts, this is the standard major axis.", | |
3058 "The axis rendered at the right of a chart.\nFor most ch
arts, this is a minor axis.\nFor bar charts, this is an unusual major axis." | |
3059 ], | |
3060 "type": "string" | |
3061 }, | |
3062 "type": { | 3149 "type": { |
3063 "description": "The type of this series. Valid only if the\n
chartType is\nCOMBO.\nDifferent types will change the way the series is visualiz
ed.\nOnly LINE, AREA,\nand COLUMN are supported.", | 3150 "description": "The type of this series. Valid only if the\n
chartType is\nCOMBO.\nDifferent types will change the way the series is visualiz
ed.\nOnly LINE, AREA,\nand COLUMN are supported.", |
3064 "enum": [ | 3151 "enum": [ |
3065 "BASIC_CHART_TYPE_UNSPECIFIED", | 3152 "BASIC_CHART_TYPE_UNSPECIFIED", |
3066 "BAR", | 3153 "BAR", |
3067 "LINE", | 3154 "LINE", |
3068 "AREA", | 3155 "AREA", |
3069 "COLUMN", | 3156 "COLUMN", |
3070 "SCATTER", | 3157 "SCATTER", |
3071 "COMBO" | 3158 "COMBO" |
3072 ], | 3159 ], |
3073 "enumDescriptions": [ | 3160 "enumDescriptions": [ |
3074 "Default value, do not use.", | 3161 "Default value, do not use.", |
3075 "A <a href=\"/chart/interactive/docs/gallery/barchart\">
bar chart</a>.", | 3162 "A <a href=\"/chart/interactive/docs/gallery/barchart\">
bar chart</a>.", |
3076 "A <a href=\"/chart/interactive/docs/gallery/linechart\"
>line chart</a>.", | 3163 "A <a href=\"/chart/interactive/docs/gallery/linechart\"
>line chart</a>.", |
3077 "An <a href=\"/chart/interactive/docs/gallery/areachart\
">area chart</a>.", | 3164 "An <a href=\"/chart/interactive/docs/gallery/areachart\
">area chart</a>.", |
3078 "A <a href=\"/chart/interactive/docs/gallery/columnchart
\">column chart</a>.", | 3165 "A <a href=\"/chart/interactive/docs/gallery/columnchart
\">column chart</a>.", |
3079 "A <a href=\"/chart/interactive/docs/gallery/scatterchar
t\">scatter chart</a>.", | 3166 "A <a href=\"/chart/interactive/docs/gallery/scatterchar
t\">scatter chart</a>.", |
3080 "A <a href=\"/chart/interactive/docs/gallery/combochart\
">combo chart</a>." | 3167 "A <a href=\"/chart/interactive/docs/gallery/combochart\
">combo chart</a>." |
3081 ], | 3168 ], |
3082 "type": "string" | 3169 "type": "string" |
3083 } | 3170 }, |
3084 }, | 3171 "targetAxis": { |
3085 "type": "object" | 3172 "description": "The minor axis that will specify the range o
f values for this series.\nFor example, if charting stocks over time, the \"Volu
me\" series\nmay want to be pinned to the right with the prices pinned to the le
ft,\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.", |
3086 }, | 3173 "enum": [ |
3087 "NamedRange": { | 3174 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED", |
3088 "description": "A named range.", | 3175 "BOTTOM_AXIS", |
3089 "id": "NamedRange", | 3176 "LEFT_AXIS", |
3090 "properties": { | 3177 "RIGHT_AXIS" |
3091 "namedRangeId": { | |
3092 "description": "The ID of the named range.", | |
3093 "type": "string" | |
3094 }, | |
3095 "range": { | |
3096 "$ref": "GridRange", | |
3097 "description": "The range this represents." | |
3098 }, | |
3099 "name": { | |
3100 "description": "The name of the named range.", | |
3101 "type": "string" | |
3102 } | |
3103 }, | |
3104 "type": "object" | |
3105 }, | |
3106 "RepeatCellRequest": { | |
3107 "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; othe
rs are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges wil
l 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 `=A
2`, 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, us
e the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.
", | |
3108 "id": "RepeatCellRequest", | |
3109 "properties": { | |
3110 "cell": { | |
3111 "$ref": "CellData", | |
3112 "description": "The data to write." | |
3113 }, | |
3114 "fields": { | |
3115 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `cell` is implied and should not be spec
ified.\nA single `\"*\"` can be used as short-hand for listing every field.", | |
3116 "format": "google-fieldmask", | |
3117 "type": "string" | |
3118 }, | |
3119 "range": { | |
3120 "$ref": "GridRange", | |
3121 "description": "The range to repeat the cell in." | |
3122 } | |
3123 }, | |
3124 "type": "object" | |
3125 }, | |
3126 "BasicChartSpec": { | |
3127 "description": "The specification for a basic chart. See BasicChart
Type for the list\nof charts this supports.", | |
3128 "id": "BasicChartSpec", | |
3129 "properties": { | |
3130 "chartType": { | |
3131 "description": "The type of the chart.", | |
3132 "enum": [ | |
3133 "BASIC_CHART_TYPE_UNSPECIFIED", | |
3134 "BAR", | |
3135 "LINE", | |
3136 "AREA", | |
3137 "COLUMN", | |
3138 "SCATTER", | |
3139 "COMBO" | |
3140 ], | 3178 ], |
3141 "enumDescriptions": [ | 3179 "enumDescriptions": [ |
3142 "Default value, do not use.", | 3180 "Default value, do not use.", |
3143 "A <a href=\"/chart/interactive/docs/gallery/barchart\">
bar chart</a>.", | 3181 "The axis rendered at the bottom of a chart.\nFor most c
harts, this is the standard major axis.\nFor bar charts, this is a minor axis.", |
3144 "A <a href=\"/chart/interactive/docs/gallery/linechart\"
>line chart</a>.", | 3182 "The axis rendered at the left of a chart.\nFor most cha
rts, this is a minor axis.\nFor bar charts, this is the standard major axis.", |
3145 "An <a href=\"/chart/interactive/docs/gallery/areachart\
">area chart</a>.", | 3183 "The axis rendered at the right of a chart.\nFor most ch
arts, this is a minor axis.\nFor bar charts, this is an unusual major axis." |
3146 "A <a href=\"/chart/interactive/docs/gallery/columnchart
\">column chart</a>.", | 3184 ], |
3147 "A <a href=\"/chart/interactive/docs/gallery/scatterchar
t\">scatter chart</a>.", | 3185 "type": "string" |
3148 "A <a href=\"/chart/interactive/docs/gallery/combochart\
">combo chart</a>." | |
3149 ], | |
3150 "type": "string" | |
3151 }, | |
3152 "domains": { | |
3153 "description": "The domain of data this is charting.\nOnly a
single domain is currently supported.", | |
3154 "items": { | |
3155 "$ref": "BasicChartDomain" | |
3156 }, | |
3157 "type": "array" | |
3158 }, | |
3159 "headerCount": { | |
3160 "description": "The number of rows or columns in the data th
at are \"headers\".\nIf not set, Google Sheets will guess how many rows are head
ers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis
title\n inferred from the header values.)", | |
3161 "format": "int32", | |
3162 "type": "integer" | |
3163 }, | |
3164 "series": { | |
3165 "description": "The data this chart is visualizing.", | |
3166 "items": { | |
3167 "$ref": "BasicChartSeries" | |
3168 }, | |
3169 "type": "array" | |
3170 }, | |
3171 "legendPosition": { | |
3172 "description": "The position of the chart legend.", | |
3173 "enum": [ | |
3174 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED", | |
3175 "BOTTOM_LEGEND", | |
3176 "LEFT_LEGEND", | |
3177 "RIGHT_LEGEND", | |
3178 "TOP_LEGEND", | |
3179 "NO_LEGEND" | |
3180 ], | |
3181 "enumDescriptions": [ | |
3182 "Default value, do not use.", | |
3183 "The legend is rendered on the bottom of the chart.", | |
3184 "The legend is rendered on the left of the chart.", | |
3185 "The legend is rendered on the right of the chart.", | |
3186 "The legend is rendered on the top of the chart.", | |
3187 "No legend is rendered." | |
3188 ], | |
3189 "type": "string" | |
3190 }, | |
3191 "axis": { | |
3192 "description": "The axis on the chart.", | |
3193 "items": { | |
3194 "$ref": "BasicChartAxis" | |
3195 }, | |
3196 "type": "array" | |
3197 } | |
3198 }, | |
3199 "type": "object" | |
3200 }, | |
3201 "UpdateEmbeddedObjectPositionRequest": { | |
3202 "description": "Update an embedded object's position (such as a movi
ng or resizing a\nchart or image).", | |
3203 "id": "UpdateEmbeddedObjectPositionRequest", | |
3204 "properties": { | |
3205 "newPosition": { | |
3206 "$ref": "EmbeddedObjectPosition", | |
3207 "description": "An explicit position to move the embedded ob
ject to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be creat
ed.\nIf newPosition.newSheet is set to true,\na new sheet will be created with a
n ID that will be chosen for you." | |
3208 }, | |
3209 "objectId": { | |
3210 "description": "The ID of the object to moved.", | |
3211 "format": "int32", | |
3212 "type": "integer" | |
3213 }, | |
3214 "fields": { | |
3215 "description": "The fields of OverlayPosition\nthat should b
e 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 `newPos
ition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"
` can be used as short-hand for listing every field.", | |
3216 "format": "google-fieldmask", | |
3217 "type": "string" | |
3218 } | |
3219 }, | |
3220 "type": "object" | |
3221 }, | |
3222 "SetBasicFilterRequest": { | |
3223 "description": "Sets the basic filter associated with a sheet.", | |
3224 "id": "SetBasicFilterRequest", | |
3225 "properties": { | |
3226 "filter": { | |
3227 "$ref": "BasicFilter", | |
3228 "description": "The filter to set." | |
3229 } | 3186 } |
3230 }, | 3187 }, |
3231 "type": "object" | 3188 "type": "object" |
3232 }, | 3189 }, |
3233 "AutoResizeDimensionsRequest": { | 3190 "AutoResizeDimensionsRequest": { |
3234 "description": "Automatically resizes one or more dimensions based o
n the contents\nof the cells in that dimension.", | 3191 "description": "Automatically resizes one or more dimensions based o
n the contents\nof the cells in that dimension.", |
3235 "id": "AutoResizeDimensionsRequest", | 3192 "id": "AutoResizeDimensionsRequest", |
3236 "properties": { | 3193 "properties": { |
3237 "dimensions": { | 3194 "dimensions": { |
3238 "$ref": "DimensionRange", | 3195 "$ref": "DimensionRange", |
3239 "description": "The dimensions to automatically resize.\nOnl
y COLUMNS are supported." | 3196 "description": "The dimensions to automatically resize.\nOnl
y COLUMNS are supported." |
3240 } | 3197 } |
3241 }, | 3198 }, |
3242 "type": "object" | 3199 "type": "object" |
3243 }, | 3200 }, |
3244 "DuplicateFilterViewResponse": { | 3201 "UpdateBordersRequest": { |
3245 "description": "The result of a filter view being duplicated.", | 3202 "description": "Updates the borders of a range.\nIf a field is not s
et in the request, that means the border remains as-is.\nFor example, with two s
ubsequent 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 bord
ers of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a borde
r, explicitly set the style to\nNONE.", |
3246 "id": "DuplicateFilterViewResponse", | 3203 "id": "UpdateBordersRequest", |
3247 "properties": { | 3204 "properties": { |
3248 "filter": { | 3205 "left": { |
3249 "$ref": "FilterView", | 3206 "$ref": "Border", |
3250 "description": "The newly created filter." | 3207 "description": "The border to put at the left of the range." |
3251 } | 3208 }, |
3252 }, | 3209 "bottom": { |
3253 "type": "object" | 3210 "$ref": "Border", |
3254 }, | 3211 "description": "The border to put at the bottom of the range
." |
3255 "BandingProperties": { | 3212 }, |
3256 "description": "Properties referring a single dimension (either row
or column). If both\nBandedRange.row_properties and BandedRange.column_propertie
s are\nset, the fill colors are applied to cells according to the following rule
s:\n\n* header_color and footer_color take priority over band colors.\n* first_b
and_color takes priority over second_band_color.\n* row_properties takes priorit
y over column_properties.\n\nFor example, the first row color takes priority ove
r the first column\ncolor, but the first column color takes priority over the se
cond 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.", | 3213 "innerVertical": { |
3257 "id": "BandingProperties", | 3214 "$ref": "Border", |
3258 "properties": { | 3215 "description": "The vertical border to put within the range.
" |
3259 "footerColor": { | 3216 }, |
| 3217 "right": { |
| 3218 "$ref": "Border", |
| 3219 "description": "The border to put at the right of the range.
" |
| 3220 }, |
| 3221 "range": { |
| 3222 "$ref": "GridRange", |
| 3223 "description": "The range whose borders should be updated." |
| 3224 }, |
| 3225 "innerHorizontal": { |
| 3226 "$ref": "Border", |
| 3227 "description": "The horizontal border to put within the rang
e." |
| 3228 }, |
| 3229 "top": { |
| 3230 "$ref": "Border", |
| 3231 "description": "The border to put at the top of the range." |
| 3232 } |
| 3233 }, |
| 3234 "type": "object" |
| 3235 }, |
| 3236 "CellFormat": { |
| 3237 "description": "The format of a cell.", |
| 3238 "id": "CellFormat", |
| 3239 "properties": { |
| 3240 "numberFormat": { |
| 3241 "$ref": "NumberFormat", |
| 3242 "description": "A format describing how number values should
be represented to the user." |
| 3243 }, |
| 3244 "hyperlinkDisplayType": { |
| 3245 "description": "How a hyperlink, if it exists, should be dis
played in the cell.", |
| 3246 "enum": [ |
| 3247 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED", |
| 3248 "LINKED", |
| 3249 "PLAIN_TEXT" |
| 3250 ], |
| 3251 "enumDescriptions": [ |
| 3252 "The default value: the hyperlink is rendered. Do not us
e this.", |
| 3253 "A hyperlink should be explicitly rendered.", |
| 3254 "A hyperlink should not be rendered." |
| 3255 ], |
| 3256 "type": "string" |
| 3257 }, |
| 3258 "horizontalAlignment": { |
| 3259 "description": "The horizontal alignment of the value in the
cell.", |
| 3260 "enum": [ |
| 3261 "HORIZONTAL_ALIGN_UNSPECIFIED", |
| 3262 "LEFT", |
| 3263 "CENTER", |
| 3264 "RIGHT" |
| 3265 ], |
| 3266 "enumDescriptions": [ |
| 3267 "The horizontal alignment is not specified. Do not use t
his.", |
| 3268 "The text is explicitly aligned to the left of the cell.
", |
| 3269 "The text is explicitly aligned to the center of the cel
l.", |
| 3270 "The text is explicitly aligned to the right of the cell
." |
| 3271 ], |
| 3272 "type": "string" |
| 3273 }, |
| 3274 "textFormat": { |
| 3275 "$ref": "TextFormat", |
| 3276 "description": "The format of the text in the cell (unless o
verridden by a format run)." |
| 3277 }, |
| 3278 "backgroundColor": { |
3260 "$ref": "Color", | 3279 "$ref": "Color", |
3261 "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\ncol
umn." | 3280 "description": "The background color of the cell." |
3262 }, | 3281 }, |
3263 "headerColor": { | 3282 "padding": { |
3264 "$ref": "Color", | 3283 "$ref": "Padding", |
3265 "description": "The color of the first row or column. If thi
s 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\n
from the second row or column. Otherwise, the first row or column will be\nfille
d with first_band_color and the colors will proceed to alternate\nas they normal
ly would." | 3284 "description": "The padding of the cell." |
3266 }, | 3285 }, |
3267 "secondBandColor": { | 3286 "verticalAlignment": { |
3268 "$ref": "Color", | 3287 "description": "The vertical alignment of the value in the c
ell.", |
3269 "description": "The second color that is alternating. (Requi
red)" | 3288 "enum": [ |
3270 }, | 3289 "VERTICAL_ALIGN_UNSPECIFIED", |
3271 "firstBandColor": { | 3290 "TOP", |
3272 "$ref": "Color", | 3291 "MIDDLE", |
3273 "description": "The first color that is alternating. (Requir
ed)" | 3292 "BOTTOM" |
3274 } | 3293 ], |
3275 }, | 3294 "enumDescriptions": [ |
3276 "type": "object" | 3295 "The vertical alignment is not specified. Do not use th
is.", |
| 3296 "The text is explicitly aligned to the top of the cell."
, |
| 3297 "The text is explicitly aligned to the middle of the cel
l.", |
| 3298 "The text is explicitly aligned to the bottom of the cel
l." |
| 3299 ], |
| 3300 "type": "string" |
| 3301 }, |
| 3302 "borders": { |
| 3303 "$ref": "Borders", |
| 3304 "description": "The borders of the cell." |
| 3305 }, |
| 3306 "textDirection": { |
| 3307 "description": "The direction of the text in the cell.", |
| 3308 "enum": [ |
| 3309 "TEXT_DIRECTION_UNSPECIFIED", |
| 3310 "LEFT_TO_RIGHT", |
| 3311 "RIGHT_TO_LEFT" |
| 3312 ], |
| 3313 "enumDescriptions": [ |
| 3314 "The text direction is not specified. Do not use this.", |
| 3315 "The text direction of left-to-right was set by the user
.", |
| 3316 "The text direction of right-to-left was set by the user
." |
| 3317 ], |
| 3318 "type": "string" |
| 3319 }, |
| 3320 "wrapStrategy": { |
| 3321 "description": "The wrap strategy for the value in the cell.
", |
| 3322 "enum": [ |
| 3323 "WRAP_STRATEGY_UNSPECIFIED", |
| 3324 "OVERFLOW_CELL", |
| 3325 "LEGACY_WRAP", |
| 3326 "CLIP", |
| 3327 "WRAP" |
| 3328 ], |
| 3329 "enumDescriptions": [ |
| 3330 "The default value, do not use.", |
| 3331 "Lines that are longer than the cell width will be writt
en 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 n
ext line unless the user manually inserts a new line.\nExample:\n\n | First s
entence. |\n | Manual newline that is very long. <- Text continues into next
cell\n | Next newline. |", |
| 3332 "This wrap strategy represents the old Google Sheets wra
p strategy where\nwords that are longer than a line are clipped rather than brok
en. This\nstrategy is not supported on all platforms and is being phased out.\nE
xample:\n\n | Cell has a |\n | loooooooooo| <- Word is clipped.\n | wor
d. |", |
| 3333 "Lines that are longer than the cell width will be clipp
ed.\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| <- Te
xt is clipped\n | Next newline. |", |
| 3334 "Words that are longer than a line are wrapped at the ch
aracter level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooo
oooooo| <- Word is broken.\n | ong word. |" |
| 3335 ], |
| 3336 "type": "string" |
| 3337 } |
| 3338 }, |
| 3339 "type": "object" |
| 3340 }, |
| 3341 "ClearValuesResponse": { |
| 3342 "description": "The response when clearing a range of values in a sp
readsheet.", |
| 3343 "id": "ClearValuesResponse", |
| 3344 "properties": { |
| 3345 "spreadsheetId": { |
| 3346 "description": "The spreadsheet the updates were applied to.
", |
| 3347 "type": "string" |
| 3348 }, |
| 3349 "clearedRange": { |
| 3350 "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 bound
s of the sheet, this will be the actual range\n that was cleared, bounded to the
sheet's limits.)", |
| 3351 "type": "string" |
| 3352 } |
| 3353 }, |
| 3354 "type": "object" |
| 3355 }, |
| 3356 "DeleteConditionalFormatRuleRequest": { |
| 3357 "description": "Deletes a conditional format rule at the given index
.\nAll subsequent rules' indexes are decremented.", |
| 3358 "id": "DeleteConditionalFormatRuleRequest", |
| 3359 "properties": { |
| 3360 "index": { |
| 3361 "description": "The zero-based index of the rule to be delet
ed.", |
| 3362 "format": "int32", |
| 3363 "type": "integer" |
| 3364 }, |
| 3365 "sheetId": { |
| 3366 "description": "The sheet the rule is being deleted from.", |
| 3367 "format": "int32", |
| 3368 "type": "integer" |
| 3369 } |
| 3370 }, |
| 3371 "type": "object" |
| 3372 }, |
| 3373 "AddBandingResponse": { |
| 3374 "description": "The result of adding a banded range.", |
| 3375 "id": "AddBandingResponse", |
| 3376 "properties": { |
| 3377 "bandedRange": { |
| 3378 "$ref": "BandedRange", |
| 3379 "description": "The banded range that was added." |
| 3380 } |
| 3381 }, |
| 3382 "type": "object" |
| 3383 }, |
| 3384 "DeleteNamedRangeRequest": { |
| 3385 "description": "Removes the named range with the given ID from the s
preadsheet.", |
| 3386 "id": "DeleteNamedRangeRequest", |
| 3387 "properties": { |
| 3388 "namedRangeId": { |
| 3389 "description": "The ID of the named range to delete.", |
| 3390 "type": "string" |
| 3391 } |
| 3392 }, |
| 3393 "type": "object" |
| 3394 }, |
| 3395 "ChartData": { |
| 3396 "description": "The data included in a domain or series.", |
| 3397 "id": "ChartData", |
| 3398 "properties": { |
| 3399 "sourceRange": { |
| 3400 "$ref": "ChartSourceRange", |
| 3401 "description": "The source ranges of the data." |
| 3402 } |
| 3403 }, |
| 3404 "type": "object" |
| 3405 }, |
| 3406 "BatchGetValuesResponse": { |
| 3407 "description": "The response when retrieving more than one range of
values in a spreadsheet.", |
| 3408 "id": "BatchGetValuesResponse", |
| 3409 "properties": { |
| 3410 "spreadsheetId": { |
| 3411 "description": "The ID of the spreadsheet the data was retri
eved from.", |
| 3412 "type": "string" |
| 3413 }, |
| 3414 "valueRanges": { |
| 3415 "description": "The requested values. The order of the Value
Ranges is the same as the\norder of the requested ranges.", |
| 3416 "items": { |
| 3417 "$ref": "ValueRange" |
| 3418 }, |
| 3419 "type": "array" |
| 3420 } |
| 3421 }, |
| 3422 "type": "object" |
| 3423 }, |
| 3424 "UpdateBandingRequest": { |
| 3425 "description": "Updates properties of the supplied banded range.", |
| 3426 "id": "UpdateBandingRequest", |
| 3427 "properties": { |
| 3428 "fields": { |
| 3429 "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 fiel
d.", |
| 3430 "format": "google-fieldmask", |
| 3431 "type": "string" |
| 3432 }, |
| 3433 "bandedRange": { |
| 3434 "$ref": "BandedRange", |
| 3435 "description": "The banded range to update with the new prop
erties." |
| 3436 } |
| 3437 }, |
| 3438 "type": "object" |
| 3439 }, |
| 3440 "Color": { |
| 3441 "description": "Represents a color in the RGBA color space. This rep
resentation is designed\nfor simplicity of conversion to/from color representati
ons in various\nlanguages over compactness; for example, the fields of this repr
esentation\ncan be trivially provided to the constructor of \"java.awt.Color\" i
n Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:bl
ue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily format
ted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples
:\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.getG
reen();\n float blue = (float) color.getBlue();\n float denominator
= 255.0;\n Color.Builder resultBuilder =\n Color\n
.newBuilder()\n .setRed(red / denominator)\n .setGr
een(green / denominator)\n .setBlue(blue / denominator);\n i
nt alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlp
ha(\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 = [protoco
lor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n
alpha = [alpha_wrapper value];\n }\n return [UIColor color
WithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* to
Proto(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 [resu
lt setRed:red];\n [result setGreen:green];\n [result setBlue:blu
e];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWi
thValue(alpha)];\n }\n [result autorelease];\n return re
sult;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var prot
oToCssColor = 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 = M
ath.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(', rgbPara
ms, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(
red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8)
| blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros
= 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0
; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n re
sultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n
// ...", |
| 3442 "id": "Color", |
| 3443 "properties": { |
| 3444 "green": { |
| 3445 "description": "The amount of green in the color as a value
in the interval [0, 1].", |
| 3446 "format": "float", |
| 3447 "type": "number" |
| 3448 }, |
| 3449 "blue": { |
| 3450 "description": "The amount of blue in the color as a value i
n the interval [0, 1].", |
| 3451 "format": "float", |
| 3452 "type": "number" |
| 3453 }, |
| 3454 "alpha": { |
| 3455 "description": "The fraction of this color that should be ap
plied 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\n
This 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 betwee
n a default value and the value being unset.\nIf omitted, this color object is t
o be rendered as a solid color\n(as if the alpha value had been explicitly given
with a value of 1.0).", |
| 3456 "format": "float", |
| 3457 "type": "number" |
| 3458 }, |
| 3459 "red": { |
| 3460 "description": "The amount of red in the color as a value in
the interval [0, 1].", |
| 3461 "format": "float", |
| 3462 "type": "number" |
| 3463 } |
| 3464 }, |
| 3465 "type": "object" |
3277 }, | 3466 }, |
3278 "PivotGroup": { | 3467 "PivotGroup": { |
3279 "description": "A single grouping (either row or column) in a pivot
table.", | 3468 "description": "A single grouping (either row or column) in a pivot
table.", |
3280 "id": "PivotGroup", | 3469 "id": "PivotGroup", |
3281 "properties": { | 3470 "properties": { |
3282 "sortOrder": { | 3471 "valueBucket": { |
3283 "description": "The order the values in this group should be
sorted.", | 3472 "$ref": "PivotGroupSortValueBucket", |
3284 "enum": [ | 3473 "description": "The bucket of the opposite pivot group to so
rt by.\nIf not specified, sorting is alphabetical by this group's values." |
3285 "SORT_ORDER_UNSPECIFIED", | |
3286 "ASCENDING", | |
3287 "DESCENDING" | |
3288 ], | |
3289 "enumDescriptions": [ | |
3290 "Default value, do not use this.", | |
3291 "Sort ascending.", | |
3292 "Sort descending." | |
3293 ], | |
3294 "type": "string" | |
3295 }, | 3474 }, |
3296 "sourceColumnOffset": { | 3475 "sourceColumnOffset": { |
3297 "description": "The column offset of the source range that t
his grouping is based on.\n\nFor example, if the source was `C10:E15`, a `source
ColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset
`1` would refer\nto column `D`.", | 3476 "description": "The column offset of the source range that t
his grouping is based on.\n\nFor example, if the source was `C10:E15`, a `source
ColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset
`1` would refer\nto column `D`.", |
3298 "format": "int32", | 3477 "format": "int32", |
3299 "type": "integer" | 3478 "type": "integer" |
3300 }, | 3479 }, |
3301 "showTotals": { | 3480 "showTotals": { |
3302 "description": "True if the pivot table should include the t
otals for this grouping.", | 3481 "description": "True if the pivot table should include the t
otals for this grouping.", |
3303 "type": "boolean" | 3482 "type": "boolean" |
3304 }, | 3483 }, |
3305 "valueBucket": { | |
3306 "$ref": "PivotGroupSortValueBucket", | |
3307 "description": "The bucket of the opposite pivot group to so
rt by.\nIf not specified, sorting is alphabetical by this group's values." | |
3308 }, | |
3309 "valueMetadata": { | 3484 "valueMetadata": { |
3310 "description": "Metadata about values in the grouping.", | 3485 "description": "Metadata about values in the grouping.", |
3311 "items": { | 3486 "items": { |
3312 "$ref": "PivotGroupValueMetadata" | 3487 "$ref": "PivotGroupValueMetadata" |
3313 }, | 3488 }, |
3314 "type": "array" | 3489 "type": "array" |
3315 } | 3490 }, |
3316 }, | 3491 "sortOrder": { |
3317 "type": "object" | 3492 "description": "The order the values in this group should be
sorted.", |
3318 }, | 3493 "enum": [ |
3319 "GridRange": { | 3494 "SORT_ORDER_UNSPECIFIED", |
3320 "description": "A range on a sheet.\nAll indexes are zero-based.\nIn
dexes are half open, e.g the start index is inclusive\nand the end index is excl
usive -- [start_index, end_index).\nMissing indexes indicate the range is unboun
ded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `She
et1!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!A
3: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\n
The start index must always be less than or equal to the end index.\nIf the star
t index equals the end index, then the range is empty.\nEmpty ranges are typical
ly not meaningful and are usually rendered in the\nUI as `#REF!`.", | 3495 "ASCENDING", |
3321 "id": "GridRange", | 3496 "DESCENDING" |
3322 "properties": { | 3497 ], |
| 3498 "enumDescriptions": [ |
| 3499 "Default value, do not use this.", |
| 3500 "Sort ascending.", |
| 3501 "Sort descending." |
| 3502 ], |
| 3503 "type": "string" |
| 3504 } |
| 3505 }, |
| 3506 "type": "object" |
| 3507 }, |
| 3508 "PivotTable": { |
| 3509 "description": "A pivot table.", |
| 3510 "id": "PivotTable", |
| 3511 "properties": { |
| 3512 "valueLayout": { |
| 3513 "description": "Whether values should be listed horizontally
(as columns)\nor vertically (as rows).", |
| 3514 "enum": [ |
| 3515 "HORIZONTAL", |
| 3516 "VERTICAL" |
| 3517 ], |
| 3518 "enumDescriptions": [ |
| 3519 "Values are laid out horizontally (as columns).", |
| 3520 "Values are laid out vertically (as rows)." |
| 3521 ], |
| 3522 "type": "string" |
| 3523 }, |
| 3524 "source": { |
| 3525 "$ref": "GridRange", |
| 3526 "description": "The range the pivot table is reading data fr
om." |
| 3527 }, |
| 3528 "columns": { |
| 3529 "description": "Each column grouping in the pivot table.", |
| 3530 "items": { |
| 3531 "$ref": "PivotGroup" |
| 3532 }, |
| 3533 "type": "array" |
| 3534 }, |
| 3535 "values": { |
| 3536 "description": "A list of values to include in the pivot tab
le.", |
| 3537 "items": { |
| 3538 "$ref": "PivotValue" |
| 3539 }, |
| 3540 "type": "array" |
| 3541 }, |
| 3542 "criteria": { |
| 3543 "additionalProperties": { |
| 3544 "$ref": "PivotFilterCriteria" |
| 3545 }, |
| 3546 "description": "An optional mapping of filters per source co
lumn offset.\n\nThe filters will be applied before aggregating data into the piv
ot 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 th
e source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, where
as the key `1` is for column `D`.", |
| 3547 "type": "object" |
| 3548 }, |
| 3549 "rows": { |
| 3550 "description": "Each row grouping in the pivot table.", |
| 3551 "items": { |
| 3552 "$ref": "PivotGroup" |
| 3553 }, |
| 3554 "type": "array" |
| 3555 } |
| 3556 }, |
| 3557 "type": "object" |
| 3558 }, |
| 3559 "ChartSourceRange": { |
| 3560 "description": "Source ranges for a chart.", |
| 3561 "id": "ChartSourceRange", |
| 3562 "properties": { |
| 3563 "sources": { |
| 3564 "description": "The ranges of data for a series or domain.\n
Exactly 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 rang
e, then the source\nrange at a given offset must be contiguous across the domain
and series.\n\nFor example, these are valid configurations:\n\n domain sourc
es: 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 sourc
es: C1:C5, E10:E12", |
| 3565 "items": { |
| 3566 "$ref": "GridRange" |
| 3567 }, |
| 3568 "type": "array" |
| 3569 } |
| 3570 }, |
| 3571 "type": "object" |
| 3572 }, |
| 3573 "ValueRange": { |
| 3574 "description": "Data within a range of the spreadsheet.", |
| 3575 "id": "ValueRange", |
| 3576 "properties": { |
| 3577 "range": { |
| 3578 "description": "The range the values cover, in A1 notation.\
nFor output, this range indicates the entire requested range,\neven though the v
alues will exclude trailing rows and columns.\nWhen appending values, this field
represents the range to search for a\ntable, after which values will be appende
d.", |
| 3579 "type": "string" |
| 3580 }, |
| 3581 "majorDimension": { |
| 3582 "description": "The major dimension of the values.\n\nFor ou
tput, 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 `r
ange=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, w
ith `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 defaul
ts to ROWS.", |
| 3583 "enum": [ |
| 3584 "DIMENSION_UNSPECIFIED", |
| 3585 "ROWS", |
| 3586 "COLUMNS" |
| 3587 ], |
| 3588 "enumDescriptions": [ |
| 3589 "The default value, do not use.", |
| 3590 "Operates on the rows of a sheet.", |
| 3591 "Operates on the columns of a sheet." |
| 3592 ], |
| 3593 "type": "string" |
| 3594 }, |
| 3595 "values": { |
| 3596 "description": "The data that was read or to be written. Th
is is an array of arrays,\nthe outer array representing all the data and each in
ner array\nrepresenting a major dimension. Each item in the inner array\ncorresp
onds with one cell.\n\nFor output, empty trailing rows and columns will not be i
ncluded.\n\nFor input, supported value types are: bool, string, and double.\nNul
l values will be skipped.\nTo set a cell to an empty value, set the string value
to an empty string.", |
| 3597 "items": { |
| 3598 "items": { |
| 3599 "type": "any" |
| 3600 }, |
| 3601 "type": "array" |
| 3602 }, |
| 3603 "type": "array" |
| 3604 } |
| 3605 }, |
| 3606 "type": "object" |
| 3607 }, |
| 3608 "AppendCellsRequest": { |
| 3609 "description": "Adds new cells after the last row with data in a she
et,\ninserting new rows into the sheet if necessary.", |
| 3610 "id": "AppendCellsRequest", |
| 3611 "properties": { |
| 3612 "rows": { |
| 3613 "description": "The data to append.", |
| 3614 "items": { |
| 3615 "$ref": "RowData" |
| 3616 }, |
| 3617 "type": "array" |
| 3618 }, |
| 3619 "fields": { |
| 3620 "description": "The fields of CellData that should be update
d.\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 list
ing every field.", |
| 3621 "format": "google-fieldmask", |
| 3622 "type": "string" |
| 3623 }, |
3323 "sheetId": { | 3624 "sheetId": { |
3324 "description": "The sheet this range is on.", | 3625 "description": "The sheet ID to append the data to.", |
3325 "format": "int32", | 3626 "format": "int32", |
3326 "type": "integer" | 3627 "type": "integer" |
3327 }, | 3628 } |
3328 "startColumnIndex": { | 3629 }, |
3329 "description": "The start column (inclusive) of the range, o
r not set if unbounded.", | 3630 "type": "object" |
3330 "format": "int32", | 3631 }, |
3331 "type": "integer" | 3632 "AddBandingRequest": { |
3332 }, | 3633 "description": "Adds a new banded range to the spreadsheet.", |
3333 "startRowIndex": { | 3634 "id": "AddBandingRequest", |
3334 "description": "The start row (inclusive) of the range, or n
ot set if unbounded.", | |
3335 "format": "int32", | |
3336 "type": "integer" | |
3337 }, | |
3338 "endRowIndex": { | |
3339 "description": "The end row (exclusive) of the range, or not
set if unbounded.", | |
3340 "format": "int32", | |
3341 "type": "integer" | |
3342 }, | |
3343 "endColumnIndex": { | |
3344 "description": "The end column (exclusive) of the range, or
not set if unbounded.", | |
3345 "format": "int32", | |
3346 "type": "integer" | |
3347 } | |
3348 }, | |
3349 "type": "object" | |
3350 }, | |
3351 "DeleteSheetRequest": { | |
3352 "description": "Deletes the requested sheet.", | |
3353 "id": "DeleteSheetRequest", | |
3354 "properties": { | |
3355 "sheetId": { | |
3356 "description": "The ID of the sheet to delete.", | |
3357 "format": "int32", | |
3358 "type": "integer" | |
3359 } | |
3360 }, | |
3361 "type": "object" | |
3362 }, | |
3363 "UpdateBandingRequest": { | |
3364 "description": "Updates properties of the supplied banded range.", | |
3365 "id": "UpdateBandingRequest", | |
3366 "properties": { | 3635 "properties": { |
3367 "bandedRange": { | 3636 "bandedRange": { |
3368 "$ref": "BandedRange", | 3637 "$ref": "BandedRange", |
3369 "description": "The banded range to update with the new prop
erties." | 3638 "description": "The banded range to add. The bandedRangeId\n
field 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.)" |
| 3639 } |
| 3640 }, |
| 3641 "type": "object" |
| 3642 }, |
| 3643 "Response": { |
| 3644 "description": "A single response from an update.", |
| 3645 "id": "Response", |
| 3646 "properties": { |
| 3647 "addBanding": { |
| 3648 "$ref": "AddBandingResponse", |
| 3649 "description": "A reply from adding a banded range." |
| 3650 }, |
| 3651 "addProtectedRange": { |
| 3652 "$ref": "AddProtectedRangeResponse", |
| 3653 "description": "A reply from adding a protected range." |
| 3654 }, |
| 3655 "duplicateSheet": { |
| 3656 "$ref": "DuplicateSheetResponse", |
| 3657 "description": "A reply from duplicating a sheet." |
| 3658 }, |
| 3659 "deleteConditionalFormatRule": { |
| 3660 "$ref": "DeleteConditionalFormatRuleResponse", |
| 3661 "description": "A reply from deleting a conditional format r
ule." |
| 3662 }, |
| 3663 "updateEmbeddedObjectPosition": { |
| 3664 "$ref": "UpdateEmbeddedObjectPositionResponse", |
| 3665 "description": "A reply from updating an embedded object's p
osition." |
| 3666 }, |
| 3667 "duplicateFilterView": { |
| 3668 "$ref": "DuplicateFilterViewResponse", |
| 3669 "description": "A reply from duplicating a filter view." |
| 3670 }, |
| 3671 "addChart": { |
| 3672 "$ref": "AddChartResponse", |
| 3673 "description": "A reply from adding a chart." |
| 3674 }, |
| 3675 "findReplace": { |
| 3676 "$ref": "FindReplaceResponse", |
| 3677 "description": "A reply from doing a find/replace." |
| 3678 }, |
| 3679 "addSheet": { |
| 3680 "$ref": "AddSheetResponse", |
| 3681 "description": "A reply from adding a sheet." |
| 3682 }, |
| 3683 "updateConditionalFormatRule": { |
| 3684 "$ref": "UpdateConditionalFormatRuleResponse", |
| 3685 "description": "A reply from updating a conditional format r
ule." |
| 3686 }, |
| 3687 "addNamedRange": { |
| 3688 "$ref": "AddNamedRangeResponse", |
| 3689 "description": "A reply from adding a named range." |
| 3690 }, |
| 3691 "addFilterView": { |
| 3692 "$ref": "AddFilterViewResponse", |
| 3693 "description": "A reply from adding a filter view." |
| 3694 } |
| 3695 }, |
| 3696 "type": "object" |
| 3697 }, |
| 3698 "InsertRangeRequest": { |
| 3699 "description": "Inserts cells into a range, shifting the existing ce
lls over or down.", |
| 3700 "id": "InsertRangeRequest", |
| 3701 "properties": { |
| 3702 "shiftDimension": { |
| 3703 "description": "The dimension which will be shifted when ins
erting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existi
ng cells will be shifted right.", |
| 3704 "enum": [ |
| 3705 "DIMENSION_UNSPECIFIED", |
| 3706 "ROWS", |
| 3707 "COLUMNS" |
| 3708 ], |
| 3709 "enumDescriptions": [ |
| 3710 "The default value, do not use.", |
| 3711 "Operates on the rows of a sheet.", |
| 3712 "Operates on the columns of a sheet." |
| 3713 ], |
| 3714 "type": "string" |
| 3715 }, |
| 3716 "range": { |
| 3717 "$ref": "GridRange", |
| 3718 "description": "The range to insert new cells into." |
| 3719 } |
| 3720 }, |
| 3721 "type": "object" |
| 3722 }, |
| 3723 "TextFormatRun": { |
| 3724 "description": "A run of a text format. The format of this run conti
nues until the start\nindex of the next run.\nWhen updating, all fields must be
set.", |
| 3725 "id": "TextFormatRun", |
| 3726 "properties": { |
| 3727 "format": { |
| 3728 "$ref": "TextFormat", |
| 3729 "description": "The format of this run. Absent values inher
it the cell's format." |
| 3730 }, |
| 3731 "startIndex": { |
| 3732 "description": "The character index where this run starts.", |
| 3733 "format": "int32", |
| 3734 "type": "integer" |
| 3735 } |
| 3736 }, |
| 3737 "type": "object" |
| 3738 }, |
| 3739 "EmbeddedChart": { |
| 3740 "description": "A chart embedded in a sheet.", |
| 3741 "id": "EmbeddedChart", |
| 3742 "properties": { |
| 3743 "spec": { |
| 3744 "$ref": "ChartSpec", |
| 3745 "description": "The specification of the chart." |
| 3746 }, |
| 3747 "chartId": { |
| 3748 "description": "The ID of the chart.", |
| 3749 "format": "int32", |
| 3750 "type": "integer" |
| 3751 }, |
| 3752 "position": { |
| 3753 "$ref": "EmbeddedObjectPosition", |
| 3754 "description": "The position of the chart." |
| 3755 } |
| 3756 }, |
| 3757 "type": "object" |
| 3758 }, |
| 3759 "AddNamedRangeResponse": { |
| 3760 "description": "The result of adding a named range.", |
| 3761 "id": "AddNamedRangeResponse", |
| 3762 "properties": { |
| 3763 "namedRange": { |
| 3764 "$ref": "NamedRange", |
| 3765 "description": "The named range to add." |
| 3766 } |
| 3767 }, |
| 3768 "type": "object" |
| 3769 }, |
| 3770 "RowData": { |
| 3771 "description": "Data about each cell in a row.", |
| 3772 "id": "RowData", |
| 3773 "properties": { |
| 3774 "values": { |
| 3775 "description": "The values in the row, one per column.", |
| 3776 "items": { |
| 3777 "$ref": "CellData" |
| 3778 }, |
| 3779 "type": "array" |
| 3780 } |
| 3781 }, |
| 3782 "type": "object" |
| 3783 }, |
| 3784 "GridData": { |
| 3785 "description": "Data in the grid, as well as metadata about the dime
nsions.", |
| 3786 "id": "GridData", |
| 3787 "properties": { |
| 3788 "rowData": { |
| 3789 "description": "The data in the grid, one entry per row,\nst
arting with the row in startRow.\nThe values in RowData will correspond to colum
ns starting\nat start_column.", |
| 3790 "items": { |
| 3791 "$ref": "RowData" |
| 3792 }, |
| 3793 "type": "array" |
| 3794 }, |
| 3795 "startRow": { |
| 3796 "description": "The first row this GridData refers to, zero-
based.", |
| 3797 "format": "int32", |
| 3798 "type": "integer" |
| 3799 }, |
| 3800 "columnMetadata": { |
| 3801 "description": "Metadata about the requested columns in the
grid, starting with the column\nin start_column.", |
| 3802 "items": { |
| 3803 "$ref": "DimensionProperties" |
| 3804 }, |
| 3805 "type": "array" |
| 3806 }, |
| 3807 "startColumn": { |
| 3808 "description": "The first column this GridData refers to, ze
ro-based.", |
| 3809 "format": "int32", |
| 3810 "type": "integer" |
| 3811 }, |
| 3812 "rowMetadata": { |
| 3813 "description": "Metadata about the requested rows in the gri
d, starting with the row\nin start_row.", |
| 3814 "items": { |
| 3815 "$ref": "DimensionProperties" |
| 3816 }, |
| 3817 "type": "array" |
| 3818 } |
| 3819 }, |
| 3820 "type": "object" |
| 3821 }, |
| 3822 "Border": { |
| 3823 "description": "A border along a cell.", |
| 3824 "id": "Border", |
| 3825 "properties": { |
| 3826 "color": { |
| 3827 "$ref": "Color", |
| 3828 "description": "The color of the border." |
| 3829 }, |
| 3830 "width": { |
| 3831 "description": "The width of the border, in pixels.\nDepreca
ted; the width is determined by the \"style\" field.", |
| 3832 "format": "int32", |
| 3833 "type": "integer" |
| 3834 }, |
| 3835 "style": { |
| 3836 "description": "The style of the border.", |
| 3837 "enum": [ |
| 3838 "STYLE_UNSPECIFIED", |
| 3839 "DOTTED", |
| 3840 "DASHED", |
| 3841 "SOLID", |
| 3842 "SOLID_MEDIUM", |
| 3843 "SOLID_THICK", |
| 3844 "NONE", |
| 3845 "DOUBLE" |
| 3846 ], |
| 3847 "enumDescriptions": [ |
| 3848 "The style is not specified. Do not use this.", |
| 3849 "The border is dotted.", |
| 3850 "The border is dashed.", |
| 3851 "The border is a thin solid line.", |
| 3852 "The border is a medium solid line.", |
| 3853 "The border is a thick solid line.", |
| 3854 "No border.\nUsed only when updating a border in order t
o erase it.", |
| 3855 "The border is two solid lines." |
| 3856 ], |
| 3857 "type": "string" |
| 3858 } |
| 3859 }, |
| 3860 "type": "object" |
| 3861 }, |
| 3862 "UpdateNamedRangeRequest": { |
| 3863 "description": "Updates properties of the named range with the speci
fied\nnamedRangeId.", |
| 3864 "id": "UpdateNamedRangeRequest", |
| 3865 "properties": { |
| 3866 "namedRange": { |
| 3867 "$ref": "NamedRange", |
| 3868 "description": "The named range to update with the new prope
rties." |
3370 }, | 3869 }, |
3371 "fields": { | 3870 "fields": { |
3372 "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 fiel
d.", | 3871 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `namedRange` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", |
3373 "format": "google-fieldmask", | 3872 "format": "google-fieldmask", |
3374 "type": "string" | 3873 "type": "string" |
3375 } | 3874 } |
3376 }, | 3875 }, |
3377 "type": "object" | 3876 "type": "object" |
3378 }, | 3877 }, |
3379 "ChartData": { | 3878 "FindReplaceRequest": { |
3380 "description": "The data included in a domain or series.", | 3879 "description": "Finds and replaces data in cells over a range, sheet
, or all sheets.", |
3381 "id": "ChartData", | 3880 "id": "FindReplaceRequest", |
3382 "properties": { | 3881 "properties": { |
3383 "sourceRange": { | 3882 "includeFormulas": { |
3384 "$ref": "ChartSourceRange", | 3883 "description": "True if the search should include cells with
formulas.\nFalse to skip cells with formulas.", |
3385 "description": "The source ranges of the data." | 3884 "type": "boolean" |
3386 } | 3885 }, |
3387 }, | 3886 "matchEntireCell": { |
3388 "type": "object" | 3887 "description": "True if the find value should match the enti
re cell.", |
3389 }, | 3888 "type": "boolean" |
3390 "Sheet": { | 3889 }, |
3391 "description": "A sheet in a spreadsheet.", | 3890 "searchByRegex": { |
3392 "id": "Sheet", | 3891 "description": "True if the find value is a regex.\nThe regu
lar expression and replacement should follow Java regex rules\nat https://docs.o
racle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement strin
g is allowed to refer to capturing groups.\nFor example, if one cell has the con
tents `\"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.", |
| 3892 "type": "boolean" |
| 3893 }, |
| 3894 "find": { |
| 3895 "description": "The value to search.", |
| 3896 "type": "string" |
| 3897 }, |
| 3898 "replacement": { |
| 3899 "description": "The value to use as the replacement.", |
| 3900 "type": "string" |
| 3901 }, |
| 3902 "range": { |
| 3903 "$ref": "GridRange", |
| 3904 "description": "The range to find/replace over." |
| 3905 }, |
| 3906 "sheetId": { |
| 3907 "description": "The sheet to find/replace over.", |
| 3908 "format": "int32", |
| 3909 "type": "integer" |
| 3910 }, |
| 3911 "allSheets": { |
| 3912 "description": "True to find/replace over all sheets.", |
| 3913 "type": "boolean" |
| 3914 }, |
| 3915 "matchCase": { |
| 3916 "description": "True if the search is case sensitive.", |
| 3917 "type": "boolean" |
| 3918 } |
| 3919 }, |
| 3920 "type": "object" |
| 3921 }, |
| 3922 "AddSheetRequest": { |
| 3923 "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\nEmb
eddedObjectPosition.newSheet.", |
| 3924 "id": "AddSheetRequest", |
3393 "properties": { | 3925 "properties": { |
3394 "properties": { | 3926 "properties": { |
3395 "$ref": "SheetProperties", | 3927 "$ref": "SheetProperties", |
3396 "description": "The properties of the sheet." | 3928 "description": "The properties the new sheet should have.\nA
ll 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.)" |
3397 }, | |
3398 "charts": { | |
3399 "description": "The specifications of every chart on this sh
eet.", | |
3400 "items": { | |
3401 "$ref": "EmbeddedChart" | |
3402 }, | |
3403 "type": "array" | |
3404 }, | |
3405 "filterViews": { | |
3406 "description": "The filter views in this sheet.", | |
3407 "items": { | |
3408 "$ref": "FilterView" | |
3409 }, | |
3410 "type": "array" | |
3411 }, | |
3412 "conditionalFormats": { | |
3413 "description": "The conditional format rules in this sheet."
, | |
3414 "items": { | |
3415 "$ref": "ConditionalFormatRule" | |
3416 }, | |
3417 "type": "array" | |
3418 }, | |
3419 "protectedRanges": { | |
3420 "description": "The protected ranges in this sheet.", | |
3421 "items": { | |
3422 "$ref": "ProtectedRange" | |
3423 }, | |
3424 "type": "array" | |
3425 }, | |
3426 "basicFilter": { | |
3427 "$ref": "BasicFilter", | |
3428 "description": "The filter on this sheet, if any." | |
3429 }, | |
3430 "merges": { | |
3431 "description": "The ranges that are merged together.", | |
3432 "items": { | |
3433 "$ref": "GridRange" | |
3434 }, | |
3435 "type": "array" | |
3436 }, | |
3437 "data": { | |
3438 "description": "Data in the grid, if this is a grid sheet.\n
The number of GridData objects returned is dependent on the number of\nranges re
quested on this sheet. For example, if this is representing\n`Sheet1`, and the s
preadsheet 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-base
d column D).", | |
3439 "items": { | |
3440 "$ref": "GridData" | |
3441 }, | |
3442 "type": "array" | |
3443 }, | |
3444 "bandedRanges": { | |
3445 "description": "The banded (i.e. alternating colors) ranges
on this sheet.", | |
3446 "items": { | |
3447 "$ref": "BandedRange" | |
3448 }, | |
3449 "type": "array" | |
3450 } | |
3451 }, | |
3452 "type": "object" | |
3453 }, | |
3454 "CopyPasteRequest": { | |
3455 "description": "Copies data from the source to the destination.", | |
3456 "id": "CopyPasteRequest", | |
3457 "properties": { | |
3458 "pasteType": { | |
3459 "description": "What kind of data to paste.", | |
3460 "enum": [ | |
3461 "PASTE_NORMAL", | |
3462 "PASTE_VALUES", | |
3463 "PASTE_FORMAT", | |
3464 "PASTE_NO_BORDERS", | |
3465 "PASTE_FORMULA", | |
3466 "PASTE_DATA_VALIDATION", | |
3467 "PASTE_CONDITIONAL_FORMATTING" | |
3468 ], | |
3469 "enumDescriptions": [ | |
3470 "Paste values, formulas, formats, and merges.", | |
3471 "Paste the values ONLY without formats, formulas, or mer
ges.", | |
3472 "Paste the format and data validation only.", | |
3473 "Like PASTE_NORMAL but without borders.", | |
3474 "Paste the formulas only.", | |
3475 "Paste the data validation only.", | |
3476 "Paste the conditional formatting rules only." | |
3477 ], | |
3478 "type": "string" | |
3479 }, | |
3480 "pasteOrientation": { | |
3481 "description": "How that data should be oriented when pastin
g.", | |
3482 "enum": [ | |
3483 "NORMAL", | |
3484 "TRANSPOSE" | |
3485 ], | |
3486 "enumDescriptions": [ | |
3487 "Paste normally.", | |
3488 "Paste transposed, where all rows become columns and vic
e versa." | |
3489 ], | |
3490 "type": "string" | |
3491 }, | |
3492 "source": { | |
3493 "$ref": "GridRange", | |
3494 "description": "The source range to copy." | |
3495 }, | |
3496 "destination": { | |
3497 "$ref": "GridRange", | |
3498 "description": "The location to paste to. If the range cover
s 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 t
he destination range)." | |
3499 } | 3929 } |
3500 }, | 3930 }, |
3501 "type": "object" | 3931 "type": "object" |
3502 }, | 3932 }, |
3503 "UpdateCellsRequest": { | 3933 "UpdateCellsRequest": { |
3504 "description": "Updates all cells in a range with new data.", | 3934 "description": "Updates all cells in a range with new data.", |
3505 "id": "UpdateCellsRequest", | 3935 "id": "UpdateCellsRequest", |
3506 "properties": { | 3936 "properties": { |
| 3937 "start": { |
| 3938 "$ref": "GridCoordinate", |
| 3939 "description": "The coordinate to start writing data at.\nAn
y number of rows and columns (including a different number of\ncolumns per row)
may be written." |
| 3940 }, |
| 3941 "range": { |
| 3942 "$ref": "GridRange", |
| 3943 "description": "The range to write data to.\n\nIf the data i
n rows does not cover the entire requested range,\nthe fields matching those set
in fields will be cleared." |
| 3944 }, |
3507 "rows": { | 3945 "rows": { |
3508 "description": "The data to write.", | 3946 "description": "The data to write.", |
3509 "items": { | 3947 "items": { |
3510 "$ref": "RowData" | 3948 "$ref": "RowData" |
3511 }, | 3949 }, |
3512 "type": "array" | 3950 "type": "array" |
3513 }, | 3951 }, |
3514 "fields": { | 3952 "fields": { |
3515 "description": "The fields of CellData that should be update
d.\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 list
ing every field.", | 3953 "description": "The fields of CellData that should be update
d.\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 list
ing every field.", |
3516 "format": "google-fieldmask", | 3954 "format": "google-fieldmask", |
3517 "type": "string" | 3955 "type": "string" |
3518 }, | 3956 } |
3519 "start": { | 3957 }, |
3520 "$ref": "GridCoordinate", | 3958 "type": "object" |
3521 "description": "The coordinate to start writing data at.\nAn
y number of rows and columns (including a different number of\ncolumns per row)
may be written." | 3959 }, |
3522 }, | 3960 "DeleteConditionalFormatRuleResponse": { |
3523 "range": { | 3961 "description": "The result of deleting a conditional format rule.", |
3524 "$ref": "GridRange", | 3962 "id": "DeleteConditionalFormatRuleResponse", |
3525 "description": "The range to write data to.\n\nIf the data i
n rows does not cover the entire requested range,\nthe fields matching those set
in fields will be cleared." | 3963 "properties": { |
3526 } | 3964 "rule": { |
3527 }, | 3965 "$ref": "ConditionalFormatRule", |
3528 "type": "object" | 3966 "description": "The rule that was deleted." |
3529 }, | 3967 } |
3530 "ExtendedValue": { | 3968 }, |
3531 "description": "The kinds of value that a cell in a spreadsheet can
have.", | 3969 "type": "object" |
3532 "id": "ExtendedValue", | 3970 }, |
3533 "properties": { | 3971 "DeleteRangeRequest": { |
3534 "formulaValue": { | 3972 "description": "Deletes a range of cells, shifting other cells into
the deleted area.", |
3535 "description": "Represents a formula.", | 3973 "id": "DeleteRangeRequest", |
3536 "type": "string" | 3974 "properties": { |
3537 }, | 3975 "shiftDimension": { |
3538 "errorValue": { | 3976 "description": "The dimension from which deleted cells will
be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace th
e deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the
deleted cells.", |
3539 "$ref": "ErrorValue", | |
3540 "description": "Represents an error.\nThis field is read-onl
y." | |
3541 }, | |
3542 "boolValue": { | |
3543 "description": "Represents a boolean value.", | |
3544 "type": "boolean" | |
3545 }, | |
3546 "numberValue": { | |
3547 "description": "Represents a double value.\nNote: Dates, Tim
es and DateTimes are represented as doubles in\n\"serial number\" format.", | |
3548 "format": "double", | |
3549 "type": "number" | |
3550 }, | |
3551 "stringValue": { | |
3552 "description": "Represents a string value.\nLeading single q
uotes are not included. For example, if the user typed\n`'123` into the UI, this
would be represented as a `stringValue` of\n`\"123\"`.", | |
3553 "type": "string" | |
3554 } | |
3555 }, | |
3556 "type": "object" | |
3557 }, | |
3558 "BatchUpdateSpreadsheetResponse": { | |
3559 "description": "The reply for batch updating a spreadsheet.", | |
3560 "id": "BatchUpdateSpreadsheetResponse", | |
3561 "properties": { | |
3562 "spreadsheetId": { | |
3563 "description": "The spreadsheet the updates were applied to.
", | |
3564 "type": "string" | |
3565 }, | |
3566 "updatedSpreadsheet": { | |
3567 "$ref": "Spreadsheet", | |
3568 "description": "The spreadsheet after updates were applied.
This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo
nse] is `true`." | |
3569 }, | |
3570 "replies": { | |
3571 "description": "The reply of the updates. This maps 1:1 wit
h the updates, although\nreplies to some requests may be empty.", | |
3572 "items": { | |
3573 "$ref": "Response" | |
3574 }, | |
3575 "type": "array" | |
3576 } | |
3577 }, | |
3578 "type": "object" | |
3579 }, | |
3580 "GradientRule": { | |
3581 "description": "A rule that applies a gradient color scale format, b
ased 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.", | |
3582 "id": "GradientRule", | |
3583 "properties": { | |
3584 "maxpoint": { | |
3585 "$ref": "InterpolationPoint", | |
3586 "description": "The final interpolation point." | |
3587 }, | |
3588 "midpoint": { | |
3589 "$ref": "InterpolationPoint", | |
3590 "description": "An optional midway interpolation point." | |
3591 }, | |
3592 "minpoint": { | |
3593 "$ref": "InterpolationPoint", | |
3594 "description": "The starting interpolation point." | |
3595 } | |
3596 }, | |
3597 "type": "object" | |
3598 }, | |
3599 "CutPasteRequest": { | |
3600 "description": "Moves data from the source to the destination.", | |
3601 "id": "CutPasteRequest", | |
3602 "properties": { | |
3603 "pasteType": { | |
3604 "description": "What kind of data to paste. All the source
data will be cut, regardless\nof what is pasted.", | |
3605 "enum": [ | |
3606 "PASTE_NORMAL", | |
3607 "PASTE_VALUES", | |
3608 "PASTE_FORMAT", | |
3609 "PASTE_NO_BORDERS", | |
3610 "PASTE_FORMULA", | |
3611 "PASTE_DATA_VALIDATION", | |
3612 "PASTE_CONDITIONAL_FORMATTING" | |
3613 ], | |
3614 "enumDescriptions": [ | |
3615 "Paste values, formulas, formats, and merges.", | |
3616 "Paste the values ONLY without formats, formulas, or mer
ges.", | |
3617 "Paste the format and data validation only.", | |
3618 "Like PASTE_NORMAL but without borders.", | |
3619 "Paste the formulas only.", | |
3620 "Paste the data validation only.", | |
3621 "Paste the conditional formatting rules only." | |
3622 ], | |
3623 "type": "string" | |
3624 }, | |
3625 "source": { | |
3626 "$ref": "GridRange", | |
3627 "description": "The source data to cut." | |
3628 }, | |
3629 "destination": { | |
3630 "$ref": "GridCoordinate", | |
3631 "description": "The top-left coordinate where the data shoul
d be pasted." | |
3632 } | |
3633 }, | |
3634 "type": "object" | |
3635 }, | |
3636 "OverlayPosition": { | |
3637 "description": "The location an object is overlaid on top of a grid.
", | |
3638 "id": "OverlayPosition", | |
3639 "properties": { | |
3640 "widthPixels": { | |
3641 "description": "The width of the object, in pixels. Defaults
to 600.", | |
3642 "format": "int32", | |
3643 "type": "integer" | |
3644 }, | |
3645 "anchorCell": { | |
3646 "$ref": "GridCoordinate", | |
3647 "description": "The cell the object is anchored to." | |
3648 }, | |
3649 "offsetXPixels": { | |
3650 "description": "The horizontal offset, in pixels, that the o
bject is offset\nfrom the anchor cell.", | |
3651 "format": "int32", | |
3652 "type": "integer" | |
3653 }, | |
3654 "heightPixels": { | |
3655 "description": "The height of the object, in pixels. Default
s to 371.", | |
3656 "format": "int32", | |
3657 "type": "integer" | |
3658 }, | |
3659 "offsetYPixels": { | |
3660 "description": "The vertical offset, in pixels, that the obj
ect is offset\nfrom the anchor cell.", | |
3661 "format": "int32", | |
3662 "type": "integer" | |
3663 } | |
3664 }, | |
3665 "type": "object" | |
3666 }, | |
3667 "AutoFillRequest": { | |
3668 "description": "Fills in more data based on existing data.", | |
3669 "id": "AutoFillRequest", | |
3670 "properties": { | |
3671 "useAlternateSeries": { | |
3672 "description": "True if we should generate data with the \"a
lternate\" series.\nThis differs based on the type and amount of source data.", | |
3673 "type": "boolean" | |
3674 }, | |
3675 "range": { | |
3676 "$ref": "GridRange", | |
3677 "description": "The range to autofill. This will examine the
range and detect\nthe location that has data and automatically fill that data\n
in to the rest of the range." | |
3678 }, | |
3679 "sourceAndDestination": { | |
3680 "$ref": "SourceAndDestination", | |
3681 "description": "The source and destination areas to autofill
.\nThis explicitly lists the source of the autofill and where to\nextend that da
ta." | |
3682 } | |
3683 }, | |
3684 "type": "object" | |
3685 }, | |
3686 "PieChartSpec": { | |
3687 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart
\">pie chart</a>.", | |
3688 "id": "PieChartSpec", | |
3689 "properties": { | |
3690 "legendPosition": { | |
3691 "description": "Where the legend of the pie chart should be
drawn.", | |
3692 "enum": [ | |
3693 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED", | |
3694 "BOTTOM_LEGEND", | |
3695 "LEFT_LEGEND", | |
3696 "RIGHT_LEGEND", | |
3697 "TOP_LEGEND", | |
3698 "NO_LEGEND", | |
3699 "LABELED_LEGEND" | |
3700 ], | |
3701 "enumDescriptions": [ | |
3702 "Default value, do not use.", | |
3703 "The legend is rendered on the bottom of the chart.", | |
3704 "The legend is rendered on the left of the chart.", | |
3705 "The legend is rendered on the right of the chart.", | |
3706 "The legend is rendered on the top of the chart.", | |
3707 "No legend is rendered.", | |
3708 "Each pie slice has a label attached to it." | |
3709 ], | |
3710 "type": "string" | |
3711 }, | |
3712 "series": { | |
3713 "$ref": "ChartData", | |
3714 "description": "The data that covers the one and only series
of the pie chart." | |
3715 }, | |
3716 "pieHole": { | |
3717 "description": "The size of the hole in the pie chart.", | |
3718 "format": "double", | |
3719 "type": "number" | |
3720 }, | |
3721 "threeDimensional": { | |
3722 "description": "True if the pie is three dimensional.", | |
3723 "type": "boolean" | |
3724 }, | |
3725 "domain": { | |
3726 "$ref": "ChartData", | |
3727 "description": "The data that covers the domain of the pie c
hart." | |
3728 } | |
3729 }, | |
3730 "type": "object" | |
3731 }, | |
3732 "UpdateSheetPropertiesRequest": { | |
3733 "description": "Updates properties of the sheet with the specified\n
sheetId.", | |
3734 "id": "UpdateSheetPropertiesRequest", | |
3735 "properties": { | |
3736 "fields": { | |
3737 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `properties` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", | |
3738 "format": "google-fieldmask", | |
3739 "type": "string" | |
3740 }, | |
3741 "properties": { | |
3742 "$ref": "SheetProperties", | |
3743 "description": "The properties to update." | |
3744 } | |
3745 }, | |
3746 "type": "object" | |
3747 }, | |
3748 "BooleanRule": { | |
3749 "description": "A rule that may or may not match, depending on the c
ondition.", | |
3750 "id": "BooleanRule", | |
3751 "properties": { | |
3752 "condition": { | |
3753 "$ref": "BooleanCondition", | |
3754 "description": "The condition of the rule. If the condition
evaluates to true,\nthe format will be applied." | |
3755 }, | |
3756 "format": { | |
3757 "$ref": "CellFormat", | |
3758 "description": "The format to apply.\nConditional formatting
can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou
nd color &\nbackground color." | |
3759 } | |
3760 }, | |
3761 "type": "object" | |
3762 }, | |
3763 "AppendDimensionRequest": { | |
3764 "description": "Appends rows or columns to the end of a sheet.", | |
3765 "id": "AppendDimensionRequest", | |
3766 "properties": { | |
3767 "sheetId": { | |
3768 "description": "The sheet to append rows or columns to.", | |
3769 "format": "int32", | |
3770 "type": "integer" | |
3771 }, | |
3772 "length": { | |
3773 "description": "The number of rows or columns to append.", | |
3774 "format": "int32", | |
3775 "type": "integer" | |
3776 }, | |
3777 "dimension": { | |
3778 "description": "Whether rows or columns should be appended."
, | |
3779 "enum": [ | 3977 "enum": [ |
3780 "DIMENSION_UNSPECIFIED", | 3978 "DIMENSION_UNSPECIFIED", |
3781 "ROWS", | 3979 "ROWS", |
3782 "COLUMNS" | 3980 "COLUMNS" |
3783 ], | 3981 ], |
3784 "enumDescriptions": [ | 3982 "enumDescriptions": [ |
3785 "The default value, do not use.", | 3983 "The default value, do not use.", |
3786 "Operates on the rows of a sheet.", | 3984 "Operates on the rows of a sheet.", |
3787 "Operates on the columns of a sheet." | 3985 "Operates on the columns of a sheet." |
3788 ], | 3986 ], |
3789 "type": "string" | 3987 "type": "string" |
| 3988 }, |
| 3989 "range": { |
| 3990 "$ref": "GridRange", |
| 3991 "description": "The range of cells to delete." |
| 3992 } |
| 3993 }, |
| 3994 "type": "object" |
| 3995 }, |
| 3996 "GridCoordinate": { |
| 3997 "description": "A coordinate in a sheet.\nAll indexes are zero-based
.", |
| 3998 "id": "GridCoordinate", |
| 3999 "properties": { |
| 4000 "rowIndex": { |
| 4001 "description": "The row index of the coordinate.", |
| 4002 "format": "int32", |
| 4003 "type": "integer" |
| 4004 }, |
| 4005 "columnIndex": { |
| 4006 "description": "The column index of the coordinate.", |
| 4007 "format": "int32", |
| 4008 "type": "integer" |
| 4009 }, |
| 4010 "sheetId": { |
| 4011 "description": "The sheet this coordinate is on.", |
| 4012 "format": "int32", |
| 4013 "type": "integer" |
| 4014 } |
| 4015 }, |
| 4016 "type": "object" |
| 4017 }, |
| 4018 "UpdateSheetPropertiesRequest": { |
| 4019 "description": "Updates properties of the sheet with the specified\n
sheetId.", |
| 4020 "id": "UpdateSheetPropertiesRequest", |
| 4021 "properties": { |
| 4022 "properties": { |
| 4023 "$ref": "SheetProperties", |
| 4024 "description": "The properties to update." |
| 4025 }, |
| 4026 "fields": { |
| 4027 "description": "The fields that should be updated. At least
one field must be specified.\nThe root `properties` is implied and should not b
e specified.\nA single `\"*\"` can be used as short-hand for listing every field
.", |
| 4028 "format": "google-fieldmask", |
| 4029 "type": "string" |
3790 } | 4030 } |
3791 }, | 4031 }, |
3792 "type": "object" | 4032 "type": "object" |
3793 }, | |
3794 "AddFilterViewRequest": { | |
3795 "description": "Adds a filter view.", | |
3796 "id": "AddFilterViewRequest", | |
3797 "properties": { | |
3798 "filter": { | |
3799 "$ref": "FilterView", | |
3800 "description": "The filter to add. The filterViewId\nfield i
s optional; if one is not set, an id will be randomly generated. (It\nis an erro
r to specify the ID of a filter that already exists.)" | |
3801 } | |
3802 }, | |
3803 "type": "object" | |
3804 }, | 4033 }, |
3805 "GridProperties": { | 4034 "GridProperties": { |
3806 "description": "Properties of a grid.", | 4035 "description": "Properties of a grid.", |
3807 "id": "GridProperties", | 4036 "id": "GridProperties", |
3808 "properties": { | 4037 "properties": { |
3809 "rowCount": { | 4038 "rowCount": { |
3810 "description": "The number of rows in the grid.", | 4039 "description": "The number of rows in the grid.", |
3811 "format": "int32", | 4040 "format": "int32", |
3812 "type": "integer" | 4041 "type": "integer" |
3813 }, | 4042 }, |
3814 "columnCount": { | |
3815 "description": "The number of columns in the grid.", | |
3816 "format": "int32", | |
3817 "type": "integer" | |
3818 }, | |
3819 "frozenRowCount": { | 4043 "frozenRowCount": { |
3820 "description": "The number of rows that are frozen in the gr
id.", | 4044 "description": "The number of rows that are frozen in the gr
id.", |
3821 "format": "int32", | 4045 "format": "int32", |
3822 "type": "integer" | 4046 "type": "integer" |
3823 }, | 4047 }, |
| 4048 "hideGridlines": { |
| 4049 "description": "True if the grid isn't showing gridlines in
the UI.", |
| 4050 "type": "boolean" |
| 4051 }, |
| 4052 "columnCount": { |
| 4053 "description": "The number of columns in the grid.", |
| 4054 "format": "int32", |
| 4055 "type": "integer" |
| 4056 }, |
3824 "frozenColumnCount": { | 4057 "frozenColumnCount": { |
3825 "description": "The number of columns that are frozen in the
grid.", | 4058 "description": "The number of columns that are frozen in the
grid.", |
3826 "format": "int32", | 4059 "format": "int32", |
3827 "type": "integer" | 4060 "type": "integer" |
3828 }, | |
3829 "hideGridlines": { | |
3830 "description": "True if the grid isn't showing gridlines in
the UI.", | |
3831 "type": "boolean" | |
3832 } | |
3833 }, | |
3834 "type": "object" | |
3835 }, | |
3836 "DeleteNamedRangeRequest": { | |
3837 "description": "Removes the named range with the given ID from the s
preadsheet.", | |
3838 "id": "DeleteNamedRangeRequest", | |
3839 "properties": { | |
3840 "namedRangeId": { | |
3841 "description": "The ID of the named range to delete.", | |
3842 "type": "string" | |
3843 } | |
3844 }, | |
3845 "type": "object" | |
3846 }, | |
3847 "AddChartRequest": { | |
3848 "description": "Adds a chart to a sheet in the spreadsheet.", | |
3849 "id": "AddChartRequest", | |
3850 "properties": { | |
3851 "chart": { | |
3852 "$ref": "EmbeddedChart", | |
3853 "description": "The chart that should be added to the spread
sheet, 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 a chart that already exists.)" | |
3854 } | |
3855 }, | |
3856 "type": "object" | |
3857 }, | |
3858 "SetDataValidationRequest": { | |
3859 "description": "Sets a data validation rule to every cell in the ran
ge.\nTo clear validation in a range, call this with no rule specified.", | |
3860 "id": "SetDataValidationRequest", | |
3861 "properties": { | |
3862 "rule": { | |
3863 "$ref": "DataValidationRule", | |
3864 "description": "The data validation rule to set on each cell
in the range,\nor empty to clear the data validation in the range." | |
3865 }, | |
3866 "range": { | |
3867 "$ref": "GridRange", | |
3868 "description": "The range the data validation rule should ap
ply to." | |
3869 } | |
3870 }, | |
3871 "type": "object" | |
3872 }, | |
3873 "Request": { | |
3874 "description": "A single kind of update to apply to a spreadsheet.", | |
3875 "id": "Request", | |
3876 "properties": { | |
3877 "updateEmbeddedObjectPosition": { | |
3878 "$ref": "UpdateEmbeddedObjectPositionRequest", | |
3879 "description": "Updates an embedded object's (e.g. chart, im
age) position." | |
3880 }, | |
3881 "deleteNamedRange": { | |
3882 "$ref": "DeleteNamedRangeRequest", | |
3883 "description": "Deletes a named range." | |
3884 }, | |
3885 "updateNamedRange": { | |
3886 "$ref": "UpdateNamedRangeRequest", | |
3887 "description": "Updates a named range." | |
3888 }, | |
3889 "addFilterView": { | |
3890 "$ref": "AddFilterViewRequest", | |
3891 "description": "Adds a filter view." | |
3892 }, | |
3893 "updateSpreadsheetProperties": { | |
3894 "$ref": "UpdateSpreadsheetPropertiesRequest", | |
3895 "description": "Updates the spreadsheet's properties." | |
3896 }, | |
3897 "appendDimension": { | |
3898 "$ref": "AppendDimensionRequest", | |
3899 "description": "Appends dimensions to the end of a sheet." | |
3900 }, | |
3901 "unmergeCells": { | |
3902 "$ref": "UnmergeCellsRequest", | |
3903 "description": "Unmerges merged cells." | |
3904 }, | |
3905 "insertRange": { | |
3906 "$ref": "InsertRangeRequest", | |
3907 "description": "Inserts new cells in a sheet, shifting the e
xisting cells." | |
3908 }, | |
3909 "updateProtectedRange": { | |
3910 "$ref": "UpdateProtectedRangeRequest", | |
3911 "description": "Updates a protected range." | |
3912 }, | |
3913 "deleteFilterView": { | |
3914 "$ref": "DeleteFilterViewRequest", | |
3915 "description": "Deletes a filter view from a sheet." | |
3916 }, | |
3917 "clearBasicFilter": { | |
3918 "$ref": "ClearBasicFilterRequest", | |
3919 "description": "Clears the basic filter on a sheet." | |
3920 }, | |
3921 "sortRange": { | |
3922 "$ref": "SortRangeRequest", | |
3923 "description": "Sorts data in a range." | |
3924 }, | |
3925 "repeatCell": { | |
3926 "$ref": "RepeatCellRequest", | |
3927 "description": "Repeats a single cell across a range." | |
3928 }, | |
3929 "setDataValidation": { | |
3930 "$ref": "SetDataValidationRequest", | |
3931 "description": "Sets data validation for one or more cells." | |
3932 }, | |
3933 "updateCells": { | |
3934 "$ref": "UpdateCellsRequest", | |
3935 "description": "Updates many cells at once." | |
3936 }, | |
3937 "addSheet": { | |
3938 "$ref": "AddSheetRequest", | |
3939 "description": "Adds a sheet." | |
3940 }, | |
3941 "updateFilterView": { | |
3942 "$ref": "UpdateFilterViewRequest", | |
3943 "description": "Updates the properties of a filter view." | |
3944 }, | |
3945 "updateSheetProperties": { | |
3946 "$ref": "UpdateSheetPropertiesRequest", | |
3947 "description": "Updates a sheet's properties." | |
3948 }, | |
3949 "updateDimensionProperties": { | |
3950 "$ref": "UpdateDimensionPropertiesRequest", | |
3951 "description": "Updates dimensions' properties." | |
3952 }, | |
3953 "deleteSheet": { | |
3954 "$ref": "DeleteSheetRequest", | |
3955 "description": "Deletes a sheet." | |
3956 }, | |
3957 "findReplace": { | |
3958 "$ref": "FindReplaceRequest", | |
3959 "description": "Finds and replaces occurrences of some text
with other text." | |
3960 }, | |
3961 "addProtectedRange": { | |
3962 "$ref": "AddProtectedRangeRequest", | |
3963 "description": "Adds a protected range." | |
3964 }, | |
3965 "deleteProtectedRange": { | |
3966 "$ref": "DeleteProtectedRangeRequest", | |
3967 "description": "Deletes a protected range." | |
3968 }, | |
3969 "updateConditionalFormatRule": { | |
3970 "$ref": "UpdateConditionalFormatRuleRequest", | |
3971 "description": "Updates an existing conditional format rule.
" | |
3972 }, | |
3973 "setBasicFilter": { | |
3974 "$ref": "SetBasicFilterRequest", | |
3975 "description": "Sets the basic filter on a sheet." | |
3976 }, | |
3977 "mergeCells": { | |
3978 "$ref": "MergeCellsRequest", | |
3979 "description": "Merges cells together." | |
3980 }, | |
3981 "updateBanding": { | |
3982 "$ref": "UpdateBandingRequest", | |
3983 "description": "Updates a banded range" | |
3984 }, | |
3985 "addChart": { | |
3986 "$ref": "AddChartRequest", | |
3987 "description": "Adds a chart." | |
3988 }, | |
3989 "deleteConditionalFormatRule": { | |
3990 "$ref": "DeleteConditionalFormatRuleRequest", | |
3991 "description": "Deletes an existing conditional format rule.
" | |
3992 }, | |
3993 "addBanding": { | |
3994 "$ref": "AddBandingRequest", | |
3995 "description": "Adds a new banded range" | |
3996 }, | |
3997 "deleteBanding": { | |
3998 "$ref": "DeleteBandingRequest", | |
3999 "description": "Removes a banded range" | |
4000 }, | |
4001 "updateChartSpec": { | |
4002 "$ref": "UpdateChartSpecRequest", | |
4003 "description": "Updates a chart's specifications." | |
4004 }, | |
4005 "deleteRange": { | |
4006 "$ref": "DeleteRangeRequest", | |
4007 "description": "Deletes a range of cells from a sheet, shift
ing the remaining cells." | |
4008 }, | |
4009 "deleteDimension": { | |
4010 "$ref": "DeleteDimensionRequest", | |
4011 "description": "Deletes rows or columns in a sheet." | |
4012 }, | |
4013 "deleteEmbeddedObject": { | |
4014 "$ref": "DeleteEmbeddedObjectRequest", | |
4015 "description": "Deletes an embedded object (e.g, chart, imag
e) in a sheet." | |
4016 }, | |
4017 "pasteData": { | |
4018 "$ref": "PasteDataRequest", | |
4019 "description": "Pastes data (HTML or delimited) into a sheet
." | |
4020 }, | |
4021 "addConditionalFormatRule": { | |
4022 "$ref": "AddConditionalFormatRuleRequest", | |
4023 "description": "Adds a new conditional format rule." | |
4024 }, | |
4025 "updateBorders": { | |
4026 "$ref": "UpdateBordersRequest", | |
4027 "description": "Updates the borders in a range of cells." | |
4028 }, | |
4029 "autoResizeDimensions": { | |
4030 "$ref": "AutoResizeDimensionsRequest", | |
4031 "description": "Automatically resizes one or more dimensions
based on the contents\nof the cells in that dimension." | |
4032 }, | |
4033 "duplicateSheet": { | |
4034 "$ref": "DuplicateSheetRequest", | |
4035 "description": "Duplicates a sheet." | |
4036 }, | |
4037 "duplicateFilterView": { | |
4038 "$ref": "DuplicateFilterViewRequest", | |
4039 "description": "Duplicates a filter view." | |
4040 }, | |
4041 "cutPaste": { | |
4042 "$ref": "CutPasteRequest", | |
4043 "description": "Cuts data from one area and pastes it to ano
ther." | |
4044 }, | |
4045 "appendCells": { | |
4046 "$ref": "AppendCellsRequest", | |
4047 "description": "Appends cells after the last row with data i
n a sheet." | |
4048 }, | |
4049 "addNamedRange": { | |
4050 "$ref": "AddNamedRangeRequest", | |
4051 "description": "Adds a named range." | |
4052 }, | |
4053 "autoFill": { | |
4054 "$ref": "AutoFillRequest", | |
4055 "description": "Automatically fills in more data based on ex
isting data." | |
4056 }, | |
4057 "moveDimension": { | |
4058 "$ref": "MoveDimensionRequest", | |
4059 "description": "Moves rows or columns to another location in
a sheet." | |
4060 }, | |
4061 "textToColumns": { | |
4062 "$ref": "TextToColumnsRequest", | |
4063 "description": "Converts a column of text into many columns
of text." | |
4064 }, | |
4065 "insertDimension": { | |
4066 "$ref": "InsertDimensionRequest", | |
4067 "description": "Inserts new rows or columns in a sheet." | |
4068 }, | |
4069 "copyPaste": { | |
4070 "$ref": "CopyPasteRequest", | |
4071 "description": "Copies data from one area and pastes it to a
nother." | |
4072 } | |
4073 }, | |
4074 "type": "object" | |
4075 }, | |
4076 "BatchGetValuesResponse": { | |
4077 "description": "The response when retrieving more than one range of
values in a spreadsheet.", | |
4078 "id": "BatchGetValuesResponse", | |
4079 "properties": { | |
4080 "valueRanges": { | |
4081 "description": "The requested values. The order of the Value
Ranges is the same as the\norder of the requested ranges.", | |
4082 "items": { | |
4083 "$ref": "ValueRange" | |
4084 }, | |
4085 "type": "array" | |
4086 }, | |
4087 "spreadsheetId": { | |
4088 "description": "The ID of the spreadsheet the data was retri
eved from.", | |
4089 "type": "string" | |
4090 } | |
4091 }, | |
4092 "type": "object" | |
4093 }, | |
4094 "InsertDimensionRequest": { | |
4095 "description": "Inserts rows or columns in a sheet at a particular i
ndex.", | |
4096 "id": "InsertDimensionRequest", | |
4097 "properties": { | |
4098 "inheritFromBefore": { | |
4099 "description": "Whether dimension properties should be exten
ded 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 grea
ter 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 in
serting 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 befor
e the insertion point\nwas red), whereas if `inheritFromBefore` is false, the tw
o new rows will\nbe green (because the row after the insertion point was green).
", | |
4100 "type": "boolean" | |
4101 }, | |
4102 "range": { | |
4103 "$ref": "DimensionRange", | |
4104 "description": "The dimensions to insert. Both the start an
d end indexes must be bounded." | |
4105 } | |
4106 }, | |
4107 "type": "object" | |
4108 }, | |
4109 "DeleteEmbeddedObjectRequest": { | |
4110 "description": "Deletes the embedded object with the given ID.", | |
4111 "id": "DeleteEmbeddedObjectRequest", | |
4112 "properties": { | |
4113 "objectId": { | |
4114 "description": "The ID of the embedded object to delete.", | |
4115 "format": "int32", | |
4116 "type": "integer" | |
4117 } | 4061 } |
4118 }, | 4062 }, |
4119 "type": "object" | 4063 "type": "object" |
4120 }, | 4064 }, |
4121 "BandedRange": { | 4065 "UnmergeCellsRequest": { |
4122 "description": "A banded (alternating colors) range in a sheet.", | 4066 "description": "Unmerges cells in the given range.", |
4123 "id": "BandedRange", | 4067 "id": "UnmergeCellsRequest", |
4124 "properties": { | 4068 "properties": { |
4125 "bandedRangeId": { | |
4126 "description": "The id of the banded range.", | |
4127 "format": "int32", | |
4128 "type": "integer" | |
4129 }, | |
4130 "rowProperties": { | |
4131 "$ref": "BandingProperties", | |
4132 "description": "Properties for row bands. These properties w
ill be applied on a row-by-row\nbasis throughout all the rows in the range. At l
east one of\nrow_properties or column_properties must be specified." | |
4133 }, | |
4134 "columnProperties": { | |
4135 "$ref": "BandingProperties", | |
4136 "description": "Properties for column bands. These propertie
s will be applied on a column-\nby-column basis throughout all the columns in th
e range. At least one of\nrow_properties or column_properties must be specified.
" | |
4137 }, | |
4138 "range": { | 4069 "range": { |
4139 "$ref": "GridRange", | 4070 "$ref": "GridRange", |
4140 "description": "The range over which these properties are ap
plied." | 4071 "description": "The range within which all cells should be u
nmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range m
ust not partially span any merge." |
4141 } | 4072 } |
4142 }, | 4073 }, |
4143 "type": "object" | 4074 "type": "object" |
4144 }, | 4075 }, |
4145 "DeleteConditionalFormatRuleResponse": { | 4076 "UpdateEmbeddedObjectPositionResponse": { |
4146 "description": "The result of deleting a conditional format rule.", | 4077 "description": "The result of updating an embedded object's position
.", |
4147 "id": "DeleteConditionalFormatRuleResponse", | 4078 "id": "UpdateEmbeddedObjectPositionResponse", |
4148 "properties": { | 4079 "properties": { |
4149 "rule": { | 4080 "position": { |
4150 "$ref": "ConditionalFormatRule", | 4081 "$ref": "EmbeddedObjectPosition", |
4151 "description": "The rule that was deleted." | 4082 "description": "The new position of the embedded object." |
4152 } | 4083 } |
4153 }, | 4084 }, |
4154 "type": "object" | 4085 "type": "object" |
| 4086 }, |
| 4087 "SortSpec": { |
| 4088 "description": "A sort order associated with a specific column or ro
w.", |
| 4089 "id": "SortSpec", |
| 4090 "properties": { |
| 4091 "dimensionIndex": { |
| 4092 "description": "The dimension the sort should be applied to.
", |
| 4093 "format": "int32", |
| 4094 "type": "integer" |
| 4095 }, |
| 4096 "sortOrder": { |
| 4097 "description": "The order data should be sorted.", |
| 4098 "enum": [ |
| 4099 "SORT_ORDER_UNSPECIFIED", |
| 4100 "ASCENDING", |
| 4101 "DESCENDING" |
| 4102 ], |
| 4103 "enumDescriptions": [ |
| 4104 "Default value, do not use this.", |
| 4105 "Sort ascending.", |
| 4106 "Sort descending." |
| 4107 ], |
| 4108 "type": "string" |
| 4109 } |
| 4110 }, |
| 4111 "type": "object" |
| 4112 }, |
| 4113 "Sheet": { |
| 4114 "description": "A sheet in a spreadsheet.", |
| 4115 "id": "Sheet", |
| 4116 "properties": { |
| 4117 "conditionalFormats": { |
| 4118 "description": "The conditional format rules in this sheet."
, |
| 4119 "items": { |
| 4120 "$ref": "ConditionalFormatRule" |
| 4121 }, |
| 4122 "type": "array" |
| 4123 }, |
| 4124 "protectedRanges": { |
| 4125 "description": "The protected ranges in this sheet.", |
| 4126 "items": { |
| 4127 "$ref": "ProtectedRange" |
| 4128 }, |
| 4129 "type": "array" |
| 4130 }, |
| 4131 "basicFilter": { |
| 4132 "$ref": "BasicFilter", |
| 4133 "description": "The filter on this sheet, if any." |
| 4134 }, |
| 4135 "merges": { |
| 4136 "description": "The ranges that are merged together.", |
| 4137 "items": { |
| 4138 "$ref": "GridRange" |
| 4139 }, |
| 4140 "type": "array" |
| 4141 }, |
| 4142 "data": { |
| 4143 "description": "Data in the grid, if this is a grid sheet.\n
The number of GridData objects returned is dependent on the number of\nranges re
quested on this sheet. For example, if this is representing\n`Sheet1`, and the s
preadsheet 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-base
d column D).", |
| 4144 "items": { |
| 4145 "$ref": "GridData" |
| 4146 }, |
| 4147 "type": "array" |
| 4148 }, |
| 4149 "bandedRanges": { |
| 4150 "description": "The banded (i.e. alternating colors) ranges
on this sheet.", |
| 4151 "items": { |
| 4152 "$ref": "BandedRange" |
| 4153 }, |
| 4154 "type": "array" |
| 4155 }, |
| 4156 "properties": { |
| 4157 "$ref": "SheetProperties", |
| 4158 "description": "The properties of the sheet." |
| 4159 }, |
| 4160 "charts": { |
| 4161 "description": "The specifications of every chart on this sh
eet.", |
| 4162 "items": { |
| 4163 "$ref": "EmbeddedChart" |
| 4164 }, |
| 4165 "type": "array" |
| 4166 }, |
| 4167 "filterViews": { |
| 4168 "description": "The filter views in this sheet.", |
| 4169 "items": { |
| 4170 "$ref": "FilterView" |
| 4171 }, |
| 4172 "type": "array" |
| 4173 } |
| 4174 }, |
| 4175 "type": "object" |
4155 } | 4176 } |
4156 }, | 4177 }, |
4157 "servicePath": "", | 4178 "servicePath": "", |
4158 "title": "Google Sheets API", | 4179 "title": "Google Sheets API", |
4159 "version": "v4" | 4180 "version": "v4" |
4160 } | 4181 } |
OLD | NEW |