REST Resource: processes

リソース: Process

スクリプト エディタ、トリガー、アプリケーション、または Apps Script API を使用して開始された単一のスクリプト プロセスの実行を表します。Apps Script API を介して開始された実行のみを表す Operation リソースとは異なります。

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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

duration

string (Duration format)

実行に費やされた期間。

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

ProcessType

プロセスの種類。プロセスの開始方法を定義します。

列挙型
PROCESS_TYPE_UNSPECIFIED 未指定のタイプ。
ADD_ON このプロセスはアドオンのエントリ ポイントから開始されました。
EXECUTION_API このプロセスは Apps Script API を使用して開始されました。
TIME_DRIVEN プロセスが時間ベースのトリガーから開始されました。
TRIGGER プロセスがイベントベースのトリガーから開始された。
WEBAPP このプロセスはウェブアプリのエントリ ポイントから開始されました。
EDITOR この処理は Apps Script 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 ユーザーが所有者である。

Methods

list

ユーザーによってまたはユーザーに代わって行われたプロセスに関する情報(プロセスの種類や現在のステータスなど)を一覧表示する。

listScriptProcesses

スクリプトで実行したプロセスに関する情報(プロセスのタイプや現在のステータスなど)をリストする。