REST Resource: processes
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: תהליך
ייצוג של הפעלה של תהליך סקריפט אחד שהתחילה מעורך הסקריפטים, מטריגר, מאפליקציה או באמצעות Apps Script API. המשאב הזה שונה מהמשאב Operation
| ייצוג JSON |
{
"projectName": string,
"functionName": string,
"processType": enum (ProcessType),
"processStatus": enum (ProcessStatus),
"userAccessLevel": enum (UserAccessLevel),
"startTime": string,
"duration": string
} |
| שדות |
projectName |
string
שם הסקריפט שמופעל.
|
functionName |
string
שם הפונקציה שבה התחילה ההרצה.
|
processType |
enum (ProcessType)
סוג ההפעלות.
|
processStatus |
enum (ProcessStatus)
סטטוס ההפעלות.
|
userAccessLevel |
enum (UserAccessLevel)
רמת הגישה של המשתמשים שמפעילים את הסקריפט.
|
startTime |
string (Timestamp format)
השעה שבה הביצוע התחיל. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
|
duration |
string (Duration format)
משך הביצוע שנדרש. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".
|
ProcessType
סוג התהליך, שמגדיר איך התחיל התהליך.
| טיפוסים בני מנייה (enum) |
PROCESS_TYPE_UNSPECIFIED |
הסוג לא צוין. |
ADD_ON |
התהליך התחיל בנקודת כניסה של תוסף. |
EXECUTION_API |
התהליך התחיל באמצעות Apps Script API. |
TIME_DRIVEN |
התהליך התחיל בטריגר שמבוסס על זמן. |
TRIGGER |
התהליך התחיל בטריגר שמבוסס על אירועים. |
WEBAPP |
התהליך התחיל בנקודת כניסה לאפליקציית האינטרנט. |
EDITOR |
התהליך התחיל בסביבת הפיתוח המשולבת של Apps Script. |
SIMPLE_TRIGGER |
התהליך התחיל מטריגר פשוט ב-G Suite. |
BATCH_TASK |
התהליך התחיל כמשימה במשימה באצווה. |
ProcessStatus
| טיפוסים בני מנייה (enum) |
PROCESS_STATUS_UNSPECIFIED |
הסטטוס לא צוין. |
RUNNING |
התהליך פועל כרגע. |
PAUSED |
התהליך הושהה. |
COMPLETED |
התהליך הושלם. |
CANCELED |
התהליך בוטל. |
FAILED |
התהליך נכשל. |
TIMED_OUT |
פג הזמן הקצוב של התהליך. |
UNKNOWN |
סטטוס התהליך לא ידוע. |
DELAYED |
התהליך מתעכב, בהמתנה למכסה. |
UserAccessLevel
רמות הגישה השונות של המשתמשים.
| טיפוסים בני מנייה (enum) |
USER_ACCESS_LEVEL_UNSPECIFIED |
לא צוינה רמת גישה של משתמש |
NONE |
למשתמש אין גישה. |
READ |
למשתמש יש הרשאת קריאה בלבד. |
WRITE |
למשתמש יש גישת כתיבה. |
OWNER |
המשתמש הוא בעלים. |
שיטות |
|
|
הצגת רשימה של תהליכים שבוצעו על ידי משתמש או מטעמו, כמו סוג התהליך והסטטוס הנוכחי. |
|
|
הצגת רשימה של תהליכי הפעלה של סקריפט, כמו סוג התהליך והסטטוס הנוכחי. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
