Method: processes.listScriptProcesses
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הצגת רשימה של תהליכי הפעלה של סקריפט, כמו סוג התהליך והסטטוס הנוכחי.
בקשת HTTP
GET https://script.googleapis.com/v1/processes:listScriptProcesses
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
| פרמטרים |
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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\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. |"]]
