REST Resource: processes
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: Process
Representación de la ejecución de una sola ejecución de proceso de secuencia de comandos que se inició desde el editor de secuencia de comandos, un activador, una aplicación o la API de Apps Script. Es distinto del recurso Operation
| Representación JSON |
{
"projectName": string,
"functionName": string,
"processType": enum (ProcessType),
"processStatus": enum (ProcessStatus),
"userAccessLevel": enum (UserAccessLevel),
"startTime": string,
"duration": string
} |
| Campos |
projectName |
string
Nombre de la secuencia de comandos que se ejecuta.
|
functionName |
string
Nombre de la función con la que inició la ejecución.
|
processType |
enum (ProcessType)
El tipo de ejecuciones.
|
processStatus |
enum (ProcessStatus)
El estado de las ejecuciones.
|
userAccessLevel |
enum (UserAccessLevel)
El nivel de acceso de los usuarios en ejecución a la secuencia de comandos.
|
startTime |
string (Timestamp format)
Hora en la que comenzó la ejecución. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
|
duration |
string (Duration format)
Duración que tarda la ejecución en ejecutarse. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
|
ProcessType
Es el tipo de proceso, que define cómo se inició el proceso.
| Enumeraciones |
PROCESS_TYPE_UNSPECIFIED |
Tipo no especificado |
ADD_ON |
El proceso se inició desde un punto de entrada complementario. |
EXECUTION_API |
El proceso se inició con la API de Apps Script. |
TIME_DRIVEN |
El proceso se inició a partir de un activador basado en el tiempo. |
TRIGGER |
El proceso se inició desde un activador basado en eventos. |
WEBAPP |
El proceso se inició desde un punto de entrada de app web. |
EDITOR |
El proceso se inició con el IDE de Apps Script. |
SIMPLE_TRIGGER |
El proceso se inició a partir de un activador simple de G Suite. |
BATCH_TASK |
El proceso se inició como una tarea en un trabajo por lotes. |
ProcessStatus
Es el estado del proceso.
| Enumeraciones |
PROCESS_STATUS_UNSPECIFIED |
Estado sin especificar. |
RUNNING |
El proceso se está ejecutando en este momento. |
PAUSED |
Se pausó el proceso. |
COMPLETED |
Se completó el proceso. |
CANCELED |
Se canceló el proceso. |
FAILED |
No se pudo completar el proceso. |
TIMED_OUT |
Se agotó el tiempo de espera del proceso. |
UNKNOWN |
Se desconoce el estado del proceso. |
DELAYED |
El proceso se retrasa, a la espera de la cuota. |
UserAccessLevel
Los distintos niveles de acceso de los usuarios
| Enumeraciones |
USER_ACCESS_LEVEL_UNSPECIFIED |
Nivel de acceso del usuario sin especificar |
NONE |
El usuario no tiene acceso. |
READ |
El usuario tiene acceso de solo lectura. |
WRITE |
El usuario tiene acceso de escritura. |
OWNER |
El usuario es propietario. |
Métodos |
|
|
Enumera información sobre los procesos que realiza un usuario o en su nombre, como el tipo de proceso y el estado actual. |
|
|
Muestra información sobre los procesos ejecutados de una secuencia de comandos, como el tipo de proceso y el estado actual. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003eThe \u003ccode\u003eProcess\u003c/code\u003e resource represents a single script execution initiated from various sources like the script editor, triggers, applications, or the Apps Script API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eProcess\u003c/code\u003e details include project and function names, execution type, status, user access level, start time, and duration.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eProcessType\u003c/code\u003e identifies how the process was started (e.g., add-on, API, trigger, web app).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eProcessStatus\u003c/code\u003e indicates the current state of the execution (e.g., running, paused, completed, failed).\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can programmatically list processes using methods like \u003ccode\u003elist\u003c/code\u003e and \u003ccode\u003elistScriptProcesses\u003c/code\u003e to gain insights into executions.\u003c/p\u003e\n"]]],[],null,["# REST Resource: processes\n\n- [Resource: Process](#Process)\n - [JSON representation](#Process.SCHEMA_REPRESENTATION)\n- [ProcessType](#ProcessType)\n- [ProcessStatus](#ProcessStatus)\n- [UserAccessLevel](#UserAccessLevel)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Process\n-----------------\n\nRepresentation 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`](/apps-script/api/reference/rest/v1/scripts/run#body.Operation) resource, which only represents executions started via the Apps Script API.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"projectName\": string, \"functionName\": string, \"processType\": enum (/apps-script/api/reference/rest/v1/processes#ProcessType), \"processStatus\": enum (/apps-script/api/reference/rest/v1/processes#ProcessStatus), \"userAccessLevel\": enum (/apps-script/api/reference/rest/v1/processes#UserAccessLevel), \"startTime\": string, \"duration\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `projectName` | `string` Name of the script being executed. |\n| `functionName` | `string` Name of the function the started the execution. |\n| `processType` | `enum (`[ProcessType](/apps-script/api/reference/rest/v1/processes#ProcessType)`)` The executions type. |\n| `processStatus` | `enum (`[ProcessStatus](/apps-script/api/reference/rest/v1/processes#ProcessStatus)`)` The executions status. |\n| `userAccessLevel` | `enum (`[UserAccessLevel](/apps-script/api/reference/rest/v1/processes#UserAccessLevel)`)` The executing users access level to the script. |\n| `startTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Time the execution started. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `duration` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)` format)` Duration the execution spent executing. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n\nProcessType\n-----------\n\nThe type of process, which defines how the process was started.\n\n| Enums ||\n|----------------------------|--------------------------------------------------------|\n| `PROCESS_TYPE_UNSPECIFIED` | Unspecified type. |\n| `ADD_ON` | The process was started from an add-on entry point. |\n| `EXECUTION_API` | The process was started using the Apps Script API. |\n| `TIME_DRIVEN` | The process was started from a time-based trigger. |\n| `TRIGGER` | The process was started from an event-based trigger. |\n| `WEBAPP` | The process was started from a web app entry point. |\n| `EDITOR` | The process was started using the Apps Script IDE. |\n| `SIMPLE_TRIGGER` | The process was started from a G Suite simple trigger. |\n| `MENU` | The process was started from a G Suite menu item. |\n| `BATCH_TASK` | The process was started as a task in a batch job. |\n\nProcessStatus\n-------------\n\nThe process status.\n\n| Enums ||\n|------------------------------|--------------------------------------------|\n| `PROCESS_STATUS_UNSPECIFIED` | Unspecified status. |\n| `RUNNING` | The process is currently running. |\n| `PAUSED` | The process has paused. |\n| `COMPLETED` | The process has completed. |\n| `CANCELED` | The process was cancelled. |\n| `FAILED` | The process failed. |\n| `TIMED_OUT` | The process timed out. |\n| `UNKNOWN` | Process status unknown. |\n| `DELAYED` | The process is delayed, waiting for quota. |\n\nUserAccessLevel\n---------------\n\nThe various user access levels.\n\n| Enums ||\n|---------------------------------|--------------------------------|\n| `USER_ACCESS_LEVEL_UNSPECIFIED` | User access level unspecified |\n| `NONE` | The user has no access. |\n| `READ` | The user has read-only access. |\n| `WRITE` | The user has write access. |\n| `OWNER` | The user is an owner. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|\n| ### [list](/apps-script/api/reference/rest/v1/processes/list) | List information about processes made by or on behalf of a user, such as process type and current status. |\n| ### [listScriptProcesses](/apps-script/api/reference/rest/v1/processes/listScriptProcesses) | List information about a script's executed processes, such as process type and current status. |"]]
