REST Resource: processes

资源:Process

表示从脚本编辑器、触发器、应用或使用 Apps Script API 启动的单个脚本进程执行。它与 Operation 资源不同,后者仅表示通过 Apps Script API 启动的执行作业。

JSON 表示法
{
  "projectName": string,
  "functionName": string,
  "processType": enum (ProcessType),
  "processStatus": enum (ProcessStatus),
  "userAccessLevel": enum (UserAccessLevel),
  "startTime": string,
  "duration": string
}
字段
projectName

string

要执行的脚本的名称。

functionName

string

开始执行的函数的名称。

processType

enum (ProcessType)

执行类型。

processStatus

enum (ProcessStatus)

执行状态。

userAccessLevel

enum (UserAccessLevel)

执行用户对该脚本的访问权限级别。

startTime

string (Timestamp format)

开始执行的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

duration

string (Duration format)

执行所用的持续时间。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

ProcessType

进程的类型,用于定义进程的启动方式。

枚举
PROCESS_TYPE_UNSPECIFIED 未指定类型。
ADD_ON 该流程是从插件入口点启动的。
EXECUTION_API 该流程是使用 Apps Script API 启动的。
TIME_DRIVEN 该流程是从基于时间的触发器启动的。
TRIGGER 该流程是从基于事件的触发器启动的。
WEBAPP 该流程是从 Web 应用入口点启动的。
EDITOR 该过程是使用 Apps 脚本 IDE 启动的。
SIMPLE_TRIGGER 该流程是从 G Suite 简单触发器开始的。
MENU 该流程是从 G Suite 菜单项启动的。
BATCH_TASK 该过程作为批量作业中的任务启动。

ProcessStatus

进程状态。

枚举
PROCESS_STATUS_UNSPECIFIED 未指定状态。
RUNNING 该进程目前正在运行。
PAUSED 进程已暂停。
COMPLETED 此过程已完成。
CANCELED 进程已取消。
FAILED 处理失败。
TIMED_OUT 进程超时。
UNKNOWN 进程状态未知。
DELAYED 该进程延迟,正在等待配额。

UserAccessLevel

各种用户访问权限级别。

枚举
USER_ACCESS_LEVEL_UNSPECIFIED 未指定用户访问权限级别
NONE 该用户没有访问权限。
READ 该用户拥有只读权限。
WRITE 该用户拥有写入权限。
OWNER 用户是所有者。

方法

list

列出由用户或代表用户执行的进程的相关信息,例如进程类型和当前状态。

listScriptProcesses

列出有关脚本的已执行进程的信息,例如进程类型和当前状态。