Viewing Process Information

  • The Apps Script API provides methods to list and manage script processes, including details like process type, status, and duration.

  • You can retrieve a list of your processes or filter them based on specific criteria using processes.list and providing a ListUserProcessFilter object.

  • Similarly, you can retrieve processes associated with a particular script project using processes.listScriptProcesses and filtering them with a ListScriptProcessesFilter object.

This section provides an overview of the Apps Script API methods you can use to list your script processes.

API method overview
List your processes

processes.list

Results: Returns an array of Process objects, each containing the metadata for a process you have run. This information includes the process type, status, start time, and duration.

Options: You can define and provide a ListUserProcessFilter object to filter the process list. Only processes which match all of the filter conditions are returned.

List a project's processes

processes.listScriptProcesses

Results: Returns an array of Process objects, each containing the metadata for a process run from a specifed script project. This information includes the process type, status, start time, and duration.

Options: You can define and provide a ListScriptProcessesFilter object to filter the process list. Only processes which match all of the filter conditions are returned.