REST Resource: processes
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
منبع: فرآیند
نمایش اجرای یک فرآیند اسکریپت واحد که از ویرایشگر اسکریپت، یک راهانداز، یک برنامه کاربردی یا با استفاده از Apps Script API شروع شده است. این با منبع Operation
متمایز است، که فقط اجرای اجرا شده از طریق Apps Script API را نشان می دهد.
نمایندگی 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" . |
نوع فرآیند
نوع فرآیند که نحوه شروع فرآیند را مشخص می کند.
Enums |
---|
PROCESS_TYPE_UNSPECIFIED | نوع نامشخص |
ADD_ON | این فرآیند از یک نقطه ورودی افزودنی آغاز شد. |
EXECUTION_API | این فرآیند با استفاده از Apps Script API آغاز شد. |
TIME_DRIVEN | این فرآیند از یک ماشه مبتنی بر زمان آغاز شد. |
TRIGGER | این فرآیند از یک محرک مبتنی بر رویداد آغاز شد. |
WEBAPP | این فرآیند از یک نقطه ورود برنامه وب آغاز شد. |
EDITOR | فرآیند با استفاده از Apps Script IDE آغاز شد. |
SIMPLE_TRIGGER | این فرآیند از یک راهانداز ساده G Suite آغاز شد. |
BATCH_TASK | این فرآیند به عنوان یک کار در یک کار دسته ای آغاز شد. |
وضعیت فرآیند
Enums |
---|
PROCESS_STATUS_UNSPECIFIED | وضعیت نامشخص |
RUNNING | این فرآیند در حال حاضر در حال اجرا است. |
PAUSED | روند متوقف شده است. |
COMPLETED | فرآیند تکمیل شده است. |
CANCELED | روند لغو شد. |
FAILED | روند شکست خورد. |
TIMED_OUT | زمان پروسه تمام شد. |
UNKNOWN | وضعیت فرآیند نامشخص است. |
DELAYED | روند به تعویق افتاد، منتظر سهمیه است. |
UserAccess Level
Enums |
---|
USER_ACCESS_LEVEL_UNSPECIFIED | سطح دسترسی کاربر مشخص نشده است |
NONE | کاربر دسترسی ندارد. |
READ | کاربر دسترسی فقط خواندنی دارد. |
WRITE | کاربر دسترسی نوشتن دارد. |
OWNER | کاربر مالک است. |
روش ها |
---|
| اطلاعات مربوط به فرآیندهای انجام شده توسط یا از طرف یک کاربر، مانند نوع فرآیند و وضعیت فعلی را فهرست کنید. |
| اطلاعات مربوط به فرآیندهای اجرا شده یک اسکریپت، مانند نوع فرآیند و وضعیت فعلی را فهرست کنید. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]