Class: Google::Apis::ScriptV1::ScriptService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/script_v1/service.rb

Overview

Google Apps Script Execution API

Executes Google Apps Script projects.

Examples:

require 'google/apis/script_v1'

Script = Google::Apis::ScriptV1 # Alias the module
service = Script::ScriptService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ ScriptService

Returns a new instance of ScriptService.



45
46
47
 
# File 'generated/google/apis/script_v1/service.rb', line 45

def initialize
  super('https://script.googleapis.com/', '')
end

Instance Attribute Details

#key ⇒ String

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

Returns:

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



38
39
40
 
# File 'generated/google/apis/script_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

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

Returns:

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



43
44
45
 
# File 'generated/google/apis/script_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#run_script(script_id, execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ScriptV1::Operation

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

Parameters:

  • script_id (String) —

    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.

  • execution_request_object (Google::Apis::ScriptV1::ExecutionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



77
78
79
80
81
82
83
84
85
86
87
 
# 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