Method: processes.listScriptProcesses
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Listar informações sobre os processos executados de um script, como tipo de processo e status atual.
Solicitação HTTP
GET https://script.googleapis.com/v1/processes:listScriptProcesses
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros |
scriptId |
string
O ID do script do projeto com os processos listados.
|
scriptProcessFilter |
object (ListScriptProcessesFilter)
Um filtro usado para limitar os resultados da lista. somente processos que correspondam aos critérios de filtro serão retornados.
|
pageSize |
integer
O número máximo de processos retornados por página de resultados. O padrão é 50.
|
pageToken |
string
O token para continuar uma solicitação de lista anterior na próxima página. Ele precisa ser definido como o valor de nextPageToken de uma resposta anterior.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Resposta com a lista de recursos Process.
| Representação JSON |
{
"processes": [
{
object (Process)
}
],
"nextPageToken": string
} |
| Campos |
processes[] |
object (Process)
Lista de processos que correspondem aos parâmetros de solicitação.
|
nextPageToken |
string
Token para a próxima página de resultados. Se estiver vazio, não haverá mais páginas restantes.
|
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/script.processes
Para mais informações, consulte a Visão geral do OAuth 2.0.
ListScriptProcessesFilter
Filtro usado para especificar ainda mais quais processos serão listados. Somente os processos que correspondem a todas as condições especificadas são retornados.
| Representação JSON |
{
"deploymentId": string,
"functionName": string,
"startTime": string,
"endTime": string,
"types": [
enum (ProcessType)
],
"statuses": [
enum (ProcessStatus)
],
"userAccessLevels": [
enum (UserAccessLevel)
]
} |
| Campos |
deploymentId |
string
Campo opcional usado para limitar os processos retornados àqueles originados de projetos com um ID de implantação específico.
|
functionName |
string
Campo opcional usado para limitar os processos retornados àqueles originados de uma função de script com o nome de função especificado.
|
startTime |
string (Timestamp format)
Campo opcional usado para limitar os processos retornados àqueles que foram iniciados no carimbo de data/hora ou após. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
|
endTime |
string (Timestamp format)
Campo opcional usado para limitar os processos retornados àqueles que foram concluídos no carimbo de data/hora especificado ou antes. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
|
types[] |
enum (ProcessType)
Campo opcional usado para limitar os processos retornados aos que têm um dos tipos de processo especificados.
|
statuses[] |
enum (ProcessStatus)
Campo opcional usado para limitar os processos retornados àqueles com um dos status de processo especificados.
|
userAccessLevels[] |
enum (UserAccessLevel)
Campo opcional usado para limitar os processos retornados aos que têm um dos níveis de acesso do usuário especificados.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eLists information on script-executed processes, including process type and status, using the \u003ccode\u003eprocesses:listScriptProcesses\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of listed processes based on criteria like deployment ID, function name, timestamps, process types, statuses, and user access levels.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/script.processes\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns a paginated list of \u003ccode\u003eProcess\u003c/code\u003e resources with details of each process and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eEmploys a \u003ccode\u003eGET\u003c/code\u003e request to the \u003ccode\u003ehttps://script.googleapis.com/v1/processes:listScriptProcesses\u003c/code\u003e endpoint with optional query parameters for filtering and pagination.\u003c/p\u003e\n"]]],[],null,["# Method: processes.listScriptProcesses\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListScriptProcessesResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [ListScriptProcessesFilter](#ListScriptProcessesFilter)\n - [JSON representation](#ListScriptProcessesFilter.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nList information about a script's executed processes, such as process type and current status.\n\n### HTTP request\n\n`GET https://script.googleapis.com/v1/processes:listScriptProcesses`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `scriptId` | `string` The script ID of the project whose processes are listed. |\n| `scriptProcessFilter` | `object (`[ListScriptProcessesFilter](/apps-script/api/reference/rest/v1/processes/listScriptProcesses#ListScriptProcessesFilter)`)` A filter used to limit the list results; only processes matching the filter criteria are returned. |\n| `pageSize` | `integer` The maximum number of returned processes per page of results. Defaults to 50. |\n| `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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse with the list of [Process](/apps-script/api/reference/rest/v1/processes#Process) resources.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"processes\": [ { object (/apps-script/api/reference/rest/v1/processes#Process) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `processes[]` | `object (`[Process](/apps-script/api/reference/rest/v1/processes#Process)`)` List of processes matching request parameters. |\n| `nextPageToken` | `string` Token for the next page of results. If empty, there are no more pages remaining. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/script.processes`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nListScriptProcessesFilter\n-------------------------\n\nFilter used to further specify which processes to list. Only processes that match all the specified conditions are returned.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deploymentId\": string, \"functionName\": string, \"startTime\": string, \"endTime\": string, \"types\": [ enum (/apps-script/api/reference/rest/v1/processes#ProcessType) ], \"statuses\": [ enum (/apps-script/api/reference/rest/v1/processes#ProcessStatus) ], \"userAccessLevels\": [ enum (/apps-script/api/reference/rest/v1/processes#UserAccessLevel) ] } ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deploymentId` | `string` Optional field used to limit returned processes to those originating from projects with a specific deployment ID. |\n| `functionName` | `string` Optional field used to limit returned processes to those originating from a script function with the given function name. |\n| `startTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `endTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `types[]` | `enum (`[ProcessType](/apps-script/api/reference/rest/v1/processes#ProcessType)`)` Optional field used to limit returned processes to those having one of the specified process types. |\n| `statuses[]` | `enum (`[ProcessStatus](/apps-script/api/reference/rest/v1/processes#ProcessStatus)`)` Optional field used to limit returned processes to those having one of the specified process statuses. |\n| `userAccessLevels[]` | `enum (`[UserAccessLevel](/apps-script/api/reference/rest/v1/processes#UserAccessLevel)`)` Optional field used to limit returned processes to those having one of the specified user access levels. |"]]
