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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

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

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

types[]

enum (ProcessType)

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

statuses[]

enum (ProcessStatus)

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

userAccessLevels[]

enum (UserAccessLevel)

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