La API de Apps Script (antes conocida como API de ejecución de Apps Script) te permite ejecutar de forma remota una función en un proyecto de secuencia de comandos al que tengas acceso. Tu puede llamar a una función de Apps Script determinada y proporcionarle parámetros de entrada si necesario y recibir una respuesta devuelta.
Los ejemplos de esta página ilustran cómo algunas operaciones de ejecución comunes pueden lograrse con la API. Para obtener más información, incluidas las requisitos de autorización consulta la guía Cómo ejecutar una función.
En estos ejemplos, los marcadores de posición scriptId se usa para indicar dónde se debe proporcionar el ID del proyecto de la secuencia de comandos. Sigue el sigue estos pasos para encontrar el ID de la secuencia de comandos:
- En el proyecto de Apps Script, en la esquina superior izquierda, haz clic en Configuración del proyecto.
- Junto a "ID de la secuencia de comandos", Haz clic en Copiar.
Ejecutar una función
El siguiente comando scripts.run
llama a una función de Apps Script llamada listFolderContent y la pasa
la folderId de Drive y un número entero MAX_SIZE como argumentos. El
se ejecuta en modo de desarrollo, lo que significa que la configuración
guardar la versión de la función, independientemente de cuál sea la versión
implementado como un ejecutable.
El protocolo de solicitud se muestra a continuación. El Guía de ejecución de funciones se muestra cómo implementar una solicitud de ejecución en diferentes idiomas con la API de las bibliotecas cliente de la API.
POST https://script.googleapis.com/v1/scripts/scriptId:run
{
"function": "listFolderContent",
"parameters": [
folderId,
MAX_SIZE
],
"devMode": true
}
La respuesta a esta solicitud, cuando se complete la función llamada Apps Script, contiene los resultados de la ejecución o una respuesta de error. En este ejemplo, la función muestra correctamente un array de nombres de archivos:
{
"response": {
"result": [
"fileTitle1",
"fileTitle2",
"fileTitle3"
]
},
}
Si la función encontró un error durante la ejecución de Apps Script, la respuesta podría verse de la siguiente manera:
{
"response": {
"error": {
"code": 3,
"message": "ScriptError",
"details": [{
"@type": "type.googleapis.com/google.apps.script.v1.ExecutionError",
"errorMessage": "The script enountered an exeception it could not resolve.",
"errorType": "ScriptError",
"scriptStackTraceElements": [{
"function": "listFolderContent",
"lineNumber": 14
}]
}]
}
}
}