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

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

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 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/safebrowsing__v4.json ('k') | discovery/googleapis/searchconsole__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/admin.directory.group": { 5 "https://www.googleapis.com/auth/groups": {
6 "description": "View and manage the provisioning of groups o n your domain" 6 "description": "View and manage your Google Groups"
7 }, 7 },
8 "https://www.googleapis.com/auth/admin.directory.user": { 8 "https://www.googleapis.com/auth/forms.currentonly": {
9 "description": "View and manage the provisioning of users on your domain" 9 "description": "View and manage forms that this application has been installed in"
10 },
11 "https://www.googleapis.com/auth/drive": {
12 "description": "View and manage the files in your Google Dri ve"
10 }, 13 },
11 "https://www.googleapis.com/auth/spreadsheets": { 14 "https://www.googleapis.com/auth/spreadsheets": {
12 "description": "View and manage your spreadsheets in Google Drive" 15 "description": "View and manage your spreadsheets in Google Drive"
13 }, 16 },
14 "https://mail.google.com/": { 17 "https://mail.google.com/": {
15 "description": "Read, send, delete, and manage your email" 18 "description": "Read, send, delete, and manage your email"
16 }, 19 },
20 "https://www.googleapis.com/auth/admin.directory.group": {
21 "description": "View and manage the provisioning of groups o n your domain"
22 },
23 "https://www.googleapis.com/auth/admin.directory.user": {
24 "description": "View and manage the provisioning of users on your domain"
25 },
17 "https://www.googleapis.com/auth/forms": { 26 "https://www.googleapis.com/auth/forms": {
18 "description": "View and manage your forms in Google Drive" 27 "description": "View and manage your forms in Google Drive"
19 }, 28 },
20 "https://www.google.com/m8/feeds": { 29 "https://www.google.com/m8/feeds": {
21 "description": "Manage your contacts" 30 "description": "Manage your contacts"
22 }, 31 },
23 "https://www.googleapis.com/auth/userinfo.email": { 32 "https://www.googleapis.com/auth/userinfo.email": {
24 "description": "View your email address" 33 "description": "View your email address"
25 }, 34 },
26 "https://www.google.com/calendar/feeds": { 35 "https://www.google.com/calendar/feeds": {
27 "description": "Manage your calendars" 36 "description": "Manage your calendars"
28 },
29 "https://www.googleapis.com/auth/groups": {
30 "description": "View and manage your Google Groups"
31 },
32 "https://www.googleapis.com/auth/forms.currentonly": {
33 "description": "View and manage forms that this application has been installed in"
34 },
35 "https://www.googleapis.com/auth/drive": {
36 "description": "View and manage the files in your Google Dri ve"
37 } 37 }
38 } 38 }
39 } 39 }
40 }, 40 },
41 "basePath": "", 41 "basePath": "",
42 "baseUrl": "https://script.googleapis.com/", 42 "baseUrl": "https://script.googleapis.com/",
43 "batchPath": "batch", 43 "batchPath": "batch",
44 "description": "Executes Google Apps Script projects.", 44 "description": "Executes Google Apps Script projects.",
45 "discoveryVersion": "v1", 45 "discoveryVersion": "v1",
46 "documentationLink": "https://developers.google.com/apps-script/execution/re st/v1/scripts/run", 46 "documentationLink": "https://developers.google.com/apps-script/execution/re st/v1/scripts/run",
47 "icons": { 47 "icons": {
48 "x16": "http://www.google.com/images/icons/product/search-16.gif", 48 "x16": "http://www.google.com/images/icons/product/search-16.gif",
49 "x32": "http://www.google.com/images/icons/product/search-32.gif" 49 "x32": "http://www.google.com/images/icons/product/search-32.gif"
50 }, 50 },
51 "id": "script:v1", 51 "id": "script:v1",
52 "kind": "discovery#restDescription", 52 "kind": "discovery#restDescription",
53 "name": "script", 53 "name": "script",
54 "ownerDomain": "google.com", 54 "ownerDomain": "google.com",
55 "ownerName": "Google", 55 "ownerName": "Google",
56 "parameters": { 56 "parameters": {
57 "access_token": {
58 "description": "OAuth access token.",
59 "location": "query",
60 "type": "string"
61 },
57 "key": { 62 "key": {
58 "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.", 63 "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.",
59 "location": "query", 64 "location": "query",
60 "type": "string" 65 "type": "string"
61 }, 66 },
62 "access_token": {
63 "description": "OAuth access token.",
64 "location": "query",
65 "type": "string"
66 },
67 "quotaUser": { 67 "quotaUser": {
68 "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.", 68 "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.",
69 "location": "query", 69 "location": "query",
70 "type": "string" 70 "type": "string"
71 }, 71 },
72 "pp": { 72 "pp": {
73 "default": "true", 73 "default": "true",
74 "description": "Pretty-print response.", 74 "description": "Pretty-print response.",
75 "location": "query", 75 "location": "query",
76 "type": "boolean" 76 "type": "boolean"
77 }, 77 },
78 "bearer_token": {
79 "description": "OAuth bearer token.",
80 "location": "query",
81 "type": "string"
82 },
78 "oauth_token": { 83 "oauth_token": {
79 "description": "OAuth 2.0 token for the current user.", 84 "description": "OAuth 2.0 token for the current user.",
80 "location": "query", 85 "location": "query",
81 "type": "string" 86 "type": "string"
82 }, 87 },
83 "bearer_token": {
84 "description": "OAuth bearer token.",
85 "location": "query",
86 "type": "string"
87 },
88 "upload_protocol": { 88 "upload_protocol": {
89 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 89 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
90 "location": "query", 90 "location": "query",
91 "type": "string" 91 "type": "string"
92 }, 92 },
93 "prettyPrint": { 93 "prettyPrint": {
94 "default": "true", 94 "default": "true",
95 "description": "Returns response with indentations and line breaks." , 95 "description": "Returns response with indentations and line breaks." ,
96 "location": "query", 96 "location": "query",
97 "type": "boolean" 97 "type": "boolean"
98 }, 98 },
99 "uploadType": {
100 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
101 "location": "query",
102 "type": "string"
103 },
99 "fields": { 104 "fields": {
100 "description": "Selector specifying which fields to include in a par tial response.", 105 "description": "Selector specifying which fields to include in a par tial response.",
101 "location": "query", 106 "location": "query",
102 "type": "string" 107 "type": "string"
103 }, 108 },
104 "uploadType": { 109 "callback": {
105 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 110 "description": "JSONP",
106 "location": "query", 111 "location": "query",
107 "type": "string" 112 "type": "string"
108 }, 113 },
109 "$.xgafv": { 114 "$.xgafv": {
110 "description": "V1 error format.", 115 "description": "V1 error format.",
111 "enum": [ 116 "enum": [
112 "1", 117 "1",
113 "2" 118 "2"
114 ], 119 ],
115 "enumDescriptions": [ 120 "enumDescriptions": [
116 "v1 error format", 121 "v1 error format",
117 "v2 error format" 122 "v2 error format"
118 ], 123 ],
119 "location": "query", 124 "location": "query",
120 "type": "string" 125 "type": "string"
121 }, 126 },
122 "callback": {
123 "description": "JSONP",
124 "location": "query",
125 "type": "string"
126 },
127 "alt": { 127 "alt": {
128 "default": "json", 128 "default": "json",
129 "description": "Data format for response.", 129 "description": "Data format for response.",
130 "enum": [ 130 "enum": [
131 "json", 131 "json",
132 "media", 132 "media",
133 "proto" 133 "proto"
134 ], 134 ],
135 "enumDescriptions": [ 135 "enumDescriptions": [
136 "Responses with Content-Type of application/json", 136 "Responses with Content-Type of application/json",
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
177 "https://www.googleapis.com/auth/forms", 177 "https://www.googleapis.com/auth/forms",
178 "https://www.googleapis.com/auth/forms.currentonly", 178 "https://www.googleapis.com/auth/forms.currentonly",
179 "https://www.googleapis.com/auth/groups", 179 "https://www.googleapis.com/auth/groups",
180 "https://www.googleapis.com/auth/spreadsheets", 180 "https://www.googleapis.com/auth/spreadsheets",
181 "https://www.googleapis.com/auth/userinfo.email" 181 "https://www.googleapis.com/auth/userinfo.email"
182 ] 182 ]
183 } 183 }
184 } 184 }
185 } 185 }
186 }, 186 },
187 "revision": "20170509", 187 "revision": "20170605",
188 "rootUrl": "https://script.googleapis.com/", 188 "rootUrl": "https://script.googleapis.com/",
189 "schemas": { 189 "schemas": {
190 "Status": { 190 "Status": {
191 "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.", 191 "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
192 "id": "Status", 192 "id": "Status",
193 "properties": { 193 "properties": {
194 "code": {
195 "description": "The status code. For this API, this value wi ll always be 3, corresponding to an INVALID_ARGUMENT error.",
196 "format": "int32",
197 "type": "integer"
198 },
199 "message": {
200 "description": "A developer-facing error message, which is i n English. Any user-facing error message is localized and sent in the [`google.r pc.Status.details`](google.rpc.Status.details) field, or localized by the client .",
201 "type": "string"
202 },
203 "details": { 194 "details": {
204 "description": "An array that contains a single `ExecutionEr ror` object that provides information about the nature of the error.", 195 "description": "An array that contains a single `ExecutionEr ror` object that provides information about the nature of the error.",
205 "items": { 196 "items": {
206 "additionalProperties": { 197 "additionalProperties": {
207 "description": "Properties of the object. Contains f ield @type with type URL.", 198 "description": "Properties of the object. Contains f ield @type with type URL.",
208 "type": "any" 199 "type": "any"
209 }, 200 },
210 "type": "object" 201 "type": "object"
211 }, 202 },
212 "type": "array" 203 "type": "array"
204 },
205 "code": {
206 "description": "The status code. For this API, this value wi ll always be 3, corresponding to an INVALID_ARGUMENT error.",
207 "format": "int32",
208 "type": "integer"
209 },
210 "message": {
211 "description": "A developer-facing error message, which is i n English. Any user-facing error message is localized and sent in the [`google.r pc.Status.details`](google.rpc.Status.details) field, or localized by the client .",
212 "type": "string"
213 } 213 }
214 }, 214 },
215 "type": "object" 215 "type": "object"
216 }, 216 },
217 "ExecutionRequest": { 217 "ExecutionRequest": {
218 "description": "A request to run the function in a script. The scrip t is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.", 218 "description": "A request to run the function in a script. The scrip t is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
219 "id": "ExecutionRequest", 219 "id": "ExecutionRequest",
220 "properties": { 220 "properties": {
221 "sessionState": {
222 "description": "For Android add-ons only. An ID that represe nts the user's current session\nin the Android app for Google Docs or Sheets, in cluded as extra data in the\n[`Intent`](https://developer.android.com/guide/comp onents/intents-filters.html)\nthat launches the add-on. When an Android add-on i s run with a session\nstate, it gains the privileges of a\n[bound](https://devel opers.google.com/apps-script/guides/bound) script —\nthat is, it can acces s information like the user's current cursor position\n(in Docs) or selected cel l (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google. android.apps.docs.addons.SessionState\")`.\nOptional.",
223 "type": "string"
224 },
221 "function": { 225 "function": {
222 "description": "The name of the function to execute in the g iven script. The name does not\ninclude parentheses or parameters.", 226 "description": "The name of the function to execute in the g iven script. The name does not\ninclude parentheses or parameters.",
223 "type": "string" 227 "type": "string"
224 }, 228 },
225 "devMode": { 229 "devMode": {
226 "description": "If `true` and the user is an owner of the sc ript, the script runs at the\nmost recently saved version rather than the versio n deployed for use with\nthe Execution API. Optional; default is `false`.", 230 "description": "If `true` and the user is an owner of the sc ript, the script runs at the\nmost recently saved version rather than the versio n deployed for use with\nthe Execution API. Optional; default is `false`.",
227 "type": "boolean" 231 "type": "boolean"
228 }, 232 },
229 "parameters": { 233 "parameters": {
230 "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected ty pe in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`s tring`, `number`, `array`, `object`, or `boolean`. Optional.", 234 "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected ty pe in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`s tring`, `number`, `array`, `object`, or `boolean`. Optional.",
231 "items": { 235 "items": {
232 "type": "any" 236 "type": "any"
233 }, 237 },
234 "type": "array" 238 "type": "array"
235 },
236 "sessionState": {
237 "description": "For Android add-ons only. An ID that represe nts the user's current session\nin the Android app for Google Docs or Sheets, in cluded as extra data in the\n[`Intent`](https://developer.android.com/guide/comp onents/intents-filters.html)\nthat launches the add-on. When an Android add-on i s run with a session\nstate, it gains the privileges of a\n[bound](https://devel opers.google.com/apps-script/guides/bound) script —\nthat is, it can acces s information like the user's current cursor position\n(in Docs) or selected cel l (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google. android.apps.docs.addons.SessionState\")`.\nOptional.",
238 "type": "string"
239 } 239 }
240 }, 240 },
241 "type": "object" 241 "type": "object"
242 }, 242 },
243 "JoinAsyncRequest": { 243 "JoinAsyncRequest": {
244 "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.", 244 "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
245 "id": "JoinAsyncRequest", 245 "id": "JoinAsyncRequest",
246 "properties": { 246 "properties": {
247 "scriptId": { 247 "scriptId": {
248 "description": "The script id which specifies the script whi ch all processes in the names\nfield must be from.", 248 "description": "The script id which specifies the script whi ch all processes in the names\nfield must be from.",
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
285 "description": "The return values for each script function, in a map of operation resource\nnames to the Operation containing the result of the process. The response\nwill contain either an error or the result of the scr ipt function.", 285 "description": "The return values for each script function, in a map of operation resource\nnames to the Operation containing the result of the process. The response\nwill contain either an error or the result of the scr ipt function.",
286 "type": "object" 286 "type": "object"
287 } 287 }
288 }, 288 },
289 "type": "object" 289 "type": "object"
290 }, 290 },
291 "Operation": { 291 "Operation": {
292 "description": "The response will not arrive until the function fini shes executing. The maximum runtime is listed in the guide to [limitations in Ap ps Script](https://developers.google.com/apps-script/guides/services/quotas#curr ent_limitations).\n<p>If the script function returns successfully, the `response ` field will contain an `ExecutionResponse` object with the function's return va lue in the object's `result` field.</p>\n<p>If the script function (or Apps Scri pt itself) throws an exception, the `error` field will contain a `Status` object . The `Status` object's `details` field will contain an array with a single `Exe cutionError` object that provides information about the nature of the error.</p> \n<p>If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.</p>", 292 "description": "The response will not arrive until the function fini shes executing. The maximum runtime is listed in the guide to [limitations in Ap ps Script](https://developers.google.com/apps-script/guides/services/quotas#curr ent_limitations).\n<p>If the script function returns successfully, the `response ` field will contain an `ExecutionResponse` object with the function's return va lue in the object's `result` field.</p>\n<p>If the script function (or Apps Scri pt itself) throws an exception, the `error` field will contain a `Status` object . The `Status` object's `details` field will contain an array with a single `Exe cutionError` object that provides information about the nature of the error.</p> \n<p>If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.</p>",
293 "id": "Operation", 293 "id": "Operation",
294 "properties": { 294 "properties": {
295 "error": {
296 "$ref": "Status",
297 "description": "If a `run` call succeeds but the script func tion (or Apps Script itself) throws an exception, this field will contain a `Sta tus` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error."
298 },
299 "metadata": {
300 "additionalProperties": {
301 "description": "Properties of the object. Contains field @type with type URL.",
302 "type": "any"
303 },
304 "description": "This field is not used.",
305 "type": "object"
306 },
295 "done": { 307 "done": {
296 "description": "This field is not used.", 308 "description": "This field is not used.",
297 "type": "boolean" 309 "type": "boolean"
298 }, 310 },
299 "response": { 311 "response": {
300 "additionalProperties": { 312 "additionalProperties": {
301 "description": "Properties of the object. Contains field @type with type URL.", 313 "description": "Properties of the object. Contains field @type with type URL.",
302 "type": "any" 314 "type": "any"
303 }, 315 },
304 "description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's retur n value as the object's `result` field.", 316 "description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's retur n value as the object's `result` field.",
305 "type": "object" 317 "type": "object"
306 }, 318 },
307 "name": { 319 "name": {
308 "description": "This field is not used.", 320 "description": "This field is not used.",
309 "type": "string" 321 "type": "string"
310 },
311 "error": {
312 "$ref": "Status",
313 "description": "If a `run` call succeeds but the script func tion (or Apps Script itself) throws an exception, this field will contain a `Sta tus` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error."
314 },
315 "metadata": {
316 "additionalProperties": {
317 "description": "Properties of the object. Contains field @type with type URL.",
318 "type": "any"
319 },
320 "description": "This field is not used.",
321 "type": "object"
322 } 322 }
323 }, 323 },
324 "type": "object" 324 "type": "object"
325 }, 325 },
326 "ScriptStackTraceElement": { 326 "ScriptStackTraceElement": {
327 "description": "A stack trace through the script that shows where th e execution failed.", 327 "description": "A stack trace through the script that shows where th e execution failed.",
328 "id": "ScriptStackTraceElement", 328 "id": "ScriptStackTraceElement",
329 "properties": { 329 "properties": {
330 "function": {
331 "description": "The name of the function that failed.",
332 "type": "string"
333 },
330 "lineNumber": { 334 "lineNumber": {
331 "description": "The line number where the script failed.", 335 "description": "The line number where the script failed.",
332 "format": "int32", 336 "format": "int32",
333 "type": "integer" 337 "type": "integer"
334 },
335 "function": {
336 "description": "The name of the function that failed.",
337 "type": "string"
338 } 338 }
339 }, 339 },
340 "type": "object" 340 "type": "object"
341 }, 341 },
342 "ExecutionError": { 342 "ExecutionError": {
343 "description": "An object that provides information about the nature of an error in the Apps\nScript Execution API. If an\n`run` call succeeds but t he\nscript function (or Apps Script itself) throws an exception, the response\nb ody's `error` field contains a\n`Status` object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.", 343 "description": "An object that provides information about the nature of an error in the Apps\nScript Execution API. If an\n`run` call succeeds but t he\nscript function (or Apps Script itself) throws an exception, the response\nb ody's `error` field contains a\n`Status` object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
344 "id": "ExecutionError", 344 "id": "ExecutionError",
345 "properties": { 345 "properties": {
346 "errorType": {
347 "description": "The error type, for example `TypeError` or ` ReferenceError`. If the error\ntype is unavailable, this field is not included." ,
348 "type": "string"
349 },
346 "errorMessage": { 350 "errorMessage": {
347 "description": "The error message thrown by Apps Script, usu ally localized into the user's\nlanguage.", 351 "description": "The error message thrown by Apps Script, usu ally localized into the user's\nlanguage.",
348 "type": "string" 352 "type": "string"
349 }, 353 },
350 "scriptStackTraceElements": { 354 "scriptStackTraceElements": {
351 "description": "An array of objects that provide a stack tra ce through the script to show\nwhere the execution failed, with the deepest call first.", 355 "description": "An array of objects that provide a stack tra ce through the script to show\nwhere the execution failed, with the deepest call first.",
352 "items": { 356 "items": {
353 "$ref": "ScriptStackTraceElement" 357 "$ref": "ScriptStackTraceElement"
354 }, 358 },
355 "type": "array" 359 "type": "array"
356 },
357 "errorType": {
358 "description": "The error type, for example `TypeError` or ` ReferenceError`. If the error\ntype is unavailable, this field is not included." ,
359 "type": "string"
360 } 360 }
361 }, 361 },
362 "type": "object" 362 "type": "object"
363 } 363 }
364 }, 364 },
365 "servicePath": "", 365 "servicePath": "",
366 "title": "Google Apps Script Execution API", 366 "title": "Google Apps Script Execution API",
367 "version": "v1" 367 "version": "v1"
368 } 368 }
OLDNEW
« no previous file with comments | « discovery/googleapis/safebrowsing__v4.json ('k') | discovery/googleapis/searchconsole__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698