Vendor dependencies for GCS
This commit is contained in:
Alexander Neumann
parent
ba75a3884c
commit
8ca6a9a240
1228 changed files with 1769186 additions and 1 deletions
369
vendor/google.golang.org/api/script/v1/script-api.json
generated
vendored
Normal file
369
vendor/google.golang.org/api/script/v1/script-api.json
generated
vendored
Normal file
|
|
@ -0,0 +1,369 @@
|
|||
{
|
||||
"name": "script",
|
||||
"batchPath": "batch",
|
||||
"revision": "20170726",
|
||||
"documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
|
||||
"id": "script:v1",
|
||||
"title": "Google Apps Script Execution API",
|
||||
"discoveryVersion": "v1",
|
||||
"ownerName": "Google",
|
||||
"resources": {
|
||||
"scripts": {
|
||||
"methods": {
|
||||
"run": {
|
||||
"httpMethod": "POST",
|
||||
"parameterOrder": [
|
||||
"scriptId"
|
||||
],
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"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 \u003e Project properties**.",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"location": "path"
|
||||
}
|
||||
},
|
||||
"scopes": [
|
||||
"https://mail.google.com/",
|
||||
"https://www.google.com/calendar/feeds",
|
||||
"https://www.google.com/m8/feeds",
|
||||
"https://www.googleapis.com/auth/admin.directory.group",
|
||||
"https://www.googleapis.com/auth/admin.directory.user",
|
||||
"https://www.googleapis.com/auth/drive",
|
||||
"https://www.googleapis.com/auth/forms",
|
||||
"https://www.googleapis.com/auth/forms.currentonly",
|
||||
"https://www.googleapis.com/auth/groups",
|
||||
"https://www.googleapis.com/auth/spreadsheets",
|
||||
"https://www.googleapis.com/auth/userinfo.email"
|
||||
],
|
||||
"flatPath": "v1/scripts/{scriptId}:run",
|
||||
"path": "v1/scripts/{scriptId}:run",
|
||||
"id": "script.scripts.run",
|
||||
"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.",
|
||||
"request": {
|
||||
"$ref": "ExecutionRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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.",
|
||||
"default": "true",
|
||||
"type": "boolean"
|
||||
},
|
||||
"uploadType": {
|
||||
"location": "query",
|
||||
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
||||
"type": "string"
|
||||
},
|
||||
"fields": {
|
||||
"description": "Selector specifying which fields to include in a partial response.",
|
||||
"type": "string",
|
||||
"location": "query"
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"alt": {
|
||||
"enumDescriptions": [
|
||||
"Responses with Content-Type of application/json",
|
||||
"Media download with context-dependent Content-Type",
|
||||
"Responses with Content-Type of application/x-protobuf"
|
||||
],
|
||||
"location": "query",
|
||||
"description": "Data format for response.",
|
||||
"default": "json",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"access_token": {
|
||||
"location": "query",
|
||||
"description": "OAuth access token.",
|
||||
"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.",
|
||||
"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.",
|
||||
"type": "string",
|
||||
"location": "query"
|
||||
},
|
||||
"pp": {
|
||||
"description": "Pretty-print response.",
|
||||
"default": "true",
|
||||
"type": "boolean",
|
||||
"location": "query"
|
||||
},
|
||||
"oauth_token": {
|
||||
"location": "query",
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"type": "string"
|
||||
},
|
||||
"bearer_token": {
|
||||
"location": "query",
|
||||
"description": "OAuth bearer token.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"schemas": {
|
||||
"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": {
|
||||
"type": "any",
|
||||
"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`."
|
||||
}
|
||||
},
|
||||
"id": "ExecutionResponse"
|
||||
},
|
||||
"JoinAsyncResponse": {
|
||||
"description": "An object that provides the return value for the JoinAsync method.",
|
||||
"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"
|
||||
},
|
||||
"Operation": {
|
||||
"id": "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",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"description": "This field is not used.",
|
||||
"type": "string"
|
||||
},
|
||||
"error": {
|
||||
"$ref": "Status",
|
||||
"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."
|
||||
},
|
||||
"metadata": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "This field is not used.",
|
||||
"type": "object"
|
||||
},
|
||||
"done": {
|
||||
"description": "This field is not used.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ScriptStackTraceElement": {
|
||||
"properties": {
|
||||
"function": {
|
||||
"description": "The name of the function that failed.",
|
||||
"type": "string"
|
||||
},
|
||||
"lineNumber": {
|
||||
"format": "int32",
|
||||
"description": "The line number where the script failed.",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"id": "ScriptStackTraceElement",
|
||||
"description": "A stack trace through the script that shows where the execution failed.",
|
||||
"type": "object"
|
||||
},
|
||||
"ExecutionError": {
|
||||
"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.",
|
||||
"items": {
|
||||
"$ref": "ScriptStackTraceElement"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"id": "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."
|
||||
},
|
||||
"Status": {
|
||||
"properties": {
|
||||
"details": {
|
||||
"description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
}
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"code": {
|
||||
"format": "int32",
|
||||
"description": "The status code. For this API, this value will always be 3, corresponding to an INVALID_ARGUMENT error.",
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
"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": {
|
||||
"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 —\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"
|
||||
}
|
||||
},
|
||||
"id": "ExecutionRequest"
|
||||
},
|
||||
"JoinAsyncRequest": {
|
||||
"description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"scriptId": {
|
||||
"description": "The script id which specifies the script which all processes in the names\nfield must be from.",
|
||||
"type": "string"
|
||||
},
|
||||
"names": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array",
|
||||
"description": "List of operation resource names that we want to join,\nas returned from a call to RunAsync."
|
||||
},
|
||||
"timeout": {
|
||||
"format": "google-duration",
|
||||
"description": "Timeout for information retrieval in milliseconds.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"id": "JoinAsyncRequest"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"version": "v1",
|
||||
"baseUrl": "https://script.googleapis.com/",
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"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://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/admin.directory.user": {
|
||||
"description": "View and manage the provisioning of users 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"
|
||||
},
|
||||
"https://www.google.com/calendar/feeds": {
|
||||
"description": "Manage your calendars"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"description": "Executes Google Apps Script projects.",
|
||||
"kind": "discovery#restDescription",
|
||||
"rootUrl": "https://script.googleapis.com/",
|
||||
"basePath": "",
|
||||
"ownerDomain": "google.com"
|
||||
}
|
||||
650
vendor/google.golang.org/api/script/v1/script-gen.go
generated
vendored
Normal file
650
vendor/google.golang.org/api/script/v1/script-gen.go
generated
vendored
Normal file
|
|
@ -0,0 +1,650 @@
|
|||
// Package script provides access to the Google Apps Script Execution API.
|
||||
//
|
||||
// See https://developers.google.com/apps-script/execution/rest/v1/scripts/run
|
||||
//
|
||||
// Usage example:
|
||||
//
|
||||
// import "google.golang.org/api/script/v1"
|
||||
// ...
|
||||
// scriptService, err := script.New(oauthHttpClient)
|
||||
package script // import "google.golang.org/api/script/v1"
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
context "golang.org/x/net/context"
|
||||
ctxhttp "golang.org/x/net/context/ctxhttp"
|
||||
gensupport "google.golang.org/api/gensupport"
|
||||
googleapi "google.golang.org/api/googleapi"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Always reference these packages, just in case the auto-generated code
|
||||
// below doesn't.
|
||||
var _ = bytes.NewBuffer
|
||||
var _ = strconv.Itoa
|
||||
var _ = fmt.Sprintf
|
||||
var _ = json.NewDecoder
|
||||
var _ = io.Copy
|
||||
var _ = url.Parse
|
||||
var _ = gensupport.MarshalJSON
|
||||
var _ = googleapi.Version
|
||||
var _ = errors.New
|
||||
var _ = strings.Replace
|
||||
var _ = context.Canceled
|
||||
var _ = ctxhttp.Do
|
||||
|
||||
const apiId = "script:v1"
|
||||
const apiName = "script"
|
||||
const apiVersion = "v1"
|
||||
const basePath = "https://script.googleapis.com/"
|
||||
|
||||
// OAuth2 scopes used by this API.
|
||||
const (
|
||||
// Read, send, delete, and manage your email
|
||||
MailGoogleComScope = "https://mail.google.com/"
|
||||
|
||||
// Manage your calendars
|
||||
WwwGoogleComCalendarFeedsScope = "https://www.google.com/calendar/feeds"
|
||||
|
||||
// Manage your contacts
|
||||
WwwGoogleComM8FeedsScope = "https://www.google.com/m8/feeds"
|
||||
|
||||
// View and manage the provisioning of groups on your domain
|
||||
AdminDirectoryGroupScope = "https://www.googleapis.com/auth/admin.directory.group"
|
||||
|
||||
// View and manage the provisioning of users on your domain
|
||||
AdminDirectoryUserScope = "https://www.googleapis.com/auth/admin.directory.user"
|
||||
|
||||
// View and manage the files in your Google Drive
|
||||
DriveScope = "https://www.googleapis.com/auth/drive"
|
||||
|
||||
// View and manage your forms in Google Drive
|
||||
FormsScope = "https://www.googleapis.com/auth/forms"
|
||||
|
||||
// View and manage forms that this application has been installed in
|
||||
FormsCurrentonlyScope = "https://www.googleapis.com/auth/forms.currentonly"
|
||||
|
||||
// View and manage your Google Groups
|
||||
GroupsScope = "https://www.googleapis.com/auth/groups"
|
||||
|
||||
// View and manage your spreadsheets in Google Drive
|
||||
SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets"
|
||||
|
||||
// View your email address
|
||||
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
|
||||
)
|
||||
|
||||
func New(client *http.Client) (*Service, error) {
|
||||
if client == nil {
|
||||
return nil, errors.New("client is nil")
|
||||
}
|
||||
s := &Service{client: client, BasePath: basePath}
|
||||
s.Scripts = NewScriptsService(s)
|
||||
return s, nil
|
||||
}
|
||||
|
||||
type Service struct {
|
||||
client *http.Client
|
||||
BasePath string // API endpoint base URL
|
||||
UserAgent string // optional additional User-Agent fragment
|
||||
|
||||
Scripts *ScriptsService
|
||||
}
|
||||
|
||||
func (s *Service) userAgent() string {
|
||||
if s.UserAgent == "" {
|
||||
return googleapi.UserAgent
|
||||
}
|
||||
return googleapi.UserAgent + " " + s.UserAgent
|
||||
}
|
||||
|
||||
func NewScriptsService(s *Service) *ScriptsService {
|
||||
rs := &ScriptsService{s: s}
|
||||
return rs
|
||||
}
|
||||
|
||||
type ScriptsService struct {
|
||||
s *Service
|
||||
}
|
||||
|
||||
// ExecutionError: An object that provides information about the nature
|
||||
// of an error in the Apps
|
||||
// Script Execution API. If an
|
||||
// `run` call succeeds but the
|
||||
// script function (or Apps Script itself) throws an exception, the
|
||||
// response
|
||||
// body's `error` field contains a
|
||||
// `Status` object. The `Status` object's `details` field
|
||||
// contains an array with a single one of these `ExecutionError`
|
||||
// objects.
|
||||
type ExecutionError struct {
|
||||
// ErrorMessage: The error message thrown by Apps Script, usually
|
||||
// localized into the user's
|
||||
// language.
|
||||
ErrorMessage string `json:"errorMessage,omitempty"`
|
||||
|
||||
// ErrorType: The error type, for example `TypeError` or
|
||||
// `ReferenceError`. If the error
|
||||
// type is unavailable, this field is not included.
|
||||
ErrorType string `json:"errorType,omitempty"`
|
||||
|
||||
// ScriptStackTraceElements: An array of objects that provide a stack
|
||||
// trace through the script to show
|
||||
// where the execution failed, with the deepest call first.
|
||||
ScriptStackTraceElements []*ScriptStackTraceElement `json:"scriptStackTraceElements,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "ErrorMessage") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "ErrorMessage") to include
|
||||
// in API requests with the JSON null value. By default, fields with
|
||||
// empty values are omitted from API requests. However, any field with
|
||||
// an empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *ExecutionError) MarshalJSON() ([]byte, error) {
|
||||
type noMethod ExecutionError
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// ExecutionRequest: A request to run the function in a script. The
|
||||
// script is identified by the
|
||||
// specified `script_id`. Executing a function on a script returns
|
||||
// results
|
||||
// based on the implementation of the script.
|
||||
type ExecutionRequest struct {
|
||||
// DevMode: If `true` and the user is an owner of the script, the script
|
||||
// runs at the
|
||||
// most recently saved version rather than the version deployed for use
|
||||
// with
|
||||
// the Execution API. Optional; default is `false`.
|
||||
DevMode bool `json:"devMode,omitempty"`
|
||||
|
||||
// Function: The name of the function to execute in the given script.
|
||||
// The name does not
|
||||
// include parentheses or parameters.
|
||||
Function string `json:"function,omitempty"`
|
||||
|
||||
// Parameters: The parameters to be passed to the function being
|
||||
// executed. The object type
|
||||
// for each parameter should match the expected type in Apps
|
||||
// Script.
|
||||
// Parameters cannot be Apps Script-specific object types (such as
|
||||
// a
|
||||
// `Document` or a `Calendar`); they can only be primitive types such
|
||||
// as
|
||||
// `string`, `number`, `array`, `object`, or `boolean`. Optional.
|
||||
Parameters []interface{} `json:"parameters,omitempty"`
|
||||
|
||||
// SessionState: For Android add-ons only. An ID that represents the
|
||||
// user's current session
|
||||
// in the Android app for Google Docs or Sheets, included as extra data
|
||||
// in
|
||||
// the
|
||||
// [`Intent`](https://developer.android.com/guide/components/intents-
|
||||
// filters.html)
|
||||
// that launches the add-on. When an Android add-on is run with a
|
||||
// session
|
||||
// state, it gains the privileges of
|
||||
// a
|
||||
// [bound](https://developers.google.com/apps-script/guides/bound)
|
||||
// script —
|
||||
// that is, it can access information like the user's current cursor
|
||||
// position
|
||||
// (in Docs) or selected cell (in Sheets). To retrieve the state,
|
||||
// call
|
||||
// `Intent.getStringExtra("com.google.android.apps.docs.addons.Sessi
|
||||
// onState")`.
|
||||
// Optional.
|
||||
SessionState string `json:"sessionState,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "DevMode") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "DevMode") to include in
|
||||
// API requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *ExecutionRequest) MarshalJSON() ([]byte, error) {
|
||||
type noMethod ExecutionRequest
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// ExecutionResponse: An object that provides the return value of a
|
||||
// function executed through the
|
||||
// Apps Script Execution API. If a
|
||||
// `run` call succeeds and the
|
||||
// script function returns successfully, the response body's
|
||||
// `response` field contains this
|
||||
// `ExecutionResponse` object.
|
||||
type ExecutionResponse struct {
|
||||
// Result: The return value of the script function. The type matches the
|
||||
// object type
|
||||
// returned in Apps Script. Functions called through the Execution API
|
||||
// cannot
|
||||
// return Apps Script-specific objects (such as a `Document` or a
|
||||
// `Calendar`);
|
||||
// they can only return primitive types such as a `string`, `number`,
|
||||
// `array`,
|
||||
// `object`, or `boolean`.
|
||||
Result interface{} `json:"result,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "Result") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "Result") to include in API
|
||||
// requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *ExecutionResponse) MarshalJSON() ([]byte, error) {
|
||||
type noMethod ExecutionResponse
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// JoinAsyncRequest: A request to retrieve the results from a collection
|
||||
// of requests,
|
||||
// specified by the operation resource names.
|
||||
type JoinAsyncRequest struct {
|
||||
// Names: List of operation resource names that we want to join,
|
||||
// as returned from a call to RunAsync.
|
||||
Names []string `json:"names,omitempty"`
|
||||
|
||||
// ScriptId: The script id which specifies the script which all
|
||||
// processes in the names
|
||||
// field must be from.
|
||||
ScriptId string `json:"scriptId,omitempty"`
|
||||
|
||||
// Timeout: Timeout for information retrieval in milliseconds.
|
||||
Timeout string `json:"timeout,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "Names") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "Names") to include in API
|
||||
// requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *JoinAsyncRequest) MarshalJSON() ([]byte, error) {
|
||||
type noMethod JoinAsyncRequest
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// JoinAsyncResponse: An object that provides the return value for the
|
||||
// JoinAsync method.
|
||||
type JoinAsyncResponse struct {
|
||||
// Results: The return values for each script function, in a map of
|
||||
// operation resource
|
||||
// names to the Operation containing the result of the process. The
|
||||
// response
|
||||
// will contain either an error or the result of the script function.
|
||||
Results map[string]Operation `json:"results,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "Results") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "Results") to include in
|
||||
// API requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *JoinAsyncResponse) MarshalJSON() ([]byte, error) {
|
||||
type noMethod JoinAsyncResponse
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// Operation: 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/quot
|
||||
// as#current_limitations).
|
||||
// <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>
|
||||
// <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>
|
||||
// <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>
|
||||
type Operation struct {
|
||||
// Done: This field is not used.
|
||||
Done bool `json:"done,omitempty"`
|
||||
|
||||
// Error: 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.
|
||||
Error *Status `json:"error,omitempty"`
|
||||
|
||||
// Metadata: This field is not used.
|
||||
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
|
||||
|
||||
// Name: This field is not used.
|
||||
Name string `json:"name,omitempty"`
|
||||
|
||||
// Response: 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.
|
||||
Response googleapi.RawMessage `json:"response,omitempty"`
|
||||
|
||||
// ServerResponse contains the HTTP response code and headers from the
|
||||
// server.
|
||||
googleapi.ServerResponse `json:"-"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "Done") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "Done") to include in API
|
||||
// requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *Operation) MarshalJSON() ([]byte, error) {
|
||||
type noMethod Operation
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// ScriptStackTraceElement: A stack trace through the script that shows
|
||||
// where the execution failed.
|
||||
type ScriptStackTraceElement struct {
|
||||
// Function: The name of the function that failed.
|
||||
Function string `json:"function,omitempty"`
|
||||
|
||||
// LineNumber: The line number where the script failed.
|
||||
LineNumber int64 `json:"lineNumber,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "Function") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "Function") to include in
|
||||
// API requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *ScriptStackTraceElement) MarshalJSON() ([]byte, error) {
|
||||
type noMethod ScriptStackTraceElement
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// Status: 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 Status struct {
|
||||
// Code: The status code. For this API, this value will always be 3,
|
||||
// corresponding to an INVALID_ARGUMENT error.
|
||||
Code int64 `json:"code,omitempty"`
|
||||
|
||||
// Details: An array that contains a single `ExecutionError` object that
|
||||
// provides information about the nature of the error.
|
||||
Details []googleapi.RawMessage `json:"details,omitempty"`
|
||||
|
||||
// Message: 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.
|
||||
Message string `json:"message,omitempty"`
|
||||
|
||||
// ForceSendFields is a list of field names (e.g. "Code") to
|
||||
// unconditionally include in API requests. By default, fields with
|
||||
// empty values are omitted from API requests. However, any non-pointer,
|
||||
// non-interface field appearing in ForceSendFields will be sent to the
|
||||
// server regardless of whether the field is empty or not. This may be
|
||||
// used to include empty fields in Patch requests.
|
||||
ForceSendFields []string `json:"-"`
|
||||
|
||||
// NullFields is a list of field names (e.g. "Code") to include in API
|
||||
// requests with the JSON null value. By default, fields with empty
|
||||
// values are omitted from API requests. However, any field with an
|
||||
// empty value appearing in NullFields will be sent to the server as
|
||||
// null. It is an error if a field in this list has a non-empty value.
|
||||
// This may be used to include null fields in Patch requests.
|
||||
NullFields []string `json:"-"`
|
||||
}
|
||||
|
||||
func (s *Status) MarshalJSON() ([]byte, error) {
|
||||
type noMethod Status
|
||||
raw := noMethod(*s)
|
||||
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
||||
}
|
||||
|
||||
// method id "script.scripts.run":
|
||||
|
||||
type ScriptsRunCall struct {
|
||||
s *Service
|
||||
scriptId string
|
||||
executionrequest *ExecutionRequest
|
||||
urlParams_ gensupport.URLParams
|
||||
ctx_ context.Context
|
||||
header_ http.Header
|
||||
}
|
||||
|
||||
// Run: Runs a function in an Apps Script project. The project must be
|
||||
// deployed
|
||||
// for use with the Apps Script Execution API.
|
||||
//
|
||||
// This method requires authorization with an OAuth 2.0 token that
|
||||
// includes at
|
||||
// least one of the scopes listed in the
|
||||
// [Authorization](#authorization)
|
||||
// section; script projects that do not require authorization cannot
|
||||
// be
|
||||
// executed through this API. To find the correct scopes to include in
|
||||
// the
|
||||
// authentication token, open the project in the script editor, then
|
||||
// select
|
||||
// **File > Project properties** and click the **Scopes** tab.
|
||||
func (r *ScriptsService) Run(scriptId string, executionrequest *ExecutionRequest) *ScriptsRunCall {
|
||||
c := &ScriptsRunCall{s: r.s, urlParams_: make(gensupport.URLParams)}
|
||||
c.scriptId = scriptId
|
||||
c.executionrequest = executionrequest
|
||||
return c
|
||||
}
|
||||
|
||||
// Fields allows partial responses to be retrieved. See
|
||||
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
|
||||
// for more information.
|
||||
func (c *ScriptsRunCall) Fields(s ...googleapi.Field) *ScriptsRunCall {
|
||||
c.urlParams_.Set("fields", googleapi.CombineFields(s))
|
||||
return c
|
||||
}
|
||||
|
||||
// Context sets the context to be used in this call's Do method. Any
|
||||
// pending HTTP request will be aborted if the provided context is
|
||||
// canceled.
|
||||
func (c *ScriptsRunCall) Context(ctx context.Context) *ScriptsRunCall {
|
||||
c.ctx_ = ctx
|
||||
return c
|
||||
}
|
||||
|
||||
// Header returns an http.Header that can be modified by the caller to
|
||||
// add HTTP headers to the request.
|
||||
func (c *ScriptsRunCall) Header() http.Header {
|
||||
if c.header_ == nil {
|
||||
c.header_ = make(http.Header)
|
||||
}
|
||||
return c.header_
|
||||
}
|
||||
|
||||
func (c *ScriptsRunCall) doRequest(alt string) (*http.Response, error) {
|
||||
reqHeaders := make(http.Header)
|
||||
for k, v := range c.header_ {
|
||||
reqHeaders[k] = v
|
||||
}
|
||||
reqHeaders.Set("User-Agent", c.s.userAgent())
|
||||
var body io.Reader = nil
|
||||
body, err := googleapi.WithoutDataWrapper.JSONReader(c.executionrequest)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
reqHeaders.Set("Content-Type", "application/json")
|
||||
c.urlParams_.Set("alt", alt)
|
||||
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/scripts/{scriptId}:run")
|
||||
urls += "?" + c.urlParams_.Encode()
|
||||
req, _ := http.NewRequest("POST", urls, body)
|
||||
req.Header = reqHeaders
|
||||
googleapi.Expand(req.URL, map[string]string{
|
||||
"scriptId": c.scriptId,
|
||||
})
|
||||
return gensupport.SendRequest(c.ctx_, c.s.client, req)
|
||||
}
|
||||
|
||||
// Do executes the "script.scripts.run" call.
|
||||
// Exactly one of *Operation or error will be non-nil. Any non-2xx
|
||||
// status code is an error. Response headers are in either
|
||||
// *Operation.ServerResponse.Header or (if a response was returned at
|
||||
// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
|
||||
// to check whether the returned error was because
|
||||
// http.StatusNotModified was returned.
|
||||
func (c *ScriptsRunCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
|
||||
gensupport.SetOptions(c.urlParams_, opts...)
|
||||
res, err := c.doRequest("json")
|
||||
if res != nil && res.StatusCode == http.StatusNotModified {
|
||||
if res.Body != nil {
|
||||
res.Body.Close()
|
||||
}
|
||||
return nil, &googleapi.Error{
|
||||
Code: res.StatusCode,
|
||||
Header: res.Header,
|
||||
}
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer googleapi.CloseBody(res)
|
||||
if err := googleapi.CheckResponse(res); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
ret := &Operation{
|
||||
ServerResponse: googleapi.ServerResponse{
|
||||
Header: res.Header,
|
||||
HTTPStatusCode: res.StatusCode,
|
||||
},
|
||||
}
|
||||
target := &ret
|
||||
if err := json.NewDecoder(res.Body).Decode(target); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return ret, nil
|
||||
// {
|
||||
// "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.",
|
||||
// "flatPath": "v1/scripts/{scriptId}:run",
|
||||
// "httpMethod": "POST",
|
||||
// "id": "script.scripts.run",
|
||||
// "parameterOrder": [
|
||||
// "scriptId"
|
||||
// ],
|
||||
// "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 \u003e Project properties**.",
|
||||
// "location": "path",
|
||||
// "required": true,
|
||||
// "type": "string"
|
||||
// }
|
||||
// },
|
||||
// "path": "v1/scripts/{scriptId}:run",
|
||||
// "request": {
|
||||
// "$ref": "ExecutionRequest"
|
||||
// },
|
||||
// "response": {
|
||||
// "$ref": "Operation"
|
||||
// },
|
||||
// "scopes": [
|
||||
// "https://mail.google.com/",
|
||||
// "https://www.google.com/calendar/feeds",
|
||||
// "https://www.google.com/m8/feeds",
|
||||
// "https://www.googleapis.com/auth/admin.directory.group",
|
||||
// "https://www.googleapis.com/auth/admin.directory.user",
|
||||
// "https://www.googleapis.com/auth/drive",
|
||||
// "https://www.googleapis.com/auth/forms",
|
||||
// "https://www.googleapis.com/auth/forms.currentonly",
|
||||
// "https://www.googleapis.com/auth/groups",
|
||||
// "https://www.googleapis.com/auth/spreadsheets",
|
||||
// "https://www.googleapis.com/auth/userinfo.email"
|
||||
// ]
|
||||
// }
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue