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

Side by Side Diff: discovery/googleapis/script__v1.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/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.google.com/m8/feeds": {
6 "description": "Manage your contacts"
7 },
8 "https://www.googleapis.com/auth/userinfo.email": {
9 "description": "View your email address"
10 },
11 "https://www.google.com/calendar/feeds": {
12 "description": "Manage your calendars"
13 },
5 "https://www.googleapis.com/auth/groups": { 14 "https://www.googleapis.com/auth/groups": {
6 "description": "View and manage your Google Groups" 15 "description": "View and manage your Google Groups"
7 }, 16 },
8 "https://www.googleapis.com/auth/forms.currentonly": { 17 "https://www.googleapis.com/auth/forms.currentonly": {
9 "description": "View and manage forms that this application has been installed in" 18 "description": "View and manage forms that this application has been installed in"
10 }, 19 },
11 "https://www.googleapis.com/auth/drive": { 20 "https://www.googleapis.com/auth/drive": {
12 "description": "View and manage the files in your Google Dri ve" 21 "description": "View and manage the files in your Google Dri ve"
13 }, 22 },
23 "https://www.googleapis.com/auth/admin.directory.user": {
24 "description": "View and manage the provisioning of users on your domain"
25 },
26 "https://www.googleapis.com/auth/admin.directory.group": {
27 "description": "View and manage the provisioning of groups o n your domain"
28 },
29 "https://mail.google.com/": {
30 "description": "Read, send, delete, and manage your email"
31 },
14 "https://www.googleapis.com/auth/spreadsheets": { 32 "https://www.googleapis.com/auth/spreadsheets": {
15 "description": "View and manage your spreadsheets in Google Drive" 33 "description": "View and manage your spreadsheets in Google Drive"
16 }, 34 },
17 "https://mail.google.com/": {
18 "description": "Read, send, delete, and manage your email"
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 },
26 "https://www.googleapis.com/auth/forms": { 35 "https://www.googleapis.com/auth/forms": {
27 "description": "View and manage your forms in Google Drive" 36 "description": "View and manage your forms in Google Drive"
28 },
29 "https://www.google.com/m8/feeds": {
30 "description": "Manage your contacts"
31 },
32 "https://www.googleapis.com/auth/userinfo.email": {
33 "description": "View your email address"
34 },
35 "https://www.google.com/calendar/feeds": {
36 "description": "Manage your calendars"
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 "bearer_token": {
58 "description": "OAuth bearer token.",
59 "location": "query",
60 "type": "string"
61 },
62 "oauth_token": {
63 "description": "OAuth 2.0 token for the current user.",
64 "location": "query",
65 "type": "string"
66 },
57 "upload_protocol": { 67 "upload_protocol": {
58 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 68 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
59 "location": "query", 69 "location": "query",
60 "type": "string" 70 "type": "string"
61 }, 71 },
62 "prettyPrint": { 72 "prettyPrint": {
63 "default": "true", 73 "default": "true",
64 "description": "Returns response with indentations and line breaks." , 74 "description": "Returns response with indentations and line breaks." ,
65 "location": "query", 75 "location": "query",
66 "type": "boolean" 76 "type": "boolean"
67 }, 77 },
68 "uploadType": { 78 "uploadType": {
69 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 79 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
70 "location": "query", 80 "location": "query",
71 "type": "string" 81 "type": "string"
72 }, 82 },
73 "fields": { 83 "fields": {
74 "description": "Selector specifying which fields to include in a par tial response.", 84 "description": "Selector specifying which fields to include in a par tial response.",
75 "location": "query", 85 "location": "query",
76 "type": "string" 86 "type": "string"
77 }, 87 },
88 "callback": {
89 "description": "JSONP",
90 "location": "query",
91 "type": "string"
92 },
78 "$.xgafv": { 93 "$.xgafv": {
79 "description": "V1 error format.", 94 "description": "V1 error format.",
80 "enum": [ 95 "enum": [
81 "1", 96 "1",
82 "2" 97 "2"
83 ], 98 ],
84 "enumDescriptions": [ 99 "enumDescriptions": [
85 "v1 error format", 100 "v1 error format",
86 "v2 error format" 101 "v2 error format"
87 ], 102 ],
88 "location": "query", 103 "location": "query",
89 "type": "string" 104 "type": "string"
90 }, 105 },
91 "callback": {
92 "description": "JSONP",
93 "location": "query",
94 "type": "string"
95 },
96 "alt": { 106 "alt": {
97 "default": "json", 107 "default": "json",
98 "description": "Data format for response.", 108 "description": "Data format for response.",
99 "enum": [ 109 "enum": [
100 "json", 110 "json",
101 "media", 111 "media",
102 "proto" 112 "proto"
103 ], 113 ],
104 "enumDescriptions": [ 114 "enumDescriptions": [
105 "Responses with Content-Type of application/json", 115 "Responses with Content-Type of application/json",
(...skipping 16 matching lines...) Expand all
122 "quotaUser": { 132 "quotaUser": {
123 "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.", 133 "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.",
124 "location": "query", 134 "location": "query",
125 "type": "string" 135 "type": "string"
126 }, 136 },
127 "pp": { 137 "pp": {
128 "default": "true", 138 "default": "true",
129 "description": "Pretty-print response.", 139 "description": "Pretty-print response.",
130 "location": "query", 140 "location": "query",
131 "type": "boolean" 141 "type": "boolean"
132 },
133 "oauth_token": {
134 "description": "OAuth 2.0 token for the current user.",
135 "location": "query",
136 "type": "string"
137 },
138 "bearer_token": {
139 "description": "OAuth bearer token.",
140 "location": "query",
141 "type": "string"
142 } 142 }
143 }, 143 },
144 "protocol": "rest", 144 "protocol": "rest",
145 "resources": { 145 "resources": {
146 "scripts": { 146 "scripts": {
147 "methods": { 147 "methods": {
148 "run": { 148 "run": {
149 "description": "Runs a function in an Apps Script project. T he project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast o ne of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the pr oject in the script editor, then select\n**File > Project properties** and click the **Scopes** tab.", 149 "description": "Runs a function in an Apps Script project. T he project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast o ne of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the pr oject in the script editor, then select\n**File > Project properties** and click the **Scopes** tab.",
150 "httpMethod": "POST", 150 "httpMethod": "POST",
151 "id": "script.scripts.run", 151 "id": "script.scripts.run",
(...skipping 25 matching lines...) Expand all
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": "20170705", 187 "revision": "20170720",
188 "rootUrl": "https://script.googleapis.com/", 188 "rootUrl": "https://script.googleapis.com/",
189 "schemas": { 189 "schemas": {
190 "ExecutionError": {
191 "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.",
192 "id": "ExecutionError",
193 "properties": {
194 "errorType": {
195 "description": "The error type, for example `TypeError` or ` ReferenceError`. If the error\ntype is unavailable, this field is not included." ,
196 "type": "string"
197 },
198 "errorMessage": {
199 "description": "The error message thrown by Apps Script, usu ally localized into the user's\nlanguage.",
200 "type": "string"
201 },
202 "scriptStackTraceElements": {
203 "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.",
204 "items": {
205 "$ref": "ScriptStackTraceElement"
206 },
207 "type": "array"
208 }
209 },
210 "type": "object"
211 },
190 "Status": { 212 "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.", 213 "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", 214 "id": "Status",
193 "properties": { 215 "properties": {
194 "code": { 216 "code": {
195 "description": "The status code. For this API, this value wi ll always be 3, corresponding to an INVALID_ARGUMENT error.", 217 "description": "The status code. For this API, this value wi ll always be 3, corresponding to an INVALID_ARGUMENT error.",
196 "format": "int32", 218 "format": "int32",
197 "type": "integer" 219 "type": "integer"
198 }, 220 },
199 "message": { 221 "message": {
(...skipping 11 matching lines...) Expand all
211 }, 233 },
212 "type": "array" 234 "type": "array"
213 } 235 }
214 }, 236 },
215 "type": "object" 237 "type": "object"
216 }, 238 },
217 "ExecutionRequest": { 239 "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.", 240 "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", 241 "id": "ExecutionRequest",
220 "properties": { 242 "properties": {
243 "parameters": {
244 "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.",
245 "items": {
246 "type": "any"
247 },
248 "type": "array"
249 },
221 "sessionState": { 250 "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.", 251 "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" 252 "type": "string"
224 }, 253 },
225 "devMode": { 254 "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`.", 255 "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" 256 "type": "boolean"
228 }, 257 },
229 "function": { 258 "function": {
230 "description": "The name of the function to execute in the g iven script. The name does not\ninclude parentheses or parameters.", 259 "description": "The name of the function to execute in the g iven script. The name does not\ninclude parentheses or parameters.",
231 "type": "string" 260 "type": "string"
232 },
233 "parameters": {
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.",
235 "items": {
236 "type": "any"
237 },
238 "type": "array"
239 } 261 }
240 }, 262 },
241 "type": "object" 263 "type": "object"
242 }, 264 },
243 "JoinAsyncRequest": { 265 "JoinAsyncRequest": {
244 "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.", 266 "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
245 "id": "JoinAsyncRequest", 267 "id": "JoinAsyncRequest",
246 "properties": { 268 "properties": {
269 "names": {
270 "description": "List of operation resource names that we wan t to join,\nas returned from a call to RunAsync.",
271 "items": {
272 "type": "string"
273 },
274 "type": "array"
275 },
247 "timeout": { 276 "timeout": {
248 "description": "Timeout for information retrieval in millise conds.", 277 "description": "Timeout for information retrieval in millise conds.",
249 "format": "google-duration", 278 "format": "google-duration",
250 "type": "string" 279 "type": "string"
251 }, 280 },
252 "scriptId": { 281 "scriptId": {
253 "description": "The script id which specifies the script whi ch all processes in the names\nfield must be from.", 282 "description": "The script id which specifies the script whi ch all processes in the names\nfield must be from.",
254 "type": "string" 283 "type": "string"
255 },
256 "names": {
257 "description": "List of operation resource names that we wan t to join,\nas returned from a call to RunAsync.",
258 "items": {
259 "type": "string"
260 },
261 "type": "array"
262 } 284 }
263 }, 285 },
264 "type": "object" 286 "type": "object"
265 }, 287 },
266 "ExecutionResponse": { 288 "ExecutionResponse": {
267 "description": "An object that provides the return value of a functi on executed through the\nApps Script Execution API. If a\n`run` call succeeds an d the\nscript function returns successfully, the response body's\n`response` fie ld contains this\n`ExecutionResponse` object.", 289 "description": "An object that provides the return value of a functi on executed through the\nApps Script Execution API. If a\n`run` call succeeds an d the\nscript function returns successfully, the response body's\n`response` fie ld contains this\n`ExecutionResponse` object.",
268 "id": "ExecutionResponse", 290 "id": "ExecutionResponse",
269 "properties": { 291 "properties": {
270 "result": { 292 "result": {
271 "description": "The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called through the Execution API cannot\nreturn Apps Script-specific objects (such as a `Docum ent` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.", 293 "description": "The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called through the Execution API cannot\nreturn Apps Script-specific objects (such as a `Docum ent` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.",
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
320 "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.", 342 "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.",
321 "type": "object" 343 "type": "object"
322 } 344 }
323 }, 345 },
324 "type": "object" 346 "type": "object"
325 }, 347 },
326 "ScriptStackTraceElement": { 348 "ScriptStackTraceElement": {
327 "description": "A stack trace through the script that shows where th e execution failed.", 349 "description": "A stack trace through the script that shows where th e execution failed.",
328 "id": "ScriptStackTraceElement", 350 "id": "ScriptStackTraceElement",
329 "properties": { 351 "properties": {
352 "function": {
353 "description": "The name of the function that failed.",
354 "type": "string"
355 },
330 "lineNumber": { 356 "lineNumber": {
331 "description": "The line number where the script failed.", 357 "description": "The line number where the script failed.",
332 "format": "int32", 358 "format": "int32",
333 "type": "integer" 359 "type": "integer"
334 },
335 "function": {
336 "description": "The name of the function that failed.",
337 "type": "string"
338 } 360 }
339 }, 361 },
340 "type": "object" 362 "type": "object"
341 },
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.",
344 "id": "ExecutionError",
345 "properties": {
346 "scriptStackTraceElements": {
347 "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.",
348 "items": {
349 "$ref": "ScriptStackTraceElement"
350 },
351 "type": "array"
352 },
353 "errorType": {
354 "description": "The error type, for example `TypeError` or ` ReferenceError`. If the error\ntype is unavailable, this field is not included." ,
355 "type": "string"
356 },
357 "errorMessage": {
358 "description": "The error message thrown by Apps Script, usu ally localized into the user's\nlanguage.",
359 "type": "string"
360 }
361 },
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