Method: processes.list

List information about processes made by or on behalf of a user, such as process type and current status.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
userProcessFilter

object ( ListUserProcessesFilter )

A filter used to limit the list results; only processes matching the filter criteria are returned.
pageSize

integer

The maximum number of returned processes per page of results. Defaults to 50.
pageToken

string

The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response with the list of Process resources.

JSON representation 
 { 
 "processes" 
 : 
 [ 
 { 
 object (  Process 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
Fields
processes[]

object ( Process )

List of processes matching request parameters.
nextPageToken

string

Token for the next page of results. If empty, there are no more pages remaining.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/script.processes

For more information, see the OAuth 2.0 Overview .

ListUserProcessesFilter

Filter used to further specify which processes to list. Only processes that match all the specified conditions are returned.

JSON representation 
 { 
 "scriptId" 
 : 
 string 
 , 
 "deploymentId" 
 : 
 string 
 , 
 "projectName" 
 : 
 string 
 , 
 "functionName" 
 : 
 string 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 , 
 "types" 
 : 
 [ 
 enum (  ProcessType 
 
) 
 ] 
 , 
 "statuses" 
 : 
 [ 
 enum (  ProcessStatus 
 
) 
 ] 
 , 
 "userAccessLevels" 
 : 
 [ 
 enum (  UserAccessLevel 
 
) 
 ] 
 }
Fields
scriptId

string

Optional field used to limit returned processes to those originating from projects with a specific script ID.
deploymentId

string

Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
projectName

string

Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
functionName

string

Optional field used to limit returned processes to those originating from a script function with the given function name.
startTime

string ( Timestamp format)

Optional field used to limit returned processes to those that were started on or after the given timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
endTime

string ( Timestamp format)

Optional field used to limit returned processes to those that completed on or before the given timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
types[]

enum ( ProcessType )

Optional field used to limit returned processes to those having one of the specified process types.
statuses[]

enum ( ProcessStatus )

Optional field used to limit returned processes to those having one of the specified process statuses.
userAccessLevels[]

enum ( UserAccessLevel )

Optional field used to limit returned processes to those having one of the specified user access levels.