Google Apps Script API v1 (revision 104)

A B C D E F G I M O R S U W 

A

ADMIN_DIRECTORY_GROUP - Static variable in class com.google.api.services.script.ScriptScopes
View and manage the provisioning of groups on your domain.
ADMIN_DIRECTORY_USER - Static variable in class com.google.api.services.script.ScriptScopes
View and manage the provisioning of users on your domain.
all() - Static method in class com.google.api.services.script.ScriptScopes
Returns an unmodifiable set that contains all scopes declared by this class.

B

build() - Method in class com.google.api.services.script.Script.Builder
Builds a new instance of Script.

C

clone() - Method in class com.google.api.services.script.model.ExecutionError
 
clone() - Method in class com.google.api.services.script.model.ExecutionRequest
 
clone() - Method in class com.google.api.services.script.model.ExecutionResponse
 
clone() - Method in class com.google.api.services.script.model.Operation
 
clone() - Method in class com.google.api.services.script.model.ScriptStackTraceElement
 
clone() - Method in class com.google.api.services.script.model.Status
 
com.google.api.services.script - package com.google.api.services.script
 
com.google.api.services.script.model - package com.google.api.services.script.model
 

D

DEFAULT_BASE_URL - Static variable in class com.google.api.services.script.Script
The default encoded base URL of the service.
DEFAULT_BATCH_PATH - Static variable in class com.google.api.services.script.Script
The default encoded batch path of the service.
DEFAULT_ROOT_URL - Static variable in class com.google.api.services.script.Script
The default encoded root URL of the service.
DEFAULT_SERVICE_PATH - Static variable in class com.google.api.services.script.Script
The default encoded service path of the service.
DRIVE - Static variable in class com.google.api.services.script.ScriptScopes
View and manage the files in your Google Drive.

E

ExecutionError - Class in com.google.api.services.script.model
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.
ExecutionError() - Constructor for class com.google.api.services.script.model.ExecutionError
 
ExecutionRequest - Class in com.google.api.services.script.model
A request to run the function in a script.
ExecutionRequest() - Constructor for class com.google.api.services.script.model.ExecutionRequest
 
ExecutionResponse - Class in com.google.api.services.script.model
An object that provides the return value of a function executed using the Apps Script API.
ExecutionResponse() - Constructor for class com.google.api.services.script.model.ExecutionResponse
 

F

FORMS - Static variable in class com.google.api.services.script.ScriptScopes
View and manage your forms in Google Drive.
FORMS_CURRENTONLY - Static variable in class com.google.api.services.script.ScriptScopes
View and manage forms that this application has been installed in.

G

get$Xgafv() - Method in class com.google.api.services.script.ScriptRequest
V1 error format.
getAbstractGoogleClient() - Method in class com.google.api.services.script.ScriptRequest
 
getAccessToken() - Method in class com.google.api.services.script.ScriptRequest
OAuth access token.
getAlt() - Method in class com.google.api.services.script.ScriptRequest
Data format for response.
getBearerToken() - Method in class com.google.api.services.script.ScriptRequest
OAuth bearer token.
getCallback() - Method in class com.google.api.services.script.ScriptRequest
JSONP
getCode() - Method in class com.google.api.services.script.model.Status
The status code.
getDetails() - Method in class com.google.api.services.script.model.Status
An array that contains a single ExecutionError object that provides information about the nature of the error.
getDevMode() - Method in class com.google.api.services.script.model.ExecutionRequest
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.
getDone() - Method in class com.google.api.services.script.model.Operation
This field indicates whether the script execution has completed.
getError() - Method in class com.google.api.services.script.model.Operation
If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object.
getErrorMessage() - Method in class com.google.api.services.script.model.ExecutionError
The error message thrown by Apps Script, usually localized into the user's language.
getErrorType() - Method in class com.google.api.services.script.model.ExecutionError
The error type, for example `TypeError` or `ReferenceError`.
getFields() - Method in class com.google.api.services.script.ScriptRequest
Selector specifying which fields to include in a partial response.
getFunction() - Method in class com.google.api.services.script.model.ExecutionRequest
The name of the function to execute in the given script.
getFunction() - Method in class com.google.api.services.script.model.ScriptStackTraceElement
The name of the function that failed.
getKey() - Method in class com.google.api.services.script.ScriptRequest
API key.
getLineNumber() - Method in class com.google.api.services.script.model.ScriptStackTraceElement
The line number where the script failed.
getMessage() - Method in class com.google.api.services.script.model.Status
A developer-facing error message, which is in English.
getOauthToken() - Method in class com.google.api.services.script.ScriptRequest
OAuth 2.0 token for the current user.
getParameters() - Method in class com.google.api.services.script.model.ExecutionRequest
The parameters to be passed to the function being executed.
getPp() - Method in class com.google.api.services.script.ScriptRequest
Pretty-print response.
getPrettyPrint() - Method in class com.google.api.services.script.ScriptRequest
Returns response with indentations and line breaks.
getQuotaUser() - Method in class com.google.api.services.script.ScriptRequest
Available to use for quota purposes for server-side applications.
getResponse() - Method in class com.google.api.services.script.model.Operation
If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
getResult() - Method in class com.google.api.services.script.model.ExecutionResponse
The return value of the script function.
getScriptId() - Method in class com.google.api.services.script.Script.Scripts.Run
The script ID of the script to be executed.
getScriptStackTraceElements() - Method in class com.google.api.services.script.model.ExecutionError
An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.
getSessionState() - Method in class com.google.api.services.script.model.ExecutionRequest
For Android add-ons only.
getUploadProtocol() - Method in class com.google.api.services.script.ScriptRequest
Upload protocol for media (e.g.
getUploadType() - Method in class com.google.api.services.script.ScriptRequest
Legacy upload protocol for media (e.g.
GROUPS - Static variable in class com.google.api.services.script.ScriptScopes
View and manage your Google Groups.

I

initialize(AbstractGoogleClientRequest<?>) - Method in class com.google.api.services.script.Script
 
initializeJsonRequest(AbstractGoogleJsonClientRequest<?>) - Method in class com.google.api.services.script.ScriptRequestInitializer
 
initializeScriptRequest(ScriptRequest<?>) - Method in class com.google.api.services.script.ScriptRequestInitializer
Initializes Script request.

M

MAIL_GOOGLE_COM - Static variable in class com.google.api.services.script.ScriptScopes
Read, send, delete, and manage your email.

O

Operation - Class in com.google.api.services.script.model
A representation of a execution of an Apps Script function that is started using run.
Operation() - Constructor for class com.google.api.services.script.model.Operation
 

R

run(String, ExecutionRequest) - Method in class com.google.api.services.script.Script.Scripts
Runs a function in an Apps Script project.

S

Script - Class in com.google.api.services.script
Service definition for Script (v1).
Script(HttpTransport, JsonFactory, HttpRequestInitializer) - Constructor for class com.google.api.services.script.Script
Constructor.
Script.Builder - Class in com.google.api.services.script
Builder for Script.
Script.Builder(HttpTransport, JsonFactory, HttpRequestInitializer) - Constructor for class com.google.api.services.script.Script.Builder
Returns an instance of a new builder.
Script.Scripts - Class in com.google.api.services.script
The "scripts" collection of methods.
Script.Scripts() - Constructor for class com.google.api.services.script.Script.Scripts
 
Script.Scripts.Run - Class in com.google.api.services.script
 
Script.Scripts.Run(String, ExecutionRequest) - Constructor for class com.google.api.services.script.Script.Scripts.Run
Runs a function in an Apps Script project.
ScriptRequest<T> - Class in com.google.api.services.script
Script request.
ScriptRequest(Script, String, String, Object, Class<T>) - Constructor for class com.google.api.services.script.ScriptRequest
 
ScriptRequestInitializer - Class in com.google.api.services.script
Script request initializer for setting properties like key and userIp.
ScriptRequestInitializer() - Constructor for class com.google.api.services.script.ScriptRequestInitializer
 
ScriptRequestInitializer(String) - Constructor for class com.google.api.services.script.ScriptRequestInitializer
 
ScriptRequestInitializer(String, String) - Constructor for class com.google.api.services.script.ScriptRequestInitializer
 
scripts() - Method in class com.google.api.services.script.Script
An accessor for creating requests from the Scripts collection.
ScriptScopes - Class in com.google.api.services.script
Available OAuth 2.0 scopes for use with the Google Apps Script API.
ScriptStackTraceElement - Class in com.google.api.services.script.model
A stack trace through the script that shows where the execution failed.
ScriptStackTraceElement() - Constructor for class com.google.api.services.script.model.ScriptStackTraceElement
 
set(String, Object) - Method in class com.google.api.services.script.model.ExecutionError
 
set(String, Object) - Method in class com.google.api.services.script.model.ExecutionRequest
 
set(String, Object) - Method in class com.google.api.services.script.model.ExecutionResponse
 
set(String, Object) - Method in class com.google.api.services.script.model.Operation
 
set(String, Object) - Method in class com.google.api.services.script.model.ScriptStackTraceElement
 
set(String, Object) - Method in class com.google.api.services.script.model.Status
 
set(String, Object) - Method in class com.google.api.services.script.Script.Scripts.Run
 
set(String, Object) - Method in class com.google.api.services.script.ScriptRequest
 
set$Xgafv(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
set$Xgafv(String) - Method in class com.google.api.services.script.ScriptRequest
V1 error format.
setAccessToken(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setAccessToken(String) - Method in class com.google.api.services.script.ScriptRequest
OAuth access token.
setAlt(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setAlt(String) - Method in class com.google.api.services.script.ScriptRequest
Data format for response.
setApplicationName(String) - Method in class com.google.api.services.script.Script.Builder
 
setBatchPath(String) - Method in class com.google.api.services.script.Script.Builder
 
setBearerToken(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setBearerToken(String) - Method in class com.google.api.services.script.ScriptRequest
OAuth bearer token.
setCallback(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setCallback(String) - Method in class com.google.api.services.script.ScriptRequest
JSONP
setCode(Integer) - Method in class com.google.api.services.script.model.Status
The status code.
setDetails(List<Map<String, Object>>) - Method in class com.google.api.services.script.model.Status
An array that contains a single ExecutionError object that provides information about the nature of the error.
setDevMode(Boolean) - Method in class com.google.api.services.script.model.ExecutionRequest
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.
setDisableGZipContent(boolean) - Method in class com.google.api.services.script.ScriptRequest
 
setDone(Boolean) - Method in class com.google.api.services.script.model.Operation
This field indicates whether the script execution has completed.
setError(Status) - Method in class com.google.api.services.script.model.Operation
If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object.
setErrorMessage(String) - Method in class com.google.api.services.script.model.ExecutionError
The error message thrown by Apps Script, usually localized into the user's language.
setErrorType(String) - Method in class com.google.api.services.script.model.ExecutionError
The error type, for example `TypeError` or `ReferenceError`.
setFields(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setFields(String) - Method in class com.google.api.services.script.ScriptRequest
Selector specifying which fields to include in a partial response.
setFunction(String) - Method in class com.google.api.services.script.model.ExecutionRequest
The name of the function to execute in the given script.
setFunction(String) - Method in class com.google.api.services.script.model.ScriptStackTraceElement
The name of the function that failed.
setGoogleClientRequestInitializer(GoogleClientRequestInitializer) - Method in class com.google.api.services.script.Script.Builder
 
setHttpRequestInitializer(HttpRequestInitializer) - Method in class com.google.api.services.script.Script.Builder
 
setKey(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setKey(String) - Method in class com.google.api.services.script.ScriptRequest
API key.
setLineNumber(Integer) - Method in class com.google.api.services.script.model.ScriptStackTraceElement
The line number where the script failed.
setMessage(String) - Method in class com.google.api.services.script.model.Status
A developer-facing error message, which is in English.
setOauthToken(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setOauthToken(String) - Method in class com.google.api.services.script.ScriptRequest
OAuth 2.0 token for the current user.
setParameters(List<Object>) - Method in class com.google.api.services.script.model.ExecutionRequest
The parameters to be passed to the function being executed.
setPp(Boolean) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setPp(Boolean) - Method in class com.google.api.services.script.ScriptRequest
Pretty-print response.
setPrettyPrint(Boolean) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setPrettyPrint(Boolean) - Method in class com.google.api.services.script.ScriptRequest
Returns response with indentations and line breaks.
setQuotaUser(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setQuotaUser(String) - Method in class com.google.api.services.script.ScriptRequest
Available to use for quota purposes for server-side applications.
setRequestHeaders(HttpHeaders) - Method in class com.google.api.services.script.ScriptRequest
 
setResponse(Map<String, Object>) - Method in class com.google.api.services.script.model.Operation
If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
setResult(Object) - Method in class com.google.api.services.script.model.ExecutionResponse
The return value of the script function.
setRootUrl(String) - Method in class com.google.api.services.script.Script.Builder
 
setScriptId(String) - Method in class com.google.api.services.script.Script.Scripts.Run
The script ID of the script to be executed.
setScriptRequestInitializer(ScriptRequestInitializer) - Method in class com.google.api.services.script.Script.Builder
setScriptStackTraceElements(List<ScriptStackTraceElement>) - Method in class com.google.api.services.script.model.ExecutionError
An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.
setServicePath(String) - Method in class com.google.api.services.script.Script.Builder
 
setSessionState(String) - Method in class com.google.api.services.script.model.ExecutionRequest
For Android add-ons only.
setSuppressAllChecks(boolean) - Method in class com.google.api.services.script.Script.Builder
 
setSuppressPatternChecks(boolean) - Method in class com.google.api.services.script.Script.Builder
 
setSuppressRequiredParameterChecks(boolean) - Method in class com.google.api.services.script.Script.Builder
 
setUploadProtocol(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setUploadProtocol(String) - Method in class com.google.api.services.script.ScriptRequest
Upload protocol for media (e.g.
setUploadType(String) - Method in class com.google.api.services.script.Script.Scripts.Run
 
setUploadType(String) - Method in class com.google.api.services.script.ScriptRequest
Legacy upload protocol for media (e.g.
SPREADSHEETS - Static variable in class com.google.api.services.script.ScriptScopes
View and manage your spreadsheets in Google Drive.
Status - Class in com.google.api.services.script.model
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.
Status() - Constructor for class com.google.api.services.script.model.Status
 

U

USERINFO_EMAIL - Static variable in class com.google.api.services.script.ScriptScopes
View your email address.

W

WWW_GOOGLE_COM_CALENDAR_FEEDS - Static variable in class com.google.api.services.script.ScriptScopes
Manage your calendars.
WWW_GOOGLE_COM_M8_FEEDS - Static variable in class com.google.api.services.script.ScriptScopes
Manage your contacts.
A B C D E F G I M O R S U W