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

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

Issue 2779563003: Api-roll 47: 2017-03-27 (Closed)
Patch Set: Created 3 years, 9 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 },
14 "https://www.googleapis.com/auth/groups": { 5 "https://www.googleapis.com/auth/groups": {
15 "description": "View and manage your Google Groups" 6 "description": "View and manage your Google Groups"
16 }, 7 },
17 "https://www.googleapis.com/auth/forms.currentonly": { 8 "https://www.googleapis.com/auth/forms.currentonly": {
18 "description": "View and manage forms that this application has been installed in" 9 "description": "View and manage forms that this application has been installed in"
19 }, 10 },
20 "https://www.googleapis.com/auth/drive": { 11 "https://www.googleapis.com/auth/drive": {
21 "description": "View and manage the files in your Google Dri ve" 12 "description": "View and manage the files in your Google Dri ve"
22 }, 13 },
23 "https://www.googleapis.com/auth/spreadsheets": {
24 "description": "View and manage your spreadsheets in Google Drive"
25 },
26 "https://mail.google.com/": {
27 "description": "View and manage your mail"
28 },
29 "https://www.googleapis.com/auth/admin.directory.group": { 14 "https://www.googleapis.com/auth/admin.directory.group": {
30 "description": "View and manage the provisioning of groups o n your domain" 15 "description": "View and manage the provisioning of groups o n your domain"
31 }, 16 },
32 "https://www.googleapis.com/auth/admin.directory.user": { 17 "https://www.googleapis.com/auth/admin.directory.user": {
33 "description": "View and manage the provisioning of users on your domain" 18 "description": "View and manage the provisioning of users on your domain"
34 }, 19 },
20 "https://mail.google.com/": {
21 "description": "Read, send, delete, and manage your email"
22 },
23 "https://www.googleapis.com/auth/spreadsheets": {
24 "description": "View and manage your spreadsheets in Google Drive"
25 },
35 "https://www.googleapis.com/auth/forms": { 26 "https://www.googleapis.com/auth/forms": {
36 "description": "View and manage your forms in Google Drive" 27 "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 "alt": {
58 "default": "json",
59 "description": "Data format for response.",
60 "enum": [
61 "json",
62 "media",
63 "proto"
64 ],
65 "enumDescriptions": [
66 "Responses with Content-Type of application/json",
67 "Media download with context-dependent Content-Type",
68 "Responses with Content-Type of application/x-protobuf"
69 ],
70 "location": "query",
71 "type": "string"
72 },
73 "key": {
74 "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.",
75 "location": "query",
76 "type": "string"
77 },
78 "access_token": {
79 "description": "OAuth access token.",
80 "location": "query",
81 "type": "string"
82 },
83 "quotaUser": { 57 "quotaUser": {
84 "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.", 58 "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.",
85 "location": "query", 59 "location": "query",
86 "type": "string" 60 "type": "string"
87 }, 61 },
88 "pp": { 62 "pp": {
89 "default": "true", 63 "default": "true",
90 "description": "Pretty-print response.", 64 "description": "Pretty-print response.",
91 "location": "query", 65 "location": "query",
92 "type": "boolean" 66 "type": "boolean"
(...skipping 22 matching lines...) Expand all
115 "uploadType": { 89 "uploadType": {
116 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 90 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
117 "location": "query", 91 "location": "query",
118 "type": "string" 92 "type": "string"
119 }, 93 },
120 "fields": { 94 "fields": {
121 "description": "Selector specifying which fields to include in a par tial response.", 95 "description": "Selector specifying which fields to include in a par tial response.",
122 "location": "query", 96 "location": "query",
123 "type": "string" 97 "type": "string"
124 }, 98 },
99 "callback": {
100 "description": "JSONP",
101 "location": "query",
102 "type": "string"
103 },
125 "$.xgafv": { 104 "$.xgafv": {
126 "description": "V1 error format.", 105 "description": "V1 error format.",
127 "enum": [ 106 "enum": [
128 "1", 107 "1",
129 "2" 108 "2"
130 ], 109 ],
131 "enumDescriptions": [ 110 "enumDescriptions": [
132 "v1 error format", 111 "v1 error format",
133 "v2 error format" 112 "v2 error format"
134 ], 113 ],
135 "location": "query", 114 "location": "query",
136 "type": "string" 115 "type": "string"
137 }, 116 },
138 "callback": { 117 "alt": {
139 "description": "JSONP", 118 "default": "json",
119 "description": "Data format for response.",
120 "enum": [
121 "json",
122 "media",
123 "proto"
124 ],
125 "enumDescriptions": [
126 "Responses with Content-Type of application/json",
127 "Media download with context-dependent Content-Type",
128 "Responses with Content-Type of application/x-protobuf"
129 ],
130 "location": "query",
131 "type": "string"
132 },
133 "access_token": {
134 "description": "OAuth access token.",
135 "location": "query",
136 "type": "string"
137 },
138 "key": {
139 "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.",
140 "location": "query", 140 "location": "query",
141 "type": "string" 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.",
(...skipping 27 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": "20170301", 187 "revision": "20170321",
188 "rootUrl": "https://script.googleapis.com/", 188 "rootUrl": "https://script.googleapis.com/",
189 "schemas": { 189 "schemas": {
190 "ExecutionResponse": { 190 "ExecutionResponse": {
191 "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.", 191 "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.",
192 "id": "ExecutionResponse", 192 "id": "ExecutionResponse",
193 "properties": { 193 "properties": {
194 "result": { 194 "result": {
195 "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`.", 195 "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`.",
196 "type": "any" 196 "type": "any"
197 } 197 }
198 }, 198 },
199 "type": "object" 199 "type": "object"
200 }, 200 },
201 "Operation": { 201 "Operation": {
202 "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>", 202 "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>",
203 "id": "Operation", 203 "id": "Operation",
204 "properties": { 204 "properties": {
205 "response": {
206 "additionalProperties": {
207 "description": "Properties of the object. Contains field @type with type URL.",
208 "type": "any"
209 },
210 "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.",
211 "type": "object"
212 },
205 "name": { 213 "name": {
206 "description": "This field is not used.", 214 "description": "This field is not used.",
207 "type": "string" 215 "type": "string"
208 }, 216 },
209 "error": { 217 "error": {
210 "$ref": "Status", 218 "$ref": "Status",
211 "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." 219 "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."
212 }, 220 },
213 "metadata": { 221 "metadata": {
214 "additionalProperties": { 222 "additionalProperties": {
215 "description": "Properties of the object. Contains field @type with type URL.", 223 "description": "Properties of the object. Contains field @type with type URL.",
216 "type": "any" 224 "type": "any"
217 }, 225 },
218 "description": "This field is not used.", 226 "description": "This field is not used.",
219 "type": "object" 227 "type": "object"
220 }, 228 },
221 "done": { 229 "done": {
222 "description": "This field is not used.", 230 "description": "This field is not used.",
223 "type": "boolean" 231 "type": "boolean"
224 },
225 "response": {
226 "additionalProperties": {
227 "description": "Properties of the object. Contains field @type with type URL.",
228 "type": "any"
229 },
230 "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.",
231 "type": "object"
232 } 232 }
233 }, 233 },
234 "type": "object" 234 "type": "object"
235 }, 235 },
236 "ScriptStackTraceElement": { 236 "ScriptStackTraceElement": {
237 "description": "A stack trace through the script that shows where th e execution failed.", 237 "description": "A stack trace through the script that shows where th e execution failed.",
238 "id": "ScriptStackTraceElement", 238 "id": "ScriptStackTraceElement",
239 "properties": { 239 "properties": {
240 "function": {
241 "description": "The name of the function that failed.",
242 "type": "string"
243 },
240 "lineNumber": { 244 "lineNumber": {
241 "description": "The line number where the script failed.", 245 "description": "The line number where the script failed.",
242 "format": "int32", 246 "format": "int32",
243 "type": "integer" 247 "type": "integer"
244 },
245 "function": {
246 "description": "The name of the function that failed.",
247 "type": "string"
248 } 248 }
249 }, 249 },
250 "type": "object" 250 "type": "object"
251 }, 251 },
252 "ExecutionError": { 252 "ExecutionError": {
253 "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.", 253 "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.",
254 "id": "ExecutionError", 254 "id": "ExecutionError",
255 "properties": { 255 "properties": {
256 "errorType": { 256 "errorType": {
257 "description": "The error type, for example `TypeError` or ` ReferenceError`. If the error\ntype is unavailable, this field is not included." , 257 "description": "The error type, for example `TypeError` or ` ReferenceError`. If the error\ntype is unavailable, this field is not included." ,
(...skipping 10 matching lines...) Expand all
268 }, 268 },
269 "type": "array" 269 "type": "array"
270 } 270 }
271 }, 271 },
272 "type": "object" 272 "type": "object"
273 }, 273 },
274 "Status": { 274 "Status": {
275 "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.", 275 "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.",
276 "id": "Status", 276 "id": "Status",
277 "properties": { 277 "properties": {
278 "message": {
279 "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 .",
280 "type": "string"
281 },
278 "details": { 282 "details": {
279 "description": "An array that contains a single `ExecutionEr ror` object that provides information about the nature of the error.", 283 "description": "An array that contains a single `ExecutionEr ror` object that provides information about the nature of the error.",
280 "items": { 284 "items": {
281 "additionalProperties": { 285 "additionalProperties": {
282 "description": "Properties of the object. Contains f ield @type with type URL.", 286 "description": "Properties of the object. Contains f ield @type with type URL.",
283 "type": "any" 287 "type": "any"
284 }, 288 },
285 "type": "object" 289 "type": "object"
286 }, 290 },
287 "type": "array" 291 "type": "array"
288 }, 292 },
289 "code": { 293 "code": {
290 "description": "The status code. For this API, this value wi ll always be 3, corresponding to an INVALID_ARGUMENT error.", 294 "description": "The status code. For this API, this value wi ll always be 3, corresponding to an INVALID_ARGUMENT error.",
291 "format": "int32", 295 "format": "int32",
292 "type": "integer" 296 "type": "integer"
293 },
294 "message": {
295 "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 .",
296 "type": "string"
297 } 297 }
298 }, 298 },
299 "type": "object" 299 "type": "object"
300 }, 300 },
301 "ExecutionRequest": { 301 "ExecutionRequest": {
302 "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.", 302 "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.",
303 "id": "ExecutionRequest", 303 "id": "ExecutionRequest",
304 "properties": { 304 "properties": {
305 "sessionState": { 305 "sessionState": {
306 "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 &mdash;\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.", 306 "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 &mdash;\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.",
(...skipping 15 matching lines...) Expand all
322 "type": "array" 322 "type": "array"
323 } 323 }
324 }, 324 },
325 "type": "object" 325 "type": "object"
326 } 326 }
327 }, 327 },
328 "servicePath": "", 328 "servicePath": "",
329 "title": "Google Apps Script Execution API", 329 "title": "Google Apps Script Execution API",
330 "version": "v1" 330 "version": "v1"
331 } 331 }
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