chore: regens API reference docs (#889)
diff --git a/docs/dyn/sheets_v4.spreadsheets.values.html b/docs/dyn/sheets_v4.spreadsheets.values.html
index ee1d085..7807a4f 100644
--- a/docs/dyn/sheets_v4.spreadsheets.values.html
+++ b/docs/dyn/sheets_v4.spreadsheets.values.html
@@ -75,25 +75,25 @@
<h1><a href="sheets_v4.html">Google Sheets API</a> . <a href="sheets_v4.spreadsheets.html">spreadsheets</a> . <a href="sheets_v4.spreadsheets.values.html">values</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#append">append(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, insertDataOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</a></code></p>
+ <code><a href="#append">append(spreadsheetId, range, body=None, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, insertDataOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</a></code></p>
<p class="firstline">Appends values to a spreadsheet. The input range is used to search for</p>
<p class="toc_element">
- <code><a href="#batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchClear">batchClear(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Clears one or more ranges of values from a spreadsheet.</p>
<p class="toc_element">
- <code><a href="#batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Clears one or more ranges of values from a spreadsheet.</p>
<p class="toc_element">
- <code><a href="#batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGet">batchGet(spreadsheetId, valueRenderOption=None, ranges=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns one or more ranges of values from a spreadsheet.</p>
<p class="toc_element">
- <code><a href="#batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns one or more ranges of values that match the specified data filters.</p>
<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchUpdate">batchUpdate(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets values in one or more ranges of a spreadsheet.</p>
<p class="toc_element">
- <code><a href="#batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets values in one or more ranges of a spreadsheet.</p>
<p class="toc_element">
<code><a href="#clear">clear(spreadsheetId, range, body=None, x__xgafv=None)</a></code></p>
@@ -102,11 +102,11 @@
<code><a href="#get">get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a range of values from a spreadsheet.</p>
<p class="toc_element">
- <code><a href="#update">update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</a></code></p>
+ <code><a href="#update">update(spreadsheetId, range, body=None, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</a></code></p>
<p class="firstline">Sets values in a range of a spreadsheet.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="append">append(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, insertDataOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</code>
+ <code class="details" id="append">append(spreadsheetId, range, body=None, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, insertDataOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</code>
<pre>Appends values to a spreadsheet. The input range is used to search for
existing data and find a "table" within that range. Values will be
appended to the next row of the table, starting with the first column of
@@ -125,8 +125,8 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to update. (required)
range: string, The A1 notation of a range to search for a logical table of data.
-Values will be appended after the last row of the table. (required)
- body: object, The request body. (required)
+Values are appended after the last row of the table. (required)
+ body: object, The request body.
The object takes the form of:
{ # Data within a range of the spreadsheet.
@@ -189,8 +189,8 @@
# (before the values were appended).
# Empty if no table was found.
"updates": { # The response when updating a range of values in a spreadsheet. # Information about the updates that were applied.
- "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
"updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
+ "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
"updatedRows": 42, # The number of rows where at least one cell in the row was updated.
"updatedData": { # Data within a range of the spreadsheet. # The values of the cells after updates were applied.
# This is only included if the request's `includeValuesInResponse` field
@@ -235,7 +235,7 @@
</div>
<div class="method">
- <code class="details" id="batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</code>
+ <code class="details" id="batchClear">batchClear(spreadsheetId, body=None, x__xgafv=None)</code>
<pre>Clears one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more ranges.
Only values are cleared -- all other properties of the cell (such as
@@ -243,7 +243,7 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to update. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request for clearing more than one range of values in a spreadsheet.
@@ -262,17 +262,16 @@
{ # The response when clearing a range of values in a spreadsheet.
"spreadsheetId": "A String", # The spreadsheet the updates were applied to.
- "clearedRanges": [ # The ranges that were cleared, in A1 notation.
- # (If the requests were for an unbounded range or a ranger larger
- # than the bounds of the sheet, this will be the actual ranges
- # that were cleared, bounded to the sheet's limits.)
+ "clearedRanges": [ # The ranges that were cleared, in A1 notation. If the requests are for an
+ # unbounded range or a ranger larger than the bounds of the sheet, this is
+ # the actual ranges that were cleared, bounded to the sheet's limits.
"A String",
],
}</pre>
</div>
<div class="method">
- <code class="details" id="batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body, x__xgafv=None)</code>
+ <code class="details" id="batchClearByDataFilter">batchClearByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
<pre>Clears one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more
DataFilters. Ranges matching any of the specified data
@@ -281,7 +280,7 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to update. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request for clearing more than one range selected by a
@@ -316,8 +315,8 @@
"sheetId": 42, # The sheet this span is on.
"dimension": "A String", # The dimension of the span.
},
- "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
"sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
+ "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
},
"metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
# DeveloperMetadata.metadata_value.
@@ -401,17 +400,16 @@
{ # The response when clearing a range of values selected with
# DataFilters in a spreadsheet.
"spreadsheetId": "A String", # The spreadsheet the updates were applied to.
- "clearedRanges": [ # The ranges that were cleared, in A1 notation.
- # (If the requests were for an unbounded range or a ranger larger
- # than the bounds of the sheet, this will be the actual ranges
- # that were cleared, bounded to the sheet's limits.)
+ "clearedRanges": [ # The ranges that were cleared, in A1 notation. If the requests are for an
+ # unbounded range or a ranger larger than the bounds of the sheet, this is
+ # the actual ranges that were cleared, bounded to the sheet's limits.
"A String",
],
}</pre>
</div>
<div class="method">
- <code class="details" id="batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</code>
+ <code class="details" id="batchGet">batchGet(spreadsheetId, valueRenderOption=None, ranges=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</code>
<pre>Returns one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more ranges.
@@ -419,14 +417,13 @@
spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
valueRenderOption: string, How values should be represented in the output.
The default render option is ValueRenderOption.FORMATTED_VALUE.
+ ranges: string, The A1 notation of the values to retrieve. (repeated)
majorDimension: string, The major dimension that results should use.
For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
-then requesting `range=A1:B2,majorDimension=ROWS` will return
-`[[1,2],[3,4]]`,
-whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
+then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`,
+whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns
`[[1,3],[2,4]]`.
- ranges: string, The A1 notation of the values to retrieve. (repeated)
dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
This is ignored if value_render_option is
FORMATTED_VALUE.
@@ -482,7 +479,7 @@
</div>
<div class="method">
- <code class="details" id="batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body, x__xgafv=None)</code>
+ <code class="details" id="batchGetByDataFilter">batchGetByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
<pre>Returns one or more ranges of values that match the specified data filters.
The caller must specify the spreadsheet ID and one or more
DataFilters. Ranges that match any of the data filters in
@@ -490,7 +487,7 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request for retrieving a range of values in a spreadsheet selected by a
@@ -501,9 +498,8 @@
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
"valueRenderOption": "A String", # How values should be represented in the output.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
- "dataFilters": [ # The data filters used to match the ranges of values to retrieve. Ranges
- # that match any of the specified data filters will be included in the
- # response.
+ "dataFilters": [ # The data filters used to match the ranges of values to retrieve. Ranges
+ # that match any of the specified data filters are included in the response.
{ # Filter that describes what data should be selected or returned from a
# request.
"developerMetadataLookup": { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
@@ -533,8 +529,8 @@
"sheetId": 42, # The sheet this span is on.
"dimension": "A String", # The dimension of the span.
},
- "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
"sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
+ "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
},
"metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
# DeveloperMetadata.metadata_value.
@@ -608,10 +604,9 @@
"majorDimension": "A String", # The major dimension that results should use.
#
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
- # then a request that selects that range and sets `majorDimension=ROWS` will
- # return `[[1,2],[3,4]]`,
- # whereas a request that sets `majorDimension=COLUMNS` will return
- # `[[1,3],[2,4]]`.
+ # then a request that selects that range and sets `majorDimension=ROWS`
+ # returns `[[1,2],[3,4]]`, whereas a request that sets
+ # `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
}
x__xgafv: string, V1 error format.
@@ -692,8 +687,8 @@
"sheetId": 42, # The sheet this span is on.
"dimension": "A String", # The dimension of the span.
},
- "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
"sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
+ "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
},
"metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
# DeveloperMetadata.metadata_value.
@@ -770,7 +765,7 @@
</div>
<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</code>
+ <code class="details" id="batchUpdate">batchUpdate(spreadsheetId, body=None, x__xgafv=None)</code>
<pre>Sets values in one or more ranges of a spreadsheet.
The caller must specify the spreadsheet ID,
a valueInputOption, and one or more
@@ -778,7 +773,7 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to update. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request for updating more than one range of values in a spreadsheet.
@@ -819,20 +814,20 @@
# When writing, if this field is not set, it defaults to ROWS.
},
],
- "includeValuesInResponse": True or False, # Determines if the update response should include the values
- # of the cells that were updated. By default, responses
- # do not include the updated values. The `updatedData` field within
- # each of the BatchUpdateValuesResponse.responses will contain
- # the updated values. If the range to write was larger than than the range
- # actually written, the response will include all values in the requested
- # range (excluding trailing empty rows and columns).
- "responseValueRenderOption": "A String", # Determines how values in the response should be rendered.
- # The default render option is ValueRenderOption.FORMATTED_VALUE.
"responseDateTimeRenderOption": "A String", # Determines how dates, times, and durations in the response should be
# rendered. This is ignored if response_value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is
# DateTimeRenderOption.SERIAL_NUMBER.
+ "responseValueRenderOption": "A String", # Determines how values in the response should be rendered.
+ # The default render option is ValueRenderOption.FORMATTED_VALUE.
+ "includeValuesInResponse": True or False, # Determines if the update response should include the values
+ # of the cells that were updated. By default, responses
+ # do not include the updated values. The `updatedData` field within
+ # each of the BatchUpdateValuesResponse.responses contains the updated
+ # values. If the range to write was larger than the range actually written,
+ # the response includes all values in the requested range (excluding trailing
+ # empty rows and columns).
}
x__xgafv: string, V1 error format.
@@ -847,8 +842,8 @@
"responses": [ # One UpdateValuesResponse per requested range, in the same order as
# the requests appeared.
{ # The response when updating a range of values in a spreadsheet.
- "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
"updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
+ "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
"updatedRows": 42, # The number of rows where at least one cell in the row was updated.
"updatedData": { # Data within a range of the spreadsheet. # The values of the cells after updates were applied.
# This is only included if the request's `includeValuesInResponse` field
@@ -893,15 +888,15 @@
"totalUpdatedColumns": 42, # The total number of columns where at least one cell in the column was
# updated.
"totalUpdatedCells": 42, # The total number of cells updated.
- "totalUpdatedRows": 42, # The total number of rows where at least one cell in the row was updated.
"spreadsheetId": "A String", # The spreadsheet the updates were applied to.
+ "totalUpdatedRows": 42, # The total number of rows where at least one cell in the row was updated.
"totalUpdatedSheets": 42, # The total number of sheets where at least one cell in the sheet was
# updated.
}</pre>
</div>
<div class="method">
- <code class="details" id="batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body, x__xgafv=None)</code>
+ <code class="details" id="batchUpdateByDataFilter">batchUpdateByDataFilter(spreadsheetId, body=None, x__xgafv=None)</code>
<pre>Sets values in one or more ranges of a spreadsheet.
The caller must specify the spreadsheet ID,
a valueInputOption, and one or more
@@ -909,19 +904,20 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to update. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request for updating more than one range of values in a spreadsheet.
- "valueInputOption": "A String", # How the input data should be interpreted.
+ "responseValueRenderOption": "A String", # Determines how values in the response should be rendered.
+ # The default render option is ValueRenderOption.FORMATTED_VALUE.
"data": [ # The new values to apply to the spreadsheet. If more than one range is
- # matched by the specified DataFilter the specified values will be
- # applied to all of those ranges.
+ # matched by the specified DataFilter the specified values are applied to
+ # all of those ranges.
{ # A range of values whose location is specified by a DataFilter.
"values": [ # The data to be written. If the provided values exceed any of the ranges
- # matched by the data filter then the request will fail. If the provided
- # values are less than the matched ranges only the specified values will be
- # written, existing values in the matched ranges will remain unaffected.
+ # matched by the data filter then the request fails. If the provided values
+ # are less than the matched ranges only the specified values are written,
+ # existing values in the matched ranges remain unaffected.
[
"",
],
@@ -955,8 +951,8 @@
"sheetId": 42, # The sheet this span is on.
"dimension": "A String", # The dimension of the span.
},
- "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
"sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
+ "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
},
"metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
# DeveloperMetadata.metadata_value.
@@ -1032,12 +1028,11 @@
"includeValuesInResponse": True or False, # Determines if the update response should include the values
# of the cells that were updated. By default, responses
# do not include the updated values. The `updatedData` field within
- # each of the BatchUpdateValuesResponse.responses will contain
- # the updated values. If the range to write was larger than than the range
- # actually written, the response will include all values in the requested
- # range (excluding trailing empty rows and columns).
- "responseValueRenderOption": "A String", # Determines how values in the response should be rendered.
- # The default render option is ValueRenderOption.FORMATTED_VALUE.
+ # each of the BatchUpdateValuesResponse.responses contains the updated
+ # values. If the range to write was larger than the range actually written,
+ # the response includes all values in the requested range (excluding trailing
+ # empty rows and columns).
+ "valueInputOption": "A String", # How the input data should be interpreted.
"responseDateTimeRenderOption": "A String", # Determines how dates, times, and durations in the response should be
# rendered. This is ignored if response_value_render_option is
# FORMATTED_VALUE.
@@ -1057,8 +1052,8 @@
"responses": [ # The response for each range updated.
{ # The response when updating a range of values by a data filter in a
# spreadsheet.
- "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
"updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
+ "updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
"dataFilter": { # Filter that describes what data should be selected or returned from a # The data filter that selected the range that was updated.
# request.
"developerMetadataLookup": { # Selects DeveloperMetadata that matches all of the specified fields. For # Selects data associated with the developer metadata matching the criteria
@@ -1088,8 +1083,8 @@
"sheetId": 42, # The sheet this span is on.
"dimension": "A String", # The dimension of the span.
},
- "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
"sheetId": 42, # The ID of the sheet when metadata is associated with an entire sheet.
+ "spreadsheet": True or False, # True when metadata is associated with an entire spreadsheet.
},
"metadataValue": "A String", # Limits the selected developer metadata to that which has a matching
# DeveloperMetadata.metadata_value.
@@ -1254,10 +1249,9 @@
The default render option is ValueRenderOption.FORMATTED_VALUE.
majorDimension: string, The major dimension that results should use.
-For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
-then requesting `range=A1:B2,majorDimension=ROWS` will return
-`[[1,2],[3,4]]`,
-whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
+For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then
+requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`,
+whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns
`[[1,3],[2,4]]`.
dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
This is ignored if value_render_option is
@@ -1308,7 +1302,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(spreadsheetId, range, body, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</code>
+ <code class="details" id="update">update(spreadsheetId, range, body=None, valueInputOption=None, x__xgafv=None, responseValueRenderOption=None, includeValuesInResponse=None, responseDateTimeRenderOption=None)</code>
<pre>Sets values in a range of a spreadsheet.
The caller must specify the spreadsheet ID, range, and
a valueInputOption.
@@ -1316,7 +1310,7 @@
Args:
spreadsheetId: string, The ID of the spreadsheet to update. (required)
range: string, The A1 notation of the values to update. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Data within a range of the spreadsheet.
@@ -1364,9 +1358,9 @@
includeValuesInResponse: boolean, Determines if the update response should include the values
of the cells that were updated. By default, responses
do not include the updated values.
-If the range to write was larger than than the range actually written,
-the response will include all values in the requested range (excluding
-trailing empty rows and columns).
+If the range to write was larger than the range actually written, the
+response includes all values in the requested range (excluding trailing
+empty rows and columns).
responseDateTimeRenderOption: string, Determines how dates, times, and durations in the response should be
rendered. This is ignored if response_value_render_option is
FORMATTED_VALUE.
@@ -1377,8 +1371,8 @@
An object of the form:
{ # The response when updating a range of values in a spreadsheet.
- "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
"updatedRange": "A String", # The range (in A1 notation) that updates were applied to.
+ "updatedColumns": 42, # The number of columns where at least one cell in the column was updated.
"updatedRows": 42, # The number of rows where at least one cell in the row was updated.
"updatedData": { # Data within a range of the spreadsheet. # The values of the cells after updates were applied.
# This is only included if the request's `includeValuesInResponse` field