1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="script_v1.html">Apps Script API</a> . <a href="script_v1.processes.html">processes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(pageSize=None, pageToken=None, userProcessFilter_deploymentId=None, userProcessFilter_endTime=None, userProcessFilter_functionName=None, userProcessFilter_projectName=None, userProcessFilter_scriptId=None, userProcessFilter_startTime=None, userProcessFilter_statuses=None, userProcessFilter_types=None, userProcessFilter_userAccessLevels=None, x__xgafv=None)</a></code></p> 82<p class="firstline">List information about processes made by or on behalf of a user, such as process type and current status.</p> 83<p class="toc_element"> 84 <code><a href="#listScriptProcesses">listScriptProcesses(pageSize=None, pageToken=None, scriptId=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_startTime=None, scriptProcessFilter_statuses=None, scriptProcessFilter_types=None, scriptProcessFilter_userAccessLevels=None, x__xgafv=None)</a></code></p> 85<p class="firstline">List information about a script's executed processes, such as process type and current status.</p> 86<p class="toc_element"> 87 <code><a href="#listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="list">list(pageSize=None, pageToken=None, userProcessFilter_deploymentId=None, userProcessFilter_endTime=None, userProcessFilter_functionName=None, userProcessFilter_projectName=None, userProcessFilter_scriptId=None, userProcessFilter_startTime=None, userProcessFilter_statuses=None, userProcessFilter_types=None, userProcessFilter_userAccessLevels=None, x__xgafv=None)</code> 100 <pre>List information about processes made by or on behalf of a user, such as process type and current status. 101 102Args: 103 pageSize: integer, The maximum number of returned processes per page of results. Defaults to 50. 104 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. 105 userProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from projects with a specific deployment ID. 106 userProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed on or before the given timestamp. 107 userProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from a script function with the given function name. 108 userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from projects with project names containing a specific string. 109 userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from projects with a specific script ID. 110 userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were started on or after the given timestamp. 111 userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of the specified process statuses. (repeated) 112 Allowed values 113 PROCESS_STATUS_UNSPECIFIED - Unspecified status. 114 RUNNING - The process is currently running. 115 PAUSED - The process has paused. 116 COMPLETED - The process has completed. 117 CANCELED - The process was cancelled. 118 FAILED - The process failed. 119 TIMED_OUT - The process timed out. 120 UNKNOWN - Process status unknown. 121 DELAYED - The process is delayed, waiting for quota. 122 userProcessFilter_types: string, Optional field used to limit returned processes to those having one of the specified process types. (repeated) 123 Allowed values 124 PROCESS_TYPE_UNSPECIFIED - Unspecified type. 125 ADD_ON - The process was started from an add-on entry point. 126 EXECUTION_API - The process was started using the Apps Script API. 127 TIME_DRIVEN - The process was started from a time-based trigger. 128 TRIGGER - The process was started from an event-based trigger. 129 WEBAPP - The process was started from a web app entry point. 130 EDITOR - The process was started using the Apps Script IDE. 131 SIMPLE_TRIGGER - The process was started from a G Suite simple trigger. 132 MENU - The process was started from a G Suite menu item. 133 BATCH_TASK - The process was started as a task in a batch job. 134 userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of the specified user access levels. (repeated) 135 Allowed values 136 USER_ACCESS_LEVEL_UNSPECIFIED - User access level unspecified 137 NONE - The user has no access. 138 READ - The user has read-only access. 139 WRITE - The user has write access. 140 OWNER - The user is an owner. 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # Response with the list of Process resources. 150 "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages remaining. 151 "processes": [ # List of processes matching request parameters. 152 { # 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. 153 "duration": "A String", # Duration the execution spent executing. 154 "functionName": "A String", # Name of the function the started the execution. 155 "processStatus": "A String", # The executions status. 156 "processType": "A String", # The executions type. 157 "projectName": "A String", # Name of the script being executed. 158 "startTime": "A String", # Time the execution started. 159 "userAccessLevel": "A String", # The executing users access level to the script. 160 }, 161 ], 162}</pre> 163</div> 164 165<div class="method"> 166 <code class="details" id="listScriptProcesses">listScriptProcesses(pageSize=None, pageToken=None, scriptId=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_startTime=None, scriptProcessFilter_statuses=None, scriptProcessFilter_types=None, scriptProcessFilter_userAccessLevels=None, x__xgafv=None)</code> 167 <pre>List information about a script's executed processes, such as process type and current status. 168 169Args: 170 pageSize: integer, The maximum number of returned processes per page of results. Defaults to 50. 171 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. 172 scriptId: string, The script ID of the project whose processes are listed. 173 scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from projects with a specific deployment ID. 174 scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed on or before the given timestamp. 175 scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from a script function with the given function name. 176 scriptProcessFilter_startTime: string, Optional field used to limit returned processes to those that were started on or after the given timestamp. 177 scriptProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of the specified process statuses. (repeated) 178 Allowed values 179 PROCESS_STATUS_UNSPECIFIED - Unspecified status. 180 RUNNING - The process is currently running. 181 PAUSED - The process has paused. 182 COMPLETED - The process has completed. 183 CANCELED - The process was cancelled. 184 FAILED - The process failed. 185 TIMED_OUT - The process timed out. 186 UNKNOWN - Process status unknown. 187 DELAYED - The process is delayed, waiting for quota. 188 scriptProcessFilter_types: string, Optional field used to limit returned processes to those having one of the specified process types. (repeated) 189 Allowed values 190 PROCESS_TYPE_UNSPECIFIED - Unspecified type. 191 ADD_ON - The process was started from an add-on entry point. 192 EXECUTION_API - The process was started using the Apps Script API. 193 TIME_DRIVEN - The process was started from a time-based trigger. 194 TRIGGER - The process was started from an event-based trigger. 195 WEBAPP - The process was started from a web app entry point. 196 EDITOR - The process was started using the Apps Script IDE. 197 SIMPLE_TRIGGER - The process was started from a G Suite simple trigger. 198 MENU - The process was started from a G Suite menu item. 199 BATCH_TASK - The process was started as a task in a batch job. 200 scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of the specified user access levels. (repeated) 201 Allowed values 202 USER_ACCESS_LEVEL_UNSPECIFIED - User access level unspecified 203 NONE - The user has no access. 204 READ - The user has read-only access. 205 WRITE - The user has write access. 206 OWNER - The user is an owner. 207 x__xgafv: string, V1 error format. 208 Allowed values 209 1 - v1 error format 210 2 - v2 error format 211 212Returns: 213 An object of the form: 214 215 { # Response with the list of Process resources. 216 "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages remaining. 217 "processes": [ # List of processes matching request parameters. 218 { # 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. 219 "duration": "A String", # Duration the execution spent executing. 220 "functionName": "A String", # Name of the function the started the execution. 221 "processStatus": "A String", # The executions status. 222 "processType": "A String", # The executions type. 223 "projectName": "A String", # Name of the script being executed. 224 "startTime": "A String", # Time the execution started. 225 "userAccessLevel": "A String", # The executing users access level to the script. 226 }, 227 ], 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</code> 233 <pre>Retrieves the next page of results. 234 235Args: 236 previous_request: The request for the previous page. (required) 237 previous_response: The response from the request for the previous page. (required) 238 239Returns: 240 A request object that you can call 'execute()' on to request the next 241 page. Returns None if there are no more items in the collection. 242 </pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 247 <pre>Retrieves the next page of results. 248 249Args: 250 previous_request: The request for the previous page. (required) 251 previous_response: The response from the request for the previous page. (required) 252 253Returns: 254 A request object that you can call 'execute()' on to request the next 255 page. Returns None if there are no more items in the collection. 256 </pre> 257</div> 258 259</body></html>