Method: processes.list

הצגת רשימה של תהליכים שבוצעו על ידי משתמש או מטעמו, כמו סוג התהליך והסטטוס הנוכחי.

בקשת HTTP

GET https://script.googleapis.com/v1/processes

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של שאילתה

פרמטרים
userProcessFilter

object (ListUserProcessesFilter)

מסנן שמשמש להגבלת תוצאות הרשימה. יוחזרו רק תהליכים שתואמים לקריטריוני הסינון.

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.

ListUserProcessesFilter

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

ייצוג JSON
{
  "scriptId": string,
  "deploymentId": string,
  "projectName": string,
  "functionName": string,
  "startTime": string,
  "endTime": string,
  "types": [
    enum (ProcessType)
  ],
  "statuses": [
    enum (ProcessStatus)
  ],
  "userAccessLevels": [
    enum (UserAccessLevel)
  ]
}
שדות
scriptId

string

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

deploymentId

string

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

projectName

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)

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