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 總覽

列出使用者程序篩選器

使用篩選器進一步列出要列出的程序。系統只會傳回符合所有指定條件的條件。

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 UTC 的「Zulu」格式時間戳記,單位為奈秒解析度,最多可達九位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

endTime

string (Timestamp format)

選填欄位,用於將傳回的程序限制在特定時間戳記之前或之前完成的程序。

RFC3339 UTC 的「Zulu」格式時間戳記,單位為奈秒解析度,最多可達九位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

types[]

enum (ProcessType)

選填欄位,用於將傳回的程序限制為其中一種指定程序類型的程序。

statuses[]

enum (ProcessStatus)

選用的欄位可用於將傳回的程序限制為符合任何指定程序狀態的程序,

userAccessLevels[]

enum (UserAccessLevel)

選填欄位,用於將傳回的程序限制為具備其中一個指定使用者存取層級的程序。