Package script

import "google.golang.org/api/script/v1"
...
scriptService, err := script.New(oauthHttpClient)

Constants

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"
)

type ExecutionError ¶

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 (*ExecutionError) MarshalJSON ¶

func (s *ExecutionError) MarshalJSON() ([]byte, error)

type ExecutionRequest ¶

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 (*ExecutionRequest) MarshalJSON ¶

func (s *ExecutionRequest) MarshalJSON() ([]byte, error)

type ExecutionResponse ¶

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 (*ExecutionResponse) MarshalJSON ¶

func (s *ExecutionResponse) MarshalJSON() ([]byte, error)

type JoinAsyncRequest ¶

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 (*JoinAsyncRequest) MarshalJSON ¶

func (s *JoinAsyncRequest) MarshalJSON() ([]byte, error)

type JoinAsyncResponse ¶

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 (*JoinAsyncResponse) MarshalJSON ¶

func (s *JoinAsyncResponse) MarshalJSON() ([]byte, error)

type Operation ¶

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 (*Operation) MarshalJSON ¶

func (s *Operation) MarshalJSON() ([]byte, error)

type ScriptStackTraceElement ¶

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 (*ScriptStackTraceElement) MarshalJSON ¶

func (s *ScriptStackTraceElement) MarshalJSON() ([]byte, error)

type ScriptsRunCall ¶

type ScriptsRunCall struct {
    // contains filtered or unexported fields
}

func (*ScriptsRunCall) Context ¶

func (c *ScriptsRunCall) Context(ctx context.Context) *ScriptsRunCall

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 (*ScriptsRunCall) Do ¶

func (c *ScriptsRunCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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 (*ScriptsRunCall) Fields ¶

func (c *ScriptsRunCall) Fields(s ...googleapi.Field) *ScriptsRunCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ScriptsRunCall) Header ¶

func (c *ScriptsRunCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ScriptsService ¶

type ScriptsService struct {
    // contains filtered or unexported fields
}

func NewScriptsService ¶

func NewScriptsService(s *Service) *ScriptsService

func (*ScriptsService) Run ¶

func (r *ScriptsService) Run(scriptId string, executionrequest *ExecutionRequest) *ScriptsRunCall

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.

type Service ¶

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Scripts *ScriptsService
    // contains filtered or unexported fields
}

func New ¶

func New(client *http.Client) (*Service, error)

type Status ¶

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 (*Status) MarshalJSON ¶

func (s *Status) MarshalJSON() ([]byte, error)