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 世界协调时间 (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)

可选字段，用于将返回的进程限制为具有指定用户访问权限级别之一的进程。