Method: scripts.run

Ejecuta una función en un proyecto de Apps Script. El proyecto de secuencia de comandos debe implementarse para usarse con la API de Apps Script, y la aplicación que realiza la llamada debe compartir el mismo proyecto de Cloud Platform.

Este método requiere autorización con un token de OAuth 2.0 que incluya al menos uno de los permisos que se indican en la sección Autorización. Los proyectos de secuencias de comandos que no requieren autorización no se pueden ejecutar a través de esta API. Para encontrar los alcances correctos que debes incluir en el token de autenticación, abre la página Overview del proyecto de secuencia de comandos y desplázate hacia abajo hasta "Project OAuth Scopes".

El error 403, PERMISSION_DENIED: The caller does not have permission indica que el proyecto de Cloud Platform que se usó para autorizar la solicitud no es el mismo que el que usa la secuencia de comandos.

Solicitud HTTP

POST https://script.googleapis.com/v1/scripts/{deploymentId}:run

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
deploymentId

string

Es el ID de la implementación del ejecutable de la API. Busca el ID de implementación en Implementar > Administrar implementaciones en el editor de secuencias de comandos.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "function": string,
  "parameters": [
    value
  ],
  "sessionState": string,
  "devMode": boolean
}
Campos
function

string

Nombre de la función que se ejecutará en la secuencia de comandos determinada. El nombre no incluye paréntesis ni parámetros. Puede hacer referencia a una función en una biblioteca incluida, como Library.libFunction1.
parameters[]

value (Value format)

Son los parámetros que se pasarán a la función que se está ejecutando. El tipo de objeto para cada parámetro debe coincidir con el tipo esperado en Apps Script. Los parámetros no pueden ser tipos de objetos específicos de Apps Script (como un Document o un Calendar); solo pueden ser tipos primitivos, como string, number, array, object o boolean. Opcional.
sessionState

string

Obsoleto.. Solo para usarse con complementos de Android. Es un ID que representa la sesión actual del usuario en la app para Android de Documentos o Hojas de cálculo de Google, y se incluye como datos adicionales en el Intent que inicia el complemento. Cuando se ejecuta un complemento para Android con un estado de sesión, obtiene los privilegios de una secuencia de comandos vinculada, es decir, puede acceder a información como la posición actual del cursor del usuario (en Documentos) o la celda seleccionada (en Hojas de cálculo). Para recuperar el estado, llama a Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState"). Opcional.
devMode

boolean

Si true y el usuario es propietario de la secuencia de comandos, esta se ejecuta en la versión guardada más recientemente en lugar de la versión implementada para usar con la API de Apps Script. Opcional; el valor predeterminado es false.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Es una representación de la ejecución de una función de Apps Script que se inició con run. La respuesta de ejecución no llega hasta que finaliza la ejecución de la función. El tiempo de ejecución máximo se indica en la guía de cuotas de Apps Script.

Una vez que se inicia la ejecución, puede tener uno de los siguientes cuatro resultados:

  • Si la función del script se devuelve correctamente, el campo response contiene un objeto ExecutionResponse con el valor que se devuelve de la función en el campo result del objeto.
  • Si la función de secuencia de comandos (o Apps Script en sí) arroja una excepción, el campo error contiene un objeto Status. El campo details del objeto Status contiene un array con un solo objeto ExecutionError que proporciona información sobre la naturaleza del error.
  • Si la ejecución aún no se completó, el campo done es false y no están presentes los campos response ni error.
  • Si la llamada a run falla (por ejemplo, debido a una solicitud con formato incorrecto o a un error de autorización), el método devuelve un código de respuesta HTTP en el rango 4XX con un formato diferente para el cuerpo de la respuesta. Las bibliotecas cliente convierten automáticamente una respuesta 4XX en una clase de excepción.

Representación JSON 
{
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Campos
done

boolean

Este campo indica si se completó la ejecución de la secuencia de comandos. Una ejecución completada tiene un campo response propagado que contiene el ExecutionResponse de la función que se ejecutó.
Campo de unión result. El resultado de la operación, que puede ser un error o una response válida. Si done == false, no se establecen error ni response. Si done == true, se puede establecer exactamente uno de los valores error o response. Es posible que algunos servicios no proporcionen el resultado. result puede ser uno de los siguientes:
error

object (Status)

Si una llamada a run se realiza correctamente, pero la función de secuencia de comandos (o Apps Script en sí) arroja una excepción, este campo contiene un objeto Status. El campo details del objeto Status contiene un array con un solo objeto ExecutionError que proporciona información sobre la naturaleza del error.
response

object

Si la función del script se devuelve correctamente, este campo contiene un objeto ExecutionResponse con el valor que devuelve la función.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Alcances de la autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://apps-apis.google.com/a/feeds
  • https://apps-apis.google.com/a/feeds/alias/
  • https://apps-apis.google.com/a/feeds/groups/
  • https://mail.google.com/
  • https://sites.google.com/feeds
  • https://www.google.com/calendar/feeds
  • https://www.google.com/m8/feeds
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/dynamiccreatives
  • https://www.googleapis.com/auth/forms
  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/groups
  • https://www.googleapis.com/auth/script.cpanel
  • https://www.googleapis.com/auth/script.external_request
  • https://www.googleapis.com/auth/script.scriptapp
  • https://www.googleapis.com/auth/script.send_mail
  • https://www.googleapis.com/auth/script.storage
  • https://www.googleapis.com/auth/script.webapp.deploy
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/sqlservice
  • https://www.googleapis.com/auth/userinfo.email

Para obtener más información, consulta la Descripción general de OAuth 2.0.

Estado

Si una llamada a run se realiza correctamente, pero la función de la secuencia de comandos (o Apps Script en sí) arroja una excepción, el campo error del cuerpo de la respuesta contiene este objeto Status.

Representación JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

Es el código de estado. En el caso de esta API, este valor puede ser uno de los siguientes:

  • 10, que indica un error SCRIPT_TIMEOUT
  • 3, que indica un error INVALID_ARGUMENT
  • 1, que indica una ejecución de CANCELLED
message

string

Un mensaje de error dirigido al desarrollador, que está en inglés. Cualquier mensaje de error dirigido al usuario se localiza y se envía al campo details, o el cliente lo localiza.
details[]

object

Es un array que contiene un solo objeto ExecutionError que proporciona información sobre la naturaleza del error.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.