generated/google/apis/script_v1/classes.rb in google-api-client-0.43.0 vs generated/google/apis/script_v1/classes.rb in google-api-client-0.44.0
- old
+ new
@@ -24,14 +24,13 @@
# The Content resource.
class Content
include Google::Apis::Core::Hashable
- # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
- # must have type of JSON, and include the manifest configurations for the
- # project.
+ # The list of script project files. One of the files is a script manifest; it
+ # must be named "appsscript", must have type of JSON, and include the manifest
+ # configurations for the project.
# Corresponds to the JSON property `files`
# @return [Array<Google::Apis::ScriptV1::File>]
attr_accessor :files
# The script project's Drive ID.
@@ -53,12 +52,12 @@
# Request to create a script project.
class CreateProjectRequest
include Google::Apis::Core::Hashable
# The Drive ID of a parent file that the created script project is bound to.
- # This is usually the ID of a Google Doc, Google Sheet, Google Form, or
- # Google Slides file. If not set, a standalone script project is created.
+ # This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google
+ # Slides file. If not set, a standalone script project is created.
# Corresponds to the JSON property `parentId`
# @return [String]
attr_accessor :parent_id
# The title for the project.
@@ -149,17 +148,15 @@
@script_id = args[:script_id] if args.key?(:script_id)
@version_number = args[:version_number] if args.key?(:version_number)
end
end
- # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- # service Foo `
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # `
- # The JSON representation for `Empty` is empty JSON object ````.
+ # A generic empty message that you can re-use to avoid defining duplicated empty
+ # messages in your APIs. A typical example is to use it as the request or the
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
+ # `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
@@ -225,28 +222,26 @@
@result = args[:result] if args.key?(:result)
end
end
# An object that provides information about the nature of an error resulting
- # from an attempted execution of a script function using the Apps Script API.
- # If a run call
- # succeeds but the script function (or Apps Script itself) throws an exception,
- # the response body's error field
- # contains a
- # Status object. The `Status` object's `details` field
- # contains an array with a single one of these `ExecutionError` objects.
+ # from an attempted execution of a script function using the Apps Script API. If
+ # a run call succeeds but the script function (or Apps Script itself) throws an
+ # exception, the response body's error field contains a Status object. The `
+ # Status` object's `details` field contains an array with a single one of these `
+ # ExecutionError` objects.
class ExecutionError
include Google::Apis::Core::Hashable
# The error message thrown by Apps Script, usually localized into the user's
# language.
# Corresponds to the JSON property `errorMessage`
# @return [String]
attr_accessor :error_message
- # The error type, for example `TypeError` or `ReferenceError`. If the error
- # type is unavailable, this field is not included.
+ # The error type, for example `TypeError` or `ReferenceError`. If the error type
+ # is unavailable, this field is not included.
# Corresponds to the JSON property `errorType`
# @return [String]
attr_accessor :error_type
# An array of objects that provide a stack trace through the script to show
@@ -266,51 +261,48 @@
@script_stack_trace_elements = args[:script_stack_trace_elements] if args.key?(:script_stack_trace_elements)
end
end
# A request to run the function in a script. The script is identified by the
- # specified `script_id`. Executing a function on a script returns results
- # based on the implementation of the script.
+ # specified `script_id`. Executing a function on a script returns results based
+ # on the implementation of the script.
class ExecutionRequest
include Google::Apis::Core::Hashable
- # If `true` and the user is an owner of the script, the script runs at the
- # most recently saved version rather than the version deployed for use with
- # the Apps Script API. Optional; default is `false`.
+ # If `true` and the user is an owner of the script, the script runs at the most
+ # recently saved version rather than the version deployed for use with the Apps
+ # Script API. Optional; default is `false`.
# Corresponds to the JSON property `devMode`
# @return [Boolean]
attr_accessor :dev_mode
alias_method :dev_mode?, :dev_mode
# The name of the function to execute in the given script. The name does not
- # include parentheses or parameters. It can reference a function in an
- # included library such as `Library.libFunction1`.
+ # include parentheses or parameters. It can reference a function in an included
+ # library such as `Library.libFunction1`.
# Corresponds to the JSON property `function`
# @return [String]
attr_accessor :function
# The parameters to be passed to the function being executed. The object type
- # for each parameter should match the expected type in Apps Script.
- # Parameters cannot be Apps Script-specific object types (such as a
- # `Document` or a `Calendar`); they can only be primitive types such as
- # `string`, `number`, `array`, `object`, or `boolean`. Optional.
+ # for each parameter should match the expected type in Apps Script. Parameters
+ # cannot be Apps Script-specific object types (such as a `Document` or a `
+ # Calendar`); they can only be primitive types such as `string`, `number`, `
+ # array`, `object`, or `boolean`. Optional.
# Corresponds to the JSON property `parameters`
# @return [Array<Object>]
attr_accessor :parameters
- # <b>Deprecated</b>. For use with Android add-ons only. An ID that represents
- # the user's current session in the Android app for Google Docs or Sheets,
- # included as extra data in the
- # [Intent](https://developer.android.com/guide/components/intents-filters.html)
- # that launches the add-on. When an Android add-on is run with a session
- # state, it gains the privileges of a
- # [bound](https://developers.google.com/apps-script/guides/bound)
- # script—that is, it can access information like the user's current
- # cursor position (in Docs) or selected cell (in Sheets). To retrieve the
- # state, call
- # `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`.
- # Optional.
+ # *Deprecated*. For use with Android add-ons only. An ID that represents the
+ # user's current session in the Android app for Google Docs or Sheets, included
+ # as extra data in the [Intent](https://developer.android.com/guide/components/
+ # intents-filters.html) that launches the add-on. When an Android add-on is run
+ # with a session state, it gains the privileges of a [bound](https://developers.
+ # google.com/apps-script/guides/bound) script—that is, it can access information
+ # like the user's current cursor position (in Docs) or selected cell (in Sheets).
+ # To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.
+ # docs.addons.SessionState")`. Optional.
# Corresponds to the JSON property `sessionState`
# @return [String]
attr_accessor :session_state
def initialize(**args)
@@ -324,22 +316,21 @@
@parameters = args[:parameters] if args.key?(:parameters)
@session_state = args[:session_state] if args.key?(:session_state)
end
end
- # An object that provides the return value of a function executed using the
- # Apps Script API. If the script function returns successfully, the response
- # body's response field contains this
- # `ExecutionResponse` object.
+ # An object that provides the return value of a function executed using the Apps
+ # Script API. If the script function returns successfully, the response body's
+ # response field contains this `ExecutionResponse` object.
class ExecutionResponse
include Google::Apis::Core::Hashable
# The return value of the script function. The type matches the object type
# returned in Apps Script. Functions called using the Apps Script API cannot
# return Apps Script-specific objects (such as a `Document` or a `Calendar`);
- # they can only return primitive types such as a `string`, `number`, `array`,
- # `object`, or `boolean`.
+ # they can only return primitive types such as a `string`, `number`, `array`, `
+ # object`, or `boolean`.
# Corresponds to the JSON property `result`
# @return [Object]
attr_accessor :result
def initialize(**args)
@@ -350,20 +341,18 @@
def update!(**args)
@result = args[:result] if args.key?(:result)
end
end
- # An individual file within a script project.
- # A file is a third-party source code created by one or more
- # developers. It can be a server-side JS code, HTML, or a
- # configuration file. Each script project can contain multiple files.
+ # An individual file within a script project. A file is a third-party source
+ # code created by one or more developers. It can be a server-side JS code, HTML,
+ # or a configuration file. Each script project can contain multiple files.
class File
include Google::Apis::Core::Hashable
- # Creation date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
+ # Creation date timestamp. This read-only field is only visible to users who
+ # have WRITER permission for the script project.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# A set of functions. No duplicates are permitted.
@@ -374,12 +363,12 @@
# A simple user profile resource.
# Corresponds to the JSON property `lastModifyUser`
# @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeUser]
attr_accessor :last_modify_user
- # The name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
+ # The name of the file. The file extension is not part of the file name, which
+ # can be identified from the type field.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The file content.
@@ -390,13 +379,12 @@
# The type of the file.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
- # Last modified date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
+ # Last modified date timestamp. This read-only field is only visible to users
+ # who have WRITER permission for the script project.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
@@ -538,14 +526,14 @@
def update!(**args)
@values = args[:values] if args.key?(:values)
end
end
- # Representation of a single script process execution that was started from
- # the script editor, a trigger, an application, or using the Apps Script API.
- # This is distinct from the `Operation`
- # resource, which only represents executions started via the Apps Script API.
+ # Representation of a single script process execution that was started from the
+ # script editor, a trigger, an application, or using the Apps Script API. This
+ # is distinct from the `Operation` resource, which only represents executions
+ # started via the Apps Script API.
class GoogleAppsScriptTypeProcess
include Google::Apis::Core::Hashable
# Duration the execution spent executing.
# Corresponds to the JSON property `duration`
@@ -692,12 +680,11 @@
# The list of deployments.
# Corresponds to the JSON property `deployments`
# @return [Array<Google::Apis::ScriptV1::Deployment>]
attr_accessor :deployments
- # The token that can be used in the next call to get the next page of
- # results.
+ # The token that can be used in the next call to get the next page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
@@ -709,12 +696,11 @@
@deployments = args[:deployments] if args.key?(:deployments)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
- # Response with the list of
- # Process resources.
+ # Response with the list of Process resources.
class ListScriptProcessesResponse
include Google::Apis::Core::Hashable
# Token for the next page of results. If empty, there are no more pages
# remaining.
@@ -736,12 +722,11 @@
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@processes = args[:processes] if args.key?(:processes)
end
end
- # Response with the list of
- # Process resources.
+ # Response with the list of Process resources.
class ListUserProcessesResponse
include Google::Apis::Core::Hashable
# Token for the next page of results. If empty, there are no more pages
# remaining.
@@ -786,12 +771,12 @@
# Response with the list of the versions for the specified script project.
class ListVersionsResponse
include Google::Apis::Core::Hashable
- # The token use to fetch the next page of records. if not exist in the
- # response, that means no more versions to list.
+ # The token use to fetch the next page of records. if not exist in the response,
+ # that means no more versions to list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of versions.
@@ -874,31 +859,23 @@
end
# A representation of an execution of an Apps Script function started with run.
# The execution response does not arrive until the function finishes executing.
# The maximum execution runtime is listed in the [Apps Script quotas guide](/
- # apps-script/guides/services/quotas#current_limitations). <p>After execution
- # has started, it can have one of four outcomes:</p> <ul> <li> If the script
- # function returns successfully, the
- # response field contains an
- # ExecutionResponse object
- # with the function's return value in the object's `result` field.</li>
- # <li> If the script function (or Apps Script itself) throws an exception, the
- # error field contains a
- # Status object. The `Status` object's `details`
- # field contains an array with a single
- # ExecutionError object that
- # provides information about the nature of the error.</li>
- # <li> If the execution has not yet completed,
- # the done field is `false` and
- # the neither the `response` nor `error` fields are present.</li>
- # <li> If the `run` call itself fails (for example, because of a
- # malformed request or an authorization error), the method returns an HTTP
- # response code in the 4XX range with a different format for the response
- # body. Client libraries automatically convert a 4XX response into an
- # exception class.</li>
- # </ul>
+ # apps-script/guides/services/quotas#current_limitations). After execution has
+ # started, it can have one of four outcomes: - If the script function returns
+ # successfully, the response field contains an ExecutionResponse object with the
+ # function's return value in the object's `result` field. - If the script
+ # function (or Apps Script itself) throws an exception, the error field contains
+ # a Status object. The `Status` object's `details` field contains an array with
+ # a single ExecutionError object that provides information about the nature of
+ # the error. - If the execution has not yet completed, the done field is `false`
+ # and the neither the `response` nor `error` fields are present. - If the `run`
+ # call itself fails (for example, because of a malformed request or an
+ # authorization error), the method returns an HTTP response code in the 4XX
+ # range with a different format for the response body. Client libraries
+ # automatically convert a 4XX response into an exception class.
class Operation
include Google::Apis::Core::Hashable
# This field indicates whether the script execution has completed. A completed
# execution has a populated `response` field containing the ExecutionResponse
@@ -950,13 +927,13 @@
# A simple user profile resource.
# Corresponds to the JSON property `lastModifyUser`
# @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeUser]
attr_accessor :last_modify_user
- # The parent's Drive ID that the script will be attached to. This is usually
- # the ID of a Google Document or Google Sheet. This filed is optional, and
- # if not set, a stand-alone script will be created.
+ # The parent's Drive ID that the script will be attached to. This is usually the
+ # ID of a Google Document or Google Sheet. This filed is optional, and if not
+ # set, a stand-alone script will be created.
# Corresponds to the JSON property `parentId`
# @return [String]
attr_accessor :parent_id
# The script project's Drive ID.
@@ -1039,13 +1016,13 @@
# throws an exception, the response body's error field contains this `Status`
# object.
class Status
include Google::Apis::Core::Hashable
- # The status code. For this API, this value either: <ul> <li> 10, indicating a `
- # SCRIPT_TIMEOUT` error,</li> <li> 3, indicating an `INVALID_ARGUMENT` error, or<
- # /li> <li> 1, indicating a `CANCELLED` execution.</li> </ul>
+ # The status code. For this API, this value either: - 10, indicating a `
+ # SCRIPT_TIMEOUT` error, - 3, indicating an `INVALID_ARGUMENT` error, or - 1,
+ # indicating a `CANCELLED` execution.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# An array that contains a single ExecutionError object that provides
@@ -1070,12 +1047,12 @@
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
- # `Struct` represents a structured data value, consisting of fields which map
- # to dynamically typed values.
+ # `Struct` represents a structured data value, consisting of fields which map to
+ # dynamically typed values.
class Struct
include Google::Apis::Core::Hashable
# Unordered map of dynamically typed values.
# Corresponds to the JSON property `fields`
@@ -1156,12 +1133,12 @@
# Represents a string value.
# Corresponds to the JSON property `stringValue`
# @return [String]
attr_accessor :string_value
- # `Struct` represents a structured data value, consisting of fields which map
- # to dynamically typed values.
+ # `Struct` represents a structured data value, consisting of fields which map to
+ # dynamically typed values.
# Corresponds to the JSON property `structValue`
# @return [Google::Apis::ScriptV1::Struct]
attr_accessor :struct_value
def initialize(**args)
@@ -1180,13 +1157,13 @@
@string_value = args[:string_value] if args.key?(:string_value)
@struct_value = args[:struct_value] if args.key?(:struct_value)
end
end
- # A resource representing a script project version. A version is a "snapshot"
- # of a script project and is similar to a read-only branched release. When
- # creating deployments, the version to use must be specified.
+ # A resource representing a script project version. A version is a "snapshot" of
+ # a script project and is similar to a read-only branched release. When creating
+ # deployments, the version to use must be specified.
class Version
include Google::Apis::Core::Hashable
# When the version was created.
# Corresponds to the JSON property `createTime`
@@ -1201,11 +1178,11 @@
# The script project's Drive ID.
# Corresponds to the JSON property `scriptId`
# @return [String]
attr_accessor :script_id
- # The incremental ID that is created by Apps Script when a version is
- # created. This is system assigned number and is immutable once created.
+ # The incremental ID that is created by Apps Script when a version is created.
+ # This is system assigned number and is immutable once created.
# Corresponds to the JSON property `versionNumber`
# @return [Fixnum]
attr_accessor :version_number
def initialize(**args)