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

Unified Diff: discovery/googleapis/script__v1.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/safebrowsing__v4.json ('k') | discovery/googleapis/searchconsole__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/script__v1.json
diff --git a/discovery/googleapis/script__v1.json b/discovery/googleapis/script__v1.json
index 7afc6a73c7a3209cb720d1fedb0db37028d868f0..716f20f4b3e40f87f1a38ba777b962ed3bd47d7d 100644
--- a/discovery/googleapis/script__v1.json
+++ b/discovery/googleapis/script__v1.json
@@ -2,15 +2,6 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.google.com/m8/feeds": {
- "description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- },
- "https://www.google.com/calendar/feeds": {
- "description": "Manage your calendars"
- },
"https://www.googleapis.com/auth/groups": {
"description": "View and manage your Google Groups"
},
@@ -34,6 +25,15 @@
},
"https://www.googleapis.com/auth/forms": {
"description": "View and manage your forms in Google Drive"
+ },
+ "https://www.google.com/m8/feeds": {
+ "description": "Manage your contacts"
+ },
+ "https://www.googleapis.com/auth/userinfo.email": {
+ "description": "View your email address"
+ },
+ "https://www.google.com/calendar/feeds": {
+ "description": "Manage your calendars"
}
}
}
@@ -41,7 +41,7 @@
"basePath": "",
"baseUrl": "https://script.googleapis.com/",
"batchPath": "batch",
- "description": "Executes Google Apps Script projects.",
+ "description": "Executes functions in Google Apps Script projects.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
"icons": {
@@ -54,16 +54,37 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
"type": "string"
},
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
@@ -118,27 +139,6 @@
],
"location": "query",
"type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
}
},
"protocol": "rest",
@@ -154,7 +154,7 @@
],
"parameters": {
"scriptId": {
- "description": "The project key of the script to be executed. To find the project key, open\nthe project in the script editor and select **File > Project properties**.",
+ "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File > Project properties**.",
"location": "path",
"required": true,
"type": "string"
@@ -184,107 +184,9 @@
}
}
},
- "revision": "20170720",
+ "revision": "20170815",
"rootUrl": "https://script.googleapis.com/",
"schemas": {
- "ExecutionError": {
- "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 the\nscript function (or Apps Script itself) throws an exception, the response\nbody'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.",
- "id": "ExecutionError",
- "properties": {
- "errorType": {
- "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
- "type": "string"
- },
- "errorMessage": {
- "description": "The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
- "type": "string"
- },
- "scriptStackTraceElements": {
- "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
- "items": {
- "$ref": "ScriptStackTraceElement"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Status": {
- "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.",
- "id": "Status",
- "properties": {
- "code": {
- "description": "The status code. For this API, this value will always be 3, corresponding to an INVALID_ARGUMENT error.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ExecutionRequest": {
- "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
- "id": "ExecutionRequest",
- "properties": {
- "parameters": {
- "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type 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`string`, `number`, `array`, `object`, or `boolean`. Optional.",
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "sessionState": {
- "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script —\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
- "type": "string"
- },
- "devMode": {
- "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Execution API. Optional; default is `false`.",
- "type": "boolean"
- },
- "function": {
- "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "JoinAsyncRequest": {
- "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
- "id": "JoinAsyncRequest",
- "properties": {
- "names": {
- "description": "List of operation resource names that we want to join,\nas returned from a call to RunAsync.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "timeout": {
- "description": "Timeout for information retrieval in milliseconds.",
- "format": "google-duration",
- "type": "string"
- },
- "scriptId": {
- "description": "The script id which specifies the script which all processes in the names\nfield must be from.",
- "type": "string"
- }
- },
- "type": "object"
- },
"ExecutionResponse": {
"description": "An object that provides the return value of a function executed through the\nApps Script Execution API. If a\n`run` call succeeds and the\nscript function returns successfully, the response body's\n`response` field contains this\n`ExecutionResponse` object.",
"id": "ExecutionResponse",
@@ -300,10 +202,6 @@
"description": "The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).\n<p>If the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.</p>\n<p>If the script function (or Apps Script 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 `ExecutionError` 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>",
"id": "Operation",
"properties": {
- "done": {
- "description": "This field is not used.",
- "type": "boolean"
- },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -313,7 +211,7 @@
"type": "object"
},
"name": {
- "description": "This field is not used.",
+ "description": "This field is only used with asynchronous executions and contains a unique identifier that can be used to subsequently invoke a `get` `cancel` or `join` on the asynchronous script execution identified by this name.",
"type": "string"
},
"error": {
@@ -327,20 +225,10 @@
},
"description": "This field is not used.",
"type": "object"
- }
- },
- "type": "object"
- },
- "JoinAsyncResponse": {
- "description": "An object that provides the return value for the JoinAsync method.",
- "id": "JoinAsyncResponse",
- "properties": {
- "results": {
- "additionalProperties": {
- "$ref": "Operation"
- },
- "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 script function.",
- "type": "object"
+ },
+ "done": {
+ "description": "This field is only used with asynchronous executions and indicates whether or not the script execution has completed. A completed execution has a populated response field containing the `ExecutionResponse` from function that was executed.",
+ "type": "boolean"
}
},
"type": "object"
@@ -360,6 +248,81 @@
}
},
"type": "object"
+ },
+ "ExecutionError": {
+ "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 the\nscript function (or Apps Script itself) throws an exception, the response\nbody'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.",
+ "id": "ExecutionError",
+ "properties": {
+ "scriptStackTraceElements": {
+ "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
+ "items": {
+ "$ref": "ScriptStackTraceElement"
+ },
+ "type": "array"
+ },
+ "errorType": {
+ "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "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.",
+ "id": "Status",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "description": "The status code. For this API, this value will always be 3, corresponding to an <code>INVALID_ARGUMENT</code> error.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ExecutionRequest": {
+ "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
+ "id": "ExecutionRequest",
+ "properties": {
+ "devMode": {
+ "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Execution API. Optional; default is `false`.",
+ "type": "boolean"
+ },
+ "function": {
+ "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type 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`string`, `number`, `array`, `object`, or `boolean`. Optional.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "sessionState": {
+ "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script &mdash;\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
+ "type": "string"
+ }
+ },
+ "type": "object"
}
},
"servicePath": "",
« 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