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)

שדה אופציונלי שמשמש להגבלת תהליכים שהוחזרו לתהליכים שהתחילו בחותמת הזמן הנתונה או אחריה.

חותמת זמן בפורמט UTC "Zulu" של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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)

שדה אופציונלי שמשמש להגבלת התהליכים שיוחזרו לאלה שיש להם אחת מרמות הגישה של המשתמשים שצוינו.