Method: processes.list

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

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

endTime

string (Timestamp format)

返されるプロセスを指定されたタイムスタンプ以前に完了したプロセスに限定するために使用されるオプション フィールド。

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

types[]

enum (ProcessType)

返されるプロセスを、指定されたプロセスタイプのいずれかを持つプロセスに限定するために使用されるオプション フィールド。

statuses[]

enum (ProcessStatus)

返されるプロセスを、指定されたプロセス ステータスのいずれかを持つプロセスに限定するために使用される省略可能なフィールド。

userAccessLevels[]

enum (UserAccessLevel)

返されるプロセスを、指定したユーザー アクセスレベルのいずれかを持つプロセスに限定するために使用されるオプション フィールド。