OLD | NEW |
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 }, |
5 "https://www.googleapis.com/auth/userinfo.email": { | 8 "https://www.googleapis.com/auth/userinfo.email": { |
6 "description": "View your email address" | 9 "description": "View your email address" |
7 }, | 10 }, |
8 "https://www.google.com/calendar/feeds": { | 11 "https://www.google.com/calendar/feeds": { |
9 "description": "Manage your calendars" | 12 "description": "Manage your calendars" |
10 }, | 13 }, |
11 "https://www.googleapis.com/auth/groups": { | 14 "https://www.googleapis.com/auth/groups": { |
12 "description": "View and manage your Google Groups" | 15 "description": "View and manage your Google Groups" |
13 }, | 16 }, |
14 "https://www.googleapis.com/auth/forms.currentonly": { | 17 "https://www.googleapis.com/auth/forms.currentonly": { |
15 "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" |
16 }, | 19 }, |
17 "https://www.googleapis.com/auth/drive": { | 20 "https://www.googleapis.com/auth/drive": { |
18 "description": "View and manage the files in your Google Dri
ve" | 21 "description": "View and manage the files in your Google Dri
ve" |
19 }, | 22 }, |
20 "https://www.googleapis.com/auth/admin.directory.user": { | |
21 "description": "View and manage the provisioning of users on
your domain" | |
22 }, | |
23 "https://www.googleapis.com/auth/admin.directory.group": { | |
24 "description": "View and manage the provisioning of groups o
n your domain" | |
25 }, | |
26 "https://www.googleapis.com/auth/spreadsheets": { | 23 "https://www.googleapis.com/auth/spreadsheets": { |
27 "description": "View and manage your spreadsheets in Google
Drive" | 24 "description": "View and manage your spreadsheets in Google
Drive" |
28 }, | 25 }, |
29 "https://mail.google.com/": { | 26 "https://mail.google.com/": { |
30 "description": "View and manage your mail" | 27 "description": "View and manage your mail" |
31 }, | 28 }, |
| 29 "https://www.googleapis.com/auth/admin.directory.group": { |
| 30 "description": "View and manage the provisioning of groups o
n your domain" |
| 31 }, |
| 32 "https://www.googleapis.com/auth/admin.directory.user": { |
| 33 "description": "View and manage the provisioning of users on
your domain" |
| 34 }, |
32 "https://www.googleapis.com/auth/forms": { | 35 "https://www.googleapis.com/auth/forms": { |
33 "description": "View and manage your forms in Google Drive" | 36 "description": "View and manage your forms in Google Drive" |
34 }, | |
35 "https://www.google.com/m8/feeds": { | |
36 "description": "Manage your contacts" | |
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 "fields": { | |
58 "description": "Selector specifying which fields to include in a par
tial response.", | |
59 "location": "query", | |
60 "type": "string" | |
61 }, | |
62 "uploadType": { | |
63 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
64 "location": "query", | |
65 "type": "string" | |
66 }, | |
67 "$.xgafv": { | |
68 "description": "V1 error format.", | |
69 "enum": [ | |
70 "1", | |
71 "2" | |
72 ], | |
73 "enumDescriptions": [ | |
74 "v1 error format", | |
75 "v2 error format" | |
76 ], | |
77 "location": "query", | |
78 "type": "string" | |
79 }, | |
80 "callback": { | |
81 "description": "JSONP", | |
82 "location": "query", | |
83 "type": "string" | |
84 }, | |
85 "alt": { | 57 "alt": { |
86 "default": "json", | 58 "default": "json", |
87 "description": "Data format for response.", | 59 "description": "Data format for response.", |
88 "enum": [ | 60 "enum": [ |
89 "json", | 61 "json", |
90 "media", | 62 "media", |
91 "proto" | 63 "proto" |
92 ], | 64 ], |
93 "enumDescriptions": [ | 65 "enumDescriptions": [ |
94 "Responses with Content-Type of application/json", | 66 "Responses with Content-Type of application/json", |
95 "Media download with context-dependent Content-Type", | 67 "Media download with context-dependent Content-Type", |
96 "Responses with Content-Type of application/x-protobuf" | 68 "Responses with Content-Type of application/x-protobuf" |
97 ], | 69 ], |
98 "location": "query", | 70 "location": "query", |
99 "type": "string" | 71 "type": "string" |
100 }, | 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 }, |
101 "access_token": { | 78 "access_token": { |
102 "description": "OAuth access token.", | 79 "description": "OAuth access token.", |
103 "location": "query", | 80 "location": "query", |
104 "type": "string" | 81 "type": "string" |
105 }, | 82 }, |
106 "key": { | |
107 "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.", | |
108 "location": "query", | |
109 "type": "string" | |
110 }, | |
111 "quotaUser": { | 83 "quotaUser": { |
112 "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.", | 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.", |
113 "location": "query", | 85 "location": "query", |
114 "type": "string" | 86 "type": "string" |
115 }, | 87 }, |
116 "pp": { | 88 "pp": { |
117 "default": "true", | 89 "default": "true", |
118 "description": "Pretty-print response.", | 90 "description": "Pretty-print response.", |
119 "location": "query", | 91 "location": "query", |
120 "type": "boolean" | 92 "type": "boolean" |
(...skipping 11 matching lines...) Expand all Loading... |
132 "upload_protocol": { | 104 "upload_protocol": { |
133 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 105 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
134 "location": "query", | 106 "location": "query", |
135 "type": "string" | 107 "type": "string" |
136 }, | 108 }, |
137 "prettyPrint": { | 109 "prettyPrint": { |
138 "default": "true", | 110 "default": "true", |
139 "description": "Returns response with indentations and line breaks."
, | 111 "description": "Returns response with indentations and line breaks."
, |
140 "location": "query", | 112 "location": "query", |
141 "type": "boolean" | 113 "type": "boolean" |
| 114 }, |
| 115 "uploadType": { |
| 116 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 117 "location": "query", |
| 118 "type": "string" |
| 119 }, |
| 120 "fields": { |
| 121 "description": "Selector specifying which fields to include in a par
tial response.", |
| 122 "location": "query", |
| 123 "type": "string" |
| 124 }, |
| 125 "$.xgafv": { |
| 126 "description": "V1 error format.", |
| 127 "enum": [ |
| 128 "1", |
| 129 "2" |
| 130 ], |
| 131 "enumDescriptions": [ |
| 132 "v1 error format", |
| 133 "v2 error format" |
| 134 ], |
| 135 "location": "query", |
| 136 "type": "string" |
| 137 }, |
| 138 "callback": { |
| 139 "description": "JSONP", |
| 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 Loading... |
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": "20170209", | 187 "revision": "20170301", |
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 }, | |
213 "name": { | 205 "name": { |
214 "description": "This field is not used.", | 206 "description": "This field is not used.", |
215 "type": "string" | 207 "type": "string" |
216 }, | 208 }, |
217 "error": { | 209 "error": { |
218 "$ref": "Status", | 210 "$ref": "Status", |
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." | 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." |
220 }, | 212 }, |
221 "metadata": { | 213 "metadata": { |
222 "additionalProperties": { | 214 "additionalProperties": { |
223 "description": "Properties of the object. Contains field
@type with type URL.", | 215 "description": "Properties of the object. Contains field
@type with type URL.", |
224 "type": "any" | 216 "type": "any" |
225 }, | 217 }, |
226 "description": "This field is not used.", | 218 "description": "This field is not used.", |
227 "type": "object" | 219 "type": "object" |
228 }, | 220 }, |
229 "done": { | 221 "done": { |
230 "description": "This field is not used.", | 222 "description": "This field is not used.", |
231 "type": "boolean" | 223 "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 }, | |
244 "lineNumber": { | 240 "lineNumber": { |
245 "description": "The line number where the script failed.", | 241 "description": "The line number where the script failed.", |
246 "format": "int32", | 242 "format": "int32", |
247 "type": "integer" | 243 "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 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
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
.", | 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" | 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": { |
| 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 —\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.", |
| 307 "type": "string" |
| 308 }, |
305 "function": { | 309 "function": { |
306 "description": "The name of the function to execute in the g
iven script. The name does not\ninclude parentheses or parameters.", | 310 "description": "The name of the function to execute in the g
iven script. The name does not\ninclude parentheses or parameters.", |
307 "type": "string" | 311 "type": "string" |
308 }, | 312 }, |
309 "devMode": { | 313 "devMode": { |
310 "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`.", | 314 "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`.", |
311 "type": "boolean" | 315 "type": "boolean" |
312 }, | 316 }, |
313 "parameters": { | 317 "parameters": { |
314 "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.", | 318 "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.", |
315 "items": { | 319 "items": { |
316 "type": "any" | 320 "type": "any" |
317 }, | 321 }, |
318 "type": "array" | 322 "type": "array" |
319 }, | |
320 "sessionState": { | |
321 "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.", | |
322 "type": "string" | |
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 } |
OLD | NEW |