Method: processes.list

プロセスの種類や現在のステータスなど、ユーザーによって、またはユーザーに代わって作成されたプロセスに関する情報をリストします。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
userProcessFilter

object (ListUserProcessesFilter)

リスト結果を制限するために使用するフィルタ。フィルタ条件に一致するプロセスのみが返されます。

pageSize

integer

結果のページあたりに返されるプロセスの最大数。デフォルトは 50 です。

pageToken

string

次のページで前の list リクエストを続行するためのトークン。これは、前のレスポンスの 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)

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