REST Resource: processes
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: Process
Représentation d'une seule exécution de processus de script qui a été lancée à partir de l'éditeur de script, d'un déclencheur, d'une application ou de l'API Apps Script. Elle est différente de la ressource Operation
, qui ne représente que les exécutions démarrées via l'API Apps Script.
Représentation JSON |
{
"projectName": string,
"functionName": string,
"processType": enum (ProcessType ),
"processStatus": enum (ProcessStatus ),
"userAccessLevel": enum (UserAccessLevel ),
"startTime": string,
"duration": string
} |
Champs |
projectName |
string
Nom du script en cours d'exécution.
|
functionName |
string
Nom de la fonction à partir de laquelle l'exécution a démarré.
|
processType |
enum (ProcessType )
Type d'exécutions.
|
processStatus |
enum (ProcessStatus )
État des exécutions.
|
userAccessLevel |
enum (UserAccessLevel )
Niveau d'accès au script des utilisateurs en cours d'exécution.
|
startTime |
string (Timestamp format)
Heure à laquelle l'exécution a démarré. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .
|
duration |
string (Duration format)
Durée d'exécution de l'exécution. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s ". Exemple : "3.5s"
|
ProcessType
Type de processus, qui définit la façon dont le processus a été lancé.
Enums |
PROCESS_TYPE_UNSPECIFIED |
Type non spécifié. |
ADD_ON |
Le processus a été lancé à partir d'un point d'entrée du module complémentaire. |
EXECUTION_API |
Le processus a été lancé à l'aide de l'API Apps Script. |
TIME_DRIVEN |
Le processus a été lancé à partir d'un déclencheur temporel. |
TRIGGER |
Le processus a été lancé à partir d'un déclencheur basé sur des événements. |
WEBAPP |
Le processus a été lancé à partir d'un point d'entrée d'application Web. |
EDITOR |
Le processus a été lancé à l'aide de l'IDE Apps Script. |
SIMPLE_TRIGGER |
Le processus a été lancé à partir d'un déclencheur simple G Suite. |
BATCH_TASK |
Le processus a été démarré en tant que tâche dans un job par lot. |
ProcessStatus
Enums |
PROCESS_STATUS_UNSPECIFIED |
État non spécifié. |
RUNNING |
Le processus est en cours d'exécution. |
PAUSED |
Le processus a été suspendu. |
COMPLETED |
Le processus est terminé. |
CANCELED |
Le processus a été annulé. |
FAILED |
Échec du processus. |
TIMED_OUT |
Le processus a expiré. |
UNKNOWN |
État du processus inconnu. |
DELAYED |
Le processus est retardé, en attente de quota. |
UserAccessLevel
Les différents niveaux d'accès des utilisateurs
Enums |
USER_ACCESS_LEVEL_UNSPECIFIED |
Niveau d'accès des utilisateurs non spécifié |
NONE |
L'utilisateur n'a aucun accès. |
READ |
L'utilisateur dispose d'un accès en lecture seule. |
WRITE |
L'utilisateur dispose d'un accès en écriture. |
OWNER |
L'utilisateur est un propriétaire. |
Méthodes |
|
Répertorier des informations sur les processus créés par ou au nom d'un utilisateur, telles que le type de processus et l'état actuel. |
|
Lister les informations sur les processus exécutés d'un script, telles que le type de processus et l'état actuel. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]