Method: processes.list

列出使用者或代表使用者執行的程序相關資訊,例如程序類型和目前狀態。

HTTP 要求

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

這個網址使用 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

這個選填欄位是用來限制傳回的程序,僅限於來自具有特定指令碼 ID 的專案。

deploymentId

string

選用欄位,限制傳回的程序僅來自具有特定部署 ID 的專案。

projectName

string

選填欄位,用來限制只傳回來自專案名稱中包含特定字串的專案傳回的程序。

functionName

string

這是選填欄位,用來限制傳回的程序只包含來自具有指定函式名稱的指令碼函式。

startTime

string (Timestamp format)

選用欄位,限制只傳回指定時間戳記當天或之後啟動的程序。

RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

endTime

string (Timestamp format)

選用欄位,限制只傳回在指定時間戳記當天或之前完成的程序。

RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

types[]

enum (ProcessType)

這個選填欄位是用來限制傳回的程序,只有具有其中一種指定程序類型的程序。

statuses[]

enum (ProcessStatus)

此為選填欄位,用來限制傳回的程序只有具有任一指定程序狀態的使用者。

userAccessLevels[]

enum (UserAccessLevel)

這是選填欄位,用途是限制系統只傳回具有指定使用者存取層級的程序。