Class ScriptsResource.RunRequest

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 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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
ScriptBaseServiceRequest<Operation>
ScriptsResource.RunRequest
Implements
Inherited Members
Namespace: Google.Apis.Script.v1
Assembly: Google.Apis.Script.v1.dll
Syntax
public class ScriptsResource.RunRequest : ScriptBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

RunRequest(IClientService, ExecutionRequest, string)

Constructs a new Run request.

Declaration
public RunRequest(IClientService service, ExecutionRequest body, string scriptId)
Parameters
Type Name Description
IClientService service
ExecutionRequest body
string scriptId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Script.v1.Data.Operation>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Script.v1.Data.Operation>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Script.v1.Data.Operation>.RestPath

ScriptId

The script ID of the script to be executed. Find the script ID on the Project settings page under "IDs." As multiple executable APIs can be deployed in new IDE for same script, this field should be populated with DeploymentID generated while deploying in new IDE instead of script ID.

Declaration
[RequestParameter("scriptId", RequestParameterType.Path)]
public virtual string ScriptId { get; }
Property Value
Type Description
string

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Script.v1.Data.Operation>.GetBody()

InitParameters()

Initializes Run parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements