docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/script_v1.projects.html b/docs/dyn/script_v1.projects.html
index 3dafc4d..7cb10a2 100644
--- a/docs/dyn/script_v1.projects.html
+++ b/docs/dyn/script_v1.projects.html
@@ -94,7 +94,7 @@
<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="toc_element">
- <code><a href="#getMetrics">getMetrics(scriptId, metricsFilter_deploymentId=None, x__xgafv=None, metricsGranularity=None)</a></code></p>
+ <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="toc_element">
<code><a href="#updateContent">updateContent(scriptId, body=None, x__xgafv=None)</a></code></p>
@@ -110,8 +110,8 @@
The object takes the form of:
{ # 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.
+ "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.
}
@@ -125,34 +125,34 @@
An object of the form:
{ # The script project resource.
- "updateTime": "A String", # When the script was last updated.
- "lastModifyUser": { # A simple user profile resource. # User who last modified the script.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "title": "A String", # The title for the project.
- "creator": { # A simple user profile resource. # User who originally created the script.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "scriptId": "A String", # The script project's Drive ID.
- "parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually
+ "title": "A String", # The title for the project.
+ "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.
+ "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.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "createTime": "A String", # When the script was created.
+ "updateTime": "A String", # When the script was last updated.
+ "creator": { # A simple user profile resource. # User who originally created the script.
+ "name": "A String", # The user's display name.
+ "email": "A String", # The user's identifying email address.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "scriptId": "A String", # The script project's Drive ID.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(scriptId, x__xgafv=None)</code>
- <pre>Gets a script project's metadata.
+ <pre>Gets a script project's metadata.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ scriptId: string, The script project's Drive ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -162,25 +162,25 @@
An object of the form:
{ # The script project resource.
- "updateTime": "A String", # When the script was last updated.
- "lastModifyUser": { # A simple user profile resource. # User who last modified the script.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "title": "A String", # The title for the project.
- "creator": { # A simple user profile resource. # User who originally created the script.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "scriptId": "A String", # The script project's Drive ID.
- "parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually
+ "title": "A String", # The title for the project.
+ "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.
+ "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.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "createTime": "A String", # When the script was created.
+ "updateTime": "A String", # When the script was last updated.
+ "creator": { # A simple user profile resource. # User who originally created the script.
+ "name": "A String", # The user's display name.
+ "email": "A String", # The user's identifying email address.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "scriptId": "A String", # The script project's Drive ID.
}</pre>
</div>
@@ -190,9 +190,9 @@
metadata for each script file.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ 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.
+project's HEAD version is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -202,83 +202,83 @@
An object of the form:
{ # The Content resource.
- "files": [ # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
+ "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.
- "updateTime": "A String", # Last modified 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.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "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.
+ "source": "A String", # The file content.
+ "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.
+ "type": "A String", # The type of the file.
+ "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 function name in the script project.
},
],
},
- "type": "A String", # The type of the file.
- "createTime": "A String", # Creation date timestamp.
+ "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 name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
+ "name": "A String", # The user's display name.
+ "email": "A String", # The user's identifying email address.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "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.
},
],
- "scriptId": "A String", # The script project's Drive ID.
}</pre>
</div>
<div class="method">
- <code class="details" id="getMetrics">getMetrics(scriptId, metricsFilter_deploymentId=None, x__xgafv=None, metricsGranularity=None)</code>
+ <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.
Args:
scriptId: string, Required field indicating the script to get metrics for. (required)
+ metricsGranularity: string, Required field indicating what granularity of metrics are returned.
metricsFilter_deploymentId: string, Optional field indicating a specific deployment to retrieve metrics from.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- metricsGranularity: string, Required field indicating what granularity of metrics are returned.
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.
- "totalExecutions": [ # Number of total executions.
+ "totalExecutions": [ # Number of total executions.
{ # Metrics value that holds number of executions counted.
- "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.
+ "endTime": "A String", # Required field indicating the end time of the interval.
+ "startTime": "A String", # Required field indicating the start time of the interval.
+ "value": "A String", # Indicates the number of executions counted.
},
],
- "activeUsers": [ # Number of active users.
+ "activeUsers": [ # Number of active users.
{ # Metrics value that holds number of executions counted.
- "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.
+ "endTime": "A String", # Required field indicating the end time of the interval.
+ "startTime": "A String", # Required field indicating the start time of the interval.
+ "value": "A String", # Indicates the number of executions counted.
},
],
- "failedExecutions": [ # Number of failed executions.
+ "failedExecutions": [ # Number of failed executions.
{ # Metrics value that holds number of executions counted.
- "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.
+ "endTime": "A String", # Required field indicating the end time of the interval.
+ "startTime": "A String", # Required field indicating the start time of the interval.
+ "value": "A String", # Indicates the number of executions counted.
},
],
}</pre>
@@ -293,47 +293,47 @@
existing files in the project.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ scriptId: string, The script project's Drive ID. (required)
body: object, The request body.
The object takes the form of:
{ # The Content resource.
- "files": [ # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
+ "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.
- "updateTime": "A String", # Last modified 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.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "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.
+ "source": "A String", # The file content.
+ "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.
+ "type": "A String", # The type of the file.
+ "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 function name in the script project.
},
],
},
- "type": "A String", # The type of the file.
- "createTime": "A String", # Creation date timestamp.
+ "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 name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
+ "name": "A String", # The user's display name.
+ "email": "A String", # The user's identifying email address.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "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.
},
],
- "scriptId": "A String", # The script project's Drive ID.
}
x__xgafv: string, V1 error format.
@@ -345,42 +345,42 @@
An object of the form:
{ # The Content resource.
- "files": [ # The list of script project files.
- # One of the files is a script manifest; it must be named "appsscript",
+ "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.
- "updateTime": "A String", # Last modified 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.
- "email": "A String", # The user's identifying email address.
- "domain": "A String", # The user's domain.
- "name": "A String", # The user's display name.
- "photoUrl": "A String", # The user's photo.
- },
- "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.
+ "source": "A String", # The file content.
+ "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.
+ "type": "A String", # The type of the file.
+ "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 function name in the script project.
},
],
},
- "type": "A String", # The type of the file.
- "createTime": "A String", # Creation date timestamp.
+ "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 name of the file. The file extension is not part of the file
- # name, which can be identified from the type field.
+ "name": "A String", # The user's display name.
+ "email": "A String", # The user's identifying email address.
+ "domain": "A String", # The user's domain.
+ "photoUrl": "A String", # The user's photo.
+ },
+ "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.
},
],
- "scriptId": "A String", # The script project's Drive ID.
}</pre>
</div>