Script.Scripts.Run (Apps Script API v1 (Rev. 334) 1.24.1)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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(java.lang.String scriptId, ExecutionRequest content)
Runs a function in an Apps Script project.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getScriptId()` The script ID of the script to be executed.
`Script.Scripts.Run`	`set(java.lang.String parameterName, java.lang.Object value)`
`Script.Scripts.Run`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Script.Scripts.Run`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Script.Scripts.Run`	`setAlt(java.lang.String alt)` Data format for response.
`Script.Scripts.Run`	`setCallback(java.lang.String callback)` JSONP
`Script.Scripts.Run`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Script.Scripts.Run`	`setKey(java.lang.String key)` API key.
`Script.Scripts.Run`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Script.Scripts.Run`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Script.Scripts.Run`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Script.Scripts.Run`	`setScriptId(java.lang.String scriptId)` The script ID of the script to be executed.
`Script.Scripts.Run`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Script.Scripts.Run`	`setUploadType(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.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(java.lang.String $Xgafv)
```
    Description copied from class: ScriptRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ScriptRequest<Operation>
  - setAccessToken
```
public Script.Scripts.Run setAccessToken(java.lang.String accessToken)
```
    Description copied from class: ScriptRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ScriptRequest<Operation>
  - setAlt
```
public Script.Scripts.Run setAlt(java.lang.String alt)
```
    Description copied from class: ScriptRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ScriptRequest<Operation>
  - setCallback
```
public Script.Scripts.Run setCallback(java.lang.String callback)
```
    Description copied from class: ScriptRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ScriptRequest<Operation>
  - setFields
```
public Script.Scripts.Run setFields(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String uploadProtocol)
```
    Description copied from class: ScriptRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ScriptRequest<Operation>
  - getScriptId
```
public java.lang.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(java.lang.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(java.lang.String parameterName,
                              java.lang.Object value)
```
    Overrides:
    
    set in class ScriptRequest<Operation>

Apps Script API v1 (revision 334)

Class Script.Scripts.Run

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Run

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getScriptId

setScriptId

set