com.google.api.services.script

Class Script.Scripts.Run

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.script.ScriptRequest<Operation>

com.google.api.services.script.Script.Scripts.Run

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Script.Scripts

public class Script.Scripts.Run
extends ScriptRequest<Operation>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Run(String scriptId, ExecutionRequest content) Runs a function in an Apps Script project.

Method Summary

Modifier and Type	Method and Description
String	getScriptId() The script ID of the script to be executed.
Script.Scripts.Run	set(String parameterName, Object value)
Script.Scripts.Run	set$Xgafv(String $Xgafv) V1 error format.
Script.Scripts.Run	setAccessToken(String accessToken) OAuth access token.
Script.Scripts.Run	setAlt(String alt) Data format for response.
Script.Scripts.Run	setCallback(String callback) JSONP
Script.Scripts.Run	setFields(String fields) Selector specifying which fields to include in a partial response.
Script.Scripts.Run	setKey(String key) API key.
Script.Scripts.Run	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Script.Scripts.Run	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Script.Scripts.Run	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Script.Scripts.Run	setScriptId(String scriptId) The script ID of the script to be executed.
Script.Scripts.Run	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Script.Scripts.Run	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.script.ScriptRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Run

protected Run(String scriptId,
              ExecutionRequest content)

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) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab. 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. Create a request for the method "scripts.run". This request holds the parameters needed by the the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Script.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

scriptId - The script ID of the script to be executed. To find the script ID, open the project in the script editor and select **File > Project properties**.

content - the ExecutionRequest

Since:

1.13

Method Detail

set$Xgafv

public Script.Scripts.Run set$Xgafv(String $Xgafv)

Description copied from class: ScriptRequest

V1 error format.

Overrides:

set$Xgafv in class ScriptRequest<Operation>

setAccessToken

public Script.Scripts.Run setAccessToken(String accessToken)

Description copied from class: ScriptRequest

OAuth access token.

Overrides:

setAccessToken in class ScriptRequest<Operation>

setAlt

public Script.Scripts.Run setAlt(String alt)

Description copied from class: ScriptRequest

Data format for response.

Overrides:

setAlt in class ScriptRequest<Operation>

setCallback

public Script.Scripts.Run setCallback(String callback)

Description copied from class: ScriptRequest

JSONP

Overrides:

setCallback in class ScriptRequest<Operation>

setFields

public Script.Scripts.Run setFields(String fields)

Description copied from class: ScriptRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ScriptRequest<Operation>

setKey

public Script.Scripts.Run setKey(String key)

Description copied from class: ScriptRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ScriptRequest<Operation>

setOauthToken

public Script.Scripts.Run setOauthToken(String oauthToken)

Description copied from class: ScriptRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ScriptRequest<Operation>

setPrettyPrint

public Script.Scripts.Run setPrettyPrint(Boolean prettyPrint)

Description copied from class: ScriptRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ScriptRequest<Operation>

setQuotaUser

public Script.Scripts.Run setQuotaUser(String quotaUser)

Description copied from class: ScriptRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ScriptRequest<Operation>

setUploadType

public Script.Scripts.Run setUploadType(String uploadType)

Description copied from class: ScriptRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ScriptRequest<Operation>

setUploadProtocol

public Script.Scripts.Run setUploadProtocol(String uploadProtocol)

Description copied from class: ScriptRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ScriptRequest<Operation>

getScriptId

public String getScriptId()

The script ID of the script to be executed. To find the script ID, open the project in the script editor and select **File > Project properties**.

setScriptId

public Script.Scripts.Run setScriptId(String scriptId)

The script ID of the script to be executed. To find the script ID, open the project in the script editor and select **File > Project properties**.

set

public Script.Scripts.Run set(String parameterName,
                              Object value)

Overrides:

set in class ScriptRequest<Operation>