Autogenerated update (2017-11-01)
Delete: - playmoviespartner_v1 Update: - adexchangebuyer2_v2beta1 - androidenterprise_v1 - androidpublisher_v2 - bigquerydatatransfer_v1 - classroom_v1 - cloudbuild_v1 - datastore_v1beta3 - drive_v2 - logging_v2 - script_v1 - storage_v1 - videointelligence_v1beta1
This commit is contained in:
Google APIs committed
1 parent
c52f7d34f6
commit
02864e27db
36 files changed
+769
-1951
No files matched your search
@@ -22,12 +22,14 @@ module Google
|
||||
module Apis
|
||||
module ScriptV1
|
||||
|
||||
# An object that provides information about the nature of an error in the Apps
|
||||
# Script Execution API. If an
|
||||
# `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
|
||||
# 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 or
|
||||
# runAsync 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
|
||||
@@ -70,7 +72,7 @@ module Google
|
||||
|
||||
# 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 Execution API. Optional; default is `false`.
|
||||
# the Apps Script API. Optional; default is `false`.
|
||||
# Corresponds to the JSON property `devMode`
|
||||
# @return [Boolean]
|
||||
attr_accessor :dev_mode
|
||||
@@ -93,12 +95,13 @@ module Google
|
||||
|
||||
# For 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)
|
||||
# [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
|
||||
# [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`
|
||||
@@ -118,17 +121,15 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# An object that provides the return value of a function executed through the
|
||||
# Apps Script Execution API. If a
|
||||
# `run` call succeeds and the
|
||||
# script function returns successfully, the response body's
|
||||
# `response` field contains this
|
||||
# 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 through the Execution API cannot
|
||||
# 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`.
|
||||
@@ -146,47 +147,52 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# The response will not arrive until the function finishes executing. The
|
||||
# maximum runtime is listed in the guide to [limitations in Apps Script](https://
|
||||
# developers.google.com/apps-script/guides/services/quotas#current_limitations).
|
||||
# <p>If the script function returns successfully, the `response` field will
|
||||
# contain an `ExecutionResponse` object with the function's return value in the
|
||||
# object's `result` field.</p>
|
||||
# <p>If the script function (or Apps Script itself) throws an exception, the `
|
||||
# error` field will contain a `Status` object. The `Status` object's `details`
|
||||
# field will contain an array with a single `ExecutionError` object that
|
||||
# provides information about the nature of the error.</p>
|
||||
# <p>If the `run` call itself fails (for example, because of a malformed request
|
||||
# or an authorization error), the method will return an HTTP response code in
|
||||
# the 4XX range with a different format for the response body. Client libraries
|
||||
# will automatically convert a 4XX response into an exception class.</p>
|
||||
# A representation of a execution of an Apps Script function that is started
|
||||
# using run or runAsync. 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 the execution is 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 was asynchronous and has not yet completed,
|
||||
# the done field is `false` and
|
||||
# the neither the `response` nor `error` fields are present.</li>
|
||||
# <li> If the `run` or `runAsync` 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>
|
||||
class Operation
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# This field is only used with asynchronous executions and indicates whether or
|
||||
# not the script execution has completed. A completed execution has a populated
|
||||
# response field containing the `ExecutionResponse` from function that was
|
||||
# This field is only used with asynchronous executions. It indicates whether the
|
||||
# script execution has completed. A completed execution has a populated `
|
||||
# response` field containing the ExecutionResponse from function that was
|
||||
# executed.
|
||||
# Corresponds to the JSON property `done`
|
||||
# @return [Boolean]
|
||||
attr_accessor :done
|
||||
alias_method :done?, :done
|
||||
|
||||
# If a `run` call succeeds but the script function (or Apps Script itself)
|
||||
# throws an exception, the response body's `error` field will contain this `
|
||||
# If a `run` or `runAsync` call succeeds but the script function (or Apps Script
|
||||
# itself) throws an exception, the response body's error field contains this `
|
||||
# Status` object.
|
||||
# Corresponds to the JSON property `error`
|
||||
# @return [Google::Apis::ScriptV1::Status]
|
||||
attr_accessor :error
|
||||
|
||||
# This field is not used.
|
||||
# Corresponds to the JSON property `metadata`
|
||||
# @return [Hash<String,Object>]
|
||||
attr_accessor :metadata
|
||||
|
||||
# If the script function returns successfully, this field will contain an `
|
||||
# ExecutionResponse` object with the function's return value as the object's `
|
||||
# result` field.
|
||||
# If the script function returns successfully, this field contains an
|
||||
# ExecutionResponse object with the function's return value.
|
||||
# Corresponds to the JSON property `response`
|
||||
# @return [Hash<String,Object>]
|
||||
attr_accessor :response
|
||||
@@ -199,7 +205,6 @@ module Google
|
||||
def update!(**args)
|
||||
@done = args[:done] if args.key?(:done)
|
||||
@error = args[:error] if args.key?(:error)
|
||||
@metadata = args[:metadata] if args.key?(:metadata)
|
||||
@response = args[:response] if args.key?(:response)
|
||||
end
|
||||
end
|
||||
@@ -229,26 +234,27 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# If a `run` call succeeds but the script function (or Apps Script itself)
|
||||
# throws an exception, the response body's `error` field will contain this `
|
||||
# If a `run` or `runAsync` call succeeds but the script function (or Apps Script
|
||||
# itself) 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 will always be 3, corresponding to
|
||||
# an <code>INVALID_ARGUMENT</code> error.
|
||||
# The status code. For this API, this value either:
|
||||
# <ul> <li> 3, indicating an `INVALID_ARGUMENT` error, or</li> <li> 1,
|
||||
# indicating a `CANCELLED` asynchronous execution.</li> </ul>
|
||||
# Corresponds to the JSON property `code`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :code
|
||||
|
||||
# An array that contains a single `ExecutionError` object that provides
|
||||
# An array that contains a single ExecutionError object that provides
|
||||
# information about the nature of the error.
|
||||
# Corresponds to the JSON property `details`
|
||||
# @return [Array<Hash<String,Object>>]
|
||||
attr_accessor :details
|
||||
|
||||
# A developer-facing error message, which is in English. Any user-facing error
|
||||
# message is localized and sent in the [`google.rpc.Status.details`](google.rpc.
|
||||
# message is localized and sent in the [google.rpc.Status.details](google.rpc.
|
||||
# Status.details) field, or localized by the client.
|
||||
# Corresponds to the JSON property `message`
|
||||
# @return [String]
|
||||
|
||||
@@ -91,7 +91,6 @@ module Google
|
||||
property :done, as: 'done'
|
||||
property :error, as: 'error', class: Google::Apis::ScriptV1::Status, decorator: Google::Apis::ScriptV1::Status::Representation
|
||||
|
||||
hash :metadata, as: 'metadata'
|
||||
hash :response, as: 'response'
|
||||
end
|
||||
end
|
||||
|
||||
@@ -20,7 +20,7 @@ require 'google/apis/errors'
|
||||
module Google
|
||||
module Apis
|
||||
module ScriptV1
|
||||
# Google Apps Script Execution API
|
||||
# Google Apps Script API
|
||||
#
|
||||
# An API for managing and executing Google Apps Script projects.
|
||||
#
|
||||
@@ -48,7 +48,7 @@ module Google
|
||||
end
|
||||
|
||||
# Runs a function in an Apps Script project. The project must be deployed
|
||||
# for use with the Apps Script Execution API.
|
||||
# for use with the Apps Script API.
|
||||
# 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
|
||||
|
||||
Reference in new issue
Block a user