OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-03 09:58:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Publish latest versions of all APIs

Browse Source
This commit is contained in:
Sebastian Thiel
2017-09-27 14:54:55 +02:00
parent 3a6ef3db41
commit 059d6700dd
1024 changed files with 515705 additions and 77998 deletions
Download Patch File Download Diff File Expand all files Collapse all files

309
etc/api/script/v1/script-api.json
View File

@@ -1,7 +1,56 @@
{
"revision": "20170509",
"version": "v1",
"baseUrl": "https://script.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/drive": {
"description": "View and manage the files in your Google Drive"
},
"https://www.googleapis.com/auth/admin.directory.user": {
"description": "View and manage the provisioning of users on your domain"
},
"https://www.googleapis.com/auth/admin.directory.group": {
"description": "View and manage the provisioning of groups on your domain"
},
"https://www.googleapis.com/auth/spreadsheets": {
"description": "View and manage your spreadsheets in Google Drive"
},
"https://mail.google.com/": {
"description": "Read, send, delete, and manage your email"
},
"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"
},
"https://www.googleapis.com/auth/groups": {
"description": "View and manage your Google Groups"
},
"https://www.googleapis.com/auth/forms.currentonly": {
"description": "View and manage forms that this application has been installed in"
}
}
}
},
"kind": "discovery#restDescription",
"description": "Executes functions in Google Apps Script projects.",
"servicePath": "",
"rootUrl": "https://script.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "script",
"batchPath": "batch",
"id": "script:v1",
"documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
"revision": "20170918",
"title": "Google Apps Script Execution API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -9,6 +58,8 @@
"scripts": {
"methods": {
"run": {
"id": "script.scripts.run",
"path": "v1/scripts/{scriptId}:run",
"request": {
"$ref": "ExecutionRequest"
},
@@ -22,10 +73,10 @@
},
"parameters": {
"scriptId": {
"location": "path",
"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 \u003e 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 \u003e Project properties**.",
"required": true,
"type": "string"
"type": "string",
"location": "path"
}
},
"scopes": [
@@ -41,34 +92,21 @@
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1/scripts/{scriptId}:run",
"id": "script.scripts.run",
"path": "v1/scripts/{scriptId}:run"
"flatPath": "v1/scripts/{scriptId}:run"
}
}
}
},
"parameters": {
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
"type": "string",
"location": "query"
},
"callback": {
"location": "query",
@@ -76,17 +114,17 @@
"type": "string"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
"location": "query"
},
"alt": {
"type": "string",
@@ -110,9 +148,9 @@
"location": "query"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
"type": "string",
"location": "query"
},
"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.",
@@ -134,51 +172,27 @@
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks."
}
},
"schemas": {
"ScriptStackTraceElement": {
"description": "A stack trace through the script that shows where the execution failed.",
"type": "object",
"Status": {
"properties": {
"function": {
"description": "The name of the function that failed.",
"type": "string"
},
"lineNumber": {
"description": "The line number where the script failed.",
"code": {
"description": "The status code. For this API, this value will always be 3, corresponding to an \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e error.",
"format": "int32",
"type": "integer"
}
},
"id": "ScriptStackTraceElement"
},
"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.",
"type": "object",
"properties": {
"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.",
"type": "array",
"items": {
"$ref": "ScriptStackTraceElement"
}
},
"errorType": {
"description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
"type": "string"
}
},
"id": "ExecutionError"
},
"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.",
"type": "object",
"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"
@@ -193,30 +207,19 @@
"type": "object"
},
"description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error."
},
"code": {
"description": "The status code. For this API, this value will always be 3, corresponding to an INVALID_ARGUMENT error.",
"format": "int32",
"type": "integer"
}
},
"id": "Status"
"id": "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.",
"type": "object"
},
"ExecutionRequest": {
"id": "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.",
"type": "object",
"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.",
"type": "array",
"items": {
"type": "any"
}
},
"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"
"type": "string",
"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."
},
"function": {
"description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
@@ -225,31 +228,16 @@
"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"
}
}
},
"JoinAsyncRequest": {
"description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
"type": "object",
"properties": {
"scriptId": {
"type": "string",
"description": "The script id which specifies the script which all processes in the names\nfield must be from."
},
"names": {
"description": "List of operation resource names that we want to join,\nas returned from a call to RunAsync.",
"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.",
"type": "array",
"items": {
"type": "string"
"type": "any"
}
},
"timeout": {
"description": "Timeout for information retrieval in milliseconds.",
"format": "google-duration",
"type": "string"
}
},
"id": "JoinAsyncRequest"
"id": "ExecutionRequest"
},
"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.",
@@ -266,6 +254,10 @@
"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\u003cp\u003eIf 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.\u003c/p\u003e\n\u003cp\u003eIf 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.\u003c/p\u003e\n\u003cp\u003eIf 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.\u003c/p\u003e",
"type": "object",
"properties": {
"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"
},
"response": {
"description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.",
"type": "object",
@@ -274,96 +266,63 @@
"type": "any"
}
},
"name": {
"description": "This field is not used.",
"type": "string"
},
"error": {
"description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this 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.",
"$ref": "Status"
},
"metadata": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"description": "This field is not used."
},
"done": {
"description": "This field is not used.",
"type": "boolean"
"type": "object"
}
},
"id": "Operation"
},
"JoinAsyncResponse": {
"ScriptStackTraceElement": {
"id": "ScriptStackTraceElement",
"description": "A stack trace through the script that shows where the execution failed.",
"type": "object",
"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"
}
},
"id": "JoinAsyncResponse",
"description": "An object that provides the return value for the JoinAsync method."
}
},
"protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1",
"baseUrl": "https://script.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.google.com/calendar/feeds": {
"description": "Manage your calendars"
"lineNumber": {
"description": "The line number where the script failed.",
"format": "int32",
"type": "integer"
},
"https://www.googleapis.com/auth/groups": {
"description": "View and manage your Google Groups"
},
"https://www.googleapis.com/auth/forms.currentonly": {
"description": "View and manage forms that this application has been installed in"
},
"https://www.googleapis.com/auth/drive": {
"description": "View and manage the files in your Google Drive"
},
"https://www.googleapis.com/auth/spreadsheets": {
"description": "View and manage your spreadsheets in Google Drive"
},
"https://www.googleapis.com/auth/admin.directory.user": {
"description": "View and manage the provisioning of users on your domain"
},
"https://mail.google.com/": {
"description": "Read, send, delete, and manage your email"
},
"https://www.googleapis.com/auth/admin.directory.group": {
"description": "View and manage the provisioning of groups on your domain"
},
"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"
"function": {
"type": "string",
"description": "The name of the function that failed."
}
}
},
"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.",
"type": "object",
"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.",
"type": "array",
"items": {
"$ref": "ScriptStackTraceElement"
}
}
},
"id": "ExecutionError"
}
},
"kind": "discovery#restDescription",
"description": "Executes Google Apps Script projects.",
"servicePath": "",
"rootUrl": "https://script.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "script",
"batchPath": "batch"
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest"
}