OAuth2 scopes used by this API.
const (
// Read, compose, send, and permanently delete all your email from Gmail
MailGoogleComScope = "https://mail.google.com/"
// See, edit, share, and permanently delete all the calendars you can access
// using Google Calendar
WwwGoogleComCalendarFeedsScope = "https://www.google.com/calendar/feeds"
// See, edit, download, and permanently delete 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"
// See, edit, create, and delete all your Google Docs documents
DocumentsScope = "https://www.googleapis.com/auth/documents"
// See, edit, create, and delete all of your Google Drive files
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"
// Create and update Google Apps Script deployments
ScriptDeploymentsScope = "https://www.googleapis.com/auth/script.deployments"
// View Google Apps Script deployments
ScriptDeploymentsReadonlyScope = "https://www.googleapis.com/auth/script.deployments.readonly"
// View Google Apps Script project's metrics
ScriptMetricsScope = "https://www.googleapis.com/auth/script.metrics"
// View Google Apps Script processes
ScriptProcessesScope = "https://www.googleapis.com/auth/script.processes"
// Create and update Google Apps Script projects
ScriptProjectsScope = "https://www.googleapis.com/auth/script.projects"
// View Google Apps Script projects
ScriptProjectsReadonlyScope = "https://www.googleapis.com/auth/script.projects.readonly"
// See, edit, create, and delete all your Google Sheets spreadsheets
SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets"
// See your primary Google Account email address
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
)
Content: The Content resource.
type Content struct {
// Files: The list of script project files. One of the files is a script
// manifest; it must be named "appsscript", must have type of JSON, and include
// the manifest configurations for the project.
Files []*File `json:"files,omitempty"`
// ScriptId: The script project's Drive ID.
ScriptId string `json:"scriptId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Files") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Files") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Content) MarshalJSON() ([]byte, error)
CreateProjectRequest: Request to create a script project. Request to create a script project.
type CreateProjectRequest struct {
// ParentId: The Drive ID of a parent file that the created script project is
// bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form,
// or Google Slides file. If not set, a standalone script project is created.
ParentId string `json:"parentId,omitempty"`
// Title: The title for the project.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "ParentId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ParentId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CreateProjectRequest) MarshalJSON() ([]byte, error)
Deployment: Representation of a single script deployment.
type Deployment struct {
// DeploymentConfig: The deployment configuration.
DeploymentConfig *DeploymentConfig `json:"deploymentConfig,omitempty"`
// DeploymentId: The deployment ID for this deployment.
DeploymentId string `json:"deploymentId,omitempty"`
// EntryPoints: The deployment's entry points.
EntryPoints []*EntryPoint `json:"entryPoints,omitempty"`
// UpdateTime: Last modified date time stamp.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DeploymentConfig") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeploymentConfig") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Deployment) MarshalJSON() ([]byte, error)
DeploymentConfig: Metadata the defines how a deployment is configured.
type DeploymentConfig struct {
// Description: The description for this deployment.
Description string `json:"description,omitempty"`
// ManifestFileName: The manifest file name for this deployment.
ManifestFileName string `json:"manifestFileName,omitempty"`
// ScriptId: The script project's Drive ID.
ScriptId string `json:"scriptId,omitempty"`
// VersionNumber: The version number on which this deployment is based.
VersionNumber int64 `json:"versionNumber,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeploymentConfig) MarshalJSON() ([]byte, error)
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
EntryPoint: A configuration that defines how a deployment is accessed externally.
type EntryPoint struct {
// AddOn: Add-on properties.
AddOn *GoogleAppsScriptTypeAddOnEntryPoint `json:"addOn,omitempty"`
// EntryPointType: The type of the entry point.
//
// Possible values:
// "ENTRY_POINT_TYPE_UNSPECIFIED" - An unspecified entry point.
// "WEB_APP" - A web application entry point.
// "EXECUTION_API" - An API executable entry point.
// "ADD_ON" - An Add-On entry point.
EntryPointType string `json:"entryPointType,omitempty"`
// ExecutionApi: An entry point specification for Apps Script API execution
// calls.
ExecutionApi *GoogleAppsScriptTypeExecutionApiEntryPoint `json:"executionApi,omitempty"`
// WebApp: An entry point specification for web apps.
WebApp *GoogleAppsScriptTypeWebAppEntryPoint `json:"webApp,omitempty"`
// ForceSendFields is a list of field names (e.g. "AddOn") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AddOn") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EntryPoint) MarshalJSON() ([]byte, error)
ExecuteStreamResponse: The response for executing or debugging a function in an Apps Script project.
type ExecuteStreamResponse struct {
// Result: The result of the execution.
Result *ScriptExecutionResult `json:"result,omitempty"`
// ForceSendFields is a list of field names (e.g. "Result") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ExecuteStreamResponse) MarshalJSON() ([]byte, error)
ExecutionError: An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a 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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ExecutionError) MarshalJSON() ([]byte, error)
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 Apps Script 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. It can reference a function in
// an included library such as `Library.libFunction1`.
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: *Deprecated*. For use with 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.SessionState")`.
// 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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ExecutionRequest) MarshalJSON() ([]byte, error)
ExecutionResponse: An object that provides the return value of a function executed using the Apps Script API. If 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 using the Apps Script 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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ExecutionResponse) MarshalJSON() ([]byte, error)
File: An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.
type File struct {
// CreateTime: Creation date timestamp. This read-only field is only visible to
// users who have WRITER permission for the script project.
CreateTime string `json:"createTime,omitempty"`
// FunctionSet: The defined set of functions in the script file, if any.
FunctionSet *GoogleAppsScriptTypeFunctionSet `json:"functionSet,omitempty"`
// LastModifyUser: The user who modified the file most recently. This read-only
// field is only visible to users who have WRITER permission for the script
// project.
LastModifyUser *GoogleAppsScriptTypeUser `json:"lastModifyUser,omitempty"`
// Name: The name of the file. The file extension is not part of the file name,
// which can be identified from the type field.
Name string `json:"name,omitempty"`
// Source: The file content.
Source string `json:"source,omitempty"`
// Type: The type of the file.
//
// Possible values:
// "ENUM_TYPE_UNSPECIFIED" - Undetermined file type; never actually used.
// "SERVER_JS" - An Apps Script server-side code file.
// "HTML" - A file containing client-side HTML.
// "JSON" - A file in JSON format. This type is only used for the script
// project's manifest. The manifest file content must match the structure of a
// valid [ScriptManifest](/apps-script/concepts/manifests)
Type string `json:"type,omitempty"`
// UpdateTime: Last modified date timestamp. This read-only field is only
// visible to users who have WRITER permission for the script project.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *File) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeAddOnEntryPoint: An add-on entry point.
type GoogleAppsScriptTypeAddOnEntryPoint struct {
// AddOnType: The add-on's required list of supported container types.
//
// Possible values:
// "UNKNOWN_ADDON_TYPE" - Default value, unknown add-on type.
// "GMAIL" - Add-on type for Gmail.
// "DATA_STUDIO" - Add-on type for Data Studio.
AddOnType string `json:"addOnType,omitempty"`
// Description: The add-on's optional description.
Description string `json:"description,omitempty"`
// HelpUrl: The add-on's optional help URL.
HelpUrl string `json:"helpUrl,omitempty"`
// PostInstallTipUrl: The add-on's required post install tip URL.
PostInstallTipUrl string `json:"postInstallTipUrl,omitempty"`
// ReportIssueUrl: The add-on's optional report issue URL.
ReportIssueUrl string `json:"reportIssueUrl,omitempty"`
// Title: The add-on's required title.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "AddOnType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AddOnType") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeAddOnEntryPoint) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeExecutionApiConfig: API executable entry point configuration.
type GoogleAppsScriptTypeExecutionApiConfig struct {
// Access: Who has permission to run the API executable.
//
// Possible values:
// "UNKNOWN_ACCESS" - Default value, should not be used.
// "MYSELF" - Only the user who deployed the web app or executable can access
// it. Note that this is not necessarily the owner of the script project.
// "DOMAIN" - Only users in the same domain as the user who deployed the web
// app or executable can access it.
// "ANYONE" - Any logged in user can access the web app or executable.
// "ANYONE_ANONYMOUS" - Any user, logged in or not, can access the web app or
// executable.
Access string `json:"access,omitempty"`
// ForceSendFields is a list of field names (e.g. "Access") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Access") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeExecutionApiConfig) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeExecutionApiEntryPoint: An API executable entry point.
type GoogleAppsScriptTypeExecutionApiEntryPoint struct {
// EntryPointConfig: The entry point's configuration.
EntryPointConfig *GoogleAppsScriptTypeExecutionApiConfig `json:"entryPointConfig,omitempty"`
// ForceSendFields is a list of field names (e.g. "EntryPointConfig") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EntryPointConfig") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeExecutionApiEntryPoint) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeFunction: Represents a function in a script project.
type GoogleAppsScriptTypeFunction struct {
// Name: The function name in the script project.
Name string `json:"name,omitempty"`
// Parameters: The ordered list of parameter names of the function in the
// script project.
Parameters []string `json:"parameters,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeFunction) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeFunctionSet: A set of functions. No duplicates are permitted.
type GoogleAppsScriptTypeFunctionSet struct {
// Values: A list of functions composing the set.
Values []*GoogleAppsScriptTypeFunction `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeFunctionSet) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeProcess: Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.
type GoogleAppsScriptTypeProcess struct {
// Duration: Duration the execution spent executing.
Duration string `json:"duration,omitempty"`
// FunctionName: Name of the function the started the execution.
FunctionName string `json:"functionName,omitempty"`
// ProcessStatus: The executions status.
//
// Possible values:
// "PROCESS_STATUS_UNSPECIFIED" - Unspecified status.
// "RUNNING" - The process is currently running.
// "PAUSED" - The process has paused.
// "COMPLETED" - The process has completed.
// "CANCELED" - The process was cancelled.
// "FAILED" - The process failed.
// "TIMED_OUT" - The process timed out.
// "UNKNOWN" - Process status unknown.
// "DELAYED" - The process is delayed, waiting for quota.
// "EXECUTION_DISABLED" - AppsScript executions are disabled by Admin.
ProcessStatus string `json:"processStatus,omitempty"`
// ProcessType: The executions type.
//
// Possible values:
// "PROCESS_TYPE_UNSPECIFIED" - Unspecified type.
// "ADD_ON" - The process was started from an add-on entry point.
// "EXECUTION_API" - The process was started using the Apps Script API.
// "TIME_DRIVEN" - The process was started from a time-based trigger.
// "TRIGGER" - The process was started from an event-based trigger.
// "WEBAPP" - The process was started from a web app entry point.
// "EDITOR" - The process was started using the Apps Script IDE.
// "SIMPLE_TRIGGER" - The process was started from a G Suite simple trigger.
// "MENU" - The process was started from a G Suite menu item.
// "BATCH_TASK" - The process was started as a task in a batch job.
ProcessType string `json:"processType,omitempty"`
// ProjectName: Name of the script being executed.
ProjectName string `json:"projectName,omitempty"`
// RuntimeVersion: Which version of maestro to use to execute the script.
//
// Possible values:
// "RUNTIME_VERSION_UNSPECIFIED" - Runtime version unset / unknown.
// "DEPRECATED_ES5" - Legacy rhino version of the Apps script runtime
// "V8" - Current default V8 version of the apps script runtime.
RuntimeVersion string `json:"runtimeVersion,omitempty"`
// StartTime: Time the execution started.
StartTime string `json:"startTime,omitempty"`
// UserAccessLevel: The executing users access level to the script.
//
// Possible values:
// "USER_ACCESS_LEVEL_UNSPECIFIED" - User access level unspecified
// "NONE" - The user has no access.
// "READ" - The user has read-only access.
// "WRITE" - The user has write access.
// "OWNER" - The user is an owner.
UserAccessLevel string `json:"userAccessLevel,omitempty"`
// ForceSendFields is a list of field names (e.g. "Duration") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Duration") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeProcess) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeUser: A simple user profile resource.
type GoogleAppsScriptTypeUser struct {
// Domain: The user's domain.
Domain string `json:"domain,omitempty"`
// Email: The user's identifying email address.
Email string `json:"email,omitempty"`
// Name: The user's display name.
Name string `json:"name,omitempty"`
// PhotoUrl: The user's photo.
PhotoUrl string `json:"photoUrl,omitempty"`
// ForceSendFields is a list of field names (e.g. "Domain") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Domain") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeUser) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeWebAppConfig: Web app entry point configuration.
type GoogleAppsScriptTypeWebAppConfig struct {
// Access: Who has permission to run the web app.
//
// Possible values:
// "UNKNOWN_ACCESS" - Default value, should not be used.
// "MYSELF" - Only the user who deployed the web app or executable can access
// it. Note that this is not necessarily the owner of the script project.
// "DOMAIN" - Only users in the same domain as the user who deployed the web
// app or executable can access it.
// "ANYONE" - Any logged in user can access the web app or executable.
// "ANYONE_ANONYMOUS" - Any user, logged in or not, can access the web app or
// executable.
Access string `json:"access,omitempty"`
// ExecuteAs: Who to execute the web app as.
//
// Possible values:
// "UNKNOWN_EXECUTE_AS" - Default value, should not be used.
// "USER_ACCESSING" - The script runs as the user accessing the web app.
// "USER_DEPLOYING" - The script runs as the user who deployed the web app.
// Note that this is not necessarily the owner of the script project.
ExecuteAs string `json:"executeAs,omitempty"`
// ForceSendFields is a list of field names (e.g. "Access") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Access") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeWebAppConfig) MarshalJSON() ([]byte, error)
GoogleAppsScriptTypeWebAppEntryPoint: A web application entry point.
type GoogleAppsScriptTypeWebAppEntryPoint struct {
// EntryPointConfig: The entry point's configuration.
EntryPointConfig *GoogleAppsScriptTypeWebAppConfig `json:"entryPointConfig,omitempty"`
// Url: The URL for the web application.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "EntryPointConfig") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EntryPointConfig") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleAppsScriptTypeWebAppEntryPoint) MarshalJSON() ([]byte, error)
ListDeploymentsResponse: Response with the list of deployments for the specified Apps Script project.
type ListDeploymentsResponse struct {
// Deployments: The list of deployments.
Deployments []*Deployment `json:"deployments,omitempty"`
// NextPageToken: The token that can be used in the next call to get the next
// page of results.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Deployments") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Deployments") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListDeploymentsResponse) MarshalJSON() ([]byte, error)
ListScriptProcessesResponse: Response with the list of Process resources.
type ListScriptProcessesResponse struct {
// NextPageToken: Token for the next page of results. If empty, there are no
// more pages remaining.
NextPageToken string `json:"nextPageToken,omitempty"`
// Processes: List of processes matching request parameters.
Processes []*GoogleAppsScriptTypeProcess `json:"processes,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListScriptProcessesResponse) MarshalJSON() ([]byte, error)
ListUserProcessesResponse: Response with the list of Process resources.
type ListUserProcessesResponse struct {
// NextPageToken: Token for the next page of results. If empty, there are no
// more pages remaining.
NextPageToken string `json:"nextPageToken,omitempty"`
// Processes: List of processes matching request parameters.
Processes []*GoogleAppsScriptTypeProcess `json:"processes,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListUserProcessesResponse) MarshalJSON() ([]byte, error)
ListValue: `ListValue` is a wrapper around a repeated field of values.
type ListValue struct {
// Values: Repeated field of dynamically typed values.
Values []*Value `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListValue) MarshalJSON() ([]byte, error)
ListVersionsResponse: Response with the list of the versions for the specified script project.
type ListVersionsResponse struct {
// NextPageToken: The token use to fetch the next page of records. if not exist
// in the response, that means no more versions to list.
NextPageToken string `json:"nextPageToken,omitempty"`
// Versions: The list of versions.
Versions []*Version `json:"versions,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListVersionsResponse) MarshalJSON() ([]byte, error)
Metrics: Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.
type Metrics struct {
// ActiveUsers: Number of active users.
ActiveUsers []*MetricsValue `json:"activeUsers,omitempty"`
// FailedExecutions: Number of failed executions.
FailedExecutions []*MetricsValue `json:"failedExecutions,omitempty"`
// TotalExecutions: Number of total executions.
TotalExecutions []*MetricsValue `json:"totalExecutions,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ActiveUsers") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActiveUsers") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Metrics) MarshalJSON() ([]byte, error)
MetricsValue: Metrics value that holds number of executions counted.
type MetricsValue struct {
// EndTime: Required field indicating the end time of the interval.
EndTime string `json:"endTime,omitempty"`
// StartTime: Required field indicating the start time of the interval.
StartTime string `json:"startTime,omitempty"`
// Value: Indicates the number of executions counted.
Value uint64 `json:"value,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MetricsValue) MarshalJSON() ([]byte, error)
Operation: A representation of an execution of an Apps Script function started with 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). After execution has started, it can have one of four outcomes: - If the script function returns successfully, the response field contains 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 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. - If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present. - If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class.
type Operation struct {
// Done: 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.
Done bool `json:"done,omitempty"`
// Error: 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.
Error *Status `json:"error,omitempty"`
// Response: If the script function returns successfully, this field contains
// an ExecutionResponse object with the function's return value.
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
type ProcessesListCall struct {
// contains filtered or unexported fields
}
func (c *ProcessesListCall) Context(ctx context.Context) *ProcessesListCall
Context sets the context to be used in this call's Do method.
func (c *ProcessesListCall) Do(opts ...googleapi.CallOption) (*ListUserProcessesResponse, error)
Do executes the "script.processes.list" call. Any non-2xx status code is an error. Response headers are in either *ListUserProcessesResponse.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 *ProcessesListCall) Fields(s ...googleapi.Field) *ProcessesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProcessesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProcessesListCall) IfNoneMatch(entityTag string) *ProcessesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProcessesListCall) PageSize(pageSize int64) *ProcessesListCall
PageSize sets the optional parameter "pageSize": The maximum number of returned processes per page of results. Defaults to 50.
func (c *ProcessesListCall) PageToken(pageToken string) *ProcessesListCall
PageToken sets the optional parameter "pageToken": The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
func (c *ProcessesListCall) Pages(ctx context.Context, f func(*ListUserProcessesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *ProcessesListCall) UserProcessFilterDeploymentId(userProcessFilterDeploymentId string) *ProcessesListCall
UserProcessFilterDeploymentId sets the optional parameter "userProcessFilter.deploymentId": Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
func (c *ProcessesListCall) UserProcessFilterEndTime(userProcessFilterEndTime string) *ProcessesListCall
UserProcessFilterEndTime sets the optional parameter "userProcessFilter.endTime": Optional field used to limit returned processes to those that completed on or before the given timestamp.
func (c *ProcessesListCall) UserProcessFilterFunctionName(userProcessFilterFunctionName string) *ProcessesListCall
UserProcessFilterFunctionName sets the optional parameter "userProcessFilter.functionName": Optional field used to limit returned processes to those originating from a script function with the given function name.
func (c *ProcessesListCall) UserProcessFilterProjectName(userProcessFilterProjectName string) *ProcessesListCall
UserProcessFilterProjectName sets the optional parameter "userProcessFilter.projectName": Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
func (c *ProcessesListCall) UserProcessFilterScriptId(userProcessFilterScriptId string) *ProcessesListCall
UserProcessFilterScriptId sets the optional parameter "userProcessFilter.scriptId": Optional field used to limit returned processes to those originating from projects with a specific script ID.
func (c *ProcessesListCall) UserProcessFilterStartTime(userProcessFilterStartTime string) *ProcessesListCall
UserProcessFilterStartTime sets the optional parameter "userProcessFilter.startTime": Optional field used to limit returned processes to those that were started on or after the given timestamp.
func (c *ProcessesListCall) UserProcessFilterStatuses(userProcessFilterStatuses ...string) *ProcessesListCall
UserProcessFilterStatuses sets the optional parameter "userProcessFilter.statuses": Optional field used to limit returned processes to those having one of the specified process statuses.
Possible values:
"PROCESS_STATUS_UNSPECIFIED" - Unspecified status. "RUNNING" - The process is currently running. "PAUSED" - The process has paused. "COMPLETED" - The process has completed. "CANCELED" - The process was cancelled. "FAILED" - The process failed. "TIMED_OUT" - The process timed out. "UNKNOWN" - Process status unknown. "DELAYED" - The process is delayed, waiting for quota. "EXECUTION_DISABLED" - AppsScript executions are disabled by Admin.
func (c *ProcessesListCall) UserProcessFilterTypes(userProcessFilterTypes ...string) *ProcessesListCall
UserProcessFilterTypes sets the optional parameter "userProcessFilter.types": Optional field used to limit returned processes to those having one of the specified process types.
Possible values:
"PROCESS_TYPE_UNSPECIFIED" - Unspecified type. "ADD_ON" - The process was started from an add-on entry point. "EXECUTION_API" - The process was started using the Apps Script API. "TIME_DRIVEN" - The process was started from a time-based trigger. "TRIGGER" - The process was started from an event-based trigger. "WEBAPP" - The process was started from a web app entry point. "EDITOR" - The process was started using the Apps Script IDE. "SIMPLE_TRIGGER" - The process was started from a G Suite simple trigger. "MENU" - The process was started from a G Suite menu item. "BATCH_TASK" - The process was started as a task in a batch job.
func (c *ProcessesListCall) UserProcessFilterUserAccessLevels(userProcessFilterUserAccessLevels ...string) *ProcessesListCall
UserProcessFilterUserAccessLevels sets the optional parameter "userProcessFilter.userAccessLevels": Optional field used to limit returned processes to those having one of the specified user access levels.
Possible values:
"USER_ACCESS_LEVEL_UNSPECIFIED" - User access level unspecified "NONE" - The user has no access. "READ" - The user has read-only access. "WRITE" - The user has write access. "OWNER" - The user is an owner.
type ProcessesListScriptProcessesCall struct {
// contains filtered or unexported fields
}
func (c *ProcessesListScriptProcessesCall) Context(ctx context.Context) *ProcessesListScriptProcessesCall
Context sets the context to be used in this call's Do method.
func (c *ProcessesListScriptProcessesCall) Do(opts ...googleapi.CallOption) (*ListScriptProcessesResponse, error)
Do executes the "script.processes.listScriptProcesses" call. Any non-2xx status code is an error. Response headers are in either *ListScriptProcessesResponse.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 *ProcessesListScriptProcessesCall) Fields(s ...googleapi.Field) *ProcessesListScriptProcessesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProcessesListScriptProcessesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProcessesListScriptProcessesCall) IfNoneMatch(entityTag string) *ProcessesListScriptProcessesCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProcessesListScriptProcessesCall) PageSize(pageSize int64) *ProcessesListScriptProcessesCall
PageSize sets the optional parameter "pageSize": The maximum number of returned processes per page of results. Defaults to 50.
func (c *ProcessesListScriptProcessesCall) PageToken(pageToken string) *ProcessesListScriptProcessesCall
PageToken sets the optional parameter "pageToken": The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
func (c *ProcessesListScriptProcessesCall) Pages(ctx context.Context, f func(*ListScriptProcessesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *ProcessesListScriptProcessesCall) ScriptId(scriptId string) *ProcessesListScriptProcessesCall
ScriptId sets the optional parameter "scriptId": The script ID of the project whose processes are listed.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterDeploymentId(scriptProcessFilterDeploymentId string) *ProcessesListScriptProcessesCall
ScriptProcessFilterDeploymentId sets the optional parameter "scriptProcessFilter.deploymentId": Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterEndTime(scriptProcessFilterEndTime string) *ProcessesListScriptProcessesCall
ScriptProcessFilterEndTime sets the optional parameter "scriptProcessFilter.endTime": Optional field used to limit returned processes to those that completed on or before the given timestamp.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterFunctionName(scriptProcessFilterFunctionName string) *ProcessesListScriptProcessesCall
ScriptProcessFilterFunctionName sets the optional parameter "scriptProcessFilter.functionName": Optional field used to limit returned processes to those originating from a script function with the given function name.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterStartTime(scriptProcessFilterStartTime string) *ProcessesListScriptProcessesCall
ScriptProcessFilterStartTime sets the optional parameter "scriptProcessFilter.startTime": Optional field used to limit returned processes to those that were started on or after the given timestamp.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterStatuses(scriptProcessFilterStatuses ...string) *ProcessesListScriptProcessesCall
ScriptProcessFilterStatuses sets the optional parameter "scriptProcessFilter.statuses": Optional field used to limit returned processes to those having one of the specified process statuses.
Possible values:
"PROCESS_STATUS_UNSPECIFIED" - Unspecified status. "RUNNING" - The process is currently running. "PAUSED" - The process has paused. "COMPLETED" - The process has completed. "CANCELED" - The process was cancelled. "FAILED" - The process failed. "TIMED_OUT" - The process timed out. "UNKNOWN" - Process status unknown. "DELAYED" - The process is delayed, waiting for quota. "EXECUTION_DISABLED" - AppsScript executions are disabled by Admin.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterTypes(scriptProcessFilterTypes ...string) *ProcessesListScriptProcessesCall
ScriptProcessFilterTypes sets the optional parameter "scriptProcessFilter.types": Optional field used to limit returned processes to those having one of the specified process types.
Possible values:
"PROCESS_TYPE_UNSPECIFIED" - Unspecified type. "ADD_ON" - The process was started from an add-on entry point. "EXECUTION_API" - The process was started using the Apps Script API. "TIME_DRIVEN" - The process was started from a time-based trigger. "TRIGGER" - The process was started from an event-based trigger. "WEBAPP" - The process was started from a web app entry point. "EDITOR" - The process was started using the Apps Script IDE. "SIMPLE_TRIGGER" - The process was started from a G Suite simple trigger. "MENU" - The process was started from a G Suite menu item. "BATCH_TASK" - The process was started as a task in a batch job.
func (c *ProcessesListScriptProcessesCall) ScriptProcessFilterUserAccessLevels(scriptProcessFilterUserAccessLevels ...string) *ProcessesListScriptProcessesCall
ScriptProcessFilterUserAccessLevels sets the optional parameter "scriptProcessFilter.userAccessLevels": Optional field used to limit returned processes to those having one of the specified user access levels.
Possible values:
"USER_ACCESS_LEVEL_UNSPECIFIED" - User access level unspecified "NONE" - The user has no access. "READ" - The user has read-only access. "WRITE" - The user has write access. "OWNER" - The user is an owner.
type ProcessesService struct {
// contains filtered or unexported fields
}
func NewProcessesService(s *Service) *ProcessesService
func (r *ProcessesService) List() *ProcessesListCall
List: List information about processes made by or on behalf of a user, such as process type and current status.
func (r *ProcessesService) ListScriptProcesses() *ProcessesListScriptProcessesCall
ListScriptProcesses: List information about a script's executed processes, such as process type and current status.
Project: The script project resource.
type Project struct {
// CreateTime: When the script was created.
CreateTime string `json:"createTime,omitempty"`
// Creator: User who originally created the script.
Creator *GoogleAppsScriptTypeUser `json:"creator,omitempty"`
// LastModifyUser: User who last modified the script.
LastModifyUser *GoogleAppsScriptTypeUser `json:"lastModifyUser,omitempty"`
// ParentId: The parent's Drive ID that the script will be attached to. This is
// usually the ID of a Google Document or Google Sheet. This filed is optional,
// and if not set, a stand-alone script will be created.
ParentId string `json:"parentId,omitempty"`
// ScriptId: The script project's Drive ID.
ScriptId string `json:"scriptId,omitempty"`
// Title: The title for the project.
Title string `json:"title,omitempty"`
// UpdateTime: When the script was last updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Project) MarshalJSON() ([]byte, error)
type ProjectsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsCreateCall) Context(ctx context.Context) *ProjectsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsCreateCall) Do(opts ...googleapi.CallOption) (*Project, error)
Do executes the "script.projects.create" call. Any non-2xx status code is an error. Response headers are in either *Project.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 *ProjectsCreateCall) Fields(s ...googleapi.Field) *ProjectsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsDeploymentsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDeploymentsCreateCall) Context(ctx context.Context) *ProjectsDeploymentsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDeploymentsCreateCall) Do(opts ...googleapi.CallOption) (*Deployment, error)
Do executes the "script.projects.deployments.create" call. Any non-2xx status code is an error. Response headers are in either *Deployment.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 *ProjectsDeploymentsCreateCall) Fields(s ...googleapi.Field) *ProjectsDeploymentsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDeploymentsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsDeploymentsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDeploymentsDeleteCall) Context(ctx context.Context) *ProjectsDeploymentsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDeploymentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "script.projects.deployments.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 *ProjectsDeploymentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsDeploymentsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDeploymentsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsDeploymentsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDeploymentsGetCall) Context(ctx context.Context) *ProjectsDeploymentsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDeploymentsGetCall) Do(opts ...googleapi.CallOption) (*Deployment, error)
Do executes the "script.projects.deployments.get" call. Any non-2xx status code is an error. Response headers are in either *Deployment.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 *ProjectsDeploymentsGetCall) Fields(s ...googleapi.Field) *ProjectsDeploymentsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDeploymentsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsDeploymentsGetCall) IfNoneMatch(entityTag string) *ProjectsDeploymentsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsDeploymentsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDeploymentsListCall) Context(ctx context.Context) *ProjectsDeploymentsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDeploymentsListCall) Do(opts ...googleapi.CallOption) (*ListDeploymentsResponse, error)
Do executes the "script.projects.deployments.list" call. Any non-2xx status code is an error. Response headers are in either *ListDeploymentsResponse.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 *ProjectsDeploymentsListCall) Fields(s ...googleapi.Field) *ProjectsDeploymentsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDeploymentsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsDeploymentsListCall) IfNoneMatch(entityTag string) *ProjectsDeploymentsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsDeploymentsListCall) PageSize(pageSize int64) *ProjectsDeploymentsListCall
PageSize sets the optional parameter "pageSize": The maximum number of deployments on each returned page. Defaults to 50.
func (c *ProjectsDeploymentsListCall) PageToken(pageToken string) *ProjectsDeploymentsListCall
PageToken sets the optional parameter "pageToken": The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
func (c *ProjectsDeploymentsListCall) Pages(ctx context.Context, f func(*ListDeploymentsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsDeploymentsService struct {
// contains filtered or unexported fields
}
func NewProjectsDeploymentsService(s *Service) *ProjectsDeploymentsService
func (r *ProjectsDeploymentsService) Create(scriptId string, deploymentconfig *DeploymentConfig) *ProjectsDeploymentsCreateCall
Create: Creates a deployment of an Apps Script project.
- scriptId: The script project's Drive ID.
func (r *ProjectsDeploymentsService) Delete(scriptId string, deploymentId string) *ProjectsDeploymentsDeleteCall
Delete: Deletes a deployment of an Apps Script project.
- deploymentId: The deployment ID to be undeployed. - scriptId: The script project's Drive ID.
func (r *ProjectsDeploymentsService) Get(scriptId string, deploymentId string) *ProjectsDeploymentsGetCall
Get: Gets a deployment of an Apps Script project.
- deploymentId: The deployment ID. - scriptId: The script project's Drive ID.
func (r *ProjectsDeploymentsService) List(scriptId string) *ProjectsDeploymentsListCall
List: Lists the deployments of an Apps Script project.
- scriptId: The script project's Drive ID.
func (r *ProjectsDeploymentsService) Update(scriptId string, deploymentId string, updatedeploymentrequest *UpdateDeploymentRequest) *ProjectsDeploymentsUpdateCall
Update: Updates a deployment of an Apps Script project.
- deploymentId: The deployment ID for this deployment. - scriptId: The script project's Drive ID.
type ProjectsDeploymentsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsDeploymentsUpdateCall) Context(ctx context.Context) *ProjectsDeploymentsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsDeploymentsUpdateCall) Do(opts ...googleapi.CallOption) (*Deployment, error)
Do executes the "script.projects.deployments.update" call. Any non-2xx status code is an error. Response headers are in either *Deployment.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 *ProjectsDeploymentsUpdateCall) Fields(s ...googleapi.Field) *ProjectsDeploymentsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsDeploymentsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsGetCall) Do(opts ...googleapi.CallOption) (*Project, error)
Do executes the "script.projects.get" call. Any non-2xx status code is an error. Response headers are in either *Project.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 *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsGetContentCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetContentCall) Context(ctx context.Context) *ProjectsGetContentCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsGetContentCall) Do(opts ...googleapi.CallOption) (*Content, error)
Do executes the "script.projects.getContent" call. Any non-2xx status code is an error. Response headers are in either *Content.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 *ProjectsGetContentCall) Fields(s ...googleapi.Field) *ProjectsGetContentCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsGetContentCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsGetContentCall) IfNoneMatch(entityTag string) *ProjectsGetContentCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsGetContentCall) VersionNumber(versionNumber int64) *ProjectsGetContentCall
VersionNumber sets the optional parameter "versionNumber": The version number of the project to retrieve. If not provided, the project's HEAD version is returned.
type ProjectsGetMetricsCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsGetMetricsCall) Context(ctx context.Context) *ProjectsGetMetricsCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsGetMetricsCall) Do(opts ...googleapi.CallOption) (*Metrics, error)
Do executes the "script.projects.getMetrics" call. Any non-2xx status code is an error. Response headers are in either *Metrics.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 *ProjectsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsGetMetricsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsGetMetricsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsGetMetricsCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsGetMetricsCall) MetricsFilterDeploymentId(metricsFilterDeploymentId string) *ProjectsGetMetricsCall
MetricsFilterDeploymentId sets the optional parameter "metricsFilter.deploymentId": Optional field indicating a specific deployment to retrieve metrics from.
func (c *ProjectsGetMetricsCall) MetricsGranularity(metricsGranularity string) *ProjectsGetMetricsCall
MetricsGranularity sets the optional parameter "metricsGranularity": Required field indicating what granularity of metrics are returned.
Possible values:
"UNSPECIFIED_GRANULARITY" - Default metric granularity used to query no
metrics.
"WEEKLY" - Represents weekly metrics. "DAILY" - Represents daily metrics over a period of 7 days.
type ProjectsService struct {
Deployments *ProjectsDeploymentsService
Versions *ProjectsVersionsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
func (r *ProjectsService) Create(createprojectrequest *CreateProjectRequest) *ProjectsCreateCall
Create: Creates a new, empty script project with no script files and a base manifest file.
func (r *ProjectsService) Get(scriptId string) *ProjectsGetCall
Get: Gets a script project's metadata.
- scriptId: The script project's Drive ID.
func (r *ProjectsService) GetContent(scriptId string) *ProjectsGetContentCall
GetContent: Gets the content of the script project, including the code source and metadata for each script file.
- scriptId: The script project's Drive ID.
func (r *ProjectsService) GetMetrics(scriptId string) *ProjectsGetMetricsCall
GetMetrics: Get metrics data for scripts, such as number of executions and active users.
- scriptId: Required field indicating the script to get metrics for.
func (r *ProjectsService) UpdateContent(scriptId string, content *Content) *ProjectsUpdateContentCall
UpdateContent: Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.
- scriptId: The script project's Drive ID.
type ProjectsUpdateContentCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsUpdateContentCall) Context(ctx context.Context) *ProjectsUpdateContentCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsUpdateContentCall) Do(opts ...googleapi.CallOption) (*Content, error)
Do executes the "script.projects.updateContent" call. Any non-2xx status code is an error. Response headers are in either *Content.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 *ProjectsUpdateContentCall) Fields(s ...googleapi.Field) *ProjectsUpdateContentCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsUpdateContentCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsVersionsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsVersionsCreateCall) Context(ctx context.Context) *ProjectsVersionsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "script.projects.versions.create" call. Any non-2xx status code is an error. Response headers are in either *Version.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 *ProjectsVersionsCreateCall) Fields(s ...googleapi.Field) *ProjectsVersionsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsVersionsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsVersionsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsVersionsGetCall) Context(ctx context.Context) *ProjectsVersionsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsVersionsGetCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "script.projects.versions.get" call. Any non-2xx status code is an error. Response headers are in either *Version.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 *ProjectsVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsVersionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsVersionsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsVersionsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsVersionsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsVersionsListCall) Context(ctx context.Context) *ProjectsVersionsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)
Do executes the "script.projects.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListVersionsResponse.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 *ProjectsVersionsListCall) Fields(s ...googleapi.Field) *ProjectsVersionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsVersionsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsVersionsListCall) IfNoneMatch(entityTag string) *ProjectsVersionsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsVersionsListCall) PageSize(pageSize int64) *ProjectsVersionsListCall
PageSize sets the optional parameter "pageSize": The maximum number of versions on each returned page. Defaults to 50.
func (c *ProjectsVersionsListCall) PageToken(pageToken string) *ProjectsVersionsListCall
PageToken sets the optional parameter "pageToken": The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
func (c *ProjectsVersionsListCall) Pages(ctx context.Context, f func(*ListVersionsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsVersionsService struct {
// contains filtered or unexported fields
}
func NewProjectsVersionsService(s *Service) *ProjectsVersionsService
func (r *ProjectsVersionsService) Create(scriptId string, version *Version) *ProjectsVersionsCreateCall
Create: Creates a new immutable version using the current code, with a unique version number.
- scriptId: The script project's Drive ID.
func (r *ProjectsVersionsService) Get(scriptId string, versionNumber int64) *ProjectsVersionsGetCall
Get: Gets a version of a script project.
- scriptId: The script project's Drive ID. - versionNumber: The version number.
func (r *ProjectsVersionsService) List(scriptId string) *ProjectsVersionsListCall
List: List the versions of a script project.
- scriptId: The script project's Drive ID.
ScriptExecutionResult: The result of an execution.
type ScriptExecutionResult struct {
// ReturnValue: The returned value of the execution.
ReturnValue *Value `json:"returnValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReturnValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ReturnValue") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ScriptExecutionResult) MarshalJSON() ([]byte, error)
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ScriptStackTraceElement) MarshalJSON() ([]byte, error)
type ScriptsRunCall struct {
// contains filtered or unexported fields
}
func (c *ScriptsRunCall) Context(ctx context.Context) *ScriptsRunCall
Context sets the context to be used in this call's Do method.
func (c *ScriptsRunCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "script.scripts.run" call. 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) 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 details.
func (c *ScriptsRunCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ScriptsService struct {
// contains filtered or unexported fields
}
func NewScriptsService(s *Service) *ScriptsService
func (r *ScriptsService) Run(scriptId string, executionrequest *ExecutionRequest) *ScriptsRunCall
Run: Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the Authorization (#authorization-scopes) 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 script project **Overview** page and scroll down to "Project OAuth Scopes." The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Processes *ProcessesService
Projects *ProjectsService
Scripts *ScriptsService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
Status: 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.
type Status struct {
// Code: The status code. For this API, this value either: - 10, indicating a
// `SCRIPT_TIMEOUT` error, - 3, indicating an `INVALID_ARGUMENT` error, or - 1,
// indicating a `CANCELLED` execution.
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 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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
Struct: `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
type Struct struct {
// Fields: Unordered map of dynamically typed values.
Fields map[string]Value `json:"fields,omitempty"`
// ForceSendFields is a list of field names (e.g. "Fields") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Fields") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Struct) MarshalJSON() ([]byte, error)
UpdateDeploymentRequest: Request with deployment information to update an existing deployment.
type UpdateDeploymentRequest struct {
// DeploymentConfig: The deployment configuration.
DeploymentConfig *DeploymentConfig `json:"deploymentConfig,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeploymentConfig") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeploymentConfig") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UpdateDeploymentRequest) MarshalJSON() ([]byte, error)
Value: `Value` represents a dynamically typed value which is the outcome of an executed script.
type Value struct {
// BoolValue: Represents a boolean value.
BoolValue bool `json:"boolValue,omitempty"`
// BytesValue: Represents raw byte values.
BytesValue string `json:"bytesValue,omitempty"`
// DateValue: Represents a date in ms since the epoch.
DateValue int64 `json:"dateValue,omitempty,string"`
// ListValue: Represents a repeated `Value`.
ListValue *ListValue `json:"listValue,omitempty"`
// NullValue: Represents a null value.
//
// Possible values:
// "NULL_VALUE" - Null value.
NullValue string `json:"nullValue,omitempty"`
// NumberValue: Represents a double value.
NumberValue float64 `json:"numberValue,omitempty"`
// ProtoValue: Represents a structured proto value.
ProtoValue googleapi.RawMessage `json:"protoValue,omitempty"`
// StringValue: Represents a string value.
StringValue string `json:"stringValue,omitempty"`
// StructValue: Represents a structured value.
StructValue *Struct `json:"structValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "BoolValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BoolValue") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Value) MarshalJSON() ([]byte, error)
func (s *Value) UnmarshalJSON(data []byte) error
Version: A resource representing a script project version. A version is a "snapshot" of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
type Version struct {
// CreateTime: When the version was created.
CreateTime string `json:"createTime,omitempty"`
// Description: The description for this version.
Description string `json:"description,omitempty"`
// ScriptId: The script project's Drive ID.
ScriptId string `json:"scriptId,omitempty"`
// VersionNumber: The incremental ID that is created by Apps Script when a
// version is created. This is system assigned number and is immutable once
// created.
VersionNumber int64 `json:"versionNumber,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Version) MarshalJSON() ([]byte, error)