Apps Script API . processes

Instance Methods

list(userProcessFilter_types=None, userProcessFilter_userAccessLevels=None, pageSize=None, userProcessFilter_endTime=None, x__xgafv=None, userProcessFilter_projectName=None, pageToken=None, userProcessFilter_startTime=None, userProcessFilter_deploymentId=None, userProcessFilter_scriptId=None, userProcessFilter_functionName=None, userProcessFilter_statuses=None)

List information about processes made by or on behalf of a user,

listScriptProcesses(scriptProcessFilter_startTime=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_userAccessLevels=None, x__xgafv=None, pageToken=None, scriptId=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_types=None)

List information about a script's executed processes, such as process type

listScriptProcesses_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Method Details

list(userProcessFilter_types=None, userProcessFilter_userAccessLevels=None, pageSize=None, userProcessFilter_endTime=None, x__xgafv=None, userProcessFilter_projectName=None, pageToken=None, userProcessFilter_startTime=None, userProcessFilter_deploymentId=None, userProcessFilter_scriptId=None, userProcessFilter_functionName=None, userProcessFilter_statuses=None)
List information about processes made by or on behalf of a user,
such as process type and current status.

Args:
  userProcessFilter_types: string, Optional field used to limit returned processes to those having one of
the specified process types. (repeated)
  userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
the specified user access levels. (repeated)
  pageSize: integer, The maximum number of returned processes per page of results. Defaults to
50.
  userProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
on or before the given timestamp.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from
projects with project names containing a specific string.
  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.
  userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
started on or after the given timestamp.
  userProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
projects with a specific deployment ID.
  userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from
projects with a specific script ID.
  userProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
a script function with the given function name.
  userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
the specified process statuses. (repeated)

Returns:
  An object of the form:

    { # Response with the list of
      # Process resources.
    "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages
        # remaining.
    "processes": [ # List of processes matching request parameters.
      { # 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 `Operation`
          # resource, which only represents executions started via the Apps Script API.
        "processStatus": "A String", # The executions status.
        "userAccessLevel": "A String", # The executing users access level to the script.
        "functionName": "A String", # Name of the function the started the execution.
        "projectName": "A String", # Name of the script being executed.
        "startTime": "A String", # Time the execution started.
        "duration": "A String", # Duration the execution spent executing.
        "processType": "A String", # The executions type.
      },
    ],
  }
listScriptProcesses(scriptProcessFilter_startTime=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_userAccessLevels=None, x__xgafv=None, pageToken=None, scriptId=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_types=None)
List information about a script's executed processes, such as process type
and current status.

Args:
  scriptProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
started on or after the given timestamp.
  pageSize: integer, The maximum number of returned processes per page of results. Defaults to
50.
  scriptProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
the specified process statuses. (repeated)
  scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
the specified user access levels. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  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.
  scriptId: string, The script ID of the project whose processes are listed.
  scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
projects with a specific deployment ID.
  scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
on or before the given timestamp.
  scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
a script function with the given function name.
  scriptProcessFilter_types: string, Optional field used to limit returned processes to those having one of
the specified process types. (repeated)

Returns:
  An object of the form:

    { # Response with the list of
      # Process resources.
    "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages
        # remaining.
    "processes": [ # List of processes matching request parameters.
      { # 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 `Operation`
          # resource, which only represents executions started via the Apps Script API.
        "processStatus": "A String", # The executions status.
        "userAccessLevel": "A String", # The executing users access level to the script.
        "functionName": "A String", # Name of the function the started the execution.
        "projectName": "A String", # Name of the script being executed.
        "startTime": "A String", # Time the execution started.
        "duration": "A String", # Duration the execution spent executing.
        "processType": "A String", # The executions type.
      },
    ],
  }
listScriptProcesses_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.