OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2025-12-29 23:55:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Upgrade to latest API versions + code regen

Browse Source
This commit is contained in:
Sebastian Thiel
2017-12-12 14:30:54 +01:00
parent dc30217711
commit 357a0e650e
776 changed files with 356718 additions and 104442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,76 +1,30 @@
{
"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",
"revision": "20171205",
"documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
"revision": "20170918",
"title": "Google Apps Script Execution API",
"id": "script:v1",
"fullyEncodeReservedExpansion": true,
"title": "Google Apps Script API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"scripts": {
"methods": {
"run": {
"id": "script.scripts.run",
"path": "v1/scripts/{scriptId}:run",
"request": {
"$ref": "ExecutionRequest"
},
"description": "Runs a function in an Apps Script project. The 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 one 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 project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
"httpMethod": "POST",
"parameterOrder": [
"scriptId"
],
"description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one 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 project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"scriptId"
],
"httpMethod": "POST",
"parameters": {
"scriptId": {
"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**.",
@@ -92,39 +46,52 @@
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1/scripts/{scriptId}:run"
"flatPath": "v1/scripts/{scriptId}:run",
"path": "v1/scripts/{scriptId}:run",
"id": "script.scripts.run"
}
}
}
},
"parameters": {
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format."
},
"alt": {
"type": "string",
@@ -148,14 +115,14 @@
"location": "query"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string",
"location": "query"
"type": "string"
},
"quotaUser": {
"location": "query",
"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.",
"type": "string",
"location": "query"
"type": "string"
},
"pp": {
"location": "query",
@@ -164,69 +131,54 @@
"default": "true"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
"type": "string"
},
"oauth_token": {
"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."
"type": "string",
"location": "query"
}
},
"schemas": {
"Status": {
"type": "object",
"properties": {
"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"
},
"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.",
"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.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error."
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
}
},
"code": {
"description": "The status code. For this API, this value either: \u003cul\u003e \u003cli\u003e 3, indicating an `INVALID_ARGUMENT` error, or\u003c/li\u003e \u003cli\u003e 1, indicating a `CANCELLED` execution.\u003c/li\u003e \u003c/ul\u003e",
"format": "int32",
"type": "integer"
}
},
"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"
"description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` 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.",
"type": "object",
"properties": {
"sessionState": {
"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.",
"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`.",
"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 Apps Script API. Optional; default is `false`.",
"type": "boolean"
},
"parameters": {
@@ -235,70 +187,66 @@
"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)\nscript—that is, it can access information like the user's current\ncursor position (in Docs) or selected cell (in Sheets). To retrieve the\nstate, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
"type": "string"
}
},
"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.",
"type": "object",
"properties": {
"result": {
"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 `Document` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.",
"description": "The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called using the Apps Script API cannot\nreturn Apps Script-specific objects (such as a `Document` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.",
"type": "any"
}
},
"id": "ExecutionResponse"
"id": "ExecutionResponse",
"description": "An object that provides the return value of a function executed using the\nApps Script API. If the script function returns successfully, the response\nbody's response field contains this\n`ExecutionResponse` object."
},
"Operation": {
"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",
"description": "A representation of a execution of an Apps Script function that is started using run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). \u003cp\u003eAfter the execution is started, it can have one of four outcomes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e If the script function returns successfully, the\n response field contains an\n ExecutionResponse object\n with the function's return value in the object's `result` field.\u003c/li\u003e\n\u003cli\u003e If the script function (or Apps Script itself) throws an exception, the\n error field contains a\n Status object. The `Status` object's `details`\n field contains an array with a single\n ExecutionError object that\n provides information about the nature of the error.\u003c/li\u003e\n\u003cli\u003e If the execution has not yet completed,\n the done field is `false` and\n the neither the `response` nor `error` fields are present.\u003c/li\u003e\n\u003cli\u003e If the `run` call itself fails (for example, because of a\n malformed request or an authorization error), the method returns an HTTP\n response code in the 4XX range with a different format for the response\n body. Client libraries automatically convert a 4XX response into an\n exception class.\u003c/li\u003e\n\u003c/ul\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",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
},
"description": "If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.",
"type": "object"
},
"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"
"$ref": "Status",
"description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error."
},
"metadata": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"description": "This field is not used.",
"type": "object"
"done": {
"description": "This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.",
"type": "boolean"
}
},
"id": "Operation"
},
"ScriptStackTraceElement": {
"id": "ScriptStackTraceElement",
"description": "A stack trace through the script that shows where the execution failed.",
"type": "object",
"properties": {
"function": {
"description": "The name of the function that failed.",
"type": "string"
},
"lineNumber": {
"description": "The line number where the script failed.",
"format": "int32",
"type": "integer"
},
"function": {
"type": "string",
"description": "The name of the function that failed."
}
}
},
"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.",
"description": "An object that provides information about the nature of an error resulting\nfrom an attempted execution of a script function using the Apps Script API.\nIf a run call\nsucceeds but the script function (or Apps Script itself) throws an exception,\nthe response body's error field\ncontains a\nStatus object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
"type": "object",
"properties": {
"errorType": {
@@ -310,11 +258,11 @@
"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"
}
},
"description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first."
}
},
"id": "ExecutionError"
@@ -324,5 +272,50 @@
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest"
"protocol": "rest",
"version": "v1",
"baseUrl": "https://script.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"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"
},
"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"
}
}
}
},
"servicePath": "",
"description": "An API for managing and executing Google Apps Script projects.",
"kind": "discovery#restDescription",
"rootUrl": "https://script.googleapis.com/"
}