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