1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
|
// 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 (
// View and manage your mail
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 will contain a `Status`
// object. The `Status` object's `details` field will contain 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 will return 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 type for each parameter should match the expected type
// in Apps Script. Parameters cannot be Apps Script-specific objects
// (such as a `Document` or `Calendar`); they can only be primitive
// types such as a `string`, `number`, `array`, `object`, or `boolean`.
// Optional.
Parameters []interface{} `json:"parameters,omitempty"`
// SessionState: This field is not used.
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 an `run`
// call succeeds and the script function returns successfully, the
// response body's `response` field will contain this
// `ExecutionResponse` object.
type ExecutionResponse struct {
// Result: The return value of the script function. The type will match
// the type returned in Apps Script. Functions called through the
// Execution API cannot return Apps Script-specific objects (such as a
// `Document` or `Calendar`); they can only return primitive types such
// as a `string`, `number`, `array`, `object`, or `boolean`.
Result interface{} `json:"result,omitempty"`
// Possible values:
// "SUCCESS"
// "CANCELED"
Status string `json:"status,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)
}
// 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).
// 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.
//
// 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.
//
// 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.
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 OperationMetadata `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 OperationResponse `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)
}
type OperationMetadata interface{}
type OperationResponse interface{}
// 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, which should be an enum value of
// google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: An array that contains a single `ExecutionError` object that
// provides information about the nature of the error.
Details []StatusDetails `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in
// English. Any user-facing error message should be localized and sent
// in the 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)
}
type StatusDetails interface{}
// 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 that has been 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 [Authentication](#authentication) 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 that has been 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 [Authentication](#authentication) 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 \u003e Project properties** and click the **Scopes** tab.",
// "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 the project in the script editor, then 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"
// ]
// }
}
|