class Google::Apis::ScriptV1::ScriptService
Google Apps Script Execution API
An API for executing Google Apps Script projects.
@example
require 'google/apis/script_v1' Script = Google::Apis::ScriptV1 # Alias the module service = Script::ScriptService.new
@see developers.google.com/apps-script/execution/rest/v1/run
Attributes
@return [String]
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.
@return [String]
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.
Public Class Methods
# File generated/google/apis/script_v1/service.rb, line 45 def initialize super('https://script.googleapis.com/', '') end
Public Instance Methods
Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [ Authentication](#authentication) 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. @param [String] script_id
The project key of the script to be executed. To find the project key, open the project in the script editor, then select **File > Project properties**.
@param [Google::Apis::ScriptV1::ExecutionRequest] execution_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ScriptV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ScriptV1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/script_v1/service.rb, line 77 def run_script(script_id, execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/scripts/{scriptId}:run', options) command.request_representation = Google::Apis::ScriptV1::ExecutionRequest::Representation command.request_object = execution_request_object command.response_representation = Google::Apis::ScriptV1::Operation::Representation command.response_class = Google::Apis::ScriptV1::Operation command.params['scriptId'] = script_id unless script_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File generated/google/apis/script_v1/service.rb, line 91 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end