Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(273)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/sheets__v4.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/slides__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/drive.file": {
6 "description": "View and manage Google Drive files and folde rs that you have opened or created with this app"
7 },
5 "https://www.googleapis.com/auth/spreadsheets.readonly": { 8 "https://www.googleapis.com/auth/spreadsheets.readonly": {
6 "description": "View your Google Spreadsheets" 9 "description": "View your Google Spreadsheets"
7 }, 10 },
8 "https://www.googleapis.com/auth/drive.readonly": { 11 "https://www.googleapis.com/auth/drive.readonly": {
9 "description": "View the files in your Google Drive" 12 "description": "View the files in your Google Drive"
10 }, 13 },
11 "https://www.googleapis.com/auth/drive": { 14 "https://www.googleapis.com/auth/drive": {
12 "description": "View and manage the files in your Google Dri ve" 15 "description": "View and manage the files in your Google Dri ve"
13 }, 16 },
14 "https://www.googleapis.com/auth/spreadsheets": { 17 "https://www.googleapis.com/auth/spreadsheets": {
15 "description": "View and manage your spreadsheets in Google Drive" 18 "description": "View and manage your spreadsheets in Google Drive"
16 },
17 "https://www.googleapis.com/auth/drive.file": {
18 "description": "View and manage Google Drive files and folde rs that you have opened or created with this app"
19 } 19 }
20 } 20 }
21 } 21 }
22 }, 22 },
23 "basePath": "", 23 "basePath": "",
24 "baseUrl": "https://sheets.googleapis.com/", 24 "baseUrl": "https://sheets.googleapis.com/",
25 "batchPath": "batch", 25 "batchPath": "batch",
26 "canonicalName": "Sheets", 26 "canonicalName": "Sheets",
27 "description": "Reads and writes Google Sheets.", 27 "description": "Reads and writes Google Sheets.",
28 "discoveryVersion": "v1", 28 "discoveryVersion": "v1",
29 "documentationLink": "https://developers.google.com/sheets/", 29 "documentationLink": "https://developers.google.com/sheets/",
30 "icons": { 30 "icons": {
31 "x16": "http://www.google.com/images/icons/product/search-16.gif", 31 "x16": "http://www.google.com/images/icons/product/search-16.gif",
32 "x32": "http://www.google.com/images/icons/product/search-32.gif" 32 "x32": "http://www.google.com/images/icons/product/search-32.gif"
33 }, 33 },
34 "id": "sheets:v4", 34 "id": "sheets:v4",
35 "kind": "discovery#restDescription", 35 "kind": "discovery#restDescription",
36 "name": "sheets", 36 "name": "sheets",
37 "ownerDomain": "google.com", 37 "ownerDomain": "google.com",
38 "ownerName": "Google", 38 "ownerName": "Google",
39 "parameters": { 39 "parameters": {
40 "pp": {
41 "default": "true",
42 "description": "Pretty-print response.",
43 "location": "query",
44 "type": "boolean"
45 },
46 "bearer_token": {
47 "description": "OAuth bearer token.",
48 "location": "query",
49 "type": "string"
50 },
51 "oauth_token": {
52 "description": "OAuth 2.0 token for the current user.",
53 "location": "query",
54 "type": "string"
55 },
56 "upload_protocol": {
57 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
58 "location": "query",
59 "type": "string"
60 },
40 "prettyPrint": { 61 "prettyPrint": {
41 "default": "true", 62 "default": "true",
42 "description": "Returns response with indentations and line breaks." , 63 "description": "Returns response with indentations and line breaks." ,
43 "location": "query", 64 "location": "query",
44 "type": "boolean" 65 "type": "boolean"
45 }, 66 },
46 "fields": { 67 "uploadType": {
47 "description": "Selector specifying which fields to include in a par tial response.", 68 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
48 "location": "query", 69 "location": "query",
49 "type": "string" 70 "type": "string"
50 }, 71 },
51 "uploadType": { 72 "fields": {
52 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 73 "description": "Selector specifying which fields to include in a par tial response.",
53 "location": "query", 74 "location": "query",
54 "type": "string" 75 "type": "string"
55 }, 76 },
56 "$.xgafv": { 77 "$.xgafv": {
57 "description": "V1 error format.", 78 "description": "V1 error format.",
58 "enum": [ 79 "enum": [
59 "1", 80 "1",
60 "2" 81 "2"
61 ], 82 ],
62 "enumDescriptions": [ 83 "enumDescriptions": [
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
94 }, 115 },
95 "key": { 116 "key": {
96 "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.", 117 "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.",
97 "location": "query", 118 "location": "query",
98 "type": "string" 119 "type": "string"
99 }, 120 },
100 "quotaUser": { 121 "quotaUser": {
101 "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.", 122 "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.",
102 "location": "query", 123 "location": "query",
103 "type": "string" 124 "type": "string"
104 },
105 "pp": {
106 "default": "true",
107 "description": "Pretty-print response.",
108 "location": "query",
109 "type": "boolean"
110 },
111 "bearer_token": {
112 "description": "OAuth bearer token.",
113 "location": "query",
114 "type": "string"
115 },
116 "oauth_token": {
117 "description": "OAuth 2.0 token for the current user.",
118 "location": "query",
119 "type": "string"
120 },
121 "upload_protocol": {
122 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
123 "location": "query",
124 "type": "string"
125 } 125 }
126 }, 126 },
127 "protocol": "rest", 127 "protocol": "rest",
128 "resources": { 128 "resources": {
129 "spreadsheets": { 129 "spreadsheets": {
130 "methods": { 130 "methods": {
131 "get": {
132 "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.",
133 "httpMethod": "GET",
134 "id": "sheets.spreadsheets.get",
135 "parameterOrder": [
136 "spreadsheetId"
137 ],
138 "parameters": {
139 "includeGridData": {
140 "description": "True if grid data should be returned .\nThis parameter is ignored if a field mask was set in the request.",
141 "location": "query",
142 "type": "boolean"
143 },
144 "ranges": {
145 "description": "The ranges to retrieve from the spre adsheet.",
146 "location": "query",
147 "repeated": true,
148 "type": "string"
149 },
150 "spreadsheetId": {
151 "description": "The spreadsheet to request.",
152 "location": "path",
153 "required": true,
154 "type": "string"
155 }
156 },
157 "path": "v4/spreadsheets/{spreadsheetId}",
158 "response": {
159 "$ref": "Spreadsheet"
160 },
161 "scopes": [
162 "https://www.googleapis.com/auth/drive",
163 "https://www.googleapis.com/auth/drive.file",
164 "https://www.googleapis.com/auth/drive.readonly",
165 "https://www.googleapis.com/auth/spreadsheets",
166 "https://www.googleapis.com/auth/spreadsheets.readonly"
167 ]
168 },
131 "batchUpdate": { 169 "batchUpdate": {
132 "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.", 170 "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.",
133 "httpMethod": "POST", 171 "httpMethod": "POST",
134 "id": "sheets.spreadsheets.batchUpdate", 172 "id": "sheets.spreadsheets.batchUpdate",
135 "parameterOrder": [ 173 "parameterOrder": [
136 "spreadsheetId" 174 "spreadsheetId"
137 ], 175 ],
138 "parameters": { 176 "parameters": {
139 "spreadsheetId": { 177 "spreadsheetId": {
140 "description": "The spreadsheet to apply the updates to.", 178 "description": "The spreadsheet to apply the updates to.",
(...skipping 26 matching lines...) Expand all
167 "$ref": "Spreadsheet" 205 "$ref": "Spreadsheet"
168 }, 206 },
169 "response": { 207 "response": {
170 "$ref": "Spreadsheet" 208 "$ref": "Spreadsheet"
171 }, 209 },
172 "scopes": [ 210 "scopes": [
173 "https://www.googleapis.com/auth/drive", 211 "https://www.googleapis.com/auth/drive",
174 "https://www.googleapis.com/auth/drive.file", 212 "https://www.googleapis.com/auth/drive.file",
175 "https://www.googleapis.com/auth/spreadsheets" 213 "https://www.googleapis.com/auth/spreadsheets"
176 ] 214 ]
177 },
178 "get": {
179 "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.",
180 "httpMethod": "GET",
181 "id": "sheets.spreadsheets.get",
182 "parameterOrder": [
183 "spreadsheetId"
184 ],
185 "parameters": {
186 "includeGridData": {
187 "description": "True if grid data should be returned .\nThis parameter is ignored if a field mask was set in the request.",
188 "location": "query",
189 "type": "boolean"
190 },
191 "ranges": {
192 "description": "The ranges to retrieve from the spre adsheet.",
193 "location": "query",
194 "repeated": true,
195 "type": "string"
196 },
197 "spreadsheetId": {
198 "description": "The spreadsheet to request.",
199 "location": "path",
200 "required": true,
201 "type": "string"
202 }
203 },
204 "path": "v4/spreadsheets/{spreadsheetId}",
205 "response": {
206 "$ref": "Spreadsheet"
207 },
208 "scopes": [
209 "https://www.googleapis.com/auth/drive",
210 "https://www.googleapis.com/auth/drive.file",
211 "https://www.googleapis.com/auth/drive.readonly",
212 "https://www.googleapis.com/auth/spreadsheets",
213 "https://www.googleapis.com/auth/spreadsheets.readonly"
214 ]
215 } 215 }
216 }, 216 },
217 "resources": { 217 "resources": {
218 "sheets": {
219 "methods": {
220 "copyTo": {
221 "description": "Copies a single sheet from a spreads heet to another spreadsheet.\nReturns the properties of the newly created sheet. ",
222 "httpMethod": "POST",
223 "id": "sheets.spreadsheets.sheets.copyTo",
224 "parameterOrder": [
225 "spreadsheetId",
226 "sheetId"
227 ],
228 "parameters": {
229 "sheetId": {
230 "description": "The ID of the sheet to copy. ",
231 "format": "int32",
232 "location": "path",
233 "required": true,
234 "type": "integer"
235 },
236 "spreadsheetId": {
237 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
238 "location": "path",
239 "required": true,
240 "type": "string"
241 }
242 },
243 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo",
244 "request": {
245 "$ref": "CopySheetToAnotherSpreadsheetRequest"
246 },
247 "response": {
248 "$ref": "SheetProperties"
249 },
250 "scopes": [
251 "https://www.googleapis.com/auth/drive",
252 "https://www.googleapis.com/auth/drive.file",
253 "https://www.googleapis.com/auth/spreadsheets"
254 ]
255 }
256 }
257 },
258 "values": { 218 "values": {
259 "methods": { 219 "methods": {
260 "batchClear": { 220 "batchGet": {
261 "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.", 221 "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
262 "httpMethod": "POST", 222 "httpMethod": "GET",
263 "id": "sheets.spreadsheets.values.batchClear", 223 "id": "sheets.spreadsheets.values.batchGet",
264 "parameterOrder": [ 224 "parameterOrder": [
265 "spreadsheetId" 225 "spreadsheetId"
266 ], 226 ],
267 "parameters": { 227 "parameters": {
268 "spreadsheetId": { 228 "spreadsheetId": {
269 "description": "The ID of the spreadsheet to update.",
270 "location": "path",
271 "required": true,
272 "type": "string"
273 }
274 },
275 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hClear",
276 "request": {
277 "$ref": "BatchClearValuesRequest"
278 },
279 "response": {
280 "$ref": "BatchClearValuesResponse"
281 },
282 "scopes": [
283 "https://www.googleapis.com/auth/drive",
284 "https://www.googleapis.com/auth/drive.file",
285 "https://www.googleapis.com/auth/spreadsheets"
286 ]
287 },
288 "get": {
289 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.",
290 "httpMethod": "GET",
291 "id": "sheets.spreadsheets.values.get",
292 "parameterOrder": [
293 "spreadsheetId",
294 "range"
295 ],
296 "parameters": {
297 "majorDimension": {
298 "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]]`.",
299 "enum": [
300 "DIMENSION_UNSPECIFIED",
301 "ROWS",
302 "COLUMNS"
303 ],
304 "location": "query",
305 "type": "string"
306 },
307 "spreadsheetId": {
308 "description": "The ID of the spreadsheet to retrieve data from.", 229 "description": "The ID of the spreadsheet to retrieve data from.",
309 "location": "path", 230 "location": "path",
310 "required": true, 231 "required": true,
311 "type": "string" 232 "type": "string"
312 }, 233 },
313 "range": {
314 "description": "The A1 notation of the value s to retrieve.",
315 "location": "path",
316 "required": true,
317 "type": "string"
318 },
319 "dateTimeRenderOption": { 234 "dateTimeRenderOption": {
320 "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].", 235 "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].",
321 "enum": [ 236 "enum": [
322 "SERIAL_NUMBER", 237 "SERIAL_NUMBER",
323 "FORMATTED_STRING" 238 "FORMATTED_STRING"
324 ], 239 ],
325 "location": "query", 240 "location": "query",
326 "type": "string" 241 "type": "string"
327 }, 242 },
328 "valueRenderOption": { 243 "valueRenderOption": {
329 "description": "How values should be represe nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA LUE.", 244 "description": "How values should be represe nted in the output.\nThe default render option is ValueRenderOption.FORMATTED_VA LUE.",
330 "enum": [ 245 "enum": [
331 "FORMATTED_VALUE", 246 "FORMATTED_VALUE",
332 "UNFORMATTED_VALUE", 247 "UNFORMATTED_VALUE",
333 "FORMULA" 248 "FORMULA"
334 ], 249 ],
335 "location": "query", 250 "location": "query",
336 "type": "string" 251 "type": "string"
252 },
253 "majorDimension": {
254 "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]]`.",
255 "enum": [
256 "DIMENSION_UNSPECIFIED",
257 "ROWS",
258 "COLUMNS"
259 ],
260 "location": "query",
261 "type": "string"
262 },
263 "ranges": {
264 "description": "The A1 notation of the value s to retrieve.",
265 "location": "query",
266 "repeated": true,
267 "type": "string"
337 } 268 }
338 }, 269 },
339 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}", 270 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hGet",
340 "response": { 271 "response": {
341 "$ref": "ValueRange" 272 "$ref": "BatchGetValuesResponse"
342 }, 273 },
343 "scopes": [ 274 "scopes": [
344 "https://www.googleapis.com/auth/drive", 275 "https://www.googleapis.com/auth/drive",
345 "https://www.googleapis.com/auth/drive.file", 276 "https://www.googleapis.com/auth/drive.file",
346 "https://www.googleapis.com/auth/drive.readonly" , 277 "https://www.googleapis.com/auth/drive.readonly" ,
347 "https://www.googleapis.com/auth/spreadsheets", 278 "https://www.googleapis.com/auth/spreadsheets",
348 "https://www.googleapis.com/auth/spreadsheets.re adonly" 279 "https://www.googleapis.com/auth/spreadsheets.re adonly"
349 ] 280 ]
350 }, 281 },
351 "update": { 282 "clear": {
352 "description": "Sets values in a range of a spreadsh eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption .", 283 "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.",
353 "httpMethod": "PUT", 284 "httpMethod": "POST",
354 "id": "sheets.spreadsheets.values.update", 285 "id": "sheets.spreadsheets.values.clear",
355 "parameterOrder": [ 286 "parameterOrder": [
356 "spreadsheetId", 287 "spreadsheetId",
357 "range" 288 "range"
358 ], 289 ],
359 "parameters": { 290 "parameters": {
360 "includeValuesInResponse": {
361 "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).",
362 "location": "query",
363 "type": "boolean"
364 },
365 "range": { 291 "range": {
366 "description": "The A1 notation of the value s to update.", 292 "description": "The A1 notation of the value s to clear.",
367 "location": "path", 293 "location": "path",
368 "required": true, 294 "required": true,
369 "type": "string" 295 "type": "string"
370 }, 296 },
371 "spreadsheetId": { 297 "spreadsheetId": {
372 "description": "The ID of the spreadsheet to update.", 298 "description": "The ID of the spreadsheet to update.",
373 "location": "path", 299 "location": "path",
300 "required": true,
301 "type": "string"
302 }
303 },
304 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:clear",
305 "request": {
306 "$ref": "ClearValuesRequest"
307 },
308 "response": {
309 "$ref": "ClearValuesResponse"
310 },
311 "scopes": [
312 "https://www.googleapis.com/auth/drive",
313 "https://www.googleapis.com/auth/drive.file",
314 "https://www.googleapis.com/auth/spreadsheets"
315 ]
316 },
317 "append": {
318 "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/api/guides/values#append ing_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInpu tOption` only\ncontrols how the input data will be added to the sheet (column-wi se or\nrow-wise), it does not influence what cell the data starts being written\ nto.",
319 "httpMethod": "POST",
320 "id": "sheets.spreadsheets.values.append",
321 "parameterOrder": [
322 "spreadsheetId",
323 "range"
324 ],
325 "parameters": {
326 "spreadsheetId": {
327 "description": "The ID of the spreadsheet to update.",
328 "location": "path",
374 "required": true, 329 "required": true,
375 "type": "string" 330 "type": "string"
376 }, 331 },
377 "responseValueRenderOption": { 332 "responseValueRenderOption": {
378 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.", 333 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
379 "enum": [ 334 "enum": [
380 "FORMATTED_VALUE", 335 "FORMATTED_VALUE",
381 "UNFORMATTED_VALUE", 336 "UNFORMATTED_VALUE",
382 "FORMULA" 337 "FORMULA"
383 ], 338 ],
384 "location": "query", 339 "location": "query",
385 "type": "string" 340 "type": "string"
386 }, 341 },
342 "insertDataOption": {
343 "description": "How the input data should be inserted.",
344 "enum": [
345 "OVERWRITE",
346 "INSERT_ROWS"
347 ],
348 "location": "query",
349 "type": "string"
350 },
387 "valueInputOption": { 351 "valueInputOption": {
388 "description": "How the input data should be interpreted.", 352 "description": "How the input data should be interpreted.",
389 "enum": [ 353 "enum": [
390 "INPUT_VALUE_OPTION_UNSPECIFIED", 354 "INPUT_VALUE_OPTION_UNSPECIFIED",
391 "RAW", 355 "RAW",
392 "USER_ENTERED" 356 "USER_ENTERED"
393 ], 357 ],
394 "location": "query", 358 "location": "query",
395 "type": "string" 359 "type": "string"
396 }, 360 },
397 "responseDateTimeRenderOption": { 361 "responseDateTimeRenderOption": {
398 "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].", 362 "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].",
399 "enum": [ 363 "enum": [
400 "SERIAL_NUMBER", 364 "SERIAL_NUMBER",
401 "FORMATTED_STRING" 365 "FORMATTED_STRING"
402 ], 366 ],
403 "location": "query", 367 "location": "query",
404 "type": "string" 368 "type": "string"
369 },
370 "includeValuesInResponse": {
371 "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.",
372 "location": "query",
373 "type": "boolean"
374 },
375 "range": {
376 "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.",
377 "location": "path",
378 "required": true,
379 "type": "string"
405 } 380 }
406 }, 381 },
407 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}", 382 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:append",
408 "request": { 383 "request": {
409 "$ref": "ValueRange" 384 "$ref": "ValueRange"
410 }, 385 },
411 "response": { 386 "response": {
412 "$ref": "UpdateValuesResponse" 387 "$ref": "AppendValuesResponse"
413 }, 388 },
414 "scopes": [ 389 "scopes": [
415 "https://www.googleapis.com/auth/drive", 390 "https://www.googleapis.com/auth/drive",
416 "https://www.googleapis.com/auth/drive.file", 391 "https://www.googleapis.com/auth/drive.file",
417 "https://www.googleapis.com/auth/spreadsheets" 392 "https://www.googleapis.com/auth/spreadsheets"
418 ] 393 ]
419 }, 394 },
420 "batchUpdate": { 395 "batchClear": {
421 "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.", 396 "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.",
422 "httpMethod": "POST", 397 "httpMethod": "POST",
423 "id": "sheets.spreadsheets.values.batchUpdate", 398 "id": "sheets.spreadsheets.values.batchClear",
424 "parameterOrder": [ 399 "parameterOrder": [
425 "spreadsheetId" 400 "spreadsheetId"
426 ], 401 ],
427 "parameters": { 402 "parameters": {
428 "spreadsheetId": { 403 "spreadsheetId": {
429 "description": "The ID of the spreadsheet to update.", 404 "description": "The ID of the spreadsheet to update.",
430 "location": "path", 405 "location": "path",
431 "required": true, 406 "required": true,
432 "type": "string" 407 "type": "string"
433 } 408 }
434 }, 409 },
435 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hUpdate", 410 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hClear",
436 "request": { 411 "request": {
437 "$ref": "BatchUpdateValuesRequest" 412 "$ref": "BatchClearValuesRequest"
438 }, 413 },
439 "response": { 414 "response": {
440 "$ref": "BatchUpdateValuesResponse" 415 "$ref": "BatchClearValuesResponse"
441 }, 416 },
442 "scopes": [ 417 "scopes": [
443 "https://www.googleapis.com/auth/drive", 418 "https://www.googleapis.com/auth/drive",
444 "https://www.googleapis.com/auth/drive.file", 419 "https://www.googleapis.com/auth/drive.file",
445 "https://www.googleapis.com/auth/spreadsheets" 420 "https://www.googleapis.com/auth/spreadsheets"
446 ] 421 ]
447 }, 422 },
448 "clear": { 423 "get": {
449 "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.", 424 "description": "Returns a range of values from a spr eadsheet.\nThe caller must specify the spreadsheet ID and a range.",
450 "httpMethod": "POST", 425 "httpMethod": "GET",
451 "id": "sheets.spreadsheets.values.clear", 426 "id": "sheets.spreadsheets.values.get",
452 "parameterOrder": [ 427 "parameterOrder": [
453 "spreadsheetId", 428 "spreadsheetId",
454 "range" 429 "range"
455 ], 430 ],
456 "parameters": { 431 "parameters": {
457 "spreadsheetId": { 432 "range": {
458 "description": "The ID of the spreadsheet to update.", 433 "description": "The A1 notation of the value s to retrieve.",
459 "location": "path", 434 "location": "path",
460 "required": true, 435 "required": true,
461 "type": "string" 436 "type": "string"
462 },
463 "range": {
464 "description": "The A1 notation of the value s to clear.",
465 "location": "path",
466 "required": true,
467 "type": "string"
468 }
469 },
470 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:clear",
471 "request": {
472 "$ref": "ClearValuesRequest"
473 },
474 "response": {
475 "$ref": "ClearValuesResponse"
476 },
477 "scopes": [
478 "https://www.googleapis.com/auth/drive",
479 "https://www.googleapis.com/auth/drive.file",
480 "https://www.googleapis.com/auth/spreadsheets"
481 ]
482 },
483 "batchGet": {
484 "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
485 "httpMethod": "GET",
486 "id": "sheets.spreadsheets.values.batchGet",
487 "parameterOrder": [
488 "spreadsheetId"
489 ],
490 "parameters": {
491 "spreadsheetId": {
492 "description": "The ID of the spreadsheet to retrieve data from.",
493 "location": "path",
494 "required": true,
495 "type": "string"
496 }, 437 },
497 "dateTimeRenderOption": { 438 "dateTimeRenderOption": {
498 "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].", 439 "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].",
499 "enum": [ 440 "enum": [
500 "SERIAL_NUMBER", 441 "SERIAL_NUMBER",
501 "FORMATTED_STRING" 442 "FORMATTED_STRING"
502 ], 443 ],
503 "location": "query", 444 "location": "query",
504 "type": "string" 445 "type": "string"
505 }, 446 },
(...skipping 10 matching lines...) Expand all
516 "majorDimension": { 457 "majorDimension": {
517 "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]]`.", 458 "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]]`.",
518 "enum": [ 459 "enum": [
519 "DIMENSION_UNSPECIFIED", 460 "DIMENSION_UNSPECIFIED",
520 "ROWS", 461 "ROWS",
521 "COLUMNS" 462 "COLUMNS"
522 ], 463 ],
523 "location": "query", 464 "location": "query",
524 "type": "string" 465 "type": "string"
525 }, 466 },
526 "ranges": { 467 "spreadsheetId": {
527 "description": "The A1 notation of the value s to retrieve.", 468 "description": "The ID of the spreadsheet to retrieve data from.",
528 "location": "query", 469 "location": "path",
529 "repeated": true, 470 "required": true,
530 "type": "string" 471 "type": "string"
531 } 472 }
532 }, 473 },
533 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hGet", 474 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}",
534 "response": { 475 "response": {
535 "$ref": "BatchGetValuesResponse" 476 "$ref": "ValueRange"
536 }, 477 },
537 "scopes": [ 478 "scopes": [
538 "https://www.googleapis.com/auth/drive", 479 "https://www.googleapis.com/auth/drive",
539 "https://www.googleapis.com/auth/drive.file", 480 "https://www.googleapis.com/auth/drive.file",
540 "https://www.googleapis.com/auth/drive.readonly" , 481 "https://www.googleapis.com/auth/drive.readonly" ,
541 "https://www.googleapis.com/auth/spreadsheets", 482 "https://www.googleapis.com/auth/spreadsheets",
542 "https://www.googleapis.com/auth/spreadsheets.re adonly" 483 "https://www.googleapis.com/auth/spreadsheets.re adonly"
543 ] 484 ]
544 }, 485 },
545 "append": { 486 "update": {
546 "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/api/guides/values#append ing_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInpu tOption` only\ncontrols how the input data will be added to the sheet (column-wi se or\nrow-wise), it does not influence what cell the data starts being written\ nto.", 487 "description": "Sets values in a range of a spreadsh eet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption .",
547 "httpMethod": "POST", 488 "httpMethod": "PUT",
548 "id": "sheets.spreadsheets.values.append", 489 "id": "sheets.spreadsheets.values.update",
549 "parameterOrder": [ 490 "parameterOrder": [
550 "spreadsheetId", 491 "spreadsheetId",
551 "range" 492 "range"
552 ], 493 ],
553 "parameters": { 494 "parameters": {
554 "responseDateTimeRenderOption": {
555 "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].",
556 "enum": [
557 "SERIAL_NUMBER",
558 "FORMATTED_STRING"
559 ],
560 "location": "query",
561 "type": "string"
562 },
563 "includeValuesInResponse": {
564 "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.",
565 "location": "query",
566 "type": "boolean"
567 },
568 "range": {
569 "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.",
570 "location": "path",
571 "required": true,
572 "type": "string"
573 },
574 "spreadsheetId": { 495 "spreadsheetId": {
575 "description": "The ID of the spreadsheet to update.", 496 "description": "The ID of the spreadsheet to update.",
576 "location": "path", 497 "location": "path",
577 "required": true, 498 "required": true,
578 "type": "string" 499 "type": "string"
579 }, 500 },
580 "responseValueRenderOption": { 501 "responseValueRenderOption": {
581 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.", 502 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FO RMATTED_VALUE.",
582 "enum": [ 503 "enum": [
583 "FORMATTED_VALUE", 504 "FORMATTED_VALUE",
584 "UNFORMATTED_VALUE", 505 "UNFORMATTED_VALUE",
585 "FORMULA" 506 "FORMULA"
586 ], 507 ],
587 "location": "query", 508 "location": "query",
588 "type": "string" 509 "type": "string"
589 }, 510 },
590 "insertDataOption": {
591 "description": "How the input data should be inserted.",
592 "enum": [
593 "OVERWRITE",
594 "INSERT_ROWS"
595 ],
596 "location": "query",
597 "type": "string"
598 },
599 "valueInputOption": { 511 "valueInputOption": {
600 "description": "How the input data should be interpreted.", 512 "description": "How the input data should be interpreted.",
601 "enum": [ 513 "enum": [
602 "INPUT_VALUE_OPTION_UNSPECIFIED", 514 "INPUT_VALUE_OPTION_UNSPECIFIED",
603 "RAW", 515 "RAW",
604 "USER_ENTERED" 516 "USER_ENTERED"
605 ], 517 ],
606 "location": "query", 518 "location": "query",
607 "type": "string" 519 "type": "string"
520 },
521 "responseDateTimeRenderOption": {
522 "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].",
523 "enum": [
524 "SERIAL_NUMBER",
525 "FORMATTED_STRING"
526 ],
527 "location": "query",
528 "type": "string"
529 },
530 "includeValuesInResponse": {
531 "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).",
532 "location": "query",
533 "type": "boolean"
534 },
535 "range": {
536 "description": "The A1 notation of the value s to update.",
537 "location": "path",
538 "required": true,
539 "type": "string"
608 } 540 }
609 }, 541 },
610 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}:append", 542 "path": "v4/spreadsheets/{spreadsheetId}/values/{ran ge}",
611 "request": { 543 "request": {
612 "$ref": "ValueRange" 544 "$ref": "ValueRange"
613 }, 545 },
614 "response": { 546 "response": {
615 "$ref": "AppendValuesResponse" 547 "$ref": "UpdateValuesResponse"
616 }, 548 },
617 "scopes": [ 549 "scopes": [
618 "https://www.googleapis.com/auth/drive", 550 "https://www.googleapis.com/auth/drive",
551 "https://www.googleapis.com/auth/drive.file",
552 "https://www.googleapis.com/auth/spreadsheets"
553 ]
554 },
555 "batchUpdate": {
556 "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.",
557 "httpMethod": "POST",
558 "id": "sheets.spreadsheets.values.batchUpdate",
559 "parameterOrder": [
560 "spreadsheetId"
561 ],
562 "parameters": {
563 "spreadsheetId": {
564 "description": "The ID of the spreadsheet to update.",
565 "location": "path",
566 "required": true,
567 "type": "string"
568 }
569 },
570 "path": "v4/spreadsheets/{spreadsheetId}/values:batc hUpdate",
571 "request": {
572 "$ref": "BatchUpdateValuesRequest"
573 },
574 "response": {
575 "$ref": "BatchUpdateValuesResponse"
576 },
577 "scopes": [
578 "https://www.googleapis.com/auth/drive",
579 "https://www.googleapis.com/auth/drive.file",
580 "https://www.googleapis.com/auth/spreadsheets"
581 ]
582 }
583 }
584 },
585 "sheets": {
586 "methods": {
587 "copyTo": {
588 "description": "Copies a single sheet from a spreads heet to another spreadsheet.\nReturns the properties of the newly created sheet. ",
589 "httpMethod": "POST",
590 "id": "sheets.spreadsheets.sheets.copyTo",
591 "parameterOrder": [
592 "spreadsheetId",
593 "sheetId"
594 ],
595 "parameters": {
596 "spreadsheetId": {
597 "description": "The ID of the spreadsheet co ntaining the sheet to copy.",
598 "location": "path",
599 "required": true,
600 "type": "string"
601 },
602 "sheetId": {
603 "description": "The ID of the sheet to copy. ",
604 "format": "int32",
605 "location": "path",
606 "required": true,
607 "type": "integer"
608 }
609 },
610 "path": "v4/spreadsheets/{spreadsheetId}/sheets/{she etId}:copyTo",
611 "request": {
612 "$ref": "CopySheetToAnotherSpreadsheetRequest"
613 },
614 "response": {
615 "$ref": "SheetProperties"
616 },
617 "scopes": [
618 "https://www.googleapis.com/auth/drive",
619 "https://www.googleapis.com/auth/drive.file", 619 "https://www.googleapis.com/auth/drive.file",
620 "https://www.googleapis.com/auth/spreadsheets" 620 "https://www.googleapis.com/auth/spreadsheets"
621 ] 621 ]
622 } 622 }
623 } 623 }
624 } 624 }
625 } 625 }
626 } 626 }
627 }, 627 },
628 "revision": "20170630", 628 "revision": "20170720",
629 "rootUrl": "https://sheets.googleapis.com/", 629 "rootUrl": "https://sheets.googleapis.com/",
630 "schemas": { 630 "schemas": {
631 "UpdateEmbeddedObjectPositionRequest": {
632 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).",
633 "id": "UpdateEmbeddedObjectPositionRequest",
634 "properties": {
635 "objectId": {
636 "description": "The ID of the object to moved.",
637 "format": "int32",
638 "type": "integer"
639 },
640 "newPosition": {
641 "$ref": "EmbeddedObjectPosition",
642 "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."
643 },
644 "fields": {
645 "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.",
646 "format": "google-fieldmask",
647 "type": "string"
648 }
649 },
650 "type": "object"
651 },
652 "TextRotation": {
653 "description": "The rotation applied to text in a cell.",
654 "id": "TextRotation",
655 "properties": {
656 "vertical": {
657 "description": "If true, text reads top to bottom, but the o rientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
658 "type": "boolean"
659 },
660 "angle": {
661 "description": "The angle between the standard orientation a nd the desired orientation.\nMeasured in degrees. Valid values are between -90 a nd 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNo te: For LTR text direction positive angles are in the counterclockwise\ndirectio n, whereas for RTL they are in the clockwise direction",
662 "format": "int32",
663 "type": "integer"
664 }
665 },
666 "type": "object"
667 },
668 "PieChartSpec": {
669 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart \">pie chart</a>.",
670 "id": "PieChartSpec",
671 "properties": {
672 "threeDimensional": {
673 "description": "True if the pie is three dimensional.",
674 "type": "boolean"
675 },
676 "domain": {
677 "$ref": "ChartData",
678 "description": "The data that covers the domain of the pie c hart."
679 },
680 "series": {
681 "$ref": "ChartData",
682 "description": "The data that covers the one and only series of the pie chart."
683 },
684 "pieHole": {
685 "description": "The size of the hole in the pie chart.",
686 "format": "double",
687 "type": "number"
688 },
689 "legendPosition": {
690 "description": "Where the legend of the pie chart should be drawn.",
691 "enum": [
692 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
693 "BOTTOM_LEGEND",
694 "LEFT_LEGEND",
695 "RIGHT_LEGEND",
696 "TOP_LEGEND",
697 "NO_LEGEND",
698 "LABELED_LEGEND"
699 ],
700 "enumDescriptions": [
701 "Default value, do not use.",
702 "The legend is rendered on the bottom of the chart.",
703 "The legend is rendered on the left of the chart.",
704 "The legend is rendered on the right of the chart.",
705 "The legend is rendered on the top of the chart.",
706 "No legend is rendered.",
707 "Each pie slice has a label attached to it."
708 ],
709 "type": "string"
710 }
711 },
712 "type": "object"
713 },
714 "UpdateFilterViewRequest": {
715 "description": "Updates properties of the filter view.",
716 "id": "UpdateFilterViewRequest",
717 "properties": {
718 "filter": {
719 "$ref": "FilterView",
720 "description": "The new properties of the filter view."
721 },
722 "fields": {
723 "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.",
724 "format": "google-fieldmask",
725 "type": "string"
726 }
727 },
728 "type": "object"
729 },
730 "ConditionalFormatRule": {
731 "description": "A rule describing a conditional format.",
732 "id": "ConditionalFormatRule",
733 "properties": {
734 "ranges": {
735 "description": "The ranges that will be formatted if the con dition is true.\nAll the ranges must be on the same grid.",
736 "items": {
737 "$ref": "GridRange"
738 },
739 "type": "array"
740 },
741 "gradientRule": {
742 "$ref": "GradientRule",
743 "description": "The formatting will vary based on the gradie nts in the rule."
744 },
745 "booleanRule": {
746 "$ref": "BooleanRule",
747 "description": "The formatting is either \"on\" or \"off\" a ccording to the rule."
748 }
749 },
750 "type": "object"
751 },
752 "CopyPasteRequest": {
753 "description": "Copies data from the source to the destination.",
754 "id": "CopyPasteRequest",
755 "properties": {
756 "destination": {
757 "$ref": "GridRange",
758 "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)."
759 },
760 "pasteOrientation": {
761 "description": "How that data should be oriented when pastin g.",
762 "enum": [
763 "NORMAL",
764 "TRANSPOSE"
765 ],
766 "enumDescriptions": [
767 "Paste normally.",
768 "Paste transposed, where all rows become columns and vic e versa."
769 ],
770 "type": "string"
771 },
772 "pasteType": {
773 "description": "What kind of data to paste.",
774 "enum": [
775 "PASTE_NORMAL",
776 "PASTE_VALUES",
777 "PASTE_FORMAT",
778 "PASTE_NO_BORDERS",
779 "PASTE_FORMULA",
780 "PASTE_DATA_VALIDATION",
781 "PASTE_CONDITIONAL_FORMATTING"
782 ],
783 "enumDescriptions": [
784 "Paste values, formulas, formats, and merges.",
785 "Paste the values ONLY without formats, formulas, or mer ges.",
786 "Paste the format and data validation only.",
787 "Like PASTE_NORMAL but without borders.",
788 "Paste the formulas only.",
789 "Paste the data validation only.",
790 "Paste the conditional formatting rules only."
791 ],
792 "type": "string"
793 },
794 "source": {
795 "$ref": "GridRange",
796 "description": "The source range to copy."
797 }
798 },
799 "type": "object"
800 },
801 "BooleanCondition": {
802 "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.",
803 "id": "BooleanCondition",
804 "properties": {
805 "values": {
806 "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.",
807 "items": {
808 "$ref": "ConditionValue"
809 },
810 "type": "array"
811 },
812 "type": {
813 "description": "The type of condition.",
814 "enum": [
815 "CONDITION_TYPE_UNSPECIFIED",
816 "NUMBER_GREATER",
817 "NUMBER_GREATER_THAN_EQ",
818 "NUMBER_LESS",
819 "NUMBER_LESS_THAN_EQ",
820 "NUMBER_EQ",
821 "NUMBER_NOT_EQ",
822 "NUMBER_BETWEEN",
823 "NUMBER_NOT_BETWEEN",
824 "TEXT_CONTAINS",
825 "TEXT_NOT_CONTAINS",
826 "TEXT_STARTS_WITH",
827 "TEXT_ENDS_WITH",
828 "TEXT_EQ",
829 "TEXT_IS_EMAIL",
830 "TEXT_IS_URL",
831 "DATE_EQ",
832 "DATE_BEFORE",
833 "DATE_AFTER",
834 "DATE_ON_OR_BEFORE",
835 "DATE_ON_OR_AFTER",
836 "DATE_BETWEEN",
837 "DATE_NOT_BETWEEN",
838 "DATE_IS_VALID",
839 "ONE_OF_RANGE",
840 "ONE_OF_LIST",
841 "BLANK",
842 "NOT_BLANK",
843 "CUSTOM_FORMULA"
844 ],
845 "enumDescriptions": [
846 "The default value, do not use.",
847 "The cell's value must be greater than the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
848 "The cell's value must be greater than or equal to the c ondition's value.\nSupported by data validation, conditional formatting and filt ers.\nRequires a single ConditionValue.",
849 "The cell's value must be less than the condition's valu e.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
850 "The cell's value must be less than or equal to the cond ition's value.\nSupported by data validation, conditional formatting and filters .\nRequires a single ConditionValue.",
851 "The cell's value must be equal to the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
852 "The cell's value must be not equal to the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
853 "The cell's value must be between the two condition valu es.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
854 "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequ ires exactly two ConditionValues.",
855 "The cell's value must contain the condition's value.\nS upported by data validation, conditional formatting and filters.\nRequires a sin gle ConditionValue.",
856 "The cell's value must not contain the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
857 "The cell's value must start with the condition's value. \nSupported by conditional formatting and filters.\nRequires a single ConditionV alue.",
858 "The cell's value must end with the condition's value.\n Supported by conditional formatting and filters.\nRequires a single ConditionVal ue.",
859 "The cell's value must be exactly the condition's value. \nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
860 "The cell's value must be a valid email address.\nSuppor ted by data validation.\nRequires no ConditionValues.",
861 "The cell's value must be a valid URL.\nSupported by dat a validation.\nRequires no ConditionValues.",
862 "The cell's value must be the same date as the condition 's value.\nSupported by data validation, conditional formatting and filters.\nRe quires a single ConditionValue.",
863 "The cell's value must be before the date of the conditi on's value.\nSupported by data validation, conditional formatting and filters.\n Requires a single ConditionValue\nthat may be a relative date.",
864 "The cell's value must be after the date of the conditio n's value.\nSupported by data validation, conditional formatting and filters.\nR equires a single ConditionValue\nthat may be a relative date.",
865 "The cell's value must be on or before the date of the c ondition's value.\nSupported by data validation.\nRequires a single ConditionVal ue\nthat may be a relative date.",
866 "The cell's value must be on or after the date of the co ndition's value.\nSupported by data validation.\nRequires a single ConditionValu e\nthat may be a relative date.",
867 "The cell's value must be between the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
868 "The cell's value must be outside the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
869 "The cell's value must be a date.\nSupported by data val idation.\nRequires no ConditionValues.",
870 "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.",
871 "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.",
872 "The cell's value must be empty.\nSupported by condition al formatting and filters.\nRequires no ConditionValues.",
873 "The cell's value must not be empty.\nSupported by condi tional formatting and filters.\nRequires no ConditionValues.",
874 "The condition's formula must evaluate to true.\nSupport ed by data validation, conditional formatting and filters.\nRequires a single Co nditionValue."
875 ],
876 "type": "string"
877 }
878 },
879 "type": "object"
880 },
881 "Request": {
882 "description": "A single kind of update to apply to a spreadsheet.",
883 "id": "Request",
884 "properties": {
885 "deleteEmbeddedObject": {
886 "$ref": "DeleteEmbeddedObjectRequest",
887 "description": "Deletes an embedded object (e.g, chart, imag e) in a sheet."
888 },
889 "updateFilterView": {
890 "$ref": "UpdateFilterViewRequest",
891 "description": "Updates the properties of a filter view."
892 },
893 "addBanding": {
894 "$ref": "AddBandingRequest",
895 "description": "Adds a new banded range"
896 },
897 "autoResizeDimensions": {
898 "$ref": "AutoResizeDimensionsRequest",
899 "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
900 },
901 "appendCells": {
902 "$ref": "AppendCellsRequest",
903 "description": "Appends cells after the last row with data i n a sheet."
904 },
905 "cutPaste": {
906 "$ref": "CutPasteRequest",
907 "description": "Cuts data from one area and pastes it to ano ther."
908 },
909 "mergeCells": {
910 "$ref": "MergeCellsRequest",
911 "description": "Merges cells together."
912 },
913 "updateNamedRange": {
914 "$ref": "UpdateNamedRangeRequest",
915 "description": "Updates a named range."
916 },
917 "updateSheetProperties": {
918 "$ref": "UpdateSheetPropertiesRequest",
919 "description": "Updates a sheet's properties."
920 },
921 "autoFill": {
922 "$ref": "AutoFillRequest",
923 "description": "Automatically fills in more data based on ex isting data."
924 },
925 "deleteDimension": {
926 "$ref": "DeleteDimensionRequest",
927 "description": "Deletes rows or columns in a sheet."
928 },
929 "sortRange": {
930 "$ref": "SortRangeRequest",
931 "description": "Sorts data in a range."
932 },
933 "deleteProtectedRange": {
934 "$ref": "DeleteProtectedRangeRequest",
935 "description": "Deletes a protected range."
936 },
937 "duplicateFilterView": {
938 "$ref": "DuplicateFilterViewRequest",
939 "description": "Duplicates a filter view."
940 },
941 "addChart": {
942 "$ref": "AddChartRequest",
943 "description": "Adds a chart."
944 },
945 "findReplace": {
946 "$ref": "FindReplaceRequest",
947 "description": "Finds and replaces occurrences of some text with other text."
948 },
949 "textToColumns": {
950 "$ref": "TextToColumnsRequest",
951 "description": "Converts a column of text into many columns of text."
952 },
953 "updateChartSpec": {
954 "$ref": "UpdateChartSpecRequest",
955 "description": "Updates a chart's specifications."
956 },
957 "updateProtectedRange": {
958 "$ref": "UpdateProtectedRangeRequest",
959 "description": "Updates a protected range."
960 },
961 "addSheet": {
962 "$ref": "AddSheetRequest",
963 "description": "Adds a sheet."
964 },
965 "copyPaste": {
966 "$ref": "CopyPasteRequest",
967 "description": "Copies data from one area and pastes it to a nother."
968 },
969 "deleteFilterView": {
970 "$ref": "DeleteFilterViewRequest",
971 "description": "Deletes a filter view from a sheet."
972 },
973 "insertDimension": {
974 "$ref": "InsertDimensionRequest",
975 "description": "Inserts new rows or columns in a sheet."
976 },
977 "deleteRange": {
978 "$ref": "DeleteRangeRequest",
979 "description": "Deletes a range of cells from a sheet, shift ing the remaining cells."
980 },
981 "deleteBanding": {
982 "$ref": "DeleteBandingRequest",
983 "description": "Removes a banded range"
984 },
985 "addFilterView": {
986 "$ref": "AddFilterViewRequest",
987 "description": "Adds a filter view."
988 },
989 "updateBorders": {
990 "$ref": "UpdateBordersRequest",
991 "description": "Updates the borders in a range of cells."
992 },
993 "setDataValidation": {
994 "$ref": "SetDataValidationRequest",
995 "description": "Sets data validation for one or more cells."
996 },
997 "deleteConditionalFormatRule": {
998 "$ref": "DeleteConditionalFormatRuleRequest",
999 "description": "Deletes an existing conditional format rule. "
1000 },
1001 "repeatCell": {
1002 "$ref": "RepeatCellRequest",
1003 "description": "Repeats a single cell across a range."
1004 },
1005 "clearBasicFilter": {
1006 "$ref": "ClearBasicFilterRequest",
1007 "description": "Clears the basic filter on a sheet."
1008 },
1009 "appendDimension": {
1010 "$ref": "AppendDimensionRequest",
1011 "description": "Appends dimensions to the end of a sheet."
1012 },
1013 "updateConditionalFormatRule": {
1014 "$ref": "UpdateConditionalFormatRuleRequest",
1015 "description": "Updates an existing conditional format rule. "
1016 },
1017 "insertRange": {
1018 "$ref": "InsertRangeRequest",
1019 "description": "Inserts new cells in a sheet, shifting the e xisting cells."
1020 },
1021 "moveDimension": {
1022 "$ref": "MoveDimensionRequest",
1023 "description": "Moves rows or columns to another location in a sheet."
1024 },
1025 "randomizeRange": {
1026 "$ref": "RandomizeRangeRequest",
1027 "description": "Randomizes the order of the rows in a range. "
1028 },
1029 "updateBanding": {
1030 "$ref": "UpdateBandingRequest",
1031 "description": "Updates a banded range"
1032 },
1033 "deleteNamedRange": {
1034 "$ref": "DeleteNamedRangeRequest",
1035 "description": "Deletes a named range."
1036 },
1037 "addProtectedRange": {
1038 "$ref": "AddProtectedRangeRequest",
1039 "description": "Adds a protected range."
1040 },
1041 "duplicateSheet": {
1042 "$ref": "DuplicateSheetRequest",
1043 "description": "Duplicates a sheet."
1044 },
1045 "deleteSheet": {
1046 "$ref": "DeleteSheetRequest",
1047 "description": "Deletes a sheet."
1048 },
1049 "unmergeCells": {
1050 "$ref": "UnmergeCellsRequest",
1051 "description": "Unmerges merged cells."
1052 },
1053 "updateEmbeddedObjectPosition": {
1054 "$ref": "UpdateEmbeddedObjectPositionRequest",
1055 "description": "Updates an embedded object's (e.g. chart, im age) position."
1056 },
1057 "updateDimensionProperties": {
1058 "$ref": "UpdateDimensionPropertiesRequest",
1059 "description": "Updates dimensions' properties."
1060 },
1061 "pasteData": {
1062 "$ref": "PasteDataRequest",
1063 "description": "Pastes data (HTML or delimited) into a sheet ."
1064 },
1065 "setBasicFilter": {
1066 "$ref": "SetBasicFilterRequest",
1067 "description": "Sets the basic filter on a sheet."
1068 },
1069 "addConditionalFormatRule": {
1070 "$ref": "AddConditionalFormatRuleRequest",
1071 "description": "Adds a new conditional format rule."
1072 },
1073 "addNamedRange": {
1074 "$ref": "AddNamedRangeRequest",
1075 "description": "Adds a named range."
1076 },
1077 "updateCells": {
1078 "$ref": "UpdateCellsRequest",
1079 "description": "Updates many cells at once."
1080 },
1081 "updateSpreadsheetProperties": {
1082 "$ref": "UpdateSpreadsheetPropertiesRequest",
1083 "description": "Updates the spreadsheet's properties."
1084 }
1085 },
1086 "type": "object"
1087 },
1088 "GridRange": {
1089 "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!`.",
1090 "id": "GridRange",
1091 "properties": {
1092 "sheetId": {
1093 "description": "The sheet this range is on.",
1094 "format": "int32",
1095 "type": "integer"
1096 },
1097 "endColumnIndex": {
1098 "description": "The end column (exclusive) of the range, or not set if unbounded.",
1099 "format": "int32",
1100 "type": "integer"
1101 },
1102 "endRowIndex": {
1103 "description": "The end row (exclusive) of the range, or not set if unbounded.",
1104 "format": "int32",
1105 "type": "integer"
1106 },
1107 "startRowIndex": {
1108 "description": "The start row (inclusive) of the range, or n ot set if unbounded.",
1109 "format": "int32",
1110 "type": "integer"
1111 },
1112 "startColumnIndex": {
1113 "description": "The start column (inclusive) of the range, o r not set if unbounded.",
1114 "format": "int32",
1115 "type": "integer"
1116 }
1117 },
1118 "type": "object"
1119 },
1120 "BasicChartSpec": {
1121 "description": "The specification for a basic chart. See BasicChart Type for the list\nof charts this supports.",
1122 "id": "BasicChartSpec",
1123 "properties": {
1124 "domains": {
1125 "description": "The domain of data this is charting.\nOnly a single domain is supported.",
1126 "items": {
1127 "$ref": "BasicChartDomain"
1128 },
1129 "type": "array"
1130 },
1131 "lineSmoothing": {
1132 "description": "Gets whether all lines should be rendered sm ooth or straight by default.\nApplies to Line charts.",
1133 "type": "boolean"
1134 },
1135 "headerCount": {
1136 "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.)",
1137 "format": "int32",
1138 "type": "integer"
1139 },
1140 "stackedType": {
1141 "description": "The stacked type for charts that support ver tical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.",
1142 "enum": [
1143 "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
1144 "NOT_STACKED",
1145 "STACKED",
1146 "PERCENT_STACKED"
1147 ],
1148 "enumDescriptions": [
1149 "Default value, do not use.",
1150 "Series are not stacked.",
1151 "Series values are stacked, each value is rendered verti cally beginning\nfrom the top of the value below it.",
1152 "Vertical stacks are stretched to reach the top of the c hart, with\nvalues laid out as percentages of each other."
1153 ],
1154 "type": "string"
1155 },
1156 "axis": {
1157 "description": "The axis on the chart.",
1158 "items": {
1159 "$ref": "BasicChartAxis"
1160 },
1161 "type": "array"
1162 },
1163 "threeDimensional": {
1164 "description": "True to make the chart 3D.\nApplies to Bar a nd Column charts.",
1165 "type": "boolean"
1166 },
1167 "interpolateNulls": {
1168 "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missin g). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Comb o charts.",
1169 "type": "boolean"
1170 },
1171 "chartType": {
1172 "description": "The type of the chart.",
1173 "enum": [
1174 "BASIC_CHART_TYPE_UNSPECIFIED",
1175 "BAR",
1176 "LINE",
1177 "AREA",
1178 "COLUMN",
1179 "SCATTER",
1180 "COMBO",
1181 "STEPPED_AREA"
1182 ],
1183 "enumDescriptions": [
1184 "Default value, do not use.",
1185 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
1186 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
1187 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
1188 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
1189 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
1190 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>.",
1191 "A <a href=\"/chart/interactive/docs/gallery/steppedarea chart\">stepped area chart</a>."
1192 ],
1193 "type": "string"
1194 },
1195 "series": {
1196 "description": "The data this chart is visualizing.",
1197 "items": {
1198 "$ref": "BasicChartSeries"
1199 },
1200 "type": "array"
1201 },
1202 "legendPosition": {
1203 "description": "The position of the chart legend.",
1204 "enum": [
1205 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
1206 "BOTTOM_LEGEND",
1207 "LEFT_LEGEND",
1208 "RIGHT_LEGEND",
1209 "TOP_LEGEND",
1210 "NO_LEGEND"
1211 ],
1212 "enumDescriptions": [
1213 "Default value, do not use.",
1214 "The legend is rendered on the bottom of the chart.",
1215 "The legend is rendered on the left of the chart.",
1216 "The legend is rendered on the right of the chart.",
1217 "The legend is rendered on the top of the chart.",
1218 "No legend is rendered."
1219 ],
1220 "type": "string"
1221 }
1222 },
1223 "type": "object"
1224 },
1225 "SetDataValidationRequest": {
1226 "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.",
1227 "id": "SetDataValidationRequest",
1228 "properties": {
1229 "rule": {
1230 "$ref": "DataValidationRule",
1231 "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
1232 },
1233 "range": {
1234 "$ref": "GridRange",
1235 "description": "The range the data validation rule should ap ply to."
1236 }
1237 },
1238 "type": "object"
1239 },
1240 "BubbleChartSpec": {
1241 "description": "A <a href=\"/chart/interactive/docs/gallery/bubblech art\">bubble chart</a>.",
1242 "id": "BubbleChartSpec",
1243 "properties": {
1244 "bubbleTextStyle": {
1245 "$ref": "TextFormat",
1246 "description": "The format of the text inside the bubbles.\n Underline and Strikethrough are not supported."
1247 },
1248 "bubbleBorderColor": {
1249 "$ref": "Color",
1250 "description": "The bubble border color."
1251 },
1252 "groupIds": {
1253 "$ref": "ChartData",
1254 "description": "The data containing the bubble group IDs. Al l bubbles with the same group\nID will be drawn in the same color. If bubble_siz es is specified then\nthis field must also be specified but may contain blank va lues.\nThis field is optional."
1255 },
1256 "bubbleLabels": {
1257 "$ref": "ChartData",
1258 "description": "The data containing the bubble labels. Thes e do not need to be unique."
1259 },
1260 "bubbleMinRadiusSize": {
1261 "description": "The minimum radius size of the bubbles, in p ixels.\nIf specific, the field must be a positive value.",
1262 "format": "int32",
1263 "type": "integer"
1264 },
1265 "bubbleMaxRadiusSize": {
1266 "description": "The max radius size of the bubbles, in pixel s.\nIf specified, the field must be a positive value.",
1267 "format": "int32",
1268 "type": "integer"
1269 },
1270 "series": {
1271 "$ref": "ChartData",
1272 "description": "The data contianing the bubble y-values. Th ese values locate the bubbles\nin the chart vertically."
1273 },
1274 "legendPosition": {
1275 "description": "Where the legend of the chart should be draw n.",
1276 "enum": [
1277 "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
1278 "BOTTOM_LEGEND",
1279 "LEFT_LEGEND",
1280 "RIGHT_LEGEND",
1281 "TOP_LEGEND",
1282 "NO_LEGEND",
1283 "INSIDE_LEGEND"
1284 ],
1285 "enumDescriptions": [
1286 "Default value, do not use.",
1287 "The legend is rendered on the bottom of the chart.",
1288 "The legend is rendered on the left of the chart.",
1289 "The legend is rendered on the right of the chart.",
1290 "The legend is rendered on the top of the chart.",
1291 "No legend is rendered.",
1292 "The legend is rendered inside the chart area."
1293 ],
1294 "type": "string"
1295 },
1296 "domain": {
1297 "$ref": "ChartData",
1298 "description": "The data containing the bubble x-values. Th ese values locate the bubbles\nin the chart horizontally."
1299 },
1300 "bubbleOpacity": {
1301 "description": "The opacity of the bubbles between 0 and 1.0 .\n0 is fully transparent and 1 is fully opaque.",
1302 "format": "float",
1303 "type": "number"
1304 },
1305 "bubbleSizes": {
1306 "$ref": "ChartData",
1307 "description": "The data contianing the bubble sizes. Bubbl e sizes are used to draw\nthe bubbles at different sizes relative to each other. \nIf specified, group_ids must also be specified. This field is\noptional."
1308 }
1309 },
1310 "type": "object"
1311 },
1312 "CellData": {
1313 "description": "Data about a specific cell.",
1314 "id": "CellData",
1315 "properties": {
1316 "formattedValue": {
1317 "description": "The formatted value of the cell.\nThis is th e value as it's shown to the user.\nThis field is read-only.",
1318 "type": "string"
1319 },
1320 "textFormatRuns": {
1321 "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.",
1322 "items": {
1323 "$ref": "TextFormatRun"
1324 },
1325 "type": "array"
1326 },
1327 "hyperlink": {
1328 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnter edValue.formulaValue\nfield.)",
1329 "type": "string"
1330 },
1331 "pivotTable": {
1332 "$ref": "PivotTable",
1333 "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."
1334 },
1335 "userEnteredFormat": {
1336 "$ref": "CellFormat",
1337 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format."
1338 },
1339 "effectiveFormat": {
1340 "$ref": "CellFormat",
1341 "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."
1342 },
1343 "note": {
1344 "description": "Any note on the cell.",
1345 "type": "string"
1346 },
1347 "userEnteredValue": {
1348 "$ref": "ExtendedValue",
1349 "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."
1350 },
1351 "dataValidation": {
1352 "$ref": "DataValidationRule",
1353 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
1354 },
1355 "effectiveValue": {
1356 "$ref": "ExtendedValue",
1357 "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."
1358 }
1359 },
1360 "type": "object"
1361 },
1362 "BatchUpdateSpreadsheetRequest": {
1363 "description": "The request for updating any aspect of a spreadsheet .",
1364 "id": "BatchUpdateSpreadsheetRequest",
1365 "properties": {
1366 "requests": {
1367 "description": "A list of updates to apply to the spreadshee t.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
1368 "items": {
1369 "$ref": "Request"
1370 },
1371 "type": "array"
1372 },
1373 "responseIncludeGridData": {
1374 "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.",
1375 "type": "boolean"
1376 },
1377 "responseRanges": {
1378 "description": "Limits the ranges included in the response s preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
1379 "items": {
1380 "type": "string"
1381 },
1382 "type": "array"
1383 },
1384 "includeSpreadsheetInResponse": {
1385 "description": "Determines if the update response should inc lude the spreadsheet\nresource.",
1386 "type": "boolean"
1387 }
1388 },
1389 "type": "object"
1390 },
1391 "Padding": {
1392 "description": "The amount of padding around the cell, in pixels.\nW hen updating padding, every field must be specified.",
1393 "id": "Padding",
1394 "properties": {
1395 "top": {
1396 "description": "The top padding of the cell.",
1397 "format": "int32",
1398 "type": "integer"
1399 },
1400 "left": {
1401 "description": "The left padding of the cell.",
1402 "format": "int32",
1403 "type": "integer"
1404 },
1405 "right": {
1406 "description": "The right padding of the cell.",
1407 "format": "int32",
1408 "type": "integer"
1409 },
1410 "bottom": {
1411 "description": "The bottom padding of the cell.",
1412 "format": "int32",
1413 "type": "integer"
1414 }
1415 },
1416 "type": "object"
1417 },
1418 "BasicChartAxis": {
1419 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.",
1420 "id": "BasicChartAxis",
1421 "properties": {
1422 "title": {
1423 "description": "The title of this axis. If set, this overrid es any title inferred\nfrom headers of the data.",
1424 "type": "string"
1425 },
1426 "position": {
1427 "description": "The position of this axis.",
1428 "enum": [
1429 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
1430 "BOTTOM_AXIS",
1431 "LEFT_AXIS",
1432 "RIGHT_AXIS"
1433 ],
1434 "enumDescriptions": [
1435 "Default value, do not use.",
1436 "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.",
1437 "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.",
1438 "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."
1439 ],
1440 "type": "string"
1441 },
1442 "format": {
1443 "$ref": "TextFormat",
1444 "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
1445 }
1446 },
1447 "type": "object"
1448 },
1449 "DeleteDimensionRequest": {
1450 "description": "Deletes the dimensions from the sheet.",
1451 "id": "DeleteDimensionRequest",
1452 "properties": {
1453 "range": {
1454 "$ref": "DimensionRange",
1455 "description": "The dimensions to delete from the sheet."
1456 }
1457 },
1458 "type": "object"
1459 },
1460 "UpdateChartSpecRequest": {
1461 "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.)",
1462 "id": "UpdateChartSpecRequest",
1463 "properties": {
1464 "chartId": {
1465 "description": "The ID of the chart to update.",
1466 "format": "int32",
1467 "type": "integer"
1468 },
1469 "spec": {
1470 "$ref": "ChartSpec",
1471 "description": "The specification to apply to the chart."
1472 }
1473 },
1474 "type": "object"
1475 },
1476 "DeleteFilterViewRequest": {
1477 "description": "Deletes a particular filter view.",
1478 "id": "DeleteFilterViewRequest",
1479 "properties": {
1480 "filterId": {
1481 "description": "The ID of the filter to delete.",
1482 "format": "int32",
1483 "type": "integer"
1484 }
1485 },
1486 "type": "object"
1487 },
1488 "BatchUpdateValuesResponse": { 631 "BatchUpdateValuesResponse": {
1489 "description": "The response when updating a range of values in a sp readsheet.", 632 "description": "The response when updating a range of values in a sp readsheet.",
1490 "id": "BatchUpdateValuesResponse", 633 "id": "BatchUpdateValuesResponse",
1491 "properties": { 634 "properties": {
635 "totalUpdatedColumns": {
636 "description": "The total number of columns where at least o ne cell in the column was\nupdated.",
637 "format": "int32",
638 "type": "integer"
639 },
1492 "spreadsheetId": { 640 "spreadsheetId": {
1493 "description": "The spreadsheet the updates were applied to. ", 641 "description": "The spreadsheet the updates were applied to. ",
1494 "type": "string" 642 "type": "string"
1495 }, 643 },
1496 "totalUpdatedRows": { 644 "totalUpdatedRows": {
1497 "description": "The total number of rows where at least one cell in the row was updated.", 645 "description": "The total number of rows where at least one cell in the row was updated.",
1498 "format": "int32", 646 "format": "int32",
1499 "type": "integer" 647 "type": "integer"
1500 }, 648 },
1501 "responses": { 649 "responses": {
1502 "description": "One UpdateValuesResponse per requested range , in the same order as\nthe requests appeared.", 650 "description": "One UpdateValuesResponse per requested range , in the same order as\nthe requests appeared.",
1503 "items": { 651 "items": {
1504 "$ref": "UpdateValuesResponse" 652 "$ref": "UpdateValuesResponse"
1505 }, 653 },
1506 "type": "array" 654 "type": "array"
1507 }, 655 },
1508 "totalUpdatedSheets": { 656 "totalUpdatedSheets": {
1509 "description": "The total number of sheets where at least on e cell in the sheet was\nupdated.", 657 "description": "The total number of sheets where at least on e cell in the sheet was\nupdated.",
1510 "format": "int32", 658 "format": "int32",
1511 "type": "integer" 659 "type": "integer"
1512 }, 660 },
1513 "totalUpdatedCells": { 661 "totalUpdatedCells": {
1514 "description": "The total number of cells updated.", 662 "description": "The total number of cells updated.",
1515 "format": "int32", 663 "format": "int32",
1516 "type": "integer" 664 "type": "integer"
1517 },
1518 "totalUpdatedColumns": {
1519 "description": "The total number of columns where at least o ne cell in the column was\nupdated.",
1520 "format": "int32",
1521 "type": "integer"
1522 } 665 }
1523 }, 666 },
1524 "type": "object" 667 "type": "object"
1525 }, 668 },
1526 "SortRangeRequest": { 669 "SortRangeRequest": {
1527 "description": "Sorts data in rows based on a sort order per column. ", 670 "description": "Sorts data in rows based on a sort order per column. ",
1528 "id": "SortRangeRequest", 671 "id": "SortRangeRequest",
1529 "properties": { 672 "properties": {
1530 "range": { 673 "range": {
1531 "$ref": "GridRange", 674 "$ref": "GridRange",
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after
1606 "description": "The result of duplicating a sheet.", 749 "description": "The result of duplicating a sheet.",
1607 "id": "DuplicateSheetResponse", 750 "id": "DuplicateSheetResponse",
1608 "properties": { 751 "properties": {
1609 "properties": { 752 "properties": {
1610 "$ref": "SheetProperties", 753 "$ref": "SheetProperties",
1611 "description": "The properties of the duplicate sheet." 754 "description": "The properties of the duplicate sheet."
1612 } 755 }
1613 }, 756 },
1614 "type": "object" 757 "type": "object"
1615 }, 758 },
1616 "ClearBasicFilterRequest": {
1617 "description": "Clears the basic filter, if any exists on the sheet. ",
1618 "id": "ClearBasicFilterRequest",
1619 "properties": {
1620 "sheetId": {
1621 "description": "The sheet ID on which the basic filter shoul d be cleared.",
1622 "format": "int32",
1623 "type": "integer"
1624 }
1625 },
1626 "type": "object"
1627 },
1628 "TextToColumnsRequest": { 759 "TextToColumnsRequest": {
1629 "description": "Splits a column of text into multiple columns,\nbase d on a delimiter in each cell.", 760 "description": "Splits a column of text into multiple columns,\nbase d on a delimiter in each cell.",
1630 "id": "TextToColumnsRequest", 761 "id": "TextToColumnsRequest",
1631 "properties": { 762 "properties": {
1632 "delimiterType": { 763 "delimiterType": {
1633 "description": "The delimiter type to use.", 764 "description": "The delimiter type to use.",
1634 "enum": [ 765 "enum": [
1635 "DELIMITER_TYPE_UNSPECIFIED", 766 "DELIMITER_TYPE_UNSPECIFIED",
1636 "COMMA", 767 "COMMA",
1637 "SEMICOLON", 768 "SEMICOLON",
(...skipping 15 matching lines...) Expand all
1653 "$ref": "GridRange", 784 "$ref": "GridRange",
1654 "description": "The source data range. This must span exact ly one column." 785 "description": "The source data range. This must span exact ly one column."
1655 }, 786 },
1656 "delimiter": { 787 "delimiter": {
1657 "description": "The delimiter to use. Used only if delimiter Type is\nCUSTOM.", 788 "description": "The delimiter to use. Used only if delimiter Type is\nCUSTOM.",
1658 "type": "string" 789 "type": "string"
1659 } 790 }
1660 }, 791 },
1661 "type": "object" 792 "type": "object"
1662 }, 793 },
1663 "DeleteBandingRequest": { 794 "ClearBasicFilterRequest": {
1664 "description": "Removes the banded range with the given ID from the spreadsheet.", 795 "description": "Clears the basic filter, if any exists on the sheet. ",
1665 "id": "DeleteBandingRequest", 796 "id": "ClearBasicFilterRequest",
1666 "properties": { 797 "properties": {
1667 "bandedRangeId": { 798 "sheetId": {
1668 "description": "The ID of the banded range to delete.", 799 "description": "The sheet ID on which the basic filter shoul d be cleared.",
1669 "format": "int32", 800 "format": "int32",
1670 "type": "integer" 801 "type": "integer"
1671 } 802 }
1672 }, 803 },
1673 "type": "object" 804 "type": "object"
1674 }, 805 },
1675 "BatchUpdateSpreadsheetResponse": { 806 "BatchUpdateSpreadsheetResponse": {
1676 "description": "The reply for batch updating a spreadsheet.", 807 "description": "The reply for batch updating a spreadsheet.",
1677 "id": "BatchUpdateSpreadsheetResponse", 808 "id": "BatchUpdateSpreadsheetResponse",
1678 "properties": { 809 "properties": {
1679 "updatedSpreadsheet": { 810 "updatedSpreadsheet": {
1680 "$ref": "Spreadsheet", 811 "$ref": "Spreadsheet",
1681 "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo nse] is `true`." 812 "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_respo nse] is `true`."
1682 }, 813 },
1683 "replies": { 814 "replies": {
1684 "description": "The reply of the updates. This maps 1:1 wit h the updates, although\nreplies to some requests may be empty.", 815 "description": "The reply of the updates. This maps 1:1 wit h the updates, although\nreplies to some requests may be empty.",
1685 "items": { 816 "items": {
1686 "$ref": "Response" 817 "$ref": "Response"
1687 }, 818 },
1688 "type": "array" 819 "type": "array"
1689 }, 820 },
1690 "spreadsheetId": { 821 "spreadsheetId": {
1691 "description": "The spreadsheet the updates were applied to. ", 822 "description": "The spreadsheet the updates were applied to. ",
1692 "type": "string" 823 "type": "string"
1693 } 824 }
1694 }, 825 },
1695 "type": "object" 826 "type": "object"
1696 }, 827 },
828 "DeleteBandingRequest": {
829 "description": "Removes the banded range with the given ID from the spreadsheet.",
830 "id": "DeleteBandingRequest",
831 "properties": {
832 "bandedRangeId": {
833 "description": "The ID of the banded range to delete.",
834 "format": "int32",
835 "type": "integer"
836 }
837 },
838 "type": "object"
839 },
1697 "AppendValuesResponse": { 840 "AppendValuesResponse": {
1698 "description": "The response when updating a range of values in a sp readsheet.", 841 "description": "The response when updating a range of values in a sp readsheet.",
1699 "id": "AppendValuesResponse", 842 "id": "AppendValuesResponse",
1700 "properties": { 843 "properties": {
1701 "spreadsheetId": { 844 "spreadsheetId": {
1702 "description": "The spreadsheet the updates were applied to. ", 845 "description": "The spreadsheet the updates were applied to. ",
1703 "type": "string" 846 "type": "string"
1704 }, 847 },
1705 "updates": { 848 "updates": {
1706 "$ref": "UpdateValuesResponse", 849 "$ref": "UpdateValuesResponse",
1707 "description": "Information about the updates that were appl ied." 850 "description": "Information about the updates that were appl ied."
1708 }, 851 },
1709 "tableRange": { 852 "tableRange": {
1710 "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.", 853 "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.",
1711 "type": "string" 854 "type": "string"
1712 } 855 }
1713 }, 856 },
1714 "type": "object" 857 "type": "object"
1715 }, 858 },
1716 "AddFilterViewRequest": { 859 "MoveDimensionRequest": {
1717 "description": "Adds a filter view.", 860 "description": "Moves one or more rows or columns.",
1718 "id": "AddFilterViewRequest", 861 "id": "MoveDimensionRequest",
1719 "properties": { 862 "properties": {
1720 "filter": { 863 "destinationIndex": {
1721 "$ref": "FilterView", 864 "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`.",
1722 "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.)" 865 "format": "int32",
866 "type": "integer"
867 },
868 "source": {
869 "$ref": "DimensionRange",
870 "description": "The source dimensions to move."
1723 } 871 }
1724 }, 872 },
1725 "type": "object" 873 "type": "object"
1726 }, 874 },
1727 "PivotFilterCriteria": { 875 "PivotFilterCriteria": {
1728 "description": "Criteria for showing/hiding rows in a pivot table.", 876 "description": "Criteria for showing/hiding rows in a pivot table.",
1729 "id": "PivotFilterCriteria", 877 "id": "PivotFilterCriteria",
1730 "properties": { 878 "properties": {
1731 "visibleValues": { 879 "visibleValues": {
1732 "description": "Values that should be included. Values not listed here are excluded.", 880 "description": "Values that should be included. Values not listed here are excluded.",
1733 "items": { 881 "items": {
1734 "type": "string" 882 "type": "string"
1735 }, 883 },
1736 "type": "array" 884 "type": "array"
1737 } 885 }
1738 }, 886 },
1739 "type": "object" 887 "type": "object"
1740 }, 888 },
1741 "MoveDimensionRequest": { 889 "AddFilterViewRequest": {
1742 "description": "Moves one or more rows or columns.", 890 "description": "Adds a filter view.",
1743 "id": "MoveDimensionRequest", 891 "id": "AddFilterViewRequest",
1744 "properties": { 892 "properties": {
1745 "destinationIndex": { 893 "filter": {
1746 "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`.", 894 "$ref": "FilterView",
1747 "format": "int32", 895 "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.)"
1748 "type": "integer"
1749 },
1750 "source": {
1751 "$ref": "DimensionRange",
1752 "description": "The source dimensions to move."
1753 } 896 }
1754 }, 897 },
1755 "type": "object" 898 "type": "object"
1756 }, 899 },
1757 "AddConditionalFormatRuleRequest": { 900 "AddConditionalFormatRuleRequest": {
1758 "description": "Adds a new conditional format rule at the given inde x.\nAll subsequent rules' indexes are incremented.", 901 "description": "Adds a new conditional format rule at the given inde x.\nAll subsequent rules' indexes are incremented.",
1759 "id": "AddConditionalFormatRuleRequest", 902 "id": "AddConditionalFormatRuleRequest",
1760 "properties": { 903 "properties": {
1761 "rule": { 904 "rule": {
1762 "$ref": "ConditionalFormatRule", 905 "$ref": "ConditionalFormatRule",
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
1817 "description": "A pie chart specification." 960 "description": "A pie chart specification."
1818 }, 961 },
1819 "titleTextFormat": { 962 "titleTextFormat": {
1820 "$ref": "TextFormat", 963 "$ref": "TextFormat",
1821 "description": "The title text format.\nStrikethrough and un derline are not supported." 964 "description": "The title text format.\nStrikethrough and un derline are not supported."
1822 }, 965 },
1823 "title": { 966 "title": {
1824 "description": "The title of the chart.", 967 "description": "The title of the chart.",
1825 "type": "string" 968 "type": "string"
1826 }, 969 },
970 "altText": {
971 "description": "The alternative text that describes the char t. This is often used\nfor accessibility.",
972 "type": "string"
973 },
1827 "histogramChart": { 974 "histogramChart": {
1828 "$ref": "HistogramChartSpec", 975 "$ref": "HistogramChartSpec",
1829 "description": "A histogram chart specification." 976 "description": "A histogram chart specification."
1830 }, 977 },
1831 "candlestickChart": { 978 "candlestickChart": {
1832 "$ref": "CandlestickChartSpec", 979 "$ref": "CandlestickChartSpec",
1833 "description": "A candlestick chart specification." 980 "description": "A candlestick chart specification."
1834 }, 981 },
1835 "bubbleChart": { 982 "bubbleChart": {
1836 "$ref": "BubbleChartSpec", 983 "$ref": "BubbleChartSpec",
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
1876 }, 1023 },
1877 "type": "object" 1024 "type": "object"
1878 }, 1025 },
1879 "CandlestickDomain": { 1026 "CandlestickDomain": {
1880 "description": "The domain of a CandlestickChart.", 1027 "description": "The domain of a CandlestickChart.",
1881 "id": "CandlestickDomain", 1028 "id": "CandlestickDomain",
1882 "properties": { 1029 "properties": {
1883 "data": { 1030 "data": {
1884 "$ref": "ChartData", 1031 "$ref": "ChartData",
1885 "description": "The data of the CandlestickDomain." 1032 "description": "The data of the CandlestickDomain."
1033 },
1034 "reversed": {
1035 "description": "True to reverse the order of the domain valu es (horizontal axis).",
1036 "type": "boolean"
1886 } 1037 }
1887 }, 1038 },
1888 "type": "object" 1039 "type": "object"
1889 }, 1040 },
1890 "SheetProperties": { 1041 "SheetProperties": {
1891 "description": "Properties of a sheet.", 1042 "description": "Properties of a sheet.",
1892 "id": "SheetProperties", 1043 "id": "SheetProperties",
1893 "properties": { 1044 "properties": {
1045 "title": {
1046 "description": "The name of the sheet.",
1047 "type": "string"
1048 },
1049 "tabColor": {
1050 "$ref": "Color",
1051 "description": "The color of the tab in the UI."
1052 },
1053 "index": {
1054 "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.",
1055 "format": "int32",
1056 "type": "integer"
1057 },
1894 "sheetId": { 1058 "sheetId": {
1895 "description": "The ID of the sheet. Must be non-negative.\n This field cannot be changed once set.", 1059 "description": "The ID of the sheet. Must be non-negative.\n This field cannot be changed once set.",
1896 "format": "int32", 1060 "format": "int32",
1897 "type": "integer" 1061 "type": "integer"
1898 }, 1062 },
1899 "rightToLeft": { 1063 "rightToLeft": {
1900 "description": "True if the sheet is an RTL sheet instead of an LTR sheet.", 1064 "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
1901 "type": "boolean" 1065 "type": "boolean"
1902 }, 1066 },
1903 "hidden": { 1067 "hidden": {
(...skipping 10 matching lines...) Expand all
1914 "enumDescriptions": [ 1078 "enumDescriptions": [
1915 "Default value, do not use.", 1079 "Default value, do not use.",
1916 "The sheet is a grid.", 1080 "The sheet is a grid.",
1917 "The sheet has no grid and instead has an object like a chart or image." 1081 "The sheet has no grid and instead has an object like a chart or image."
1918 ], 1082 ],
1919 "type": "string" 1083 "type": "string"
1920 }, 1084 },
1921 "gridProperties": { 1085 "gridProperties": {
1922 "$ref": "GridProperties", 1086 "$ref": "GridProperties",
1923 "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." 1087 "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."
1924 },
1925 "title": {
1926 "description": "The name of the sheet.",
1927 "type": "string"
1928 },
1929 "tabColor": {
1930 "$ref": "Color",
1931 "description": "The color of the tab in the UI."
1932 },
1933 "index": {
1934 "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.",
1935 "format": "int32",
1936 "type": "integer"
1937 } 1088 }
1938 }, 1089 },
1939 "type": "object" 1090 "type": "object"
1940 }, 1091 },
1941 "UpdateDimensionPropertiesRequest": { 1092 "UpdateDimensionPropertiesRequest": {
1942 "description": "Updates properties of dimensions within the specifie d range.", 1093 "description": "Updates properties of dimensions within the specifie d range.",
1943 "id": "UpdateDimensionPropertiesRequest", 1094 "id": "UpdateDimensionPropertiesRequest",
1944 "properties": { 1095 "properties": {
1945 "range": { 1096 "range": {
1946 "$ref": "DimensionRange", 1097 "$ref": "DimensionRange",
1947 "description": "The rows or columns to update." 1098 "description": "The rows or columns to update."
1948 }, 1099 },
1949 "fields": { 1100 "fields": {
1950 "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 .", 1101 "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 .",
1951 "format": "google-fieldmask", 1102 "format": "google-fieldmask",
1952 "type": "string" 1103 "type": "string"
1953 }, 1104 },
1954 "properties": { 1105 "properties": {
1955 "$ref": "DimensionProperties", 1106 "$ref": "DimensionProperties",
1956 "description": "Properties to update." 1107 "description": "Properties to update."
1957 } 1108 }
1958 }, 1109 },
1959 "type": "object" 1110 "type": "object"
1960 }, 1111 },
1961 "SourceAndDestination": { 1112 "SourceAndDestination": {
1962 "description": "A combination of a source range and how to extend th at source.", 1113 "description": "A combination of a source range and how to extend th at source.",
1963 "id": "SourceAndDestination", 1114 "id": "SourceAndDestination",
1964 "properties": { 1115 "properties": {
1116 "source": {
1117 "$ref": "GridRange",
1118 "description": "The location of the data to use as the sourc e of the autofill."
1119 },
1965 "dimension": { 1120 "dimension": {
1966 "description": "The dimension that data should be filled int o.", 1121 "description": "The dimension that data should be filled int o.",
1967 "enum": [ 1122 "enum": [
1968 "DIMENSION_UNSPECIFIED", 1123 "DIMENSION_UNSPECIFIED",
1969 "ROWS", 1124 "ROWS",
1970 "COLUMNS" 1125 "COLUMNS"
1971 ], 1126 ],
1972 "enumDescriptions": [ 1127 "enumDescriptions": [
1973 "The default value, do not use.", 1128 "The default value, do not use.",
1974 "Operates on the rows of a sheet.", 1129 "Operates on the rows of a sheet.",
1975 "Operates on the columns of a sheet." 1130 "Operates on the columns of a sheet."
1976 ], 1131 ],
1977 "type": "string" 1132 "type": "string"
1978 }, 1133 },
1979 "fillLength": { 1134 "fillLength": {
1980 "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.", 1135 "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.",
1981 "format": "int32", 1136 "format": "int32",
1982 "type": "integer" 1137 "type": "integer"
1983 },
1984 "source": {
1985 "$ref": "GridRange",
1986 "description": "The location of the data to use as the sourc e of the autofill."
1987 } 1138 }
1988 }, 1139 },
1989 "type": "object" 1140 "type": "object"
1990 }, 1141 },
1991 "FilterView": { 1142 "FilterView": {
1992 "description": "A filter view.", 1143 "description": "A filter view.",
1993 "id": "FilterView", 1144 "id": "FilterView",
1994 "properties": { 1145 "properties": {
1995 "criteria": { 1146 "criteria": {
1996 "additionalProperties": { 1147 "additionalProperties": {
(...skipping 30 matching lines...) Expand all
2027 "type": "object" 1178 "type": "object"
2028 }, 1179 },
2029 "OrgChartSpec": { 1180 "OrgChartSpec": {
2030 "description": "An <a href=\"/chart/interactive/docs/gallery/orgchar t\">org chart</a>.\nOrg charts require a unique set of labels in labels and may\ noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also r eporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_ labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"Presi dent\", \"VP Sales\".", 1181 "description": "An <a href=\"/chart/interactive/docs/gallery/orgchar t\">org chart</a>.\nOrg charts require a unique set of labels in labels and may\ noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also r eporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_ labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"Presi dent\", \"VP Sales\".",
2031 "id": "OrgChartSpec", 1182 "id": "OrgChartSpec",
2032 "properties": { 1183 "properties": {
2033 "parentLabels": { 1184 "parentLabels": {
2034 "$ref": "ChartData", 1185 "$ref": "ChartData",
2035 "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional." 1186 "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
2036 }, 1187 },
1188 "labels": {
1189 "$ref": "ChartData",
1190 "description": "The data containing the labels for all the n odes in the chart. Labels\nmust be unique."
1191 },
2037 "nodeSize": { 1192 "nodeSize": {
2038 "description": "The size of the org chart nodes.", 1193 "description": "The size of the org chart nodes.",
2039 "enum": [ 1194 "enum": [
2040 "ORG_CHART_LABEL_SIZE_UNSPECIFIED", 1195 "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
2041 "SMALL", 1196 "SMALL",
2042 "MEDIUM", 1197 "MEDIUM",
2043 "LARGE" 1198 "LARGE"
2044 ], 1199 ],
2045 "enumDescriptions": [ 1200 "enumDescriptions": [
2046 "Default value, do not use.", 1201 "Default value, do not use.",
2047 "The small org chart node size.", 1202 "The small org chart node size.",
2048 "The medium org chart node size.", 1203 "The medium org chart node size.",
2049 "The large org chart node size." 1204 "The large org chart node size."
2050 ], 1205 ],
2051 "type": "string" 1206 "type": "string"
2052 }, 1207 },
2053 "labels": {
2054 "$ref": "ChartData",
2055 "description": "The data containing the labels for all the n odes in the chart. Labels\nmust be unique."
2056 },
2057 "nodeColor": { 1208 "nodeColor": {
2058 "$ref": "Color", 1209 "$ref": "Color",
2059 "description": "The color of the org chart nodes." 1210 "description": "The color of the org chart nodes."
2060 }, 1211 },
2061 "tooltips": { 1212 "tooltips": {
2062 "$ref": "ChartData", 1213 "$ref": "ChartData",
2063 "description": "The data containing the tooltip for the corr esponding node. A blank value\nresults in no tooltip being displayed for the no de.\nThis field is optional." 1214 "description": "The data containing the tooltip for the corr esponding node. A blank value\nresults in no tooltip being displayed for the no de.\nThis field is optional."
2064 }, 1215 },
2065 "selectedNodeColor": { 1216 "selectedNodeColor": {
2066 "$ref": "Color", 1217 "$ref": "Color",
2067 "description": "The color of the selected org chart nodes." 1218 "description": "The color of the selected org chart nodes."
2068 } 1219 }
2069 }, 1220 },
2070 "type": "object" 1221 "type": "object"
2071 }, 1222 },
2072 "BandingProperties": { 1223 "BandingProperties": {
2073 "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.", 1224 "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.",
2074 "id": "BandingProperties", 1225 "id": "BandingProperties",
2075 "properties": { 1226 "properties": {
1227 "firstBandColor": {
1228 "$ref": "Color",
1229 "description": "The first color that is alternating. (Requir ed)"
1230 },
1231 "secondBandColor": {
1232 "$ref": "Color",
1233 "description": "The second color that is alternating. (Requi red)"
1234 },
1235 "footerColor": {
1236 "$ref": "Color",
1237 "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."
1238 },
2076 "headerColor": { 1239 "headerColor": {
2077 "$ref": "Color", 1240 "$ref": "Color",
2078 "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." 1241 "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."
2079 },
2080 "firstBandColor": {
2081 "$ref": "Color",
2082 "description": "The first color that is alternating. (Requir ed)"
2083 },
2084 "secondBandColor": {
2085 "$ref": "Color",
2086 "description": "The second color that is alternating. (Requi red)"
2087 },
2088 "footerColor": {
2089 "$ref": "Color",
2090 "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."
2091 } 1242 }
2092 }, 1243 },
2093 "type": "object" 1244 "type": "object"
2094 }, 1245 },
2095 "AddProtectedRangeResponse": { 1246 "AddProtectedRangeResponse": {
2096 "description": "The result of adding a new protected range.", 1247 "description": "The result of adding a new protected range.",
2097 "id": "AddProtectedRangeResponse", 1248 "id": "AddProtectedRangeResponse",
2098 "properties": { 1249 "properties": {
2099 "protectedRange": { 1250 "protectedRange": {
2100 "$ref": "ProtectedRange", 1251 "$ref": "ProtectedRange",
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
2136 "$ref": "ChartData", 1287 "$ref": "ChartData",
2137 "description": "The data of the CandlestickSeries." 1288 "description": "The data of the CandlestickSeries."
2138 } 1289 }
2139 }, 1290 },
2140 "type": "object" 1291 "type": "object"
2141 }, 1292 },
2142 "HistogramChartSpec": { 1293 "HistogramChartSpec": {
2143 "description": "A <a href=\"/chart/interactive/docs/gallery/histogra m\">histogram chart</a>.\nA histogram chart groups data items into bins, display ing each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\ nexplicitly.", 1294 "description": "A <a href=\"/chart/interactive/docs/gallery/histogra m\">histogram chart</a>.\nA histogram chart groups data items into bins, display ing each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\ nexplicitly.",
2144 "id": "HistogramChartSpec", 1295 "id": "HistogramChartSpec",
2145 "properties": { 1296 "properties": {
2146 "outlierPercentile": {
2147 "description": "The outlier percentile is used to ensure tha t outliers do not adversely\naffect the calculation of bucket sizes. For exampl e, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% o f values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\ nMust be between 0.0 and 0.5.",
2148 "format": "double",
2149 "type": "number"
2150 },
2151 "showItemDividers": {
2152 "description": "Whether horizontal divider lines should be d isplayed between items in each\ncolumn.",
2153 "type": "boolean"
2154 },
2155 "series": {
2156 "description": "The series for a histogram may be either a s ingle series of values to be\nbucketed or multiple series, each of the same leng th, containing the name\nof the series followed by the values to be bucketed for that series.",
2157 "items": {
2158 "$ref": "HistogramSeries"
2159 },
2160 "type": "array"
2161 },
2162 "legendPosition": { 1297 "legendPosition": {
2163 "description": "The position of the chart legend.", 1298 "description": "The position of the chart legend.",
2164 "enum": [ 1299 "enum": [
2165 "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED", 1300 "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
2166 "BOTTOM_LEGEND", 1301 "BOTTOM_LEGEND",
2167 "LEFT_LEGEND", 1302 "LEFT_LEGEND",
2168 "RIGHT_LEGEND", 1303 "RIGHT_LEGEND",
2169 "TOP_LEGEND", 1304 "TOP_LEGEND",
2170 "NO_LEGEND", 1305 "NO_LEGEND",
2171 "INSIDE_LEGEND" 1306 "INSIDE_LEGEND"
2172 ], 1307 ],
2173 "enumDescriptions": [ 1308 "enumDescriptions": [
2174 "Default value, do not use.", 1309 "Default value, do not use.",
2175 "The legend is rendered on the bottom of the chart.", 1310 "The legend is rendered on the bottom of the chart.",
2176 "The legend is rendered on the left of the chart.", 1311 "The legend is rendered on the left of the chart.",
2177 "The legend is rendered on the right of the chart.", 1312 "The legend is rendered on the right of the chart.",
2178 "The legend is rendered on the top of the chart.", 1313 "The legend is rendered on the top of the chart.",
2179 "No legend is rendered.", 1314 "No legend is rendered.",
2180 "The legend is rendered inside the chart area." 1315 "The legend is rendered inside the chart area."
2181 ], 1316 ],
2182 "type": "string" 1317 "type": "string"
2183 }, 1318 },
2184 "bucketSize": { 1319 "bucketSize": {
2185 "description": "By default the bucket size (the range of val ues stacked in a single\ncolumn) is chosen automatically, but it may be overridd en here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.", 1320 "description": "By default the bucket size (the range of val ues stacked in a single\ncolumn) is chosen automatically, but it may be overridd en here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
2186 "format": "double", 1321 "format": "double",
2187 "type": "number" 1322 "type": "number"
1323 },
1324 "outlierPercentile": {
1325 "description": "The outlier percentile is used to ensure tha t outliers do not adversely\naffect the calculation of bucket sizes. For exampl e, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% o f values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\ nMust be between 0.0 and 0.5.",
1326 "format": "double",
1327 "type": "number"
1328 },
1329 "showItemDividers": {
1330 "description": "Whether horizontal divider lines should be d isplayed between items in each\ncolumn.",
1331 "type": "boolean"
1332 },
1333 "series": {
1334 "description": "The series for a histogram may be either a s ingle series of values to be\nbucketed or multiple series, each of the same leng th, containing the name\nof the series followed by the values to be bucketed for that series.",
1335 "items": {
1336 "$ref": "HistogramSeries"
1337 },
1338 "type": "array"
2188 } 1339 }
2189 }, 1340 },
2190 "type": "object" 1341 "type": "object"
2191 }, 1342 },
2192 "UpdateValuesResponse": { 1343 "UpdateValuesResponse": {
2193 "description": "The response when updating a range of values in a sp readsheet.", 1344 "description": "The response when updating a range of values in a sp readsheet.",
2194 "id": "UpdateValuesResponse", 1345 "id": "UpdateValuesResponse",
2195 "properties": { 1346 "properties": {
2196 "updatedColumns": {
2197 "description": "The number of columns where at least one cel l in the column was updated.",
2198 "format": "int32",
2199 "type": "integer"
2200 },
2201 "spreadsheetId": {
2202 "description": "The spreadsheet the updates were applied to. ",
2203 "type": "string"
2204 },
2205 "updatedRange": { 1347 "updatedRange": {
2206 "description": "The range (in A1 notation) that updates were applied to.", 1348 "description": "The range (in A1 notation) that updates were applied to.",
2207 "type": "string" 1349 "type": "string"
2208 }, 1350 },
2209 "updatedCells": { 1351 "updatedCells": {
2210 "description": "The number of cells updated.", 1352 "description": "The number of cells updated.",
2211 "format": "int32", 1353 "format": "int32",
2212 "type": "integer" 1354 "type": "integer"
2213 }, 1355 },
2214 "updatedRows": { 1356 "updatedRows": {
2215 "description": "The number of rows where at least one cell i n the row was updated.", 1357 "description": "The number of rows where at least one cell i n the row was updated.",
2216 "format": "int32", 1358 "format": "int32",
2217 "type": "integer" 1359 "type": "integer"
2218 }, 1360 },
2219 "updatedData": { 1361 "updatedData": {
2220 "$ref": "ValueRange", 1362 "$ref": "ValueRange",
2221 "description": "The values of the cells after updates were a pplied.\nThis is only included if the request's `includeValuesInResponse` field\ nwas `true`." 1363 "description": "The values of the cells after updates were a pplied.\nThis is only included if the request's `includeValuesInResponse` field\ nwas `true`."
1364 },
1365 "updatedColumns": {
1366 "description": "The number of columns where at least one cel l in the column was updated.",
1367 "format": "int32",
1368 "type": "integer"
1369 },
1370 "spreadsheetId": {
1371 "description": "The spreadsheet the updates were applied to. ",
1372 "type": "string"
2222 } 1373 }
2223 }, 1374 },
2224 "type": "object" 1375 "type": "object"
2225 }, 1376 },
2226 "ErrorValue": { 1377 "ErrorValue": {
2227 "description": "An error in a cell.", 1378 "description": "An error in a cell.",
2228 "id": "ErrorValue", 1379 "id": "ErrorValue",
2229 "properties": { 1380 "properties": {
1381 "message": {
1382 "description": "A message with more information about the er ror\n(in the spreadsheet's locale).",
1383 "type": "string"
1384 },
2230 "type": { 1385 "type": {
2231 "description": "The type of error.", 1386 "description": "The type of error.",
2232 "enum": [ 1387 "enum": [
2233 "ERROR_TYPE_UNSPECIFIED", 1388 "ERROR_TYPE_UNSPECIFIED",
2234 "ERROR", 1389 "ERROR",
2235 "NULL_VALUE", 1390 "NULL_VALUE",
2236 "DIVIDE_BY_ZERO", 1391 "DIVIDE_BY_ZERO",
2237 "VALUE", 1392 "VALUE",
2238 "REF", 1393 "REF",
2239 "NAME", 1394 "NAME",
2240 "NUM", 1395 "NUM",
2241 "N_A", 1396 "N_A",
2242 "LOADING" 1397 "LOADING"
2243 ], 1398 ],
2244 "enumDescriptions": [ 1399 "enumDescriptions": [
2245 "The default error type, do not use this.", 1400 "The default error type, do not use this.",
2246 "Corresponds to the `#ERROR!` error.", 1401 "Corresponds to the `#ERROR!` error.",
2247 "Corresponds to the `#NULL!` error.", 1402 "Corresponds to the `#NULL!` error.",
2248 "Corresponds to the `#DIV/0` error.", 1403 "Corresponds to the `#DIV/0` error.",
2249 "Corresponds to the `#VALUE!` error.", 1404 "Corresponds to the `#VALUE!` error.",
2250 "Corresponds to the `#REF!` error.", 1405 "Corresponds to the `#REF!` error.",
2251 "Corresponds to the `#NAME?` error.", 1406 "Corresponds to the `#NAME?` error.",
2252 "Corresponds to the `#NUM`! error.", 1407 "Corresponds to the `#NUM`! error.",
2253 "Corresponds to the `#N/A` error.", 1408 "Corresponds to the `#N/A` error.",
2254 "Corresponds to the `Loading...` state." 1409 "Corresponds to the `Loading...` state."
2255 ], 1410 ],
2256 "type": "string" 1411 "type": "string"
2257 },
2258 "message": {
2259 "description": "A message with more information about the er ror\n(in the spreadsheet's locale).",
2260 "type": "string"
2261 } 1412 }
2262 }, 1413 },
2263 "type": "object" 1414 "type": "object"
2264 }, 1415 },
2265 "PivotValue": { 1416 "PivotValue": {
2266 "description": "The definition of how a value in a pivot table shoul d be calculated.", 1417 "description": "The definition of how a value in a pivot table shoul d be calculated.",
2267 "id": "PivotValue", 1418 "id": "PivotValue",
2268 "properties": { 1419 "properties": {
2269 "formula": {
2270 "description": "A custom formula to calculate the value. Th e formula must start\nwith an `=` character.",
2271 "type": "string"
2272 },
2273 "summarizeFunction": { 1420 "summarizeFunction": {
2274 "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.", 1421 "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.",
2275 "enum": [ 1422 "enum": [
2276 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED", 1423 "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
2277 "SUM", 1424 "SUM",
2278 "COUNTA", 1425 "COUNTA",
2279 "COUNT", 1426 "COUNT",
2280 "COUNTUNIQUE", 1427 "COUNTUNIQUE",
2281 "AVERAGE", 1428 "AVERAGE",
2282 "MAX", 1429 "MAX",
(...skipping 26 matching lines...) Expand all
2309 "type": "string" 1456 "type": "string"
2310 }, 1457 },
2311 "sourceColumnOffset": { 1458 "sourceColumnOffset": {
2312 "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`.", 1459 "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`.",
2313 "format": "int32", 1460 "format": "int32",
2314 "type": "integer" 1461 "type": "integer"
2315 }, 1462 },
2316 "name": { 1463 "name": {
2317 "description": "A name to use for the value. This is only us ed if formula was set.\nOtherwise, the column name is used.", 1464 "description": "A name to use for the value. This is only us ed if formula was set.\nOtherwise, the column name is used.",
2318 "type": "string" 1465 "type": "string"
1466 },
1467 "formula": {
1468 "description": "A custom formula to calculate the value. Th e formula must start\nwith an `=` character.",
1469 "type": "string"
2319 } 1470 }
2320 }, 1471 },
2321 "type": "object" 1472 "type": "object"
2322 }, 1473 },
2323 "CopySheetToAnotherSpreadsheetRequest": { 1474 "CopySheetToAnotherSpreadsheetRequest": {
2324 "description": "The request to copy a sheet across spreadsheets.", 1475 "description": "The request to copy a sheet across spreadsheets.",
2325 "id": "CopySheetToAnotherSpreadsheetRequest", 1476 "id": "CopySheetToAnotherSpreadsheetRequest",
2326 "properties": { 1477 "properties": {
2327 "destinationSpreadsheetId": { 1478 "destinationSpreadsheetId": {
2328 "description": "The ID of the spreadsheet to copy the sheet to.", 1479 "description": "The ID of the spreadsheet to copy the sheet to.",
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
2365 "$ref": "CandlestickDomain", 1516 "$ref": "CandlestickDomain",
2366 "description": "The domain data (horizontal axis) for the ca ndlestick chart. String data\nwill be treated as discrete labels, other data wi ll be treated as\ncontinuous values." 1517 "description": "The domain data (horizontal axis) for the ca ndlestick chart. String data\nwill be treated as discrete labels, other data wi ll be treated as\ncontinuous values."
2367 } 1518 }
2368 }, 1519 },
2369 "type": "object" 1520 "type": "object"
2370 }, 1521 },
2371 "CandlestickData": { 1522 "CandlestickData": {
2372 "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.", 1523 "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
2373 "id": "CandlestickData", 1524 "id": "CandlestickData",
2374 "properties": { 1525 "properties": {
1526 "openSeries": {
1527 "$ref": "CandlestickSeries",
1528 "description": "The range data (vertical axis) for the open/ initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be h ollow."
1529 },
1530 "highSeries": {
1531 "$ref": "CandlestickSeries",
1532 "description": "The range data (vertical axis) for the high/ maximum value for each\ncandle. This is the top of the candle's center line."
1533 },
2375 "closeSeries": { 1534 "closeSeries": {
2376 "$ref": "CandlestickSeries", 1535 "$ref": "CandlestickSeries",
2377 "description": "The range data (vertical axis) for the close /final value for each candle.\nThis is the top of the candle body. If greater t han the open value the\ncandle will be filled. Otherwise the candle will be hol low." 1536 "description": "The range data (vertical axis) for the close /final value for each candle.\nThis is the top of the candle body. If greater t han the open value the\ncandle will be filled. Otherwise the candle will be hol low."
2378 }, 1537 },
2379 "lowSeries": { 1538 "lowSeries": {
2380 "$ref": "CandlestickSeries", 1539 "$ref": "CandlestickSeries",
2381 "description": "The range data (vertical axis) for the low/m inimum value for each candle.\nThis is the bottom of the candle's center line." 1540 "description": "The range data (vertical axis) for the low/m inimum value for each candle.\nThis is the bottom of the candle's center line."
2382 },
2383 "openSeries": {
2384 "$ref": "CandlestickSeries",
2385 "description": "The range data (vertical axis) for the open/ initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be h ollow."
2386 },
2387 "highSeries": {
2388 "$ref": "CandlestickSeries",
2389 "description": "The range data (vertical axis) for the high/ maximum value for each\ncandle. This is the top of the candle's center line."
2390 } 1541 }
2391 }, 1542 },
2392 "type": "object" 1543 "type": "object"
2393 }, 1544 },
2394 "EmbeddedObjectPosition": { 1545 "EmbeddedObjectPosition": {
2395 "description": "The position of an embedded object such as a chart." , 1546 "description": "The position of an embedded object such as a chart." ,
2396 "id": "EmbeddedObjectPosition", 1547 "id": "EmbeddedObjectPosition",
2397 "properties": { 1548 "properties": {
1549 "newSheet": {
1550 "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
1551 "type": "boolean"
1552 },
2398 "overlayPosition": { 1553 "overlayPosition": {
2399 "$ref": "OverlayPosition", 1554 "$ref": "OverlayPosition",
2400 "description": "The position at which the object is overlaid on top of a grid." 1555 "description": "The position at which the object is overlaid on top of a grid."
2401 }, 1556 },
2402 "sheetId": { 1557 "sheetId": {
2403 "description": "The sheet this is on. Set only if the embedd ed object\nis on its own sheet. Must be non-negative.", 1558 "description": "The sheet this is on. Set only if the embedd ed object\nis on its own sheet. Must be non-negative.",
2404 "format": "int32", 1559 "format": "int32",
2405 "type": "integer" 1560 "type": "integer"
2406 },
2407 "newSheet": {
2408 "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
2409 "type": "boolean"
2410 } 1561 }
2411 }, 1562 },
2412 "type": "object" 1563 "type": "object"
2413 }, 1564 },
2414 "DeleteProtectedRangeRequest": { 1565 "DeleteProtectedRangeRequest": {
2415 "description": "Deletes the protected range with the given ID.", 1566 "description": "Deletes the protected range with the given ID.",
2416 "id": "DeleteProtectedRangeRequest", 1567 "id": "DeleteProtectedRangeRequest",
2417 "properties": { 1568 "properties": {
2418 "protectedRangeId": { 1569 "protectedRangeId": {
2419 "description": "The ID of the protected range to delete.", 1570 "description": "The ID of the protected range to delete.",
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after
2454 "$ref": "InterpolationPoint", 1605 "$ref": "InterpolationPoint",
2455 "description": "The final interpolation point." 1606 "description": "The final interpolation point."
2456 }, 1607 },
2457 "minpoint": { 1608 "minpoint": {
2458 "$ref": "InterpolationPoint", 1609 "$ref": "InterpolationPoint",
2459 "description": "The starting interpolation point." 1610 "description": "The starting interpolation point."
2460 } 1611 }
2461 }, 1612 },
2462 "type": "object" 1613 "type": "object"
2463 }, 1614 },
2464 "SetBasicFilterRequest": {
2465 "description": "Sets the basic filter associated with a sheet.",
2466 "id": "SetBasicFilterRequest",
2467 "properties": {
2468 "filter": {
2469 "$ref": "BasicFilter",
2470 "description": "The filter to set."
2471 }
2472 },
2473 "type": "object"
2474 },
2475 "ClearValuesRequest": { 1615 "ClearValuesRequest": {
2476 "description": "The request for clearing a range of values in a spre adsheet.", 1616 "description": "The request for clearing a range of values in a spre adsheet.",
2477 "id": "ClearValuesRequest", 1617 "id": "ClearValuesRequest",
2478 "properties": {}, 1618 "properties": {},
2479 "type": "object" 1619 "type": "object"
2480 }, 1620 },
1621 "SetBasicFilterRequest": {
1622 "description": "Sets the basic filter associated with a sheet.",
1623 "id": "SetBasicFilterRequest",
1624 "properties": {
1625 "filter": {
1626 "$ref": "BasicFilter",
1627 "description": "The filter to set."
1628 }
1629 },
1630 "type": "object"
1631 },
2481 "InterpolationPoint": { 1632 "InterpolationPoint": {
2482 "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.", 1633 "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.",
2483 "id": "InterpolationPoint", 1634 "id": "InterpolationPoint",
2484 "properties": { 1635 "properties": {
2485 "value": {
2486 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.",
2487 "type": "string"
2488 },
2489 "color": {
2490 "$ref": "Color",
2491 "description": "The color this interpolation point should us e."
2492 },
2493 "type": { 1636 "type": {
2494 "description": "How the value should be interpreted.", 1637 "description": "How the value should be interpreted.",
2495 "enum": [ 1638 "enum": [
2496 "INTERPOLATION_POINT_TYPE_UNSPECIFIED", 1639 "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
2497 "MIN", 1640 "MIN",
2498 "MAX", 1641 "MAX",
2499 "NUMBER", 1642 "NUMBER",
2500 "PERCENT", 1643 "PERCENT",
2501 "PERCENTILE" 1644 "PERCENTILE"
2502 ], 1645 ],
2503 "enumDescriptions": [ 1646 "enumDescriptions": [
2504 "The default value, do not use.", 1647 "The default value, do not use.",
2505 "The interpolation point will use the minimum value in t he\ncells over the range of the conditional format.", 1648 "The interpolation point will use the minimum value in t he\ncells over the range of the conditional format.",
2506 "The interpolation point will use the maximum value in t he\ncells over the range of the conditional format.", 1649 "The interpolation point will use the maximum value in t he\ncells over the range of the conditional format.",
2507 "The interpolation point will use exactly the value in\n InterpolationPoint.value.", 1650 "The interpolation point will use exactly the value in\n InterpolationPoint.value.",
2508 "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).", 1651 "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).",
2509 "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)." 1652 "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)."
2510 ], 1653 ],
2511 "type": "string" 1654 "type": "string"
1655 },
1656 "value": {
1657 "description": "The value this interpolation point uses. Ma y be a formula.\nUnused if type is MIN or\nMAX.",
1658 "type": "string"
1659 },
1660 "color": {
1661 "$ref": "Color",
1662 "description": "The color this interpolation point should us e."
2512 } 1663 }
2513 }, 1664 },
2514 "type": "object" 1665 "type": "object"
2515 }, 1666 },
2516 "DeleteEmbeddedObjectRequest": { 1667 "DeleteEmbeddedObjectRequest": {
2517 "description": "Deletes the embedded object with the given ID.", 1668 "description": "Deletes the embedded object with the given ID.",
2518 "id": "DeleteEmbeddedObjectRequest", 1669 "id": "DeleteEmbeddedObjectRequest",
2519 "properties": { 1670 "properties": {
2520 "objectId": { 1671 "objectId": {
2521 "description": "The ID of the embedded object to delete.", 1672 "description": "The ID of the embedded object to delete.",
(...skipping 28 matching lines...) Expand all
2550 "type": "integer" 1701 "type": "integer"
2551 }, 1702 },
2552 "formulasChanged": { 1703 "formulasChanged": {
2553 "description": "The number of formula cells changed.", 1704 "description": "The number of formula cells changed.",
2554 "format": "int32", 1705 "format": "int32",
2555 "type": "integer" 1706 "type": "integer"
2556 } 1707 }
2557 }, 1708 },
2558 "type": "object" 1709 "type": "object"
2559 }, 1710 },
1711 "DuplicateFilterViewRequest": {
1712 "description": "Duplicates a particular filter view.",
1713 "id": "DuplicateFilterViewRequest",
1714 "properties": {
1715 "filterId": {
1716 "description": "The ID of the filter being duplicated.",
1717 "format": "int32",
1718 "type": "integer"
1719 }
1720 },
1721 "type": "object"
1722 },
2560 "DeleteSheetRequest": { 1723 "DeleteSheetRequest": {
2561 "description": "Deletes the requested sheet.", 1724 "description": "Deletes the requested sheet.",
2562 "id": "DeleteSheetRequest", 1725 "id": "DeleteSheetRequest",
2563 "properties": { 1726 "properties": {
2564 "sheetId": { 1727 "sheetId": {
2565 "description": "The ID of the sheet to delete.", 1728 "description": "The ID of the sheet to delete.",
2566 "format": "int32", 1729 "format": "int32",
2567 "type": "integer" 1730 "type": "integer"
2568 } 1731 }
2569 }, 1732 },
2570 "type": "object" 1733 "type": "object"
2571 }, 1734 },
2572 "DuplicateFilterViewRequest": {
2573 "description": "Duplicates a particular filter view.",
2574 "id": "DuplicateFilterViewRequest",
2575 "properties": {
2576 "filterId": {
2577 "description": "The ID of the filter being duplicated.",
2578 "format": "int32",
2579 "type": "integer"
2580 }
2581 },
2582 "type": "object"
2583 },
2584 "UpdateConditionalFormatRuleResponse": { 1735 "UpdateConditionalFormatRuleResponse": {
2585 "description": "The result of updating a conditional format rule.", 1736 "description": "The result of updating a conditional format rule.",
2586 "id": "UpdateConditionalFormatRuleResponse", 1737 "id": "UpdateConditionalFormatRuleResponse",
2587 "properties": { 1738 "properties": {
1739 "newRule": {
1740 "$ref": "ConditionalFormatRule",
1741 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
1742 },
1743 "oldIndex": {
1744 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
1745 "format": "int32",
1746 "type": "integer"
1747 },
2588 "oldRule": { 1748 "oldRule": {
2589 "$ref": "ConditionalFormatRule", 1749 "$ref": "ConditionalFormatRule",
2590 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)." 1750 "description": "The old (deleted) rule. Not set if a rule wa s moved\n(because it is the same as new_rule)."
2591 }, 1751 },
2592 "newIndex": { 1752 "newIndex": {
2593 "description": "The index of the new rule.", 1753 "description": "The index of the new rule.",
2594 "format": "int32", 1754 "format": "int32",
2595 "type": "integer" 1755 "type": "integer"
2596 }, 1756 }
2597 "newRule": { 1757 },
2598 "$ref": "ConditionalFormatRule", 1758 "type": "object"
2599 "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)" 1759 },
2600 }, 1760 "DuplicateSheetRequest": {
2601 "oldIndex": { 1761 "description": "Duplicates the contents of a sheet.",
2602 "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).", 1762 "id": "DuplicateSheetRequest",
1763 "properties": {
1764 "newSheetName": {
1765 "description": "The name of the new sheet. If empty, a new name is chosen for you.",
1766 "type": "string"
1767 },
1768 "sourceSheetId": {
1769 "description": "The sheet to duplicate.",
1770 "format": "int32",
1771 "type": "integer"
1772 },
1773 "newSheetId": {
1774 "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.",
1775 "format": "int32",
1776 "type": "integer"
1777 },
1778 "insertSheetIndex": {
1779 "description": "The zero-based index where the new sheet sho uld be inserted.\nThe index of all sheets after this are incremented.",
2603 "format": "int32", 1780 "format": "int32",
2604 "type": "integer" 1781 "type": "integer"
2605 } 1782 }
2606 }, 1783 },
2607 "type": "object" 1784 "type": "object"
2608 }, 1785 },
2609 "ConditionValue": { 1786 "ConditionValue": {
2610 "description": "The value of the condition.", 1787 "description": "The value of the condition.",
2611 "id": "ConditionValue", 1788 "id": "ConditionValue",
2612 "properties": { 1789 "properties": {
(...skipping 19 matching lines...) Expand all
2632 "The value is one week before today.", 1809 "The value is one week before today.",
2633 "The value is yesterday.", 1810 "The value is yesterday.",
2634 "The value is today.", 1811 "The value is today.",
2635 "The value is tomorrow." 1812 "The value is tomorrow."
2636 ], 1813 ],
2637 "type": "string" 1814 "type": "string"
2638 } 1815 }
2639 }, 1816 },
2640 "type": "object" 1817 "type": "object"
2641 }, 1818 },
2642 "DuplicateSheetRequest": {
2643 "description": "Duplicates the contents of a sheet.",
2644 "id": "DuplicateSheetRequest",
2645 "properties": {
2646 "newSheetId": {
2647 "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.",
2648 "format": "int32",
2649 "type": "integer"
2650 },
2651 "insertSheetIndex": {
2652 "description": "The zero-based index where the new sheet sho uld be inserted.\nThe index of all sheets after this are incremented.",
2653 "format": "int32",
2654 "type": "integer"
2655 },
2656 "newSheetName": {
2657 "description": "The name of the new sheet. If empty, a new name is chosen for you.",
2658 "type": "string"
2659 },
2660 "sourceSheetId": {
2661 "description": "The sheet to duplicate.",
2662 "format": "int32",
2663 "type": "integer"
2664 }
2665 },
2666 "type": "object"
2667 },
2668 "ExtendedValue": { 1819 "ExtendedValue": {
2669 "description": "The kinds of value that a cell in a spreadsheet can have.", 1820 "description": "The kinds of value that a cell in a spreadsheet can have.",
2670 "id": "ExtendedValue", 1821 "id": "ExtendedValue",
2671 "properties": { 1822 "properties": {
2672 "errorValue": {
2673 "$ref": "ErrorValue",
2674 "description": "Represents an error.\nThis field is read-onl y."
2675 },
2676 "formulaValue": {
2677 "description": "Represents a formula.",
2678 "type": "string"
2679 },
2680 "boolValue": {
2681 "description": "Represents a boolean value.",
2682 "type": "boolean"
2683 },
2684 "stringValue": {
2685 "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\"`.",
2686 "type": "string"
2687 },
2688 "numberValue": { 1823 "numberValue": {
2689 "description": "Represents a double value.\nNote: Dates, Tim es and DateTimes are represented as doubles in\n\"serial number\" format.", 1824 "description": "Represents a double value.\nNote: Dates, Tim es and DateTimes are represented as doubles in\n\"serial number\" format.",
2690 "format": "double", 1825 "format": "double",
2691 "type": "number" 1826 "type": "number"
2692 } 1827 },
2693 }, 1828 "errorValue": {
2694 "type": "object" 1829 "$ref": "ErrorValue",
2695 }, 1830 "description": "Represents an error.\nThis field is read-onl y."
2696 "BandedRange": { 1831 },
2697 "description": "A banded (alternating colors) range in a sheet.", 1832 "formulaValue": {
2698 "id": "BandedRange", 1833 "description": "Represents a formula.",
2699 "properties": { 1834 "type": "string"
2700 "range": { 1835 },
2701 "$ref": "GridRange", 1836 "boolValue": {
2702 "description": "The range over which these properties are ap plied." 1837 "description": "Represents a boolean value.",
2703 }, 1838 "type": "boolean"
2704 "bandedRangeId": { 1839 },
2705 "description": "The id of the banded range.", 1840 "stringValue": {
2706 "format": "int32", 1841 "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\"`.",
2707 "type": "integer" 1842 "type": "string"
2708 }, 1843 }
2709 "columnProperties": { 1844 },
2710 "$ref": "BandingProperties", 1845 "type": "object"
2711 "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. " 1846 },
2712 }, 1847 "AddChartRequest": {
2713 "rowProperties": { 1848 "description": "Adds a chart to a sheet in the spreadsheet.",
2714 "$ref": "BandingProperties", 1849 "id": "AddChartRequest",
2715 "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." 1850 "properties": {
2716 } 1851 "chart": {
2717 }, 1852 "$ref": "EmbeddedChart",
2718 "type": "object" 1853 "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.)"
2719 }, 1854 }
2720 "HistogramSeries": { 1855 },
2721 "description": "A histogram series containing the series color and d ata.", 1856 "type": "object"
2722 "id": "HistogramSeries", 1857 },
2723 "properties": { 1858 "Spreadsheet": {
2724 "barColor": { 1859 "description": "Resource that represents a spreadsheet.",
2725 "$ref": "Color", 1860 "id": "Spreadsheet",
2726 "description": "The color of the column representing this se ries in each bucket.\nThis field is optional." 1861 "properties": {
2727 }, 1862 "properties": {
2728 "data": { 1863 "$ref": "SpreadsheetProperties",
2729 "$ref": "ChartData", 1864 "description": "Overall properties of a spreadsheet."
2730 "description": "The data for this histogram series." 1865 },
1866 "namedRanges": {
1867 "description": "The named ranges defined in a spreadsheet.",
1868 "items": {
1869 "$ref": "NamedRange"
1870 },
1871 "type": "array"
1872 },
1873 "sheets": {
1874 "description": "The sheets that are part of a spreadsheet.",
1875 "items": {
1876 "$ref": "Sheet"
1877 },
1878 "type": "array"
1879 },
1880 "spreadsheetId": {
1881 "description": "The ID of the spreadsheet.\nThis field is re ad-only.",
1882 "type": "string"
1883 },
1884 "spreadsheetUrl": {
1885 "description": "The url of the spreadsheet.\nThis field is r ead-only.",
1886 "type": "string"
2731 } 1887 }
2732 }, 1888 },
2733 "type": "object" 1889 "type": "object"
2734 }, 1890 },
2735 "BatchClearValuesResponse": { 1891 "BatchClearValuesResponse": {
2736 "description": "The response when clearing a range of values in a sp readsheet.", 1892 "description": "The response when clearing a range of values in a sp readsheet.",
2737 "id": "BatchClearValuesResponse", 1893 "id": "BatchClearValuesResponse",
2738 "properties": { 1894 "properties": {
2739 "spreadsheetId": { 1895 "spreadsheetId": {
2740 "description": "The spreadsheet the updates were applied to. ", 1896 "description": "The spreadsheet the updates were applied to. ",
2741 "type": "string" 1897 "type": "string"
2742 }, 1898 },
2743 "clearedRanges": { 1899 "clearedRanges": {
2744 "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.)", 1900 "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.)",
2745 "items": { 1901 "items": {
2746 "type": "string" 1902 "type": "string"
2747 }, 1903 },
2748 "type": "array" 1904 "type": "array"
2749 } 1905 }
2750 }, 1906 },
2751 "type": "object" 1907 "type": "object"
2752 }, 1908 },
2753 "Spreadsheet": { 1909 "BandedRange": {
2754 "description": "Resource that represents a spreadsheet.", 1910 "description": "A banded (alternating colors) range in a sheet.",
2755 "id": "Spreadsheet", 1911 "id": "BandedRange",
2756 "properties": { 1912 "properties": {
2757 "properties": { 1913 "columnProperties": {
2758 "$ref": "SpreadsheetProperties", 1914 "$ref": "BandingProperties",
2759 "description": "Overall properties of a spreadsheet." 1915 "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. "
2760 }, 1916 },
2761 "namedRanges": { 1917 "rowProperties": {
2762 "description": "The named ranges defined in a spreadsheet.", 1918 "$ref": "BandingProperties",
2763 "items": { 1919 "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."
2764 "$ref": "NamedRange" 1920 },
2765 }, 1921 "range": {
2766 "type": "array" 1922 "$ref": "GridRange",
2767 }, 1923 "description": "The range over which these properties are ap plied."
2768 "sheets": { 1924 },
2769 "description": "The sheets that are part of a spreadsheet.", 1925 "bandedRangeId": {
2770 "items": { 1926 "description": "The id of the banded range.",
2771 "$ref": "Sheet" 1927 "format": "int32",
2772 }, 1928 "type": "integer"
2773 "type": "array" 1929 }
2774 }, 1930 },
2775 "spreadsheetId": { 1931 "type": "object"
2776 "description": "The ID of the spreadsheet.\nThis field is re ad-only.", 1932 },
2777 "type": "string" 1933 "HistogramSeries": {
2778 }, 1934 "description": "A histogram series containing the series color and d ata.",
2779 "spreadsheetUrl": { 1935 "id": "HistogramSeries",
2780 "description": "The url of the spreadsheet.\nThis field is r ead-only.", 1936 "properties": {
2781 "type": "string" 1937 "barColor": {
2782 } 1938 "$ref": "Color",
2783 }, 1939 "description": "The color of the column representing this se ries in each bucket.\nThis field is optional."
2784 "type": "object" 1940 },
2785 }, 1941 "data": {
2786 "AddChartRequest": { 1942 "$ref": "ChartData",
2787 "description": "Adds a chart to a sheet in the spreadsheet.", 1943 "description": "The data for this histogram series."
2788 "id": "AddChartRequest",
2789 "properties": {
2790 "chart": {
2791 "$ref": "EmbeddedChart",
2792 "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.)"
2793 } 1944 }
2794 }, 1945 },
2795 "type": "object" 1946 "type": "object"
2796 }, 1947 },
2797 "UpdateProtectedRangeRequest": { 1948 "UpdateProtectedRangeRequest": {
2798 "description": "Updates an existing protected range with the specifi ed\nprotectedRangeId.", 1949 "description": "Updates an existing protected range with the specifi ed\nprotectedRangeId.",
2799 "id": "UpdateProtectedRangeRequest", 1950 "id": "UpdateProtectedRangeRequest",
2800 "properties": { 1951 "properties": {
2801 "fields": { 1952 "fields": {
2802 "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.", 1953 "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.",
2803 "format": "google-fieldmask", 1954 "format": "google-fieldmask",
2804 "type": "string" 1955 "type": "string"
2805 }, 1956 },
2806 "protectedRange": { 1957 "protectedRange": {
2807 "$ref": "ProtectedRange", 1958 "$ref": "ProtectedRange",
2808 "description": "The protected range to update with the new p roperties." 1959 "description": "The protected range to update with the new p roperties."
2809 } 1960 }
2810 }, 1961 },
2811 "type": "object" 1962 "type": "object"
2812 }, 1963 },
2813 "TextFormat": { 1964 "TextFormat": {
2814 "description": "The format of a run of text in a cell.\nAbsent value s indicate that the field isn't specified.", 1965 "description": "The format of a run of text in a cell.\nAbsent value s indicate that the field isn't specified.",
2815 "id": "TextFormat", 1966 "id": "TextFormat",
2816 "properties": { 1967 "properties": {
1968 "foregroundColor": {
1969 "$ref": "Color",
1970 "description": "The foreground color of the text."
1971 },
1972 "bold": {
1973 "description": "True if the text is bold.",
1974 "type": "boolean"
1975 },
2817 "fontFamily": { 1976 "fontFamily": {
2818 "description": "The font family.", 1977 "description": "The font family.",
2819 "type": "string" 1978 "type": "string"
2820 }, 1979 },
1980 "strikethrough": {
1981 "description": "True if the text has a strikethrough.",
1982 "type": "boolean"
1983 },
2821 "italic": { 1984 "italic": {
2822 "description": "True if the text is italicized.", 1985 "description": "True if the text is italicized.",
2823 "type": "boolean" 1986 "type": "boolean"
2824 }, 1987 },
2825 "strikethrough": {
2826 "description": "True if the text has a strikethrough.",
2827 "type": "boolean"
2828 },
2829 "fontSize": { 1988 "fontSize": {
2830 "description": "The size of the font.", 1989 "description": "The size of the font.",
2831 "format": "int32", 1990 "format": "int32",
2832 "type": "integer" 1991 "type": "integer"
2833 }, 1992 },
2834 "underline": { 1993 "underline": {
2835 "description": "True if the text is underlined.", 1994 "description": "True if the text is underlined.",
2836 "type": "boolean" 1995 "type": "boolean"
2837 },
2838 "bold": {
2839 "description": "True if the text is bold.",
2840 "type": "boolean"
2841 },
2842 "foregroundColor": {
2843 "$ref": "Color",
2844 "description": "The foreground color of the text."
2845 } 1996 }
2846 }, 1997 },
2847 "type": "object" 1998 "type": "object"
2848 }, 1999 },
2849 "AddSheetResponse": { 2000 "AddSheetResponse": {
2850 "description": "The result of adding a sheet.", 2001 "description": "The result of adding a sheet.",
2851 "id": "AddSheetResponse", 2002 "id": "AddSheetResponse",
2852 "properties": { 2003 "properties": {
2853 "properties": { 2004 "properties": {
2854 "$ref": "SheetProperties", 2005 "$ref": "SheetProperties",
(...skipping 10 matching lines...) Expand all
2865 "$ref": "FilterView", 2016 "$ref": "FilterView",
2866 "description": "The newly added filter view." 2017 "description": "The newly added filter view."
2867 } 2018 }
2868 }, 2019 },
2869 "type": "object" 2020 "type": "object"
2870 }, 2021 },
2871 "IterativeCalculationSettings": { 2022 "IterativeCalculationSettings": {
2872 "description": "Settings to control how circular dependencies are re solved with iterative\ncalculation.", 2023 "description": "Settings to control how circular dependencies are re solved with iterative\ncalculation.",
2873 "id": "IterativeCalculationSettings", 2024 "id": "IterativeCalculationSettings",
2874 "properties": { 2025 "properties": {
2026 "maxIterations": {
2027 "description": "When iterative calculation is enabled, the m aximum number of calculation\nrounds to perform.",
2028 "format": "int32",
2029 "type": "integer"
2030 },
2875 "convergenceThreshold": { 2031 "convergenceThreshold": {
2876 "description": "When iterative calculation is enabled and su ccessive results differ by\nless than this threshold value, the calculation roun ds stop.", 2032 "description": "When iterative calculation is enabled and su ccessive results differ by\nless than this threshold value, the calculation roun ds stop.",
2877 "format": "double", 2033 "format": "double",
2878 "type": "number" 2034 "type": "number"
2879 },
2880 "maxIterations": {
2881 "description": "When iterative calculation is enabled, the m aximum number of calculation\nrounds to perform.",
2882 "format": "int32",
2883 "type": "integer"
2884 } 2035 }
2885 }, 2036 },
2886 "type": "object" 2037 "type": "object"
2887 }, 2038 },
2888 "OverlayPosition": { 2039 "OverlayPosition": {
2889 "description": "The location an object is overlaid on top of a grid. ", 2040 "description": "The location an object is overlaid on top of a grid. ",
2890 "id": "OverlayPosition", 2041 "id": "OverlayPosition",
2891 "properties": { 2042 "properties": {
2043 "heightPixels": {
2044 "description": "The height of the object, in pixels. Default s to 371.",
2045 "format": "int32",
2046 "type": "integer"
2047 },
2048 "offsetYPixels": {
2049 "description": "The vertical offset, in pixels, that the obj ect is offset\nfrom the anchor cell.",
2050 "format": "int32",
2051 "type": "integer"
2052 },
2053 "widthPixels": {
2054 "description": "The width of the object, in pixels. Defaults to 600.",
2055 "format": "int32",
2056 "type": "integer"
2057 },
2892 "offsetXPixels": { 2058 "offsetXPixels": {
2893 "description": "The horizontal offset, in pixels, that the o bject is offset\nfrom the anchor cell.", 2059 "description": "The horizontal offset, in pixels, that the o bject is offset\nfrom the anchor cell.",
2894 "format": "int32", 2060 "format": "int32",
2895 "type": "integer" 2061 "type": "integer"
2896 }, 2062 },
2897 "anchorCell": { 2063 "anchorCell": {
2898 "$ref": "GridCoordinate", 2064 "$ref": "GridCoordinate",
2899 "description": "The cell the object is anchored to." 2065 "description": "The cell the object is anchored to."
2900 },
2901 "heightPixels": {
2902 "description": "The height of the object, in pixels. Default s to 371.",
2903 "format": "int32",
2904 "type": "integer"
2905 },
2906 "offsetYPixels": {
2907 "description": "The vertical offset, in pixels, that the obj ect is offset\nfrom the anchor cell.",
2908 "format": "int32",
2909 "type": "integer"
2910 },
2911 "widthPixels": {
2912 "description": "The width of the object, in pixels. Defaults to 600.",
2913 "format": "int32",
2914 "type": "integer"
2915 } 2066 }
2916 }, 2067 },
2917 "type": "object" 2068 "type": "object"
2918 }, 2069 },
2919 "SpreadsheetProperties": { 2070 "SpreadsheetProperties": {
2920 "description": "Properties of a spreadsheet.", 2071 "description": "Properties of a spreadsheet.",
2921 "id": "SpreadsheetProperties", 2072 "id": "SpreadsheetProperties",
2922 "properties": { 2073 "properties": {
2923 "locale": {
2924 "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.",
2925 "type": "string"
2926 },
2927 "iterativeCalculationSettings": { 2074 "iterativeCalculationSettings": {
2928 "$ref": "IterativeCalculationSettings", 2075 "$ref": "IterativeCalculationSettings",
2929 "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." 2076 "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."
2930 }, 2077 },
2078 "defaultFormat": {
2079 "$ref": "CellFormat",
2080 "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."
2081 },
2931 "autoRecalc": { 2082 "autoRecalc": {
2932 "description": "The amount of time to wait before volatile f unctions are recalculated.", 2083 "description": "The amount of time to wait before volatile f unctions are recalculated.",
2933 "enum": [ 2084 "enum": [
2934 "RECALCULATION_INTERVAL_UNSPECIFIED", 2085 "RECALCULATION_INTERVAL_UNSPECIFIED",
2935 "ON_CHANGE", 2086 "ON_CHANGE",
2936 "MINUTE", 2087 "MINUTE",
2937 "HOUR" 2088 "HOUR"
2938 ], 2089 ],
2939 "enumDescriptions": [ 2090 "enumDescriptions": [
2940 "Default value. This value must not be used.", 2091 "Default value. This value must not be used.",
2941 "Volatile functions are updated on every change.", 2092 "Volatile functions are updated on every change.",
2942 "Volatile functions are updated on every change and ever y minute.", 2093 "Volatile functions are updated on every change and ever y minute.",
2943 "Volatile functions are updated on every change and hour ly." 2094 "Volatile functions are updated on every change and hour ly."
2944 ], 2095 ],
2945 "type": "string" 2096 "type": "string"
2946 }, 2097 },
2947 "defaultFormat": { 2098 "title": {
2948 "$ref": "CellFormat", 2099 "description": "The title of the spreadsheet.",
2949 "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." 2100 "type": "string"
2950 }, 2101 },
2951 "timeZone": { 2102 "timeZone": {
2952 "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`.", 2103 "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`.",
2953 "type": "string" 2104 "type": "string"
2954 }, 2105 },
2955 "title": { 2106 "locale": {
2956 "description": "The title of the spreadsheet.", 2107 "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.",
2957 "type": "string" 2108 "type": "string"
2958 } 2109 }
2959 }, 2110 },
2960 "type": "object" 2111 "type": "object"
2961 }, 2112 },
2962 "RepeatCellRequest": { 2113 "RepeatCellRequest": {
2963 "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. ", 2114 "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. ",
2964 "id": "RepeatCellRequest", 2115 "id": "RepeatCellRequest",
2965 "properties": { 2116 "properties": {
2117 "range": {
2118 "$ref": "GridRange",
2119 "description": "The range to repeat the cell in."
2120 },
2121 "fields": {
2122 "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.",
2123 "format": "google-fieldmask",
2124 "type": "string"
2125 },
2966 "cell": { 2126 "cell": {
2967 "$ref": "CellData", 2127 "$ref": "CellData",
2968 "description": "The data to write." 2128 "description": "The data to write."
2969 },
2970 "range": {
2971 "$ref": "GridRange",
2972 "description": "The range to repeat the cell in."
2973 },
2974 "fields": {
2975 "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.",
2976 "format": "google-fieldmask",
2977 "type": "string"
2978 } 2129 }
2979 }, 2130 },
2980 "type": "object" 2131 "type": "object"
2981 }, 2132 },
2982 "AddChartResponse": { 2133 "AddChartResponse": {
2983 "description": "The result of adding a chart to a spreadsheet.", 2134 "description": "The result of adding a chart to a spreadsheet.",
2984 "id": "AddChartResponse", 2135 "id": "AddChartResponse",
2985 "properties": { 2136 "properties": {
2986 "chart": { 2137 "chart": {
2987 "$ref": "EmbeddedChart", 2138 "$ref": "EmbeddedChart",
2988 "description": "The newly added chart." 2139 "description": "The newly added chart."
2989 } 2140 }
2990 }, 2141 },
2991 "type": "object" 2142 "type": "object"
2992 }, 2143 },
2993 "InsertDimensionRequest": { 2144 "InsertDimensionRequest": {
2994 "description": "Inserts rows or columns in a sheet at a particular i ndex.", 2145 "description": "Inserts rows or columns in a sheet at a particular i ndex.",
2995 "id": "InsertDimensionRequest", 2146 "id": "InsertDimensionRequest",
2996 "properties": { 2147 "properties": {
2148 "range": {
2149 "$ref": "DimensionRange",
2150 "description": "The dimensions to insert. Both the start an d end indexes must be bounded."
2151 },
2997 "inheritFromBefore": { 2152 "inheritFromBefore": {
2998 "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). ", 2153 "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). ",
2999 "type": "boolean" 2154 "type": "boolean"
3000 },
3001 "range": {
3002 "$ref": "DimensionRange",
3003 "description": "The dimensions to insert. Both the start an d end indexes must be bounded."
3004 } 2155 }
3005 }, 2156 },
3006 "type": "object" 2157 "type": "object"
3007 }, 2158 },
3008 "UpdateSpreadsheetPropertiesRequest": { 2159 "UpdateSpreadsheetPropertiesRequest": {
3009 "description": "Updates properties of a spreadsheet.", 2160 "description": "Updates properties of a spreadsheet.",
3010 "id": "UpdateSpreadsheetPropertiesRequest", 2161 "id": "UpdateSpreadsheetPropertiesRequest",
3011 "properties": { 2162 "properties": {
2163 "fields": {
2164 "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 .",
2165 "format": "google-fieldmask",
2166 "type": "string"
2167 },
3012 "properties": { 2168 "properties": {
3013 "$ref": "SpreadsheetProperties", 2169 "$ref": "SpreadsheetProperties",
3014 "description": "The properties to update." 2170 "description": "The properties to update."
3015 },
3016 "fields": {
3017 "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 .",
3018 "format": "google-fieldmask",
3019 "type": "string"
3020 } 2171 }
3021 }, 2172 },
3022 "type": "object" 2173 "type": "object"
3023 }, 2174 },
3024 "BatchUpdateValuesRequest": { 2175 "BatchUpdateValuesRequest": {
3025 "description": "The request for updating more than one range of valu es in a spreadsheet.", 2176 "description": "The request for updating more than one range of valu es in a spreadsheet.",
3026 "id": "BatchUpdateValuesRequest", 2177 "id": "BatchUpdateValuesRequest",
3027 "properties": { 2178 "properties": {
3028 "responseValueRenderOption": { 2179 "responseValueRenderOption": {
3029 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", 2180 "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
3076 ], 2227 ],
3077 "type": "string" 2228 "type": "string"
3078 } 2229 }
3079 }, 2230 },
3080 "type": "object" 2231 "type": "object"
3081 }, 2232 },
3082 "ProtectedRange": { 2233 "ProtectedRange": {
3083 "description": "A protected range.", 2234 "description": "A protected range.",
3084 "id": "ProtectedRange", 2235 "id": "ProtectedRange",
3085 "properties": { 2236 "properties": {
3086 "warningOnly": {
3087 "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.",
3088 "type": "boolean"
3089 },
3090 "requestingUserCanEdit": {
3091 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
3092 "type": "boolean"
3093 },
3094 "range": {
3095 "$ref": "GridRange",
3096 "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."
3097 },
3098 "editors": {
3099 "$ref": "Editors",
3100 "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."
3101 },
3102 "description": { 2237 "description": {
3103 "description": "The description of this protected range.", 2238 "description": "The description of this protected range.",
3104 "type": "string" 2239 "type": "string"
3105 }, 2240 },
3106 "unprotectedRanges": { 2241 "unprotectedRanges": {
3107 "description": "The list of unprotected ranges within a prot ected sheet.\nUnprotected ranges are only supported on protected sheets.", 2242 "description": "The list of unprotected ranges within a prot ected sheet.\nUnprotected ranges are only supported on protected sheets.",
3108 "items": { 2243 "items": {
3109 "$ref": "GridRange" 2244 "$ref": "GridRange"
3110 }, 2245 },
3111 "type": "array" 2246 "type": "array"
3112 }, 2247 },
3113 "namedRangeId": { 2248 "namedRangeId": {
3114 "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. ", 2249 "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. ",
3115 "type": "string" 2250 "type": "string"
3116 }, 2251 },
3117 "protectedRangeId": { 2252 "protectedRangeId": {
3118 "description": "The ID of the protected range.\nThis field i s read-only.", 2253 "description": "The ID of the protected range.\nThis field i s read-only.",
3119 "format": "int32", 2254 "format": "int32",
3120 "type": "integer" 2255 "type": "integer"
2256 },
2257 "warningOnly": {
2258 "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.",
2259 "type": "boolean"
2260 },
2261 "requestingUserCanEdit": {
2262 "description": "True if the user who requested this protecte d range can edit the\nprotected area.\nThis field is read-only.",
2263 "type": "boolean"
2264 },
2265 "range": {
2266 "$ref": "GridRange",
2267 "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."
2268 },
2269 "editors": {
2270 "$ref": "Editors",
2271 "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."
3121 } 2272 }
3122 }, 2273 },
3123 "type": "object" 2274 "type": "object"
3124 }, 2275 },
3125 "DimensionProperties": { 2276 "DimensionProperties": {
3126 "description": "Properties about a dimension.", 2277 "description": "Properties about a dimension.",
3127 "id": "DimensionProperties", 2278 "id": "DimensionProperties",
3128 "properties": { 2279 "properties": {
3129 "pixelSize": { 2280 "pixelSize": {
3130 "description": "The height (if a row) or width (if a column) of the dimension in pixels.", 2281 "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
3131 "format": "int32", 2282 "format": "int32",
3132 "type": "integer" 2283 "type": "integer"
3133 }, 2284 },
3134 "hiddenByUser": { 2285 "hiddenByUser": {
3135 "description": "True if this dimension is explicitly hidden. ", 2286 "description": "True if this dimension is explicitly hidden. ",
3136 "type": "boolean" 2287 "type": "boolean"
3137 }, 2288 },
3138 "hiddenByFilter": { 2289 "hiddenByFilter": {
3139 "description": "True if this dimension is being filtered.\nT his field is read-only.", 2290 "description": "True if this dimension is being filtered.\nT his field is read-only.",
3140 "type": "boolean" 2291 "type": "boolean"
3141 } 2292 }
3142 }, 2293 },
3143 "type": "object" 2294 "type": "object"
3144 }, 2295 },
3145 "NamedRange": { 2296 "NamedRange": {
3146 "description": "A named range.", 2297 "description": "A named range.",
3147 "id": "NamedRange", 2298 "id": "NamedRange",
3148 "properties": { 2299 "properties": {
3149 "name": {
3150 "description": "The name of the named range.",
3151 "type": "string"
3152 },
3153 "namedRangeId": { 2300 "namedRangeId": {
3154 "description": "The ID of the named range.", 2301 "description": "The ID of the named range.",
3155 "type": "string" 2302 "type": "string"
3156 }, 2303 },
3157 "range": { 2304 "range": {
3158 "$ref": "GridRange", 2305 "$ref": "GridRange",
3159 "description": "The range this represents." 2306 "description": "The range this represents."
2307 },
2308 "name": {
2309 "description": "The name of the named range.",
2310 "type": "string"
3160 } 2311 }
3161 }, 2312 },
3162 "type": "object" 2313 "type": "object"
3163 }, 2314 },
3164 "DimensionRange": { 2315 "DimensionRange": {
3165 "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.", 2316 "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.",
3166 "id": "DimensionRange", 2317 "id": "DimensionRange",
3167 "properties": { 2318 "properties": {
3168 "dimension": { 2319 "dimension": {
3169 "description": "The dimension of the span.", 2320 "description": "The dimension of the span.",
3170 "enum": [ 2321 "enum": [
3171 "DIMENSION_UNSPECIFIED", 2322 "DIMENSION_UNSPECIFIED",
3172 "ROWS", 2323 "ROWS",
2324 "COLUMNS"
2325 ],
2326 "enumDescriptions": [
2327 "The default value, do not use.",
2328 "Operates on the rows of a sheet.",
2329 "Operates on the columns of a sheet."
2330 ],
2331 "type": "string"
2332 },
2333 "endIndex": {
2334 "description": "The end (exclusive) of the span, or not set if unbounded.",
2335 "format": "int32",
2336 "type": "integer"
2337 },
2338 "startIndex": {
2339 "description": "The start (inclusive) of the span, or not se t if unbounded.",
2340 "format": "int32",
2341 "type": "integer"
2342 },
2343 "sheetId": {
2344 "description": "The sheet this span is on.",
2345 "format": "int32",
2346 "type": "integer"
2347 }
2348 },
2349 "type": "object"
2350 },
2351 "CutPasteRequest": {
2352 "description": "Moves data from the source to the destination.",
2353 "id": "CutPasteRequest",
2354 "properties": {
2355 "pasteType": {
2356 "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
2357 "enum": [
2358 "PASTE_NORMAL",
2359 "PASTE_VALUES",
2360 "PASTE_FORMAT",
2361 "PASTE_NO_BORDERS",
2362 "PASTE_FORMULA",
2363 "PASTE_DATA_VALIDATION",
2364 "PASTE_CONDITIONAL_FORMATTING"
2365 ],
2366 "enumDescriptions": [
2367 "Paste values, formulas, formats, and merges.",
2368 "Paste the values ONLY without formats, formulas, or mer ges.",
2369 "Paste the format and data validation only.",
2370 "Like PASTE_NORMAL but without borders.",
2371 "Paste the formulas only.",
2372 "Paste the data validation only.",
2373 "Paste the conditional formatting rules only."
2374 ],
2375 "type": "string"
2376 },
2377 "source": {
2378 "$ref": "GridRange",
2379 "description": "The source data to cut."
2380 },
2381 "destination": {
2382 "$ref": "GridCoordinate",
2383 "description": "The top-left coordinate where the data shoul d be pasted."
2384 }
2385 },
2386 "type": "object"
2387 },
2388 "Borders": {
2389 "description": "The borders of the cell.",
2390 "id": "Borders",
2391 "properties": {
2392 "right": {
2393 "$ref": "Border",
2394 "description": "The right border of the cell."
2395 },
2396 "bottom": {
2397 "$ref": "Border",
2398 "description": "The bottom border of the cell."
2399 },
2400 "top": {
2401 "$ref": "Border",
2402 "description": "The top border of the cell."
2403 },
2404 "left": {
2405 "$ref": "Border",
2406 "description": "The left border of the cell."
2407 }
2408 },
2409 "type": "object"
2410 },
2411 "BasicChartSeries": {
2412 "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\".",
2413 "id": "BasicChartSeries",
2414 "properties": {
2415 "type": {
2416 "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.",
2417 "enum": [
2418 "BASIC_CHART_TYPE_UNSPECIFIED",
2419 "BAR",
2420 "LINE",
2421 "AREA",
2422 "COLUMN",
2423 "SCATTER",
2424 "COMBO",
2425 "STEPPED_AREA"
2426 ],
2427 "enumDescriptions": [
2428 "Default value, do not use.",
2429 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
2430 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
2431 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
2432 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
2433 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
2434 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>.",
2435 "A <a href=\"/chart/interactive/docs/gallery/steppedarea chart\">stepped area chart</a>."
2436 ],
2437 "type": "string"
2438 },
2439 "series": {
2440 "$ref": "ChartData",
2441 "description": "The data being visualized in this chart seri es."
2442 },
2443 "targetAxis": {
2444 "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.",
2445 "enum": [
2446 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
2447 "BOTTOM_AXIS",
2448 "LEFT_AXIS",
2449 "RIGHT_AXIS"
2450 ],
2451 "enumDescriptions": [
2452 "Default value, do not use.",
2453 "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.",
2454 "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.",
2455 "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."
2456 ],
2457 "type": "string"
2458 }
2459 },
2460 "type": "object"
2461 },
2462 "AutoResizeDimensionsRequest": {
2463 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
2464 "id": "AutoResizeDimensionsRequest",
2465 "properties": {
2466 "dimensions": {
2467 "$ref": "DimensionRange",
2468 "description": "The dimensions to automatically resize.\nOnl y COLUMNS are supported."
2469 }
2470 },
2471 "type": "object"
2472 },
2473 "UpdateBordersRequest": {
2474 "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.",
2475 "id": "UpdateBordersRequest",
2476 "properties": {
2477 "right": {
2478 "$ref": "Border",
2479 "description": "The border to put at the right of the range. "
2480 },
2481 "range": {
2482 "$ref": "GridRange",
2483 "description": "The range whose borders should be updated."
2484 },
2485 "innerHorizontal": {
2486 "$ref": "Border",
2487 "description": "The horizontal border to put within the rang e."
2488 },
2489 "top": {
2490 "$ref": "Border",
2491 "description": "The border to put at the top of the range."
2492 },
2493 "left": {
2494 "$ref": "Border",
2495 "description": "The border to put at the left of the range."
2496 },
2497 "bottom": {
2498 "$ref": "Border",
2499 "description": "The border to put at the bottom of the range ."
2500 },
2501 "innerVertical": {
2502 "$ref": "Border",
2503 "description": "The vertical border to put within the range. "
2504 }
2505 },
2506 "type": "object"
2507 },
2508 "CellFormat": {
2509 "description": "The format of a cell.",
2510 "id": "CellFormat",
2511 "properties": {
2512 "backgroundColor": {
2513 "$ref": "Color",
2514 "description": "The background color of the cell."
2515 },
2516 "verticalAlignment": {
2517 "description": "The vertical alignment of the value in the c ell.",
2518 "enum": [
2519 "VERTICAL_ALIGN_UNSPECIFIED",
2520 "TOP",
2521 "MIDDLE",
2522 "BOTTOM"
2523 ],
2524 "enumDescriptions": [
2525 "The vertical alignment is not specified. Do not use th is.",
2526 "The text is explicitly aligned to the top of the cell." ,
2527 "The text is explicitly aligned to the middle of the cel l.",
2528 "The text is explicitly aligned to the bottom of the cel l."
2529 ],
2530 "type": "string"
2531 },
2532 "padding": {
2533 "$ref": "Padding",
2534 "description": "The padding of the cell."
2535 },
2536 "textDirection": {
2537 "description": "The direction of the text in the cell.",
2538 "enum": [
2539 "TEXT_DIRECTION_UNSPECIFIED",
2540 "LEFT_TO_RIGHT",
2541 "RIGHT_TO_LEFT"
2542 ],
2543 "enumDescriptions": [
2544 "The text direction is not specified. Do not use this.",
2545 "The text direction of left-to-right was set by the user .",
2546 "The text direction of right-to-left was set by the user ."
2547 ],
2548 "type": "string"
2549 },
2550 "borders": {
2551 "$ref": "Borders",
2552 "description": "The borders of the cell."
2553 },
2554 "wrapStrategy": {
2555 "description": "The wrap strategy for the value in the cell. ",
2556 "enum": [
2557 "WRAP_STRATEGY_UNSPECIFIED",
2558 "OVERFLOW_CELL",
2559 "LEGACY_WRAP",
2560 "CLIP",
2561 "WRAP"
2562 ],
2563 "enumDescriptions": [
2564 "The default value, do not use.",
2565 "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. |",
2566 "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. |",
2567 "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. |",
2568 "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. |"
2569 ],
2570 "type": "string"
2571 },
2572 "textRotation": {
2573 "$ref": "TextRotation",
2574 "description": "The rotation applied to text in a cell"
2575 },
2576 "numberFormat": {
2577 "$ref": "NumberFormat",
2578 "description": "A format describing how number values should be represented to the user."
2579 },
2580 "hyperlinkDisplayType": {
2581 "description": "How a hyperlink, if it exists, should be dis played in the cell.",
2582 "enum": [
2583 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
2584 "LINKED",
2585 "PLAIN_TEXT"
2586 ],
2587 "enumDescriptions": [
2588 "The default value: the hyperlink is rendered. Do not us e this.",
2589 "A hyperlink should be explicitly rendered.",
2590 "A hyperlink should not be rendered."
2591 ],
2592 "type": "string"
2593 },
2594 "horizontalAlignment": {
2595 "description": "The horizontal alignment of the value in the cell.",
2596 "enum": [
2597 "HORIZONTAL_ALIGN_UNSPECIFIED",
2598 "LEFT",
2599 "CENTER",
2600 "RIGHT"
2601 ],
2602 "enumDescriptions": [
2603 "The horizontal alignment is not specified. Do not use t his.",
2604 "The text is explicitly aligned to the left of the cell. ",
2605 "The text is explicitly aligned to the center of the cel l.",
2606 "The text is explicitly aligned to the right of the cell ."
2607 ],
2608 "type": "string"
2609 },
2610 "textFormat": {
2611 "$ref": "TextFormat",
2612 "description": "The format of the text in the cell (unless o verridden by a format run)."
2613 }
2614 },
2615 "type": "object"
2616 },
2617 "ClearValuesResponse": {
2618 "description": "The response when clearing a range of values in a sp readsheet.",
2619 "id": "ClearValuesResponse",
2620 "properties": {
2621 "spreadsheetId": {
2622 "description": "The spreadsheet the updates were applied to. ",
2623 "type": "string"
2624 },
2625 "clearedRange": {
2626 "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.)",
2627 "type": "string"
2628 }
2629 },
2630 "type": "object"
2631 },
2632 "DeleteConditionalFormatRuleRequest": {
2633 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
2634 "id": "DeleteConditionalFormatRuleRequest",
2635 "properties": {
2636 "index": {
2637 "description": "The zero-based index of the rule to be delet ed.",
2638 "format": "int32",
2639 "type": "integer"
2640 },
2641 "sheetId": {
2642 "description": "The sheet the rule is being deleted from.",
2643 "format": "int32",
2644 "type": "integer"
2645 }
2646 },
2647 "type": "object"
2648 },
2649 "DeleteNamedRangeRequest": {
2650 "description": "Removes the named range with the given ID from the s preadsheet.",
2651 "id": "DeleteNamedRangeRequest",
2652 "properties": {
2653 "namedRangeId": {
2654 "description": "The ID of the named range to delete.",
2655 "type": "string"
2656 }
2657 },
2658 "type": "object"
2659 },
2660 "AddBandingResponse": {
2661 "description": "The result of adding a banded range.",
2662 "id": "AddBandingResponse",
2663 "properties": {
2664 "bandedRange": {
2665 "$ref": "BandedRange",
2666 "description": "The banded range that was added."
2667 }
2668 },
2669 "type": "object"
2670 },
2671 "ChartData": {
2672 "description": "The data included in a domain or series.",
2673 "id": "ChartData",
2674 "properties": {
2675 "sourceRange": {
2676 "$ref": "ChartSourceRange",
2677 "description": "The source ranges of the data."
2678 }
2679 },
2680 "type": "object"
2681 },
2682 "BatchGetValuesResponse": {
2683 "description": "The response when retrieving more than one range of values in a spreadsheet.",
2684 "id": "BatchGetValuesResponse",
2685 "properties": {
2686 "valueRanges": {
2687 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
2688 "items": {
2689 "$ref": "ValueRange"
2690 },
2691 "type": "array"
2692 },
2693 "spreadsheetId": {
2694 "description": "The ID of the spreadsheet the data was retri eved from.",
2695 "type": "string"
2696 }
2697 },
2698 "type": "object"
2699 },
2700 "UpdateBandingRequest": {
2701 "description": "Updates properties of the supplied banded range.",
2702 "id": "UpdateBandingRequest",
2703 "properties": {
2704 "bandedRange": {
2705 "$ref": "BandedRange",
2706 "description": "The banded range to update with the new prop erties."
2707 },
2708 "fields": {
2709 "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.",
2710 "format": "google-fieldmask",
2711 "type": "string"
2712 }
2713 },
2714 "type": "object"
2715 },
2716 "Color": {
2717 "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 // ...",
2718 "id": "Color",
2719 "properties": {
2720 "red": {
2721 "description": "The amount of red in the color as a value in the interval [0, 1].",
2722 "format": "float",
2723 "type": "number"
2724 },
2725 "alpha": {
2726 "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).",
2727 "format": "float",
2728 "type": "number"
2729 },
2730 "blue": {
2731 "description": "The amount of blue in the color as a value i n the interval [0, 1].",
2732 "format": "float",
2733 "type": "number"
2734 },
2735 "green": {
2736 "description": "The amount of green in the color as a value in the interval [0, 1].",
2737 "format": "float",
2738 "type": "number"
2739 }
2740 },
2741 "type": "object"
2742 },
2743 "PivotGroup": {
2744 "description": "A single grouping (either row or column) in a pivot table.",
2745 "id": "PivotGroup",
2746 "properties": {
2747 "valueBucket": {
2748 "$ref": "PivotGroupSortValueBucket",
2749 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values."
2750 },
2751 "valueMetadata": {
2752 "description": "Metadata about values in the grouping.",
2753 "items": {
2754 "$ref": "PivotGroupValueMetadata"
2755 },
2756 "type": "array"
2757 },
2758 "showTotals": {
2759 "description": "True if the pivot table should include the t otals for this grouping.",
2760 "type": "boolean"
2761 },
2762 "sourceColumnOffset": {
2763 "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`.",
2764 "format": "int32",
2765 "type": "integer"
2766 },
2767 "sortOrder": {
2768 "description": "The order the values in this group should be sorted.",
2769 "enum": [
2770 "SORT_ORDER_UNSPECIFIED",
2771 "ASCENDING",
2772 "DESCENDING"
2773 ],
2774 "enumDescriptions": [
2775 "Default value, do not use this.",
2776 "Sort ascending.",
2777 "Sort descending."
2778 ],
2779 "type": "string"
2780 }
2781 },
2782 "type": "object"
2783 },
2784 "PivotTable": {
2785 "description": "A pivot table.",
2786 "id": "PivotTable",
2787 "properties": {
2788 "values": {
2789 "description": "A list of values to include in the pivot tab le.",
2790 "items": {
2791 "$ref": "PivotValue"
2792 },
2793 "type": "array"
2794 },
2795 "source": {
2796 "$ref": "GridRange",
2797 "description": "The range the pivot table is reading data fr om."
2798 },
2799 "columns": {
2800 "description": "Each column grouping in the pivot table.",
2801 "items": {
2802 "$ref": "PivotGroup"
2803 },
2804 "type": "array"
2805 },
2806 "criteria": {
2807 "additionalProperties": {
2808 "$ref": "PivotFilterCriteria"
2809 },
2810 "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`.",
2811 "type": "object"
2812 },
2813 "rows": {
2814 "description": "Each row grouping in the pivot table.",
2815 "items": {
2816 "$ref": "PivotGroup"
2817 },
2818 "type": "array"
2819 },
2820 "valueLayout": {
2821 "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
2822 "enum": [
2823 "HORIZONTAL",
2824 "VERTICAL"
2825 ],
2826 "enumDescriptions": [
2827 "Values are laid out horizontally (as columns).",
2828 "Values are laid out vertically (as rows)."
2829 ],
2830 "type": "string"
2831 }
2832 },
2833 "type": "object"
2834 },
2835 "ChartSourceRange": {
2836 "description": "Source ranges for a chart.",
2837 "id": "ChartSourceRange",
2838 "properties": {
2839 "sources": {
2840 "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",
2841 "items": {
2842 "$ref": "GridRange"
2843 },
2844 "type": "array"
2845 }
2846 },
2847 "type": "object"
2848 },
2849 "ValueRange": {
2850 "description": "Data within a range of the spreadsheet.",
2851 "id": "ValueRange",
2852 "properties": {
2853 "values": {
2854 "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.",
2855 "items": {
2856 "items": {
2857 "type": "any"
2858 },
2859 "type": "array"
2860 },
2861 "type": "array"
2862 },
2863 "majorDimension": {
2864 "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.",
2865 "enum": [
2866 "DIMENSION_UNSPECIFIED",
2867 "ROWS",
2868 "COLUMNS"
2869 ],
2870 "enumDescriptions": [
2871 "The default value, do not use.",
2872 "Operates on the rows of a sheet.",
2873 "Operates on the columns of a sheet."
2874 ],
2875 "type": "string"
2876 },
2877 "range": {
2878 "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.",
2879 "type": "string"
2880 }
2881 },
2882 "type": "object"
2883 },
2884 "AppendCellsRequest": {
2885 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
2886 "id": "AppendCellsRequest",
2887 "properties": {
2888 "fields": {
2889 "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.",
2890 "format": "google-fieldmask",
2891 "type": "string"
2892 },
2893 "rows": {
2894 "description": "The data to append.",
2895 "items": {
2896 "$ref": "RowData"
2897 },
2898 "type": "array"
2899 },
2900 "sheetId": {
2901 "description": "The sheet ID to append the data to.",
2902 "format": "int32",
2903 "type": "integer"
2904 }
2905 },
2906 "type": "object"
2907 },
2908 "AddBandingRequest": {
2909 "description": "Adds a new banded range to the spreadsheet.",
2910 "id": "AddBandingRequest",
2911 "properties": {
2912 "bandedRange": {
2913 "$ref": "BandedRange",
2914 "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.)"
2915 }
2916 },
2917 "type": "object"
2918 },
2919 "Response": {
2920 "description": "A single response from an update.",
2921 "id": "Response",
2922 "properties": {
2923 "addFilterView": {
2924 "$ref": "AddFilterViewResponse",
2925 "description": "A reply from adding a filter view."
2926 },
2927 "addBanding": {
2928 "$ref": "AddBandingResponse",
2929 "description": "A reply from adding a banded range."
2930 },
2931 "addProtectedRange": {
2932 "$ref": "AddProtectedRangeResponse",
2933 "description": "A reply from adding a protected range."
2934 },
2935 "duplicateSheet": {
2936 "$ref": "DuplicateSheetResponse",
2937 "description": "A reply from duplicating a sheet."
2938 },
2939 "updateEmbeddedObjectPosition": {
2940 "$ref": "UpdateEmbeddedObjectPositionResponse",
2941 "description": "A reply from updating an embedded object's p osition."
2942 },
2943 "deleteConditionalFormatRule": {
2944 "$ref": "DeleteConditionalFormatRuleResponse",
2945 "description": "A reply from deleting a conditional format r ule."
2946 },
2947 "duplicateFilterView": {
2948 "$ref": "DuplicateFilterViewResponse",
2949 "description": "A reply from duplicating a filter view."
2950 },
2951 "addChart": {
2952 "$ref": "AddChartResponse",
2953 "description": "A reply from adding a chart."
2954 },
2955 "findReplace": {
2956 "$ref": "FindReplaceResponse",
2957 "description": "A reply from doing a find/replace."
2958 },
2959 "addSheet": {
2960 "$ref": "AddSheetResponse",
2961 "description": "A reply from adding a sheet."
2962 },
2963 "updateConditionalFormatRule": {
2964 "$ref": "UpdateConditionalFormatRuleResponse",
2965 "description": "A reply from updating a conditional format r ule."
2966 },
2967 "addNamedRange": {
2968 "$ref": "AddNamedRangeResponse",
2969 "description": "A reply from adding a named range."
2970 }
2971 },
2972 "type": "object"
2973 },
2974 "InsertRangeRequest": {
2975 "description": "Inserts cells into a range, shifting the existing ce lls over or down.",
2976 "id": "InsertRangeRequest",
2977 "properties": {
2978 "shiftDimension": {
2979 "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.",
2980 "enum": [
2981 "DIMENSION_UNSPECIFIED",
2982 "ROWS",
3173 "COLUMNS" 2983 "COLUMNS"
3174 ], 2984 ],
3175 "enumDescriptions": [ 2985 "enumDescriptions": [
3176 "The default value, do not use.", 2986 "The default value, do not use.",
3177 "Operates on the rows of a sheet.", 2987 "Operates on the rows of a sheet.",
3178 "Operates on the columns of a sheet." 2988 "Operates on the columns of a sheet."
3179 ], 2989 ],
3180 "type": "string" 2990 "type": "string"
3181 }, 2991 },
3182 "endIndex": { 2992 "range": {
3183 "description": "The end (exclusive) of the span, or not set if unbounded.", 2993 "$ref": "GridRange",
3184 "format": "int32", 2994 "description": "The range to insert new cells into."
3185 "type": "integer" 2995 }
3186 }, 2996 },
2997 "type": "object"
2998 },
2999 "TextFormatRun": {
3000 "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.",
3001 "id": "TextFormatRun",
3002 "properties": {
3187 "startIndex": { 3003 "startIndex": {
3188 "description": "The start (inclusive) of the span, or not se t if unbounded.", 3004 "description": "The character index where this run starts.",
3189 "format": "int32", 3005 "format": "int32",
3190 "type": "integer" 3006 "type": "integer"
3007 },
3008 "format": {
3009 "$ref": "TextFormat",
3010 "description": "The format of this run. Absent values inher it the cell's format."
3011 }
3012 },
3013 "type": "object"
3014 },
3015 "EmbeddedChart": {
3016 "description": "A chart embedded in a sheet.",
3017 "id": "EmbeddedChart",
3018 "properties": {
3019 "chartId": {
3020 "description": "The ID of the chart.",
3021 "format": "int32",
3022 "type": "integer"
3023 },
3024 "position": {
3025 "$ref": "EmbeddedObjectPosition",
3026 "description": "The position of the chart."
3027 },
3028 "spec": {
3029 "$ref": "ChartSpec",
3030 "description": "The specification of the chart."
3031 }
3032 },
3033 "type": "object"
3034 },
3035 "AddNamedRangeResponse": {
3036 "description": "The result of adding a named range.",
3037 "id": "AddNamedRangeResponse",
3038 "properties": {
3039 "namedRange": {
3040 "$ref": "NamedRange",
3041 "description": "The named range to add."
3042 }
3043 },
3044 "type": "object"
3045 },
3046 "RowData": {
3047 "description": "Data about each cell in a row.",
3048 "id": "RowData",
3049 "properties": {
3050 "values": {
3051 "description": "The values in the row, one per column.",
3052 "items": {
3053 "$ref": "CellData"
3054 },
3055 "type": "array"
3056 }
3057 },
3058 "type": "object"
3059 },
3060 "GridData": {
3061 "description": "Data in the grid, as well as metadata about the dime nsions.",
3062 "id": "GridData",
3063 "properties": {
3064 "rowData": {
3065 "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.",
3066 "items": {
3067 "$ref": "RowData"
3068 },
3069 "type": "array"
3070 },
3071 "startRow": {
3072 "description": "The first row this GridData refers to, zero- based.",
3073 "format": "int32",
3074 "type": "integer"
3075 },
3076 "columnMetadata": {
3077 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
3078 "items": {
3079 "$ref": "DimensionProperties"
3080 },
3081 "type": "array"
3082 },
3083 "startColumn": {
3084 "description": "The first column this GridData refers to, ze ro-based.",
3085 "format": "int32",
3086 "type": "integer"
3087 },
3088 "rowMetadata": {
3089 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
3090 "items": {
3091 "$ref": "DimensionProperties"
3092 },
3093 "type": "array"
3094 }
3095 },
3096 "type": "object"
3097 },
3098 "Border": {
3099 "description": "A border along a cell.",
3100 "id": "Border",
3101 "properties": {
3102 "color": {
3103 "$ref": "Color",
3104 "description": "The color of the border."
3105 },
3106 "width": {
3107 "description": "The width of the border, in pixels.\nDepreca ted; the width is determined by the \"style\" field.",
3108 "format": "int32",
3109 "type": "integer"
3110 },
3111 "style": {
3112 "description": "The style of the border.",
3113 "enum": [
3114 "STYLE_UNSPECIFIED",
3115 "DOTTED",
3116 "DASHED",
3117 "SOLID",
3118 "SOLID_MEDIUM",
3119 "SOLID_THICK",
3120 "NONE",
3121 "DOUBLE"
3122 ],
3123 "enumDescriptions": [
3124 "The style is not specified. Do not use this.",
3125 "The border is dotted.",
3126 "The border is dashed.",
3127 "The border is a thin solid line.",
3128 "The border is a medium solid line.",
3129 "The border is a thick solid line.",
3130 "No border.\nUsed only when updating a border in order t o erase it.",
3131 "The border is two solid lines."
3132 ],
3133 "type": "string"
3134 }
3135 },
3136 "type": "object"
3137 },
3138 "FindReplaceRequest": {
3139 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.",
3140 "id": "FindReplaceRequest",
3141 "properties": {
3142 "searchByRegex": {
3143 "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.",
3144 "type": "boolean"
3145 },
3146 "find": {
3147 "description": "The value to search.",
3148 "type": "string"
3149 },
3150 "replacement": {
3151 "description": "The value to use as the replacement.",
3152 "type": "string"
3153 },
3154 "range": {
3155 "$ref": "GridRange",
3156 "description": "The range to find/replace over."
3191 }, 3157 },
3192 "sheetId": { 3158 "sheetId": {
3193 "description": "The sheet this span is on.", 3159 "description": "The sheet to find/replace over.",
3194 "format": "int32", 3160 "format": "int32",
3195 "type": "integer" 3161 "type": "integer"
3196 } 3162 },
3197 }, 3163 "matchCase": {
3198 "type": "object" 3164 "description": "True if the search is case sensitive.",
3199 }, 3165 "type": "boolean"
3200 "CutPasteRequest": { 3166 },
3201 "description": "Moves data from the source to the destination.", 3167 "allSheets": {
3202 "id": "CutPasteRequest", 3168 "description": "True to find/replace over all sheets.",
3203 "properties": { 3169 "type": "boolean"
3204 "destination": { 3170 },
3171 "includeFormulas": {
3172 "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
3173 "type": "boolean"
3174 },
3175 "matchEntireCell": {
3176 "description": "True if the find value should match the enti re cell.",
3177 "type": "boolean"
3178 }
3179 },
3180 "type": "object"
3181 },
3182 "UpdateNamedRangeRequest": {
3183 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
3184 "id": "UpdateNamedRangeRequest",
3185 "properties": {
3186 "namedRange": {
3187 "$ref": "NamedRange",
3188 "description": "The named range to update with the new prope rties."
3189 },
3190 "fields": {
3191 "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 .",
3192 "format": "google-fieldmask",
3193 "type": "string"
3194 }
3195 },
3196 "type": "object"
3197 },
3198 "AddSheetRequest": {
3199 "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.",
3200 "id": "AddSheetRequest",
3201 "properties": {
3202 "properties": {
3203 "$ref": "SheetProperties",
3204 "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.)"
3205 }
3206 },
3207 "type": "object"
3208 },
3209 "UpdateCellsRequest": {
3210 "description": "Updates all cells in a range with new data.",
3211 "id": "UpdateCellsRequest",
3212 "properties": {
3213 "start": {
3205 "$ref": "GridCoordinate", 3214 "$ref": "GridCoordinate",
3206 "description": "The top-left coordinate where the data shoul d be pasted." 3215 "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."
3207 }, 3216 },
3208 "pasteType": { 3217 "range": {
3209 "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.", 3218 "$ref": "GridRange",
3219 "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."
3220 },
3221 "fields": {
3222 "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.",
3223 "format": "google-fieldmask",
3224 "type": "string"
3225 },
3226 "rows": {
3227 "description": "The data to write.",
3228 "items": {
3229 "$ref": "RowData"
3230 },
3231 "type": "array"
3232 }
3233 },
3234 "type": "object"
3235 },
3236 "DeleteConditionalFormatRuleResponse": {
3237 "description": "The result of deleting a conditional format rule.",
3238 "id": "DeleteConditionalFormatRuleResponse",
3239 "properties": {
3240 "rule": {
3241 "$ref": "ConditionalFormatRule",
3242 "description": "The rule that was deleted."
3243 }
3244 },
3245 "type": "object"
3246 },
3247 "RandomizeRangeRequest": {
3248 "description": "Randomizes the order of the rows in a range.",
3249 "id": "RandomizeRangeRequest",
3250 "properties": {
3251 "range": {
3252 "$ref": "GridRange",
3253 "description": "The range to randomize."
3254 }
3255 },
3256 "type": "object"
3257 },
3258 "DeleteRangeRequest": {
3259 "description": "Deletes a range of cells, shifting other cells into the deleted area.",
3260 "id": "DeleteRangeRequest",
3261 "properties": {
3262 "shiftDimension": {
3263 "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.",
3210 "enum": [ 3264 "enum": [
3211 "PASTE_NORMAL", 3265 "DIMENSION_UNSPECIFIED",
3212 "PASTE_VALUES", 3266 "ROWS",
3213 "PASTE_FORMAT", 3267 "COLUMNS"
3214 "PASTE_NO_BORDERS",
3215 "PASTE_FORMULA",
3216 "PASTE_DATA_VALIDATION",
3217 "PASTE_CONDITIONAL_FORMATTING"
3218 ],
3219 "enumDescriptions": [
3220 "Paste values, formulas, formats, and merges.",
3221 "Paste the values ONLY without formats, formulas, or mer ges.",
3222 "Paste the format and data validation only.",
3223 "Like PASTE_NORMAL but without borders.",
3224 "Paste the formulas only.",
3225 "Paste the data validation only.",
3226 "Paste the conditional formatting rules only."
3227 ],
3228 "type": "string"
3229 },
3230 "source": {
3231 "$ref": "GridRange",
3232 "description": "The source data to cut."
3233 }
3234 },
3235 "type": "object"
3236 },
3237 "Borders": {
3238 "description": "The borders of the cell.",
3239 "id": "Borders",
3240 "properties": {
3241 "right": {
3242 "$ref": "Border",
3243 "description": "The right border of the cell."
3244 },
3245 "bottom": {
3246 "$ref": "Border",
3247 "description": "The bottom border of the cell."
3248 },
3249 "top": {
3250 "$ref": "Border",
3251 "description": "The top border of the cell."
3252 },
3253 "left": {
3254 "$ref": "Border",
3255 "description": "The left border of the cell."
3256 }
3257 },
3258 "type": "object"
3259 },
3260 "BasicChartSeries": {
3261 "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\".",
3262 "id": "BasicChartSeries",
3263 "properties": {
3264 "targetAxis": {
3265 "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.",
3266 "enum": [
3267 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
3268 "BOTTOM_AXIS",
3269 "LEFT_AXIS",
3270 "RIGHT_AXIS"
3271 ],
3272 "enumDescriptions": [
3273 "Default value, do not use.",
3274 "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.",
3275 "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.",
3276 "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."
3277 ],
3278 "type": "string"
3279 },
3280 "type": {
3281 "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.",
3282 "enum": [
3283 "BASIC_CHART_TYPE_UNSPECIFIED",
3284 "BAR",
3285 "LINE",
3286 "AREA",
3287 "COLUMN",
3288 "SCATTER",
3289 "COMBO",
3290 "STEPPED_AREA"
3291 ],
3292 "enumDescriptions": [
3293 "Default value, do not use.",
3294 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
3295 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
3296 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
3297 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
3298 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
3299 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>.",
3300 "A <a href=\"/chart/interactive/docs/gallery/steppedarea chart\">stepped area chart</a>."
3301 ],
3302 "type": "string"
3303 },
3304 "series": {
3305 "$ref": "ChartData",
3306 "description": "The data being visualized in this chart seri es."
3307 }
3308 },
3309 "type": "object"
3310 },
3311 "AutoResizeDimensionsRequest": {
3312 "description": "Automatically resizes one or more dimensions based o n the contents\nof the cells in that dimension.",
3313 "id": "AutoResizeDimensionsRequest",
3314 "properties": {
3315 "dimensions": {
3316 "$ref": "DimensionRange",
3317 "description": "The dimensions to automatically resize.\nOnl y COLUMNS are supported."
3318 }
3319 },
3320 "type": "object"
3321 },
3322 "UpdateBordersRequest": {
3323 "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.",
3324 "id": "UpdateBordersRequest",
3325 "properties": {
3326 "innerHorizontal": {
3327 "$ref": "Border",
3328 "description": "The horizontal border to put within the rang e."
3329 },
3330 "top": {
3331 "$ref": "Border",
3332 "description": "The border to put at the top of the range."
3333 },
3334 "left": {
3335 "$ref": "Border",
3336 "description": "The border to put at the left of the range."
3337 },
3338 "bottom": {
3339 "$ref": "Border",
3340 "description": "The border to put at the bottom of the range ."
3341 },
3342 "innerVertical": {
3343 "$ref": "Border",
3344 "description": "The vertical border to put within the range. "
3345 },
3346 "right": {
3347 "$ref": "Border",
3348 "description": "The border to put at the right of the range. "
3349 },
3350 "range": {
3351 "$ref": "GridRange",
3352 "description": "The range whose borders should be updated."
3353 }
3354 },
3355 "type": "object"
3356 },
3357 "CellFormat": {
3358 "description": "The format of a cell.",
3359 "id": "CellFormat",
3360 "properties": {
3361 "textDirection": {
3362 "description": "The direction of the text in the cell.",
3363 "enum": [
3364 "TEXT_DIRECTION_UNSPECIFIED",
3365 "LEFT_TO_RIGHT",
3366 "RIGHT_TO_LEFT"
3367 ],
3368 "enumDescriptions": [
3369 "The text direction is not specified. Do not use this.",
3370 "The text direction of left-to-right was set by the user .",
3371 "The text direction of right-to-left was set by the user ."
3372 ],
3373 "type": "string"
3374 },
3375 "borders": {
3376 "$ref": "Borders",
3377 "description": "The borders of the cell."
3378 },
3379 "wrapStrategy": {
3380 "description": "The wrap strategy for the value in the cell. ",
3381 "enum": [
3382 "WRAP_STRATEGY_UNSPECIFIED",
3383 "OVERFLOW_CELL",
3384 "LEGACY_WRAP",
3385 "CLIP",
3386 "WRAP"
3387 ], 3268 ],
3388 "enumDescriptions": [ 3269 "enumDescriptions": [
3389 "The default value, do not use.", 3270 "The default value, do not use.",
3390 "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. |", 3271 "Operates on the rows of a sheet.",
3391 "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. |", 3272 "Operates on the columns of a sheet."
3392 "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. |", 3273 ],
3393 "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. |" 3274 "type": "string"
3394 ], 3275 },
3395 "type": "string" 3276 "range": {
3396 }, 3277 "$ref": "GridRange",
3397 "textRotation": { 3278 "description": "The range of cells to delete."
3398 "$ref": "TextRotation", 3279 }
3399 "description": "The rotation applied to text in a cell" 3280 },
3400 }, 3281 "type": "object"
3401 "numberFormat": { 3282 },
3402 "$ref": "NumberFormat", 3283 "GridCoordinate": {
3403 "description": "A format describing how number values should be represented to the user." 3284 "description": "A coordinate in a sheet.\nAll indexes are zero-based .",
3404 }, 3285 "id": "GridCoordinate",
3405 "hyperlinkDisplayType": { 3286 "properties": {
3406 "description": "How a hyperlink, if it exists, should be dis played in the cell.", 3287 "columnIndex": {
3407 "enum": [ 3288 "description": "The column index of the coordinate.",
3408 "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED", 3289 "format": "int32",
3409 "LINKED", 3290 "type": "integer"
3410 "PLAIN_TEXT" 3291 },
3411 ], 3292 "rowIndex": {
3412 "enumDescriptions": [ 3293 "description": "The row index of the coordinate.",
3413 "The default value: the hyperlink is rendered. Do not us e this.", 3294 "format": "int32",
3414 "A hyperlink should be explicitly rendered.", 3295 "type": "integer"
3415 "A hyperlink should not be rendered." 3296 },
3416 ],
3417 "type": "string"
3418 },
3419 "horizontalAlignment": {
3420 "description": "The horizontal alignment of the value in the cell.",
3421 "enum": [
3422 "HORIZONTAL_ALIGN_UNSPECIFIED",
3423 "LEFT",
3424 "CENTER",
3425 "RIGHT"
3426 ],
3427 "enumDescriptions": [
3428 "The horizontal alignment is not specified. Do not use t his.",
3429 "The text is explicitly aligned to the left of the cell. ",
3430 "The text is explicitly aligned to the center of the cel l.",
3431 "The text is explicitly aligned to the right of the cell ."
3432 ],
3433 "type": "string"
3434 },
3435 "textFormat": {
3436 "$ref": "TextFormat",
3437 "description": "The format of the text in the cell (unless o verridden by a format run)."
3438 },
3439 "backgroundColor": {
3440 "$ref": "Color",
3441 "description": "The background color of the cell."
3442 },
3443 "verticalAlignment": {
3444 "description": "The vertical alignment of the value in the c ell.",
3445 "enum": [
3446 "VERTICAL_ALIGN_UNSPECIFIED",
3447 "TOP",
3448 "MIDDLE",
3449 "BOTTOM"
3450 ],
3451 "enumDescriptions": [
3452 "The vertical alignment is not specified. Do not use th is.",
3453 "The text is explicitly aligned to the top of the cell." ,
3454 "The text is explicitly aligned to the middle of the cel l.",
3455 "The text is explicitly aligned to the bottom of the cel l."
3456 ],
3457 "type": "string"
3458 },
3459 "padding": {
3460 "$ref": "Padding",
3461 "description": "The padding of the cell."
3462 }
3463 },
3464 "type": "object"
3465 },
3466 "ClearValuesResponse": {
3467 "description": "The response when clearing a range of values in a sp readsheet.",
3468 "id": "ClearValuesResponse",
3469 "properties": {
3470 "spreadsheetId": {
3471 "description": "The spreadsheet the updates were applied to. ",
3472 "type": "string"
3473 },
3474 "clearedRange": {
3475 "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.)",
3476 "type": "string"
3477 }
3478 },
3479 "type": "object"
3480 },
3481 "DeleteConditionalFormatRuleRequest": {
3482 "description": "Deletes a conditional format rule at the given index .\nAll subsequent rules' indexes are decremented.",
3483 "id": "DeleteConditionalFormatRuleRequest",
3484 "properties": {
3485 "sheetId": { 3297 "sheetId": {
3486 "description": "The sheet the rule is being deleted from.", 3298 "description": "The sheet this coordinate is on.",
3487 "format": "int32", 3299 "format": "int32",
3488 "type": "integer" 3300 "type": "integer"
3489 }, 3301 }
3490 "index": { 3302 },
3491 "description": "The zero-based index of the rule to be delet ed.", 3303 "type": "object"
3492 "format": "int32", 3304 },
3493 "type": "integer" 3305 "UpdateSheetPropertiesRequest": {
3494 } 3306 "description": "Updates properties of the sheet with the specified\n sheetId.",
3495 }, 3307 "id": "UpdateSheetPropertiesRequest",
3496 "type": "object" 3308 "properties": {
3497 },
3498 "AddBandingResponse": {
3499 "description": "The result of adding a banded range.",
3500 "id": "AddBandingResponse",
3501 "properties": {
3502 "bandedRange": {
3503 "$ref": "BandedRange",
3504 "description": "The banded range that was added."
3505 }
3506 },
3507 "type": "object"
3508 },
3509 "DeleteNamedRangeRequest": {
3510 "description": "Removes the named range with the given ID from the s preadsheet.",
3511 "id": "DeleteNamedRangeRequest",
3512 "properties": {
3513 "namedRangeId": {
3514 "description": "The ID of the named range to delete.",
3515 "type": "string"
3516 }
3517 },
3518 "type": "object"
3519 },
3520 "ChartData": {
3521 "description": "The data included in a domain or series.",
3522 "id": "ChartData",
3523 "properties": {
3524 "sourceRange": {
3525 "$ref": "ChartSourceRange",
3526 "description": "The source ranges of the data."
3527 }
3528 },
3529 "type": "object"
3530 },
3531 "BatchGetValuesResponse": {
3532 "description": "The response when retrieving more than one range of values in a spreadsheet.",
3533 "id": "BatchGetValuesResponse",
3534 "properties": {
3535 "valueRanges": {
3536 "description": "The requested values. The order of the Value Ranges is the same as the\norder of the requested ranges.",
3537 "items": {
3538 "$ref": "ValueRange"
3539 },
3540 "type": "array"
3541 },
3542 "spreadsheetId": {
3543 "description": "The ID of the spreadsheet the data was retri eved from.",
3544 "type": "string"
3545 }
3546 },
3547 "type": "object"
3548 },
3549 "UpdateBandingRequest": {
3550 "description": "Updates properties of the supplied banded range.",
3551 "id": "UpdateBandingRequest",
3552 "properties": {
3553 "bandedRange": {
3554 "$ref": "BandedRange",
3555 "description": "The banded range to update with the new prop erties."
3556 },
3557 "fields": { 3309 "fields": {
3558 "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.", 3310 "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 .",
3559 "format": "google-fieldmask", 3311 "format": "google-fieldmask",
3560 "type": "string" 3312 "type": "string"
3561 } 3313 },
3562 }, 3314 "properties": {
3563 "type": "object" 3315 "$ref": "SheetProperties",
3564 }, 3316 "description": "The properties to update."
3565 "Color": { 3317 }
3566 "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 // ...", 3318 },
3567 "id": "Color", 3319 "type": "object"
3568 "properties": { 3320 },
3569 "alpha": { 3321 "GridProperties": {
3570 "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).", 3322 "description": "Properties of a grid.",
3571 "format": "float", 3323 "id": "GridProperties",
3572 "type": "number" 3324 "properties": {
3573 }, 3325 "hideGridlines": {
3574 "blue": { 3326 "description": "True if the grid isn't showing gridlines in the UI.",
3575 "description": "The amount of blue in the color as a value i n the interval [0, 1].", 3327 "type": "boolean"
3576 "format": "float", 3328 },
3577 "type": "number" 3329 "frozenRowCount": {
3578 }, 3330 "description": "The number of rows that are frozen in the gr id.",
3579 "green": { 3331 "format": "int32",
3580 "description": "The amount of green in the color as a value in the interval [0, 1].", 3332 "type": "integer"
3581 "format": "float", 3333 },
3582 "type": "number" 3334 "frozenColumnCount": {
3583 }, 3335 "description": "The number of columns that are frozen in the grid.",
3584 "red": { 3336 "format": "int32",
3585 "description": "The amount of red in the color as a value in the interval [0, 1].", 3337 "type": "integer"
3586 "format": "float", 3338 },
3587 "type": "number" 3339 "columnCount": {
3588 } 3340 "description": "The number of columns in the grid.",
3589 }, 3341 "format": "int32",
3590 "type": "object" 3342 "type": "integer"
3591 }, 3343 },
3592 "PivotGroup": { 3344 "rowCount": {
3593 "description": "A single grouping (either row or column) in a pivot table.", 3345 "description": "The number of rows in the grid.",
3594 "id": "PivotGroup", 3346 "format": "int32",
3595 "properties": { 3347 "type": "integer"
3348 }
3349 },
3350 "type": "object"
3351 },
3352 "UnmergeCellsRequest": {
3353 "description": "Unmerges cells in the given range.",
3354 "id": "UnmergeCellsRequest",
3355 "properties": {
3356 "range": {
3357 "$ref": "GridRange",
3358 "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."
3359 }
3360 },
3361 "type": "object"
3362 },
3363 "UpdateEmbeddedObjectPositionResponse": {
3364 "description": "The result of updating an embedded object's position .",
3365 "id": "UpdateEmbeddedObjectPositionResponse",
3366 "properties": {
3367 "position": {
3368 "$ref": "EmbeddedObjectPosition",
3369 "description": "The new position of the embedded object."
3370 }
3371 },
3372 "type": "object"
3373 },
3374 "SortSpec": {
3375 "description": "A sort order associated with a specific column or ro w.",
3376 "id": "SortSpec",
3377 "properties": {
3378 "dimensionIndex": {
3379 "description": "The dimension the sort should be applied to. ",
3380 "format": "int32",
3381 "type": "integer"
3382 },
3596 "sortOrder": { 3383 "sortOrder": {
3597 "description": "The order the values in this group should be sorted.", 3384 "description": "The order data should be sorted.",
3598 "enum": [ 3385 "enum": [
3599 "SORT_ORDER_UNSPECIFIED", 3386 "SORT_ORDER_UNSPECIFIED",
3600 "ASCENDING", 3387 "ASCENDING",
3601 "DESCENDING" 3388 "DESCENDING"
3602 ], 3389 ],
3603 "enumDescriptions": [ 3390 "enumDescriptions": [
3604 "Default value, do not use this.", 3391 "Default value, do not use this.",
3605 "Sort ascending.", 3392 "Sort ascending.",
3606 "Sort descending." 3393 "Sort descending."
3607 ], 3394 ],
3608 "type": "string" 3395 "type": "string"
3609 }, 3396 }
3610 "valueBucket": { 3397 },
3611 "$ref": "PivotGroupSortValueBucket", 3398 "type": "object"
3612 "description": "The bucket of the opposite pivot group to so rt by.\nIf not specified, sorting is alphabetical by this group's values." 3399 },
3613 }, 3400 "Sheet": {
3614 "valueMetadata": { 3401 "description": "A sheet in a spreadsheet.",
3615 "description": "Metadata about values in the grouping.", 3402 "id": "Sheet",
3616 "items": { 3403 "properties": {
3617 "$ref": "PivotGroupValueMetadata" 3404 "data": {
3618 }, 3405 "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).",
3619 "type": "array" 3406 "items": {
3620 }, 3407 "$ref": "GridData"
3621 "showTotals": { 3408 },
3622 "description": "True if the pivot table should include the t otals for this grouping.", 3409 "type": "array"
3623 "type": "boolean" 3410 },
3624 }, 3411 "bandedRanges": {
3625 "sourceColumnOffset": { 3412 "description": "The banded (i.e. alternating colors) ranges on this sheet.",
3626 "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`.", 3413 "items": {
3627 "format": "int32", 3414 "$ref": "BandedRange"
3628 "type": "integer" 3415 },
3629 } 3416 "type": "array"
3630 }, 3417 },
3631 "type": "object" 3418 "properties": {
3632 }, 3419 "$ref": "SheetProperties",
3633 "PivotTable": { 3420 "description": "The properties of the sheet."
3634 "description": "A pivot table.", 3421 },
3635 "id": "PivotTable", 3422 "charts": {
3636 "properties": { 3423 "description": "The specifications of every chart on this sh eet.",
3637 "valueLayout": { 3424 "items": {
3638 "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).", 3425 "$ref": "EmbeddedChart"
3426 },
3427 "type": "array"
3428 },
3429 "filterViews": {
3430 "description": "The filter views in this sheet.",
3431 "items": {
3432 "$ref": "FilterView"
3433 },
3434 "type": "array"
3435 },
3436 "conditionalFormats": {
3437 "description": "The conditional format rules in this sheet." ,
3438 "items": {
3439 "$ref": "ConditionalFormatRule"
3440 },
3441 "type": "array"
3442 },
3443 "protectedRanges": {
3444 "description": "The protected ranges in this sheet.",
3445 "items": {
3446 "$ref": "ProtectedRange"
3447 },
3448 "type": "array"
3449 },
3450 "basicFilter": {
3451 "$ref": "BasicFilter",
3452 "description": "The filter on this sheet, if any."
3453 },
3454 "merges": {
3455 "description": "The ranges that are merged together.",
3456 "items": {
3457 "$ref": "GridRange"
3458 },
3459 "type": "array"
3460 }
3461 },
3462 "type": "object"
3463 },
3464 "BooleanRule": {
3465 "description": "A rule that may or may not match, depending on the c ondition.",
3466 "id": "BooleanRule",
3467 "properties": {
3468 "format": {
3469 "$ref": "CellFormat",
3470 "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou nd color &\nbackground color."
3471 },
3472 "condition": {
3473 "$ref": "BooleanCondition",
3474 "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
3475 }
3476 },
3477 "type": "object"
3478 },
3479 "PivotGroupValueMetadata": {
3480 "description": "Metadata about a value in a pivot grouping.",
3481 "id": "PivotGroupValueMetadata",
3482 "properties": {
3483 "value": {
3484 "$ref": "ExtendedValue",
3485 "description": "The calculated value the metadata correspond s to.\n(Note that formulaValue is not valid,\n because the values will be calcul ated.)"
3486 },
3487 "collapsed": {
3488 "description": "True if the data corresponding to the value is collapsed.",
3489 "type": "boolean"
3490 }
3491 },
3492 "type": "object"
3493 },
3494 "FilterCriteria": {
3495 "description": "Criteria for showing/hiding rows in a filter or filt er view.",
3496 "id": "FilterCriteria",
3497 "properties": {
3498 "condition": {
3499 "$ref": "BooleanCondition",
3500 "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.)"
3501 },
3502 "hiddenValues": {
3503 "description": "Values that should be hidden.",
3504 "items": {
3505 "type": "string"
3506 },
3507 "type": "array"
3508 }
3509 },
3510 "type": "object"
3511 },
3512 "Editors": {
3513 "description": "The editors of a protected range.",
3514 "id": "Editors",
3515 "properties": {
3516 "users": {
3517 "description": "The email addresses of users with edit acces s to the protected range.",
3518 "items": {
3519 "type": "string"
3520 },
3521 "type": "array"
3522 },
3523 "domainUsersCanEdit": {
3524 "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.",
3525 "type": "boolean"
3526 },
3527 "groups": {
3528 "description": "The email addresses of groups with edit acce ss to the protected range.",
3529 "items": {
3530 "type": "string"
3531 },
3532 "type": "array"
3533 }
3534 },
3535 "type": "object"
3536 },
3537 "UpdateConditionalFormatRuleRequest": {
3538 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.",
3539 "id": "UpdateConditionalFormatRuleRequest",
3540 "properties": {
3541 "index": {
3542 "description": "The zero-based index of the rule that should be replaced or moved.",
3543 "format": "int32",
3544 "type": "integer"
3545 },
3546 "sheetId": {
3547 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
3548 "format": "int32",
3549 "type": "integer"
3550 },
3551 "newIndex": {
3552 "description": "The zero-based new index the rule should end up at.",
3553 "format": "int32",
3554 "type": "integer"
3555 },
3556 "rule": {
3557 "$ref": "ConditionalFormatRule",
3558 "description": "The rule that should replace the rule at the given index."
3559 }
3560 },
3561 "type": "object"
3562 },
3563 "DataValidationRule": {
3564 "description": "A data validation rule.",
3565 "id": "DataValidationRule",
3566 "properties": {
3567 "condition": {
3568 "$ref": "BooleanCondition",
3569 "description": "The condition that data in the cell must mat ch."
3570 },
3571 "showCustomUi": {
3572 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
3573 "type": "boolean"
3574 },
3575 "strict": {
3576 "description": "True if invalid data should be rejected.",
3577 "type": "boolean"
3578 },
3579 "inputMessage": {
3580 "description": "A message to show the user when adding data to the cell.",
3581 "type": "string"
3582 }
3583 },
3584 "type": "object"
3585 },
3586 "BasicChartDomain": {
3587 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.",
3588 "id": "BasicChartDomain",
3589 "properties": {
3590 "reversed": {
3591 "description": "True to reverse the order of the domain valu es (horizontal axis).",
3592 "type": "boolean"
3593 },
3594 "domain": {
3595 "$ref": "ChartData",
3596 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates."
3597 }
3598 },
3599 "type": "object"
3600 },
3601 "PasteDataRequest": {
3602 "description": "Inserts data into the spreadsheet starting at the sp ecified coordinate.",
3603 "id": "PasteDataRequest",
3604 "properties": {
3605 "type": {
3606 "description": "How the data should be pasted.",
3639 "enum": [ 3607 "enum": [
3640 "HORIZONTAL", 3608 "PASTE_NORMAL",
3641 "VERTICAL" 3609 "PASTE_VALUES",
3610 "PASTE_FORMAT",
3611 "PASTE_NO_BORDERS",
3612 "PASTE_FORMULA",
3613 "PASTE_DATA_VALIDATION",
3614 "PASTE_CONDITIONAL_FORMATTING"
3642 ], 3615 ],
3643 "enumDescriptions": [ 3616 "enumDescriptions": [
3644 "Values are laid out horizontally (as columns).", 3617 "Paste values, formulas, formats, and merges.",
3645 "Values are laid out vertically (as rows)." 3618 "Paste the values ONLY without formats, formulas, or mer ges.",
3619 "Paste the format and data validation only.",
3620 "Like PASTE_NORMAL but without borders.",
3621 "Paste the formulas only.",
3622 "Paste the data validation only.",
3623 "Paste the conditional formatting rules only."
3646 ], 3624 ],
3647 "type": "string" 3625 "type": "string"
3648 }, 3626 },
3649 "values": { 3627 "html": {
3650 "description": "A list of values to include in the pivot tab le.", 3628 "description": "True if the data is HTML.",
3651 "items": { 3629 "type": "boolean"
3652 "$ref": "PivotValue" 3630 },
3653 }, 3631 "coordinate": {
3654 "type": "array" 3632 "$ref": "GridCoordinate",
3655 }, 3633 "description": "The coordinate at which the data should star t being inserted."
3656 "source": { 3634 },
3657 "$ref": "GridRange", 3635 "delimiter": {
3658 "description": "The range the pivot table is reading data fr om." 3636 "description": "The delimiter in the data.",
3659 }, 3637 "type": "string"
3660 "columns": { 3638 },
3661 "description": "Each column grouping in the pivot table.", 3639 "data": {
3662 "items": { 3640 "description": "The data to insert.",
3663 "$ref": "PivotGroup" 3641 "type": "string"
3664 }, 3642 }
3665 "type": "array" 3643 },
3666 }, 3644 "type": "object"
3667 "criteria": { 3645 },
3668 "additionalProperties": { 3646 "AppendDimensionRequest": {
3669 "$ref": "PivotFilterCriteria" 3647 "description": "Appends rows or columns to the end of a sheet.",
3670 }, 3648 "id": "AppendDimensionRequest",
3671 "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`.", 3649 "properties": {
3672 "type": "object"
3673 },
3674 "rows": {
3675 "description": "Each row grouping in the pivot table.",
3676 "items": {
3677 "$ref": "PivotGroup"
3678 },
3679 "type": "array"
3680 }
3681 },
3682 "type": "object"
3683 },
3684 "ChartSourceRange": {
3685 "description": "Source ranges for a chart.",
3686 "id": "ChartSourceRange",
3687 "properties": {
3688 "sources": {
3689 "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",
3690 "items": {
3691 "$ref": "GridRange"
3692 },
3693 "type": "array"
3694 }
3695 },
3696 "type": "object"
3697 },
3698 "AppendCellsRequest": {
3699 "description": "Adds new cells after the last row with data in a she et,\ninserting new rows into the sheet if necessary.",
3700 "id": "AppendCellsRequest",
3701 "properties": {
3702 "fields": {
3703 "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.",
3704 "format": "google-fieldmask",
3705 "type": "string"
3706 },
3707 "rows": {
3708 "description": "The data to append.",
3709 "items": {
3710 "$ref": "RowData"
3711 },
3712 "type": "array"
3713 },
3714 "sheetId": { 3650 "sheetId": {
3715 "description": "The sheet ID to append the data to.", 3651 "description": "The sheet to append rows or columns to.",
3716 "format": "int32", 3652 "format": "int32",
3717 "type": "integer" 3653 "type": "integer"
3718 } 3654 },
3719 }, 3655 "dimension": {
3720 "type": "object" 3656 "description": "Whether rows or columns should be appended." ,
3721 },
3722 "ValueRange": {
3723 "description": "Data within a range of the spreadsheet.",
3724 "id": "ValueRange",
3725 "properties": {
3726 "values": {
3727 "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.",
3728 "items": {
3729 "items": {
3730 "type": "any"
3731 },
3732 "type": "array"
3733 },
3734 "type": "array"
3735 },
3736 "majorDimension": {
3737 "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.",
3738 "enum": [ 3657 "enum": [
3739 "DIMENSION_UNSPECIFIED", 3658 "DIMENSION_UNSPECIFIED",
3740 "ROWS", 3659 "ROWS",
3741 "COLUMNS"
3742 ],
3743 "enumDescriptions": [
3744 "The default value, do not use.",
3745 "Operates on the rows of a sheet.",
3746 "Operates on the columns of a sheet."
3747 ],
3748 "type": "string"
3749 },
3750 "range": {
3751 "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.",
3752 "type": "string"
3753 }
3754 },
3755 "type": "object"
3756 },
3757 "AddBandingRequest": {
3758 "description": "Adds a new banded range to the spreadsheet.",
3759 "id": "AddBandingRequest",
3760 "properties": {
3761 "bandedRange": {
3762 "$ref": "BandedRange",
3763 "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.)"
3764 }
3765 },
3766 "type": "object"
3767 },
3768 "Response": {
3769 "description": "A single response from an update.",
3770 "id": "Response",
3771 "properties": {
3772 "updateEmbeddedObjectPosition": {
3773 "$ref": "UpdateEmbeddedObjectPositionResponse",
3774 "description": "A reply from updating an embedded object's p osition."
3775 },
3776 "deleteConditionalFormatRule": {
3777 "$ref": "DeleteConditionalFormatRuleResponse",
3778 "description": "A reply from deleting a conditional format r ule."
3779 },
3780 "duplicateFilterView": {
3781 "$ref": "DuplicateFilterViewResponse",
3782 "description": "A reply from duplicating a filter view."
3783 },
3784 "addChart": {
3785 "$ref": "AddChartResponse",
3786 "description": "A reply from adding a chart."
3787 },
3788 "findReplace": {
3789 "$ref": "FindReplaceResponse",
3790 "description": "A reply from doing a find/replace."
3791 },
3792 "addSheet": {
3793 "$ref": "AddSheetResponse",
3794 "description": "A reply from adding a sheet."
3795 },
3796 "updateConditionalFormatRule": {
3797 "$ref": "UpdateConditionalFormatRuleResponse",
3798 "description": "A reply from updating a conditional format r ule."
3799 },
3800 "addNamedRange": {
3801 "$ref": "AddNamedRangeResponse",
3802 "description": "A reply from adding a named range."
3803 },
3804 "addFilterView": {
3805 "$ref": "AddFilterViewResponse",
3806 "description": "A reply from adding a filter view."
3807 },
3808 "addBanding": {
3809 "$ref": "AddBandingResponse",
3810 "description": "A reply from adding a banded range."
3811 },
3812 "addProtectedRange": {
3813 "$ref": "AddProtectedRangeResponse",
3814 "description": "A reply from adding a protected range."
3815 },
3816 "duplicateSheet": {
3817 "$ref": "DuplicateSheetResponse",
3818 "description": "A reply from duplicating a sheet."
3819 }
3820 },
3821 "type": "object"
3822 },
3823 "EmbeddedChart": {
3824 "description": "A chart embedded in a sheet.",
3825 "id": "EmbeddedChart",
3826 "properties": {
3827 "chartId": {
3828 "description": "The ID of the chart.",
3829 "format": "int32",
3830 "type": "integer"
3831 },
3832 "position": {
3833 "$ref": "EmbeddedObjectPosition",
3834 "description": "The position of the chart."
3835 },
3836 "spec": {
3837 "$ref": "ChartSpec",
3838 "description": "The specification of the chart."
3839 }
3840 },
3841 "type": "object"
3842 },
3843 "TextFormatRun": {
3844 "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.",
3845 "id": "TextFormatRun",
3846 "properties": {
3847 "startIndex": {
3848 "description": "The character index where this run starts.",
3849 "format": "int32",
3850 "type": "integer"
3851 },
3852 "format": {
3853 "$ref": "TextFormat",
3854 "description": "The format of this run. Absent values inher it the cell's format."
3855 }
3856 },
3857 "type": "object"
3858 },
3859 "InsertRangeRequest": {
3860 "description": "Inserts cells into a range, shifting the existing ce lls over or down.",
3861 "id": "InsertRangeRequest",
3862 "properties": {
3863 "shiftDimension": {
3864 "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.",
3865 "enum": [
3866 "DIMENSION_UNSPECIFIED",
3867 "ROWS",
3868 "COLUMNS" 3660 "COLUMNS"
3869 ], 3661 ],
3870 "enumDescriptions": [ 3662 "enumDescriptions": [
3871 "The default value, do not use.", 3663 "The default value, do not use.",
3872 "Operates on the rows of a sheet.", 3664 "Operates on the rows of a sheet.",
3873 "Operates on the columns of a sheet." 3665 "Operates on the columns of a sheet."
3874 ], 3666 ],
3875 "type": "string" 3667 "type": "string"
3876 }, 3668 },
3877 "range": { 3669 "length": {
3878 "$ref": "GridRange", 3670 "description": "The number of rows or columns to append.",
3879 "description": "The range to insert new cells into." 3671 "format": "int32",
3880 } 3672 "type": "integer"
3881 }, 3673 }
3882 "type": "object" 3674 },
3883 }, 3675 "type": "object"
3884 "AddNamedRangeResponse": { 3676 },
3885 "description": "The result of adding a named range.", 3677 "AddNamedRangeRequest": {
3886 "id": "AddNamedRangeResponse", 3678 "description": "Adds a named range to the spreadsheet.",
3679 "id": "AddNamedRangeRequest",
3887 "properties": { 3680 "properties": {
3888 "namedRange": { 3681 "namedRange": {
3889 "$ref": "NamedRange", 3682 "$ref": "NamedRange",
3890 "description": "The named range to add." 3683 "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.)"
3891 } 3684 }
3892 }, 3685 },
3893 "type": "object" 3686 "type": "object"
3894 }, 3687 },
3895 "RowData": { 3688 "UpdateEmbeddedObjectPositionRequest": {
3896 "description": "Data about each cell in a row.", 3689 "description": "Update an embedded object's position (such as a movi ng or resizing a\nchart or image).",
3897 "id": "RowData", 3690 "id": "UpdateEmbeddedObjectPositionRequest",
3898 "properties": { 3691 "properties": {
3899 "values": { 3692 "fields": {
3900 "description": "The values in the row, one per column.", 3693 "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.",
3901 "items": { 3694 "format": "google-fieldmask",
3902 "$ref": "CellData" 3695 "type": "string"
3903 }, 3696 },
3904 "type": "array" 3697 "objectId": {
3905 } 3698 "description": "The ID of the object to moved.",
3906 }, 3699 "format": "int32",
3907 "type": "object" 3700 "type": "integer"
3908 }, 3701 },
3909 "Border": { 3702 "newPosition": {
3910 "description": "A border along a cell.", 3703 "$ref": "EmbeddedObjectPosition",
3911 "id": "Border", 3704 "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."
3912 "properties": { 3705 }
3913 "color": { 3706 },
3914 "$ref": "Color", 3707 "type": "object"
3915 "description": "The color of the border." 3708 },
3916 }, 3709 "TextRotation": {
3917 "width": { 3710 "description": "The rotation applied to text in a cell.",
3918 "description": "The width of the border, in pixels.\nDepreca ted; the width is determined by the \"style\" field.", 3711 "id": "TextRotation",
3919 "format": "int32", 3712 "properties": {
3920 "type": "integer" 3713 "angle": {
3921 }, 3714 "description": "The angle between the standard orientation a nd the desired orientation.\nMeasured in degrees. Valid values are between -90 a nd 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNo te: For LTR text direction positive angles are in the counterclockwise\ndirectio n, whereas for RTL they are in the clockwise direction",
3922 "style": { 3715 "format": "int32",
3923 "description": "The style of the border.", 3716 "type": "integer"
3717 },
3718 "vertical": {
3719 "description": "If true, text reads top to bottom, but the o rientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
3720 "type": "boolean"
3721 }
3722 },
3723 "type": "object"
3724 },
3725 "PieChartSpec": {
3726 "description": "A <a href=\"/chart/interactive/docs/gallery/piechart \">pie chart</a>.",
3727 "id": "PieChartSpec",
3728 "properties": {
3729 "threeDimensional": {
3730 "description": "True if the pie is three dimensional.",
3731 "type": "boolean"
3732 },
3733 "domain": {
3734 "$ref": "ChartData",
3735 "description": "The data that covers the domain of the pie c hart."
3736 },
3737 "series": {
3738 "$ref": "ChartData",
3739 "description": "The data that covers the one and only series of the pie chart."
3740 },
3741 "pieHole": {
3742 "description": "The size of the hole in the pie chart.",
3743 "format": "double",
3744 "type": "number"
3745 },
3746 "legendPosition": {
3747 "description": "Where the legend of the pie chart should be drawn.",
3924 "enum": [ 3748 "enum": [
3925 "STYLE_UNSPECIFIED", 3749 "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
3926 "DOTTED", 3750 "BOTTOM_LEGEND",
3927 "DASHED", 3751 "LEFT_LEGEND",
3928 "SOLID", 3752 "RIGHT_LEGEND",
3929 "SOLID_MEDIUM", 3753 "TOP_LEGEND",
3930 "SOLID_THICK", 3754 "NO_LEGEND",
3931 "NONE", 3755 "LABELED_LEGEND"
3932 "DOUBLE"
3933 ], 3756 ],
3934 "enumDescriptions": [ 3757 "enumDescriptions": [
3935 "The style is not specified. Do not use this.", 3758 "Default value, do not use.",
3936 "The border is dotted.", 3759 "The legend is rendered on the bottom of the chart.",
3937 "The border is dashed.", 3760 "The legend is rendered on the left of the chart.",
3938 "The border is a thin solid line.", 3761 "The legend is rendered on the right of the chart.",
3939 "The border is a medium solid line.", 3762 "The legend is rendered on the top of the chart.",
3940 "The border is a thick solid line.", 3763 "No legend is rendered.",
3941 "No border.\nUsed only when updating a border in order t o erase it.", 3764 "Each pie slice has a label attached to it."
3942 "The border is two solid lines." 3765 ],
3943 ], 3766 "type": "string"
3944 "type": "string" 3767 }
3945 } 3768 },
3946 }, 3769 "type": "object"
3947 "type": "object" 3770 },
3948 }, 3771 "UpdateFilterViewRequest": {
3949 "GridData": { 3772 "description": "Updates properties of the filter view.",
3950 "description": "Data in the grid, as well as metadata about the dime nsions.", 3773 "id": "UpdateFilterViewRequest",
3951 "id": "GridData", 3774 "properties": {
3952 "properties": { 3775 "filter": {
3953 "rowData": { 3776 "$ref": "FilterView",
3954 "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.", 3777 "description": "The new properties of the filter view."
3955 "items": {
3956 "$ref": "RowData"
3957 },
3958 "type": "array"
3959 },
3960 "startRow": {
3961 "description": "The first row this GridData refers to, zero- based.",
3962 "format": "int32",
3963 "type": "integer"
3964 },
3965 "columnMetadata": {
3966 "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
3967 "items": {
3968 "$ref": "DimensionProperties"
3969 },
3970 "type": "array"
3971 },
3972 "startColumn": {
3973 "description": "The first column this GridData refers to, ze ro-based.",
3974 "format": "int32",
3975 "type": "integer"
3976 },
3977 "rowMetadata": {
3978 "description": "Metadata about the requested rows in the gri d, starting with the row\nin start_row.",
3979 "items": {
3980 "$ref": "DimensionProperties"
3981 },
3982 "type": "array"
3983 }
3984 },
3985 "type": "object"
3986 },
3987 "UpdateNamedRangeRequest": {
3988 "description": "Updates properties of the named range with the speci fied\nnamedRangeId.",
3989 "id": "UpdateNamedRangeRequest",
3990 "properties": {
3991 "namedRange": {
3992 "$ref": "NamedRange",
3993 "description": "The named range to update with the new prope rties."
3994 }, 3778 },
3995 "fields": { 3779 "fields": {
3996 "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 .", 3780 "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.",
3997 "format": "google-fieldmask", 3781 "format": "google-fieldmask",
3998 "type": "string" 3782 "type": "string"
3999 } 3783 }
4000 }, 3784 },
4001 "type": "object" 3785 "type": "object"
4002 }, 3786 },
4003 "FindReplaceRequest": { 3787 "ConditionalFormatRule": {
4004 "description": "Finds and replaces data in cells over a range, sheet , or all sheets.", 3788 "description": "A rule describing a conditional format.",
4005 "id": "FindReplaceRequest", 3789 "id": "ConditionalFormatRule",
4006 "properties": { 3790 "properties": {
4007 "replacement": { 3791 "booleanRule": {
4008 "description": "The value to use as the replacement.", 3792 "$ref": "BooleanRule",
4009 "type": "string" 3793 "description": "The formatting is either \"on\" or \"off\" a ccording to the rule."
4010 }, 3794 },
4011 "range": { 3795 "ranges": {
4012 "$ref": "GridRange", 3796 "description": "The ranges that will be formatted if the con dition is true.\nAll the ranges must be on the same grid.",
4013 "description": "The range to find/replace over."
4014 },
4015 "sheetId": {
4016 "description": "The sheet to find/replace over.",
4017 "format": "int32",
4018 "type": "integer"
4019 },
4020 "allSheets": {
4021 "description": "True to find/replace over all sheets.",
4022 "type": "boolean"
4023 },
4024 "matchCase": {
4025 "description": "True if the search is case sensitive.",
4026 "type": "boolean"
4027 },
4028 "includeFormulas": {
4029 "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
4030 "type": "boolean"
4031 },
4032 "matchEntireCell": {
4033 "description": "True if the find value should match the enti re cell.",
4034 "type": "boolean"
4035 },
4036 "find": {
4037 "description": "The value to search.",
4038 "type": "string"
4039 },
4040 "searchByRegex": {
4041 "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.",
4042 "type": "boolean"
4043 }
4044 },
4045 "type": "object"
4046 },
4047 "AddSheetRequest": {
4048 "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.",
4049 "id": "AddSheetRequest",
4050 "properties": {
4051 "properties": {
4052 "$ref": "SheetProperties",
4053 "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.)"
4054 }
4055 },
4056 "type": "object"
4057 },
4058 "UpdateCellsRequest": {
4059 "description": "Updates all cells in a range with new data.",
4060 "id": "UpdateCellsRequest",
4061 "properties": {
4062 "range": {
4063 "$ref": "GridRange",
4064 "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."
4065 },
4066 "fields": {
4067 "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.",
4068 "format": "google-fieldmask",
4069 "type": "string"
4070 },
4071 "rows": {
4072 "description": "The data to write.",
4073 "items": {
4074 "$ref": "RowData"
4075 },
4076 "type": "array"
4077 },
4078 "start": {
4079 "$ref": "GridCoordinate",
4080 "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."
4081 }
4082 },
4083 "type": "object"
4084 },
4085 "RandomizeRangeRequest": {
4086 "description": "Randomizes the order of the rows in a range.",
4087 "id": "RandomizeRangeRequest",
4088 "properties": {
4089 "range": {
4090 "$ref": "GridRange",
4091 "description": "The range to randomize."
4092 }
4093 },
4094 "type": "object"
4095 },
4096 "DeleteConditionalFormatRuleResponse": {
4097 "description": "The result of deleting a conditional format rule.",
4098 "id": "DeleteConditionalFormatRuleResponse",
4099 "properties": {
4100 "rule": {
4101 "$ref": "ConditionalFormatRule",
4102 "description": "The rule that was deleted."
4103 }
4104 },
4105 "type": "object"
4106 },
4107 "DeleteRangeRequest": {
4108 "description": "Deletes a range of cells, shifting other cells into the deleted area.",
4109 "id": "DeleteRangeRequest",
4110 "properties": {
4111 "shiftDimension": {
4112 "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.",
4113 "enum": [
4114 "DIMENSION_UNSPECIFIED",
4115 "ROWS",
4116 "COLUMNS"
4117 ],
4118 "enumDescriptions": [
4119 "The default value, do not use.",
4120 "Operates on the rows of a sheet.",
4121 "Operates on the columns of a sheet."
4122 ],
4123 "type": "string"
4124 },
4125 "range": {
4126 "$ref": "GridRange",
4127 "description": "The range of cells to delete."
4128 }
4129 },
4130 "type": "object"
4131 },
4132 "GridCoordinate": {
4133 "description": "A coordinate in a sheet.\nAll indexes are zero-based .",
4134 "id": "GridCoordinate",
4135 "properties": {
4136 "sheetId": {
4137 "description": "The sheet this coordinate is on.",
4138 "format": "int32",
4139 "type": "integer"
4140 },
4141 "columnIndex": {
4142 "description": "The column index of the coordinate.",
4143 "format": "int32",
4144 "type": "integer"
4145 },
4146 "rowIndex": {
4147 "description": "The row index of the coordinate.",
4148 "format": "int32",
4149 "type": "integer"
4150 }
4151 },
4152 "type": "object"
4153 },
4154 "UpdateSheetPropertiesRequest": {
4155 "description": "Updates properties of the sheet with the specified\n sheetId.",
4156 "id": "UpdateSheetPropertiesRequest",
4157 "properties": {
4158 "properties": {
4159 "$ref": "SheetProperties",
4160 "description": "The properties to update."
4161 },
4162 "fields": {
4163 "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 .",
4164 "format": "google-fieldmask",
4165 "type": "string"
4166 }
4167 },
4168 "type": "object"
4169 },
4170 "UnmergeCellsRequest": {
4171 "description": "Unmerges cells in the given range.",
4172 "id": "UnmergeCellsRequest",
4173 "properties": {
4174 "range": {
4175 "$ref": "GridRange",
4176 "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."
4177 }
4178 },
4179 "type": "object"
4180 },
4181 "GridProperties": {
4182 "description": "Properties of a grid.",
4183 "id": "GridProperties",
4184 "properties": {
4185 "rowCount": {
4186 "description": "The number of rows in the grid.",
4187 "format": "int32",
4188 "type": "integer"
4189 },
4190 "hideGridlines": {
4191 "description": "True if the grid isn't showing gridlines in the UI.",
4192 "type": "boolean"
4193 },
4194 "frozenRowCount": {
4195 "description": "The number of rows that are frozen in the gr id.",
4196 "format": "int32",
4197 "type": "integer"
4198 },
4199 "frozenColumnCount": {
4200 "description": "The number of columns that are frozen in the grid.",
4201 "format": "int32",
4202 "type": "integer"
4203 },
4204 "columnCount": {
4205 "description": "The number of columns in the grid.",
4206 "format": "int32",
4207 "type": "integer"
4208 }
4209 },
4210 "type": "object"
4211 },
4212 "UpdateEmbeddedObjectPositionResponse": {
4213 "description": "The result of updating an embedded object's position .",
4214 "id": "UpdateEmbeddedObjectPositionResponse",
4215 "properties": {
4216 "position": {
4217 "$ref": "EmbeddedObjectPosition",
4218 "description": "The new position of the embedded object."
4219 }
4220 },
4221 "type": "object"
4222 },
4223 "SortSpec": {
4224 "description": "A sort order associated with a specific column or ro w.",
4225 "id": "SortSpec",
4226 "properties": {
4227 "dimensionIndex": {
4228 "description": "The dimension the sort should be applied to. ",
4229 "format": "int32",
4230 "type": "integer"
4231 },
4232 "sortOrder": {
4233 "description": "The order data should be sorted.",
4234 "enum": [
4235 "SORT_ORDER_UNSPECIFIED",
4236 "ASCENDING",
4237 "DESCENDING"
4238 ],
4239 "enumDescriptions": [
4240 "Default value, do not use this.",
4241 "Sort ascending.",
4242 "Sort descending."
4243 ],
4244 "type": "string"
4245 }
4246 },
4247 "type": "object"
4248 },
4249 "Sheet": {
4250 "description": "A sheet in a spreadsheet.",
4251 "id": "Sheet",
4252 "properties": {
4253 "filterViews": {
4254 "description": "The filter views in this sheet.",
4255 "items": {
4256 "$ref": "FilterView"
4257 },
4258 "type": "array"
4259 },
4260 "conditionalFormats": {
4261 "description": "The conditional format rules in this sheet." ,
4262 "items": {
4263 "$ref": "ConditionalFormatRule"
4264 },
4265 "type": "array"
4266 },
4267 "protectedRanges": {
4268 "description": "The protected ranges in this sheet.",
4269 "items": {
4270 "$ref": "ProtectedRange"
4271 },
4272 "type": "array"
4273 },
4274 "basicFilter": {
4275 "$ref": "BasicFilter",
4276 "description": "The filter on this sheet, if any."
4277 },
4278 "merges": {
4279 "description": "The ranges that are merged together.",
4280 "items": { 3797 "items": {
4281 "$ref": "GridRange" 3798 "$ref": "GridRange"
4282 }, 3799 },
4283 "type": "array" 3800 "type": "array"
4284 }, 3801 },
4285 "data": { 3802 "gradientRule": {
4286 "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).", 3803 "$ref": "GradientRule",
4287 "items": { 3804 "description": "The formatting will vary based on the gradie nts in the rule."
4288 "$ref": "GridData" 3805 }
4289 }, 3806 },
4290 "type": "array" 3807 "type": "object"
4291 }, 3808 },
4292 "bandedRanges": { 3809 "CopyPasteRequest": {
4293 "description": "The banded (i.e. alternating colors) ranges on this sheet.", 3810 "description": "Copies data from the source to the destination.",
4294 "items": { 3811 "id": "CopyPasteRequest",
4295 "$ref": "BandedRange" 3812 "properties": {
4296 }, 3813 "pasteType": {
4297 "type": "array" 3814 "description": "What kind of data to paste.",
4298 },
4299 "properties": {
4300 "$ref": "SheetProperties",
4301 "description": "The properties of the sheet."
4302 },
4303 "charts": {
4304 "description": "The specifications of every chart on this sh eet.",
4305 "items": {
4306 "$ref": "EmbeddedChart"
4307 },
4308 "type": "array"
4309 }
4310 },
4311 "type": "object"
4312 },
4313 "BooleanRule": {
4314 "description": "A rule that may or may not match, depending on the c ondition.",
4315 "id": "BooleanRule",
4316 "properties": {
4317 "format": {
4318 "$ref": "CellFormat",
4319 "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforegrou nd color &\nbackground color."
4320 },
4321 "condition": {
4322 "$ref": "BooleanCondition",
4323 "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
4324 }
4325 },
4326 "type": "object"
4327 },
4328 "PivotGroupValueMetadata": {
4329 "description": "Metadata about a value in a pivot grouping.",
4330 "id": "PivotGroupValueMetadata",
4331 "properties": {
4332 "value": {
4333 "$ref": "ExtendedValue",
4334 "description": "The calculated value the metadata correspond s to.\n(Note that formulaValue is not valid,\n because the values will be calcul ated.)"
4335 },
4336 "collapsed": {
4337 "description": "True if the data corresponding to the value is collapsed.",
4338 "type": "boolean"
4339 }
4340 },
4341 "type": "object"
4342 },
4343 "FilterCriteria": {
4344 "description": "Criteria for showing/hiding rows in a filter or filt er view.",
4345 "id": "FilterCriteria",
4346 "properties": {
4347 "condition": {
4348 "$ref": "BooleanCondition",
4349 "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.)"
4350 },
4351 "hiddenValues": {
4352 "description": "Values that should be hidden.",
4353 "items": {
4354 "type": "string"
4355 },
4356 "type": "array"
4357 }
4358 },
4359 "type": "object"
4360 },
4361 "Editors": {
4362 "description": "The editors of a protected range.",
4363 "id": "Editors",
4364 "properties": {
4365 "users": {
4366 "description": "The email addresses of users with edit acces s to the protected range.",
4367 "items": {
4368 "type": "string"
4369 },
4370 "type": "array"
4371 },
4372 "domainUsersCanEdit": {
4373 "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.",
4374 "type": "boolean"
4375 },
4376 "groups": {
4377 "description": "The email addresses of groups with edit acce ss to the protected range.",
4378 "items": {
4379 "type": "string"
4380 },
4381 "type": "array"
4382 }
4383 },
4384 "type": "object"
4385 },
4386 "UpdateConditionalFormatRuleRequest": {
4387 "description": "Updates a conditional format rule at the given index ,\nor moves a conditional format rule to another index.",
4388 "id": "UpdateConditionalFormatRuleRequest",
4389 "properties": {
4390 "sheetId": {
4391 "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
4392 "format": "int32",
4393 "type": "integer"
4394 },
4395 "newIndex": {
4396 "description": "The zero-based new index the rule should end up at.",
4397 "format": "int32",
4398 "type": "integer"
4399 },
4400 "rule": {
4401 "$ref": "ConditionalFormatRule",
4402 "description": "The rule that should replace the rule at the given index."
4403 },
4404 "index": {
4405 "description": "The zero-based index of the rule that should be replaced or moved.",
4406 "format": "int32",
4407 "type": "integer"
4408 }
4409 },
4410 "type": "object"
4411 },
4412 "DataValidationRule": {
4413 "description": "A data validation rule.",
4414 "id": "DataValidationRule",
4415 "properties": {
4416 "showCustomUi": {
4417 "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
4418 "type": "boolean"
4419 },
4420 "strict": {
4421 "description": "True if invalid data should be rejected.",
4422 "type": "boolean"
4423 },
4424 "inputMessage": {
4425 "description": "A message to show the user when adding data to the cell.",
4426 "type": "string"
4427 },
4428 "condition": {
4429 "$ref": "BooleanCondition",
4430 "description": "The condition that data in the cell must mat ch."
4431 }
4432 },
4433 "type": "object"
4434 },
4435 "BasicChartDomain": {
4436 "description": "The domain of a chart.\nFor example, if charting sto ck prices over time, this would be the date.",
4437 "id": "BasicChartDomain",
4438 "properties": {
4439 "reversed": {
4440 "description": "True to reverse the order of the domain valu es (horizontal axis).\nNot applicable to Gauge, Geo, Histogram, Org, Pie, Radar, and Treemap\ncharts.",
4441 "type": "boolean"
4442 },
4443 "domain": {
4444 "$ref": "ChartData",
4445 "description": "The data of the domain. For example, if char ting stock prices over time,\nthis is the data representing the dates."
4446 }
4447 },
4448 "type": "object"
4449 },
4450 "PasteDataRequest": {
4451 "description": "Inserts data into the spreadsheet starting at the sp ecified coordinate.",
4452 "id": "PasteDataRequest",
4453 "properties": {
4454 "coordinate": {
4455 "$ref": "GridCoordinate",
4456 "description": "The coordinate at which the data should star t being inserted."
4457 },
4458 "delimiter": {
4459 "description": "The delimiter in the data.",
4460 "type": "string"
4461 },
4462 "data": {
4463 "description": "The data to insert.",
4464 "type": "string"
4465 },
4466 "type": {
4467 "description": "How the data should be pasted.",
4468 "enum": [ 3815 "enum": [
4469 "PASTE_NORMAL", 3816 "PASTE_NORMAL",
4470 "PASTE_VALUES", 3817 "PASTE_VALUES",
4471 "PASTE_FORMAT", 3818 "PASTE_FORMAT",
4472 "PASTE_NO_BORDERS", 3819 "PASTE_NO_BORDERS",
4473 "PASTE_FORMULA", 3820 "PASTE_FORMULA",
4474 "PASTE_DATA_VALIDATION", 3821 "PASTE_DATA_VALIDATION",
4475 "PASTE_CONDITIONAL_FORMATTING" 3822 "PASTE_CONDITIONAL_FORMATTING"
4476 ], 3823 ],
4477 "enumDescriptions": [ 3824 "enumDescriptions": [
4478 "Paste values, formulas, formats, and merges.", 3825 "Paste values, formulas, formats, and merges.",
4479 "Paste the values ONLY without formats, formulas, or mer ges.", 3826 "Paste the values ONLY without formats, formulas, or mer ges.",
4480 "Paste the format and data validation only.", 3827 "Paste the format and data validation only.",
4481 "Like PASTE_NORMAL but without borders.", 3828 "Like PASTE_NORMAL but without borders.",
4482 "Paste the formulas only.", 3829 "Paste the formulas only.",
4483 "Paste the data validation only.", 3830 "Paste the data validation only.",
4484 "Paste the conditional formatting rules only." 3831 "Paste the conditional formatting rules only."
4485 ], 3832 ],
4486 "type": "string" 3833 "type": "string"
4487 }, 3834 },
4488 "html": { 3835 "source": {
4489 "description": "True if the data is HTML.", 3836 "$ref": "GridRange",
4490 "type": "boolean" 3837 "description": "The source range to copy."
4491 } 3838 },
4492 }, 3839 "destination": {
4493 "type": "object" 3840 "$ref": "GridRange",
4494 }, 3841 "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)."
4495 "AppendDimensionRequest": { 3842 },
4496 "description": "Appends rows or columns to the end of a sheet.", 3843 "pasteOrientation": {
4497 "id": "AppendDimensionRequest", 3844 "description": "How that data should be oriented when pastin g.",
4498 "properties": {
4499 "sheetId": {
4500 "description": "The sheet to append rows or columns to.",
4501 "format": "int32",
4502 "type": "integer"
4503 },
4504 "dimension": {
4505 "description": "Whether rows or columns should be appended." ,
4506 "enum": [ 3845 "enum": [
4507 "DIMENSION_UNSPECIFIED", 3846 "NORMAL",
4508 "ROWS", 3847 "TRANSPOSE"
4509 "COLUMNS" 3848 ],
3849 "enumDescriptions": [
3850 "Paste normally.",
3851 "Paste transposed, where all rows become columns and vic e versa."
3852 ],
3853 "type": "string"
3854 }
3855 },
3856 "type": "object"
3857 },
3858 "Request": {
3859 "description": "A single kind of update to apply to a spreadsheet.",
3860 "id": "Request",
3861 "properties": {
3862 "deleteEmbeddedObject": {
3863 "$ref": "DeleteEmbeddedObjectRequest",
3864 "description": "Deletes an embedded object (e.g, chart, imag e) in a sheet."
3865 },
3866 "updateFilterView": {
3867 "$ref": "UpdateFilterViewRequest",
3868 "description": "Updates the properties of a filter view."
3869 },
3870 "addBanding": {
3871 "$ref": "AddBandingRequest",
3872 "description": "Adds a new banded range"
3873 },
3874 "autoResizeDimensions": {
3875 "$ref": "AutoResizeDimensionsRequest",
3876 "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
3877 },
3878 "appendCells": {
3879 "$ref": "AppendCellsRequest",
3880 "description": "Appends cells after the last row with data i n a sheet."
3881 },
3882 "cutPaste": {
3883 "$ref": "CutPasteRequest",
3884 "description": "Cuts data from one area and pastes it to ano ther."
3885 },
3886 "mergeCells": {
3887 "$ref": "MergeCellsRequest",
3888 "description": "Merges cells together."
3889 },
3890 "updateNamedRange": {
3891 "$ref": "UpdateNamedRangeRequest",
3892 "description": "Updates a named range."
3893 },
3894 "updateSheetProperties": {
3895 "$ref": "UpdateSheetPropertiesRequest",
3896 "description": "Updates a sheet's properties."
3897 },
3898 "deleteDimension": {
3899 "$ref": "DeleteDimensionRequest",
3900 "description": "Deletes rows or columns in a sheet."
3901 },
3902 "autoFill": {
3903 "$ref": "AutoFillRequest",
3904 "description": "Automatically fills in more data based on ex isting data."
3905 },
3906 "sortRange": {
3907 "$ref": "SortRangeRequest",
3908 "description": "Sorts data in a range."
3909 },
3910 "deleteProtectedRange": {
3911 "$ref": "DeleteProtectedRangeRequest",
3912 "description": "Deletes a protected range."
3913 },
3914 "duplicateFilterView": {
3915 "$ref": "DuplicateFilterViewRequest",
3916 "description": "Duplicates a filter view."
3917 },
3918 "addChart": {
3919 "$ref": "AddChartRequest",
3920 "description": "Adds a chart."
3921 },
3922 "findReplace": {
3923 "$ref": "FindReplaceRequest",
3924 "description": "Finds and replaces occurrences of some text with other text."
3925 },
3926 "textToColumns": {
3927 "$ref": "TextToColumnsRequest",
3928 "description": "Converts a column of text into many columns of text."
3929 },
3930 "updateChartSpec": {
3931 "$ref": "UpdateChartSpecRequest",
3932 "description": "Updates a chart's specifications."
3933 },
3934 "addSheet": {
3935 "$ref": "AddSheetRequest",
3936 "description": "Adds a sheet."
3937 },
3938 "updateProtectedRange": {
3939 "$ref": "UpdateProtectedRangeRequest",
3940 "description": "Updates a protected range."
3941 },
3942 "deleteFilterView": {
3943 "$ref": "DeleteFilterViewRequest",
3944 "description": "Deletes a filter view from a sheet."
3945 },
3946 "copyPaste": {
3947 "$ref": "CopyPasteRequest",
3948 "description": "Copies data from one area and pastes it to a nother."
3949 },
3950 "insertDimension": {
3951 "$ref": "InsertDimensionRequest",
3952 "description": "Inserts new rows or columns in a sheet."
3953 },
3954 "deleteRange": {
3955 "$ref": "DeleteRangeRequest",
3956 "description": "Deletes a range of cells from a sheet, shift ing the remaining cells."
3957 },
3958 "deleteBanding": {
3959 "$ref": "DeleteBandingRequest",
3960 "description": "Removes a banded range"
3961 },
3962 "addFilterView": {
3963 "$ref": "AddFilterViewRequest",
3964 "description": "Adds a filter view."
3965 },
3966 "setDataValidation": {
3967 "$ref": "SetDataValidationRequest",
3968 "description": "Sets data validation for one or more cells."
3969 },
3970 "updateBorders": {
3971 "$ref": "UpdateBordersRequest",
3972 "description": "Updates the borders in a range of cells."
3973 },
3974 "deleteConditionalFormatRule": {
3975 "$ref": "DeleteConditionalFormatRuleRequest",
3976 "description": "Deletes an existing conditional format rule. "
3977 },
3978 "clearBasicFilter": {
3979 "$ref": "ClearBasicFilterRequest",
3980 "description": "Clears the basic filter on a sheet."
3981 },
3982 "repeatCell": {
3983 "$ref": "RepeatCellRequest",
3984 "description": "Repeats a single cell across a range."
3985 },
3986 "appendDimension": {
3987 "$ref": "AppendDimensionRequest",
3988 "description": "Appends dimensions to the end of a sheet."
3989 },
3990 "updateConditionalFormatRule": {
3991 "$ref": "UpdateConditionalFormatRuleRequest",
3992 "description": "Updates an existing conditional format rule. "
3993 },
3994 "insertRange": {
3995 "$ref": "InsertRangeRequest",
3996 "description": "Inserts new cells in a sheet, shifting the e xisting cells."
3997 },
3998 "moveDimension": {
3999 "$ref": "MoveDimensionRequest",
4000 "description": "Moves rows or columns to another location in a sheet."
4001 },
4002 "randomizeRange": {
4003 "$ref": "RandomizeRangeRequest",
4004 "description": "Randomizes the order of the rows in a range. "
4005 },
4006 "updateBanding": {
4007 "$ref": "UpdateBandingRequest",
4008 "description": "Updates a banded range"
4009 },
4010 "deleteNamedRange": {
4011 "$ref": "DeleteNamedRangeRequest",
4012 "description": "Deletes a named range."
4013 },
4014 "addProtectedRange": {
4015 "$ref": "AddProtectedRangeRequest",
4016 "description": "Adds a protected range."
4017 },
4018 "duplicateSheet": {
4019 "$ref": "DuplicateSheetRequest",
4020 "description": "Duplicates a sheet."
4021 },
4022 "deleteSheet": {
4023 "$ref": "DeleteSheetRequest",
4024 "description": "Deletes a sheet."
4025 },
4026 "unmergeCells": {
4027 "$ref": "UnmergeCellsRequest",
4028 "description": "Unmerges merged cells."
4029 },
4030 "updateEmbeddedObjectPosition": {
4031 "$ref": "UpdateEmbeddedObjectPositionRequest",
4032 "description": "Updates an embedded object's (e.g. chart, im age) position."
4033 },
4034 "updateDimensionProperties": {
4035 "$ref": "UpdateDimensionPropertiesRequest",
4036 "description": "Updates dimensions' properties."
4037 },
4038 "pasteData": {
4039 "$ref": "PasteDataRequest",
4040 "description": "Pastes data (HTML or delimited) into a sheet ."
4041 },
4042 "setBasicFilter": {
4043 "$ref": "SetBasicFilterRequest",
4044 "description": "Sets the basic filter on a sheet."
4045 },
4046 "addConditionalFormatRule": {
4047 "$ref": "AddConditionalFormatRuleRequest",
4048 "description": "Adds a new conditional format rule."
4049 },
4050 "updateCells": {
4051 "$ref": "UpdateCellsRequest",
4052 "description": "Updates many cells at once."
4053 },
4054 "addNamedRange": {
4055 "$ref": "AddNamedRangeRequest",
4056 "description": "Adds a named range."
4057 },
4058 "updateSpreadsheetProperties": {
4059 "$ref": "UpdateSpreadsheetPropertiesRequest",
4060 "description": "Updates the spreadsheet's properties."
4061 }
4062 },
4063 "type": "object"
4064 },
4065 "BooleanCondition": {
4066 "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.",
4067 "id": "BooleanCondition",
4068 "properties": {
4069 "values": {
4070 "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.",
4071 "items": {
4072 "$ref": "ConditionValue"
4073 },
4074 "type": "array"
4075 },
4076 "type": {
4077 "description": "The type of condition.",
4078 "enum": [
4079 "CONDITION_TYPE_UNSPECIFIED",
4080 "NUMBER_GREATER",
4081 "NUMBER_GREATER_THAN_EQ",
4082 "NUMBER_LESS",
4083 "NUMBER_LESS_THAN_EQ",
4084 "NUMBER_EQ",
4085 "NUMBER_NOT_EQ",
4086 "NUMBER_BETWEEN",
4087 "NUMBER_NOT_BETWEEN",
4088 "TEXT_CONTAINS",
4089 "TEXT_NOT_CONTAINS",
4090 "TEXT_STARTS_WITH",
4091 "TEXT_ENDS_WITH",
4092 "TEXT_EQ",
4093 "TEXT_IS_EMAIL",
4094 "TEXT_IS_URL",
4095 "DATE_EQ",
4096 "DATE_BEFORE",
4097 "DATE_AFTER",
4098 "DATE_ON_OR_BEFORE",
4099 "DATE_ON_OR_AFTER",
4100 "DATE_BETWEEN",
4101 "DATE_NOT_BETWEEN",
4102 "DATE_IS_VALID",
4103 "ONE_OF_RANGE",
4104 "ONE_OF_LIST",
4105 "BLANK",
4106 "NOT_BLANK",
4107 "CUSTOM_FORMULA"
4510 ], 4108 ],
4511 "enumDescriptions": [ 4109 "enumDescriptions": [
4512 "The default value, do not use.", 4110 "The default value, do not use.",
4513 "Operates on the rows of a sheet.", 4111 "The cell's value must be greater than the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
4514 "Operates on the columns of a sheet." 4112 "The cell's value must be greater than or equal to the c ondition's value.\nSupported by data validation, conditional formatting and filt ers.\nRequires a single ConditionValue.",
4515 ], 4113 "The cell's value must be less than the condition's valu e.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4516 "type": "string" 4114 "The cell's value must be less than or equal to the cond ition's value.\nSupported by data validation, conditional formatting and filters .\nRequires a single ConditionValue.",
4517 }, 4115 "The cell's value must be equal to the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4518 "length": { 4116 "The cell's value must be not equal to the condition's v alue.\nSupported by data validation, conditional formatting and filters.\nRequir es a single ConditionValue.",
4519 "description": "The number of rows or columns to append.", 4117 "The cell's value must be between the two condition valu es.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
4520 "format": "int32", 4118 "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequ ires exactly two ConditionValues.",
4521 "type": "integer" 4119 "The cell's value must contain the condition's value.\nS upported by data validation, conditional formatting and filters.\nRequires a sin gle ConditionValue.",
4522 } 4120 "The cell's value must not contain the condition's value .\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4523 }, 4121 "The cell's value must start with the condition's value. \nSupported by conditional formatting and filters.\nRequires a single ConditionV alue.",
4524 "type": "object" 4122 "The cell's value must end with the condition's value.\n Supported by conditional formatting and filters.\nRequires a single ConditionVal ue.",
4525 }, 4123 "The cell's value must be exactly the condition's value. \nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
4526 "AddNamedRangeRequest": { 4124 "The cell's value must be a valid email address.\nSuppor ted by data validation.\nRequires no ConditionValues.",
4527 "description": "Adds a named range to the spreadsheet.", 4125 "The cell's value must be a valid URL.\nSupported by dat a validation.\nRequires no ConditionValues.",
4528 "id": "AddNamedRangeRequest", 4126 "The cell's value must be the same date as the condition 's value.\nSupported by data validation, conditional formatting and filters.\nRe quires a single ConditionValue.",
4529 "properties": { 4127 "The cell's value must be before the date of the conditi on's value.\nSupported by data validation, conditional formatting and filters.\n Requires a single ConditionValue\nthat may be a relative date.",
4530 "namedRange": { 4128 "The cell's value must be after the date of the conditio n's value.\nSupported by data validation, conditional formatting and filters.\nR equires a single ConditionValue\nthat may be a relative date.",
4531 "$ref": "NamedRange", 4129 "The cell's value must be on or before the date of the c ondition's value.\nSupported by data validation.\nRequires a single ConditionVal ue\nthat may be a relative date.",
4532 "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.)" 4130 "The cell's value must be on or after the date of the co ndition's value.\nSupported by data validation.\nRequires a single ConditionValu e\nthat may be a relative date.",
4533 } 4131 "The cell's value must be between the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
4534 }, 4132 "The cell's value must be outside the dates of the two c ondition values.\nSupported by data validation.\nRequires exactly two ConditionV alues.",
4535 "type": "object" 4133 "The cell's value must be a date.\nSupported by data val idation.\nRequires no ConditionValues.",
4134 "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.",
4135 "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.",
4136 "The cell's value must be empty.\nSupported by condition al formatting and filters.\nRequires no ConditionValues.",
4137 "The cell's value must not be empty.\nSupported by condi tional formatting and filters.\nRequires no ConditionValues.",
4138 "The condition's formula must evaluate to true.\nSupport ed by data validation, conditional formatting and filters.\nRequires a single Co nditionValue."
4139 ],
4140 "type": "string"
4141 }
4142 },
4143 "type": "object"
4144 },
4145 "GridRange": {
4146 "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!`.",
4147 "id": "GridRange",
4148 "properties": {
4149 "endColumnIndex": {
4150 "description": "The end column (exclusive) of the range, or not set if unbounded.",
4151 "format": "int32",
4152 "type": "integer"
4153 },
4154 "endRowIndex": {
4155 "description": "The end row (exclusive) of the range, or not set if unbounded.",
4156 "format": "int32",
4157 "type": "integer"
4158 },
4159 "startRowIndex": {
4160 "description": "The start row (inclusive) of the range, or n ot set if unbounded.",
4161 "format": "int32",
4162 "type": "integer"
4163 },
4164 "startColumnIndex": {
4165 "description": "The start column (inclusive) of the range, o r not set if unbounded.",
4166 "format": "int32",
4167 "type": "integer"
4168 },
4169 "sheetId": {
4170 "description": "The sheet this range is on.",
4171 "format": "int32",
4172 "type": "integer"
4173 }
4174 },
4175 "type": "object"
4176 },
4177 "BasicChartSpec": {
4178 "description": "The specification for a basic chart. See BasicChart Type for the list\nof charts this supports.",
4179 "id": "BasicChartSpec",
4180 "properties": {
4181 "legendPosition": {
4182 "description": "The position of the chart legend.",
4183 "enum": [
4184 "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
4185 "BOTTOM_LEGEND",
4186 "LEFT_LEGEND",
4187 "RIGHT_LEGEND",
4188 "TOP_LEGEND",
4189 "NO_LEGEND"
4190 ],
4191 "enumDescriptions": [
4192 "Default value, do not use.",
4193 "The legend is rendered on the bottom of the chart.",
4194 "The legend is rendered on the left of the chart.",
4195 "The legend is rendered on the right of the chart.",
4196 "The legend is rendered on the top of the chart.",
4197 "No legend is rendered."
4198 ],
4199 "type": "string"
4200 },
4201 "domains": {
4202 "description": "The domain of data this is charting.\nOnly a single domain is supported.",
4203 "items": {
4204 "$ref": "BasicChartDomain"
4205 },
4206 "type": "array"
4207 },
4208 "lineSmoothing": {
4209 "description": "Gets whether all lines should be rendered sm ooth or straight by default.\nApplies to Line charts.",
4210 "type": "boolean"
4211 },
4212 "headerCount": {
4213 "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.)",
4214 "format": "int32",
4215 "type": "integer"
4216 },
4217 "stackedType": {
4218 "description": "The stacked type for charts that support ver tical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.",
4219 "enum": [
4220 "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
4221 "NOT_STACKED",
4222 "STACKED",
4223 "PERCENT_STACKED"
4224 ],
4225 "enumDescriptions": [
4226 "Default value, do not use.",
4227 "Series are not stacked.",
4228 "Series values are stacked, each value is rendered verti cally beginning\nfrom the top of the value below it.",
4229 "Vertical stacks are stretched to reach the top of the c hart, with\nvalues laid out as percentages of each other."
4230 ],
4231 "type": "string"
4232 },
4233 "threeDimensional": {
4234 "description": "True to make the chart 3D.\nApplies to Bar a nd Column charts.",
4235 "type": "boolean"
4236 },
4237 "axis": {
4238 "description": "The axis on the chart.",
4239 "items": {
4240 "$ref": "BasicChartAxis"
4241 },
4242 "type": "array"
4243 },
4244 "interpolateNulls": {
4245 "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missin g). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Comb o charts.",
4246 "type": "boolean"
4247 },
4248 "chartType": {
4249 "description": "The type of the chart.",
4250 "enum": [
4251 "BASIC_CHART_TYPE_UNSPECIFIED",
4252 "BAR",
4253 "LINE",
4254 "AREA",
4255 "COLUMN",
4256 "SCATTER",
4257 "COMBO",
4258 "STEPPED_AREA"
4259 ],
4260 "enumDescriptions": [
4261 "Default value, do not use.",
4262 "A <a href=\"/chart/interactive/docs/gallery/barchart\"> bar chart</a>.",
4263 "A <a href=\"/chart/interactive/docs/gallery/linechart\" >line chart</a>.",
4264 "An <a href=\"/chart/interactive/docs/gallery/areachart\ ">area chart</a>.",
4265 "A <a href=\"/chart/interactive/docs/gallery/columnchart \">column chart</a>.",
4266 "A <a href=\"/chart/interactive/docs/gallery/scatterchar t\">scatter chart</a>.",
4267 "A <a href=\"/chart/interactive/docs/gallery/combochart\ ">combo chart</a>.",
4268 "A <a href=\"/chart/interactive/docs/gallery/steppedarea chart\">stepped area chart</a>."
4269 ],
4270 "type": "string"
4271 },
4272 "series": {
4273 "description": "The data this chart is visualizing.",
4274 "items": {
4275 "$ref": "BasicChartSeries"
4276 },
4277 "type": "array"
4278 }
4279 },
4280 "type": "object"
4281 },
4282 "BubbleChartSpec": {
4283 "description": "A <a href=\"/chart/interactive/docs/gallery/bubblech art\">bubble chart</a>.",
4284 "id": "BubbleChartSpec",
4285 "properties": {
4286 "bubbleMaxRadiusSize": {
4287 "description": "The max radius size of the bubbles, in pixel s.\nIf specified, the field must be a positive value.",
4288 "format": "int32",
4289 "type": "integer"
4290 },
4291 "series": {
4292 "$ref": "ChartData",
4293 "description": "The data contianing the bubble y-values. Th ese values locate the bubbles\nin the chart vertically."
4294 },
4295 "legendPosition": {
4296 "description": "Where the legend of the chart should be draw n.",
4297 "enum": [
4298 "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
4299 "BOTTOM_LEGEND",
4300 "LEFT_LEGEND",
4301 "RIGHT_LEGEND",
4302 "TOP_LEGEND",
4303 "NO_LEGEND",
4304 "INSIDE_LEGEND"
4305 ],
4306 "enumDescriptions": [
4307 "Default value, do not use.",
4308 "The legend is rendered on the bottom of the chart.",
4309 "The legend is rendered on the left of the chart.",
4310 "The legend is rendered on the right of the chart.",
4311 "The legend is rendered on the top of the chart.",
4312 "No legend is rendered.",
4313 "The legend is rendered inside the chart area."
4314 ],
4315 "type": "string"
4316 },
4317 "domain": {
4318 "$ref": "ChartData",
4319 "description": "The data containing the bubble x-values. Th ese values locate the bubbles\nin the chart horizontally."
4320 },
4321 "bubbleSizes": {
4322 "$ref": "ChartData",
4323 "description": "The data contianing the bubble sizes. Bubbl e sizes are used to draw\nthe bubbles at different sizes relative to each other. \nIf specified, group_ids must also be specified. This field is\noptional."
4324 },
4325 "bubbleOpacity": {
4326 "description": "The opacity of the bubbles between 0 and 1.0 .\n0 is fully transparent and 1 is fully opaque.",
4327 "format": "float",
4328 "type": "number"
4329 },
4330 "bubbleBorderColor": {
4331 "$ref": "Color",
4332 "description": "The bubble border color."
4333 },
4334 "bubbleTextStyle": {
4335 "$ref": "TextFormat",
4336 "description": "The format of the text inside the bubbles.\n Underline and Strikethrough are not supported."
4337 },
4338 "groupIds": {
4339 "$ref": "ChartData",
4340 "description": "The data containing the bubble group IDs. Al l bubbles with the same group\nID will be drawn in the same color. If bubble_siz es is specified then\nthis field must also be specified but may contain blank va lues.\nThis field is optional."
4341 },
4342 "bubbleLabels": {
4343 "$ref": "ChartData",
4344 "description": "The data containing the bubble labels. Thes e do not need to be unique."
4345 },
4346 "bubbleMinRadiusSize": {
4347 "description": "The minimum radius size of the bubbles, in p ixels.\nIf specific, the field must be a positive value.",
4348 "format": "int32",
4349 "type": "integer"
4350 }
4351 },
4352 "type": "object"
4353 },
4354 "SetDataValidationRequest": {
4355 "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.",
4356 "id": "SetDataValidationRequest",
4357 "properties": {
4358 "rule": {
4359 "$ref": "DataValidationRule",
4360 "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
4361 },
4362 "range": {
4363 "$ref": "GridRange",
4364 "description": "The range the data validation rule should ap ply to."
4365 }
4366 },
4367 "type": "object"
4368 },
4369 "CellData": {
4370 "description": "Data about a specific cell.",
4371 "id": "CellData",
4372 "properties": {
4373 "dataValidation": {
4374 "$ref": "DataValidationRule",
4375 "description": "A data validation rule on the cell, if any.\ n\nWhen writing, the new data validation rule will overwrite any prior rule."
4376 },
4377 "userEnteredValue": {
4378 "$ref": "ExtendedValue",
4379 "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."
4380 },
4381 "effectiveValue": {
4382 "$ref": "ExtendedValue",
4383 "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."
4384 },
4385 "textFormatRuns": {
4386 "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.",
4387 "items": {
4388 "$ref": "TextFormatRun"
4389 },
4390 "type": "array"
4391 },
4392 "formattedValue": {
4393 "description": "The formatted value of the cell.\nThis is th e value as it's shown to the user.\nThis field is read-only.",
4394 "type": "string"
4395 },
4396 "hyperlink": {
4397 "description": "A hyperlink this cell points to, if any.\nTh is field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnter edValue.formulaValue\nfield.)",
4398 "type": "string"
4399 },
4400 "pivotTable": {
4401 "$ref": "PivotTable",
4402 "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."
4403 },
4404 "userEnteredFormat": {
4405 "$ref": "CellFormat",
4406 "description": "The format the user entered for the cell.\n\ nWhen writing, the new format will be merged with the existing format."
4407 },
4408 "note": {
4409 "description": "Any note on the cell.",
4410 "type": "string"
4411 },
4412 "effectiveFormat": {
4413 "$ref": "CellFormat",
4414 "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."
4415 }
4416 },
4417 "type": "object"
4418 },
4419 "BatchUpdateSpreadsheetRequest": {
4420 "description": "The request for updating any aspect of a spreadsheet .",
4421 "id": "BatchUpdateSpreadsheetRequest",
4422 "properties": {
4423 "responseIncludeGridData": {
4424 "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.",
4425 "type": "boolean"
4426 },
4427 "responseRanges": {
4428 "description": "Limits the ranges included in the response s preadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
4429 "items": {
4430 "type": "string"
4431 },
4432 "type": "array"
4433 },
4434 "includeSpreadsheetInResponse": {
4435 "description": "Determines if the update response should inc lude the spreadsheet\nresource.",
4436 "type": "boolean"
4437 },
4438 "requests": {
4439 "description": "A list of updates to apply to the spreadshee t.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
4440 "items": {
4441 "$ref": "Request"
4442 },
4443 "type": "array"
4444 }
4445 },
4446 "type": "object"
4447 },
4448 "BasicChartAxis": {
4449 "description": "An axis of the chart.\nA chart may not have more tha n one axis per\naxis position.",
4450 "id": "BasicChartAxis",
4451 "properties": {
4452 "format": {
4453 "$ref": "TextFormat",
4454 "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
4455 },
4456 "title": {
4457 "description": "The title of this axis. If set, this overrid es any title inferred\nfrom headers of the data.",
4458 "type": "string"
4459 },
4460 "position": {
4461 "description": "The position of this axis.",
4462 "enum": [
4463 "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
4464 "BOTTOM_AXIS",
4465 "LEFT_AXIS",
4466 "RIGHT_AXIS"
4467 ],
4468 "enumDescriptions": [
4469 "Default value, do not use.",
4470 "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.",
4471 "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.",
4472 "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."
4473 ],
4474 "type": "string"
4475 }
4476 },
4477 "type": "object"
4478 },
4479 "Padding": {
4480 "description": "The amount of padding around the cell, in pixels.\nW hen updating padding, every field must be specified.",
4481 "id": "Padding",
4482 "properties": {
4483 "bottom": {
4484 "description": "The bottom padding of the cell.",
4485 "format": "int32",
4486 "type": "integer"
4487 },
4488 "top": {
4489 "description": "The top padding of the cell.",
4490 "format": "int32",
4491 "type": "integer"
4492 },
4493 "left": {
4494 "description": "The left padding of the cell.",
4495 "format": "int32",
4496 "type": "integer"
4497 },
4498 "right": {
4499 "description": "The right padding of the cell.",
4500 "format": "int32",
4501 "type": "integer"
4502 }
4503 },
4504 "type": "object"
4505 },
4506 "DeleteDimensionRequest": {
4507 "description": "Deletes the dimensions from the sheet.",
4508 "id": "DeleteDimensionRequest",
4509 "properties": {
4510 "range": {
4511 "$ref": "DimensionRange",
4512 "description": "The dimensions to delete from the sheet."
4513 }
4514 },
4515 "type": "object"
4516 },
4517 "UpdateChartSpecRequest": {
4518 "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.)",
4519 "id": "UpdateChartSpecRequest",
4520 "properties": {
4521 "spec": {
4522 "$ref": "ChartSpec",
4523 "description": "The specification to apply to the chart."
4524 },
4525 "chartId": {
4526 "description": "The ID of the chart to update.",
4527 "format": "int32",
4528 "type": "integer"
4529 }
4530 },
4531 "type": "object"
4532 },
4533 "DeleteFilterViewRequest": {
4534 "description": "Deletes a particular filter view.",
4535 "id": "DeleteFilterViewRequest",
4536 "properties": {
4537 "filterId": {
4538 "description": "The ID of the filter to delete.",
4539 "format": "int32",
4540 "type": "integer"
4541 }
4542 },
4543 "type": "object"
4536 } 4544 }
4537 }, 4545 },
4538 "servicePath": "", 4546 "servicePath": "",
4539 "title": "Google Sheets API", 4547 "title": "Google Sheets API",
4540 "version": "v4" 4548 "version": "v4"
4541 } 4549 }
OLDNEW
« no previous file with comments | « discovery/googleapis/serviceuser__v1.json ('k') | discovery/googleapis/slides__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698