docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/script_v1.projects.html b/docs/dyn/script_v1.projects.html
index 553ed06..891ac0e 100644
--- a/docs/dyn/script_v1.projects.html
+++ b/docs/dyn/script_v1.projects.html
@@ -85,25 +85,32 @@
<p class="firstline">Returns the versions Resource.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a new, empty script project with no script files and a base</p>
+<p class="firstline">Creates a new, empty script project with no script files and a base manifest file.</p>
<p class="toc_element">
<code><a href="#get">get(scriptId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a script project's metadata.</p>
<p class="toc_element">
<code><a href="#getContent">getContent(scriptId, versionNumber=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the content of the script project, including the code source and</p>
+<p class="firstline">Gets the content of the script project, including the code source and metadata for each script file.</p>
<p class="toc_element">
<code><a href="#getMetrics">getMetrics(scriptId, metricsGranularity=None, metricsFilter_deploymentId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Get metrics data for scripts, such as number of executions and</p>
+<p class="firstline">Get metrics data for scripts, such as number of executions and active users.</p>
<p class="toc_element">
<code><a href="#updateContent">updateContent(scriptId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the content of the specified script project.</p>
+<p class="firstline">Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
- <pre>Creates a new, empty script project with no script files and a base
-manifest file.
+ <pre>Creates a new, empty script project with no script files and a base manifest file.
Args:
body: object, The request body.
@@ -111,9 +118,7 @@
{ # Request to create a script project.
"title": "A String", # The title for the project.
- "parentId": "A String", # The Drive ID of a parent file that the created script project is bound to.
- # This is usually the ID of a Google Doc, Google Sheet, Google Form, or
- # Google Slides file. If not set, a standalone script project is created.
+ "parentId": "A String", # The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created.
}
x__xgafv: string, V1 error format.
@@ -125,25 +130,23 @@
An object of the form:
{ # The script project resource.
- "lastModifyUser": { # A simple user profile resource. # User who last modified the script.
- "name": "A String", # The user's display name.
- "email": "A String", # The user's identifying email address.
- "photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
- },
- "updateTime": "A String", # When the script was last updated.
- "parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually
- # the ID of a Google Document or Google Sheet. This filed is optional, and
- # if not set, a stand-alone script will be created.
- "createTime": "A String", # When the script was created.
"scriptId": "A String", # The script project's Drive ID.
- "title": "A String", # The title for the project.
- "creator": { # A simple user profile resource. # User who originally created the script.
- "name": "A String", # The user's display name.
+ "lastModifyUser": { # A simple user profile resource. # User who last modified the script.
+ "domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
+ "name": "A String", # The user's display name.
},
+ "parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created.
+ "updateTime": "A String", # When the script was last updated.
+ "creator": { # A simple user profile resource. # User who originally created the script.
+ "domain": "A String", # The user's domain.
+ "email": "A String", # The user's identifying email address.
+ "photoUrl": "A String", # The user's photo.
+ "name": "A String", # The user's display name.
+ },
+ "title": "A String", # The title for the project.
+ "createTime": "A String", # When the script was created.
}</pre>
</div>
@@ -162,37 +165,33 @@
An object of the form:
{ # The script project resource.
- "lastModifyUser": { # A simple user profile resource. # User who last modified the script.
- "name": "A String", # The user's display name.
- "email": "A String", # The user's identifying email address.
- "photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
- },
- "updateTime": "A String", # When the script was last updated.
- "parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually
- # the ID of a Google Document or Google Sheet. This filed is optional, and
- # if not set, a stand-alone script will be created.
- "createTime": "A String", # When the script was created.
"scriptId": "A String", # The script project's Drive ID.
- "title": "A String", # The title for the project.
- "creator": { # A simple user profile resource. # User who originally created the script.
- "name": "A String", # The user's display name.
+ "lastModifyUser": { # A simple user profile resource. # User who last modified the script.
+ "domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
+ "name": "A String", # The user's display name.
},
+ "parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created.
+ "updateTime": "A String", # When the script was last updated.
+ "creator": { # A simple user profile resource. # User who originally created the script.
+ "domain": "A String", # The user's domain.
+ "email": "A String", # The user's identifying email address.
+ "photoUrl": "A String", # The user's photo.
+ "name": "A String", # The user's display name.
+ },
+ "title": "A String", # The title for the project.
+ "createTime": "A String", # When the script was created.
}</pre>
</div>
<div class="method">
<code class="details" id="getContent">getContent(scriptId, versionNumber=None, x__xgafv=None)</code>
- <pre>Gets the content of the script project, including the code source and
-metadata for each script file.
+ <pre>Gets the content of the script project, including the code source and metadata for each script file.
Args:
scriptId: string, The script project's Drive ID. (required)
- versionNumber: integer, The version number of the project to retrieve. If not provided, the
-project's HEAD version is returned.
+ versionNumber: integer, The version number of the project to retrieve. If not provided, the project's HEAD version is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -202,53 +201,43 @@
An object of the form:
{ # The Content resource.
- "scriptId": "A String", # The script project's Drive ID.
- "files": [ # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
- # must have type of JSON, and include the manifest configurations for the
- # project.
- { # An individual file within a script project.
- # A file is a third-party source code created by one or more
- # developers. It can be a server-side JS code, HTML, or a
- # configuration file. Each script project can contain multiple files.
- "type": "A String", # The type of the file.
- "lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "name": "A String", # The user's display name.
- "email": "A String", # The user's identifying email address.
- "photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
+ "files": [ # The list of script project files. One of the files is a script manifest; it must be named "appsscript", must have type of JSON, and include the manifest configurations for the project.
+ { # An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.
+ "name": "A String", # The name of the file. The file extension is not part of the file name, which can be identified from the type field.
+ "updateTime": "A String", # Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
+ "functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
+ "values": [ # A list of functions composing the set.
+ { # Represents a function in a script project.
+ "name": "A String", # The function name in the script project.
+ },
+ ],
+ },
+ "type": "A String", # The type of the file.
+ "createTime": "A String", # Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
+ "lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project.
+ "domain": "A String", # The user's domain.
+ "email": "A String", # The user's identifying email address.
+ "photoUrl": "A String", # The user's photo.
+ "name": "A String", # The user's display name.
+ },
+ "source": "A String", # The file content.
},
- "functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
- "values": [ # A list of functions composing the set.
- { # Represents a function in a script project.
- "name": "A String", # The function name in the script project.
- },
- ],
- },
- "name": "A String", # The name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
- "createTime": "A String", # Creation date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "updateTime": "A String", # Last modified date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "source": "A String", # The file content.
- },
- ],
- }</pre>
+ ],
+ "scriptId": "A String", # The script project's Drive ID.
+ }</pre>
</div>
<div class="method">
<code class="details" id="getMetrics">getMetrics(scriptId, metricsGranularity=None, metricsFilter_deploymentId=None, x__xgafv=None)</code>
- <pre>Get metrics data for scripts, such as number of executions and
-active users.
+ <pre>Get metrics data for scripts, such as number of executions and active users.
Args:
scriptId: string, Required field indicating the script to get metrics for. (required)
metricsGranularity: string, Required field indicating what granularity of metrics are returned.
+ Allowed values
+ UNSPECIFIED_GRANULARITY - Default metric granularity used to query no metrics.
+ WEEKLY - Represents weekly metrics.
+ DAILY - Represents daily metrics over a period of 7 days.
metricsFilter_deploymentId: string, Optional field indicating a specific deployment to retrieve metrics from.
x__xgafv: string, V1 error format.
Allowed values
@@ -258,27 +247,26 @@
Returns:
An object of the form:
- { # Resource containing usage stats for a given script, based on the supplied
- # filter and mask present in the request.
+ { # Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.
"activeUsers": [ # Number of active users.
{ # Metrics value that holds number of executions counted.
+ "startTime": "A String", # Required field indicating the start time of the interval.
"endTime": "A String", # Required field indicating the end time of the interval.
"value": "A String", # Indicates the number of executions counted.
- "startTime": "A String", # Required field indicating the start time of the interval.
},
],
"totalExecutions": [ # Number of total executions.
{ # Metrics value that holds number of executions counted.
+ "startTime": "A String", # Required field indicating the start time of the interval.
"endTime": "A String", # Required field indicating the end time of the interval.
"value": "A String", # Indicates the number of executions counted.
- "startTime": "A String", # Required field indicating the start time of the interval.
},
],
"failedExecutions": [ # Number of failed executions.
{ # Metrics value that holds number of executions counted.
+ "startTime": "A String", # Required field indicating the start time of the interval.
"endTime": "A String", # Required field indicating the end time of the interval.
"value": "A String", # Indicates the number of executions counted.
- "startTime": "A String", # Required field indicating the start time of the interval.
},
],
}</pre>
@@ -286,11 +274,7 @@
<div class="method">
<code class="details" id="updateContent">updateContent(scriptId, body=None, x__xgafv=None)</code>
- <pre>Updates the content of the specified script project.
-This content is stored as the HEAD version, and is used when the script is
-executed as a trigger, in the script editor, in add-on preview mode, or as
-a web app or Apps Script API in development mode. This clears all the
-existing files in the project.
+ <pre>Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.
Args:
scriptId: string, The script project's Drive ID. (required)
@@ -298,43 +282,30 @@
The object takes the form of:
{ # The Content resource.
- "scriptId": "A String", # The script project's Drive ID.
- "files": [ # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
- # must have type of JSON, and include the manifest configurations for the
- # project.
- { # An individual file within a script project.
- # A file is a third-party source code created by one or more
- # developers. It can be a server-side JS code, HTML, or a
- # configuration file. Each script project can contain multiple files.
- "type": "A String", # The type of the file.
- "lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "name": "A String", # The user's display name.
- "email": "A String", # The user's identifying email address.
- "photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
+ "files": [ # The list of script project files. One of the files is a script manifest; it must be named "appsscript", must have type of JSON, and include the manifest configurations for the project.
+ { # An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.
+ "name": "A String", # The name of the file. The file extension is not part of the file name, which can be identified from the type field.
+ "updateTime": "A String", # Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
+ "functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
+ "values": [ # A list of functions composing the set.
+ { # Represents a function in a script project.
+ "name": "A String", # The function name in the script project.
+ },
+ ],
+ },
+ "type": "A String", # The type of the file.
+ "createTime": "A String", # Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
+ "lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project.
+ "domain": "A String", # The user's domain.
+ "email": "A String", # The user's identifying email address.
+ "photoUrl": "A String", # The user's photo.
+ "name": "A String", # The user's display name.
+ },
+ "source": "A String", # The file content.
},
- "functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
- "values": [ # A list of functions composing the set.
- { # Represents a function in a script project.
- "name": "A String", # The function name in the script project.
- },
- ],
- },
- "name": "A String", # The name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
- "createTime": "A String", # Creation date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "updateTime": "A String", # Last modified date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "source": "A String", # The file content.
- },
- ],
-}
+ ],
+ "scriptId": "A String", # The script project's Drive ID.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -345,43 +316,30 @@
An object of the form:
{ # The Content resource.
- "scriptId": "A String", # The script project's Drive ID.
- "files": [ # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
- # must have type of JSON, and include the manifest configurations for the
- # project.
- { # An individual file within a script project.
- # A file is a third-party source code created by one or more
- # developers. It can be a server-side JS code, HTML, or a
- # configuration file. Each script project can contain multiple files.
- "type": "A String", # The type of the file.
- "lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "name": "A String", # The user's display name.
- "email": "A String", # The user's identifying email address.
- "photoUrl": "A String", # The user's photo.
- "domain": "A String", # The user's domain.
+ "files": [ # The list of script project files. One of the files is a script manifest; it must be named "appsscript", must have type of JSON, and include the manifest configurations for the project.
+ { # An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.
+ "name": "A String", # The name of the file. The file extension is not part of the file name, which can be identified from the type field.
+ "updateTime": "A String", # Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
+ "functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
+ "values": [ # A list of functions composing the set.
+ { # Represents a function in a script project.
+ "name": "A String", # The function name in the script project.
+ },
+ ],
+ },
+ "type": "A String", # The type of the file.
+ "createTime": "A String", # Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
+ "lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project.
+ "domain": "A String", # The user's domain.
+ "email": "A String", # The user's identifying email address.
+ "photoUrl": "A String", # The user's photo.
+ "name": "A String", # The user's display name.
+ },
+ "source": "A String", # The file content.
},
- "functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
- "values": [ # A list of functions composing the set.
- { # Represents a function in a script project.
- "name": "A String", # The function name in the script project.
- },
- ],
- },
- "name": "A String", # The name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
- "createTime": "A String", # Creation date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "updateTime": "A String", # Last modified date timestamp.
- # This read-only field is only visible to users who have WRITER
- # permission for the script project.
- "source": "A String", # The file content.
- },
- ],
- }</pre>
+ ],
+ "scriptId": "A String", # The script project's Drive ID.
+ }</pre>
</div>
</body></html>
\ No newline at end of file