- בקשת HTTP
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- ListScriptProcessesFilter
- רוצים לנסות?
הצגת רשימה של תהליכי הפעלה של סקריפט, כמו סוג התהליך והסטטוס הנוכחי.
בקשת HTTP
GET https://script.googleapis.com/v1/processes:listScriptProcesses
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
scriptId |
מזהה הסקריפט של הפרויקט שהתהליכים שלו מפורטים. |
scriptProcessFilter |
מסנן שמשמש להגבלת תוצאות הרשימה. יוחזרו רק תהליכים שתואמים לקריטריוני הסינון. |
pageSize |
המספר המקסימלי של תהליכים שהוחזרו לכל דף תוצאות. ברירת המחדל היא 50. |
pageToken |
האסימון להמשך בקשת רשימה קודמת בדף הבא. צריך להגדיר אותו לערך של |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
תשובה עם רשימת המשאבים של Process.
| ייצוג JSON |
|---|
{
"processes": [
{
object ( |
| שדות | |
|---|---|
processes[] |
רשימת תהליכים שתואמים לפרמטרים של בקשה. |
nextPageToken |
אסימון לדף התוצאות הבא. אם השדה ריק, לא נותרו דפים נוספים. |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/script.processes
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
ListScriptProcessesFilter
סינון משמש כדי לציין עוד יותר אילו תהליכים להציג ברשימה. מוחזרים רק תהליכים שתואמים לכל התנאים שצוינו.
| ייצוג JSON |
|---|
{ "deploymentId": string, "functionName": string, "startTime": string, "endTime": string, "types": [ enum ( |
| שדות | |
|---|---|
deploymentId |
שדה אופציונלי שמשמש להגבלת תהליכים שהוחזרו לתהליכים שמקורם בפרויקטים עם מזהה פריסה ספציפי. |
functionName |
שדה אופציונלי שמשמש להגבלת התהליכים שהוחזרו לתהליכים שמקורם בפונקציית סקריפט עם שם הפונקציה הנתון. |
startTime |
שדה אופציונלי שמשמש להגבלת תהליכים שהוחזרו לתהליכים שהתחילו בחותמת הזמן הנתונה או אחריה. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
endTime |
שדה אופציונלי שמשמש להגבלת תהליכים שהוחזרו לתהליכים שהסתיימו בחותמת הזמן הנתונה או לפניה. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
types[] |
שדה אופציונלי שמשמש להגבלת התהליכים המוחזרים לאלה שיש להם אחד מסוגי התהליכים שצוינו. |
statuses[] |
שדה אופציונלי שמשמש להגבלת תהליכים שהוחזרו למשתמשים עם אחד מהסטטוסים של התהליכים שצוינו. |
userAccessLevels[] |
שדה אופציונלי שמשמש להגבלת התהליכים שהוחזרו למשתמשים עם אחת מרמות הגישה שצוינו. |