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.

סינון רשימת משתמשים

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

ייצוג 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)

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

חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z"
endTime

string (Timestamp format)

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

חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z"
types[]

enum (ProcessType)

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

enum (ProcessStatus)

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

enum (UserAccessLevel)

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