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)

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