Method: processes.listScriptProcesses
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
اطلاعات مربوط به فرآیندهای اجرا شده یک اسکریپت، مانند نوع فرآیند و وضعیت فعلی را فهرست کنید.
درخواست HTTP
GET https://script.googleapis.com/v1/processes:listScriptProcesses
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
scriptId | string شناسه اسکریپت پروژه که فرآیندهای آن فهرست شده است. |
scriptProcessFilter | object ( ListScriptProcessesFilter ) فیلتری که برای محدود کردن نتایج لیست استفاده می شود. فقط فرآیندهای مطابق با معیارهای فیلتر بازگردانده می شوند. |
pageSize | integer حداکثر تعداد فرآیندهای برگشتی در هر صفحه از نتایج. پیش فرض 50 است. |
pageToken | string نشانه برای ادامه درخواست لیست قبلی در صفحه بعد. این باید روی مقدار nextPageToken از پاسخ قبلی تنظیم شود. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
پاسخ با لیست منابع Process .
| نمایندگی JSON |
|---|
{
"processes": [
{
object (Process)
}
],
"nextPageToken": string
} |
| فیلدها |
|---|
processes[] | object ( Process ) فهرست فرآیندهایی که با پارامترهای درخواست مطابقت دارند. |
nextPageToken | string نشانه برای صفحه بعدی نتایج. اگر خالی باشد، صفحه دیگری باقی نمانده است. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/script.processes
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
ListScriptProcessesFilter
از فیلتر برای تعیین بیشتر فرآیندهای فهرست استفاده می شود. فقط فرآیندهایی که با تمام شرایط مشخص شده مطابقت دارند بازگردانده می شوند.
| نمایندگی JSON |
|---|
{
"deploymentId": string,
"functionName": string,
"startTime": string,
"endTime": string,
"types": [
enum (ProcessType)
],
"statuses": [
enum (ProcessStatus)
],
"userAccessLevels": [
enum (UserAccessLevel)
]
} |
| فیلدها |
|---|
deploymentId | string فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به فرآیندهایی که از پروژه‌هایی با شناسه استقرار خاص نشات می‌گیرند استفاده می‌شود. |
functionName | string فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به آنهایی که از یک تابع اسکریپت با نام تابع داده شده منشأ می گیرند، استفاده می شود. |
startTime | string ( Timestamp format) فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به مواردی که در یا بعد از مهر زمانی مشخص شروع شده‌اند استفاده می‌شود. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" . |
endTime | string ( Timestamp format) فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به مواردی که در یا قبل از مهر زمانی داده شده تکمیل شده اند استفاده می شود. یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" . |
types[] | enum ( ProcessType ) فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به آنهایی که یکی از انواع فرآیند مشخص شده را دارند استفاده می شود. |
statuses[] | enum ( ProcessStatus ) فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به آنهایی که یکی از وضعیت‌های فرآیند مشخص شده را دارند، استفاده می‌شود. |
userAccessLevels[] | enum ( UserAccessLevel ) فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به مواردی که یکی از سطوح دسترسی کاربر مشخص شده را دارند، استفاده می‌شود. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eLists information on script-executed processes, including process type and status, using the \u003ccode\u003eprocesses:listScriptProcesses\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of listed processes based on criteria like deployment ID, function name, timestamps, process types, statuses, and user access levels.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/script.processes\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns a paginated list of \u003ccode\u003eProcess\u003c/code\u003e resources with details of each process and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eEmploys a \u003ccode\u003eGET\u003c/code\u003e request to the \u003ccode\u003ehttps://script.googleapis.com/v1/processes:listScriptProcesses\u003c/code\u003e endpoint with optional query parameters for filtering and pagination.\u003c/p\u003e\n"]]],[],null,["# Method: processes.listScriptProcesses\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListScriptProcessesResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [ListScriptProcessesFilter](#ListScriptProcessesFilter)\n - [JSON representation](#ListScriptProcessesFilter.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nList information about a script's executed processes, such as process type and current status.\n\n### HTTP request\n\n`GET https://script.googleapis.com/v1/processes:listScriptProcesses`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `scriptId` | `string` The script ID of the project whose processes are listed. |\n| `scriptProcessFilter` | `object (`[ListScriptProcessesFilter](/apps-script/api/reference/rest/v1/processes/listScriptProcesses#ListScriptProcessesFilter)`)` A filter used to limit the list results; only processes matching the filter criteria are returned. |\n| `pageSize` | `integer` The maximum number of returned processes per page of results. Defaults to 50. |\n| `pageToken` | `string` The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse with the list of [Process](/apps-script/api/reference/rest/v1/processes#Process) resources.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"processes\": [ { object (/apps-script/api/reference/rest/v1/processes#Process) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `processes[]` | `object (`[Process](/apps-script/api/reference/rest/v1/processes#Process)`)` List of processes matching request parameters. |\n| `nextPageToken` | `string` Token for the next page of results. If empty, there are no more pages remaining. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/script.processes`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nListScriptProcessesFilter\n-------------------------\n\nFilter used to further specify which processes to list. Only processes that match all the specified conditions are returned.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deploymentId\": string, \"functionName\": string, \"startTime\": string, \"endTime\": string, \"types\": [ enum (/apps-script/api/reference/rest/v1/processes#ProcessType) ], \"statuses\": [ enum (/apps-script/api/reference/rest/v1/processes#ProcessStatus) ], \"userAccessLevels\": [ enum (/apps-script/api/reference/rest/v1/processes#UserAccessLevel) ] } ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deploymentId` | `string` Optional field used to limit returned processes to those originating from projects with a specific deployment ID. |\n| `functionName` | `string` Optional field used to limit returned processes to those originating from a script function with the given function name. |\n| `startTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Optional field used to limit returned processes to those that were started on or after the given timestamp. 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| `endTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Optional field used to limit returned processes to those that completed on or before the given timestamp. 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| `types[]` | `enum (`[ProcessType](/apps-script/api/reference/rest/v1/processes#ProcessType)`)` Optional field used to limit returned processes to those having one of the specified process types. |\n| `statuses[]` | `enum (`[ProcessStatus](/apps-script/api/reference/rest/v1/processes#ProcessStatus)`)` Optional field used to limit returned processes to those having one of the specified process statuses. |\n| `userAccessLevels[]` | `enum (`[UserAccessLevel](/apps-script/api/reference/rest/v1/processes#UserAccessLevel)`)` Optional field used to limit returned processes to those having one of the specified user access levels. |"]]
