List Script Processes
|
|||||
|
|
||||
List information about a script's executed processes, such as process type and current status
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View Google Apps Script processes
Input
This building block consumes 10 input parameters
| Name | Format | Description |
|---|---|---|
scriptProcessFilter.statuses |
ENUMERATION |
Optional field used to limit returned processes to those having one of the specified process statuses |
scriptProcessFilter.functionName |
STRING |
Optional field used to limit returned processes to those originating from a script function with the given function name |
scriptProcessFilter.startTime |
ANY |
Optional field used to limit returned processes to those that were started on or after the given timestamp |
scriptProcessFilter.deploymentId |
STRING |
Optional field used to limit returned processes to those originating from projects with a specific deployment ID |
scriptId |
STRING |
The script ID of the project whose processes are listed |
scriptProcessFilter.types |
ENUMERATION |
Optional field used to limit returned processes to those having one of the specified process types |
pageToken |
STRING |
The token for continuing a previous list request on the next page. This
should be set to the value of |
pageSize |
INTEGER |
The maximum number of returned processes per page of results. Defaults to 50 |
scriptProcessFilter.endTime |
ANY |
Optional field used to limit returned processes to those that completed on or before the given timestamp |
scriptProcessFilter.userAccessLevels |
ENUMERATION |
Optional field used to limit returned processes to those having one of the specified user access levels |
= Parameter name
= Format
|
scriptProcessFilter.statuses ENUMERATION Optional field used to limit returned processes to those having one of the specified process statuses |
|
scriptProcessFilter.functionName STRING Optional field used to limit returned processes to those originating from a script function with the given function name |
|
scriptProcessFilter.startTime ANY Optional field used to limit returned processes to those that were started on or after the given timestamp |
|
scriptProcessFilter.deploymentId STRING Optional field used to limit returned processes to those originating from projects with a specific deployment ID |
|
scriptId STRING The script ID of the project whose processes are listed |
|
scriptProcessFilter.types ENUMERATION Optional field used to limit returned processes to those having one of the specified process types |
|
pageToken STRING The token for continuing a previous list request on the next page. This
should be set to the value of |
|
pageSize INTEGER The maximum number of returned processes per page of results. Defaults to 50 |
|
scriptProcessFilter.endTime ANY Optional field used to limit returned processes to those that completed on or before the given timestamp |
|
scriptProcessFilter.userAccessLevels ENUMERATION Optional field used to limit returned processes to those having one of the specified user access levels |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
processes[] |
OBJECT |
Representation of a single script process execution that was started from
the script editor, a trigger, an application, or using the Apps Script API.
This is distinct from the |
processes[].functionName |
STRING |
Name of the function the started the execution |
processes[].startTime |
ANY |
Time the execution started |
processes[].userAccessLevel |
ENUMERATION |
The executing users access level to the script |
processes[].processType |
ENUMERATION |
The executions type |
processes[].projectName |
STRING |
Name of the script being executed |
processes[].processStatus |
ENUMERATION |
The executions status |
processes[].duration |
ANY |
Duration the execution spent executing |
nextPageToken |
STRING |
Token for the next page of results. If empty, there are no more pages remaining |
= Parameter name
= Format
|
processes[] OBJECT Representation of a single script process execution that was started from
the script editor, a trigger, an application, or using the Apps Script API.
This is distinct from the |
|
processes[].functionName STRING Name of the function the started the execution |
|
processes[].startTime ANY Time the execution started |
|
processes[].userAccessLevel ENUMERATION The executing users access level to the script |
|
processes[].processType ENUMERATION The executions type |
|
processes[].projectName STRING Name of the script being executed |
|
processes[].processStatus ENUMERATION The executions status |
|
processes[].duration ANY Duration the execution spent executing |
|
nextPageToken STRING Token for the next page of results. If empty, there are no more pages remaining |