diff --git a/src/Sheets/AddFilterViewRequest.php b/src/Sheets/AddFilterViewRequest.php index ad25114112d..fbefc8acd63 100644 --- a/src/Sheets/AddFilterViewRequest.php +++ b/src/Sheets/AddFilterViewRequest.php @@ -23,8 +23,8 @@ class AddFilterViewRequest extends \Google\Model protected $filterDataType = ''; /** - * The filter to add. The filterViewId field is optional; if one is not set, - * an id will be randomly generated. (It is an error to specify the ID of a + * The filter to add. The filterViewId field is optional. If one is not set, + * an ID will be randomly generated. (It is an error to specify the ID of a * filter that already exists.) * * @param FilterView $filter diff --git a/src/Sheets/BatchClearValuesByDataFilterResponse.php b/src/Sheets/BatchClearValuesByDataFilterResponse.php index 81cf731c121..2255220a71d 100644 --- a/src/Sheets/BatchClearValuesByDataFilterResponse.php +++ b/src/Sheets/BatchClearValuesByDataFilterResponse.php @@ -23,8 +23,8 @@ class BatchClearValuesByDataFilterResponse extends \Google\Collection /** * The ranges that were cleared, in [A1 notation](https://developers.google.co * m/workspace/sheets/api/guides/concepts#cell). 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. + * unbounded range or a range larger than the bounds of the sheet, this is the + * actual ranges that were cleared, bounded to the sheet's limits. * * @var string[] */ @@ -39,8 +39,8 @@ class BatchClearValuesByDataFilterResponse extends \Google\Collection /** * The ranges that were cleared, in [A1 notation](https://developers.google.co * m/workspace/sheets/api/guides/concepts#cell). 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. + * unbounded range or a range larger than the bounds of the sheet, this is the + * actual ranges that were cleared, bounded to the sheet's limits. * * @param string[] $clearedRanges */ diff --git a/src/Sheets/BatchClearValuesResponse.php b/src/Sheets/BatchClearValuesResponse.php index 6515a18a2ea..b78bcae221d 100644 --- a/src/Sheets/BatchClearValuesResponse.php +++ b/src/Sheets/BatchClearValuesResponse.php @@ -22,8 +22,8 @@ class BatchClearValuesResponse extends \Google\Collection protected $collection_key = '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. + * unbounded range or a range larger than the bounds of the sheet, this is the + * actual ranges that were cleared, bounded to the sheet's limits. * * @var string[] */ @@ -37,8 +37,8 @@ class BatchClearValuesResponse extends \Google\Collection /** * 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. + * unbounded range or a range larger than the bounds of the sheet, this is the + * actual ranges that were cleared, bounded to the sheet's limits. * * @param string[] $clearedRanges */ diff --git a/src/Sheets/ClearValuesResponse.php b/src/Sheets/ClearValuesResponse.php index 3ded0bf29ee..59c94b23b22 100644 --- a/src/Sheets/ClearValuesResponse.php +++ b/src/Sheets/ClearValuesResponse.php @@ -21,7 +21,7 @@ class ClearValuesResponse extends \Google\Model { /** * The range (in A1 notation) that was cleared. (If the request was for an - * unbounded range or a ranger larger than the bounds of the sheet, this will + * unbounded range or a range larger than the bounds of the sheet, this will * be the actual range that was cleared, bounded to the sheet's limits.) * * @var string @@ -36,7 +36,7 @@ class ClearValuesResponse extends \Google\Model /** * The range (in A1 notation) that was cleared. (If the request was for an - * unbounded range or a ranger larger than the bounds of the sheet, this will + * unbounded range or a range larger than the bounds of the sheet, this will * be the actual range that was cleared, bounded to the sheet's limits.) * * @param string $clearedRange diff --git a/src/Sheets/DeveloperMetadata.php b/src/Sheets/DeveloperMetadata.php index cc8121f7ada..8fed712ca0a 100644 --- a/src/Sheets/DeveloperMetadata.php +++ b/src/Sheets/DeveloperMetadata.php @@ -57,7 +57,7 @@ class DeveloperMetadata extends \Google\Model */ public $metadataValue; /** - * The metadata visibility. Developer metadata must always have a visibility + * The metadata visibility. Developer metadata must always have visibility * specified. * * @var string @@ -132,7 +132,7 @@ public function getMetadataValue() return $this->metadataValue; } /** - * The metadata visibility. Developer metadata must always have a visibility + * The metadata visibility. Developer metadata must always have visibility * specified. * * Accepted values: DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED, DOCUMENT, diff --git a/src/Sheets/DeveloperMetadataLocation.php b/src/Sheets/DeveloperMetadataLocation.php index f87aca8f0b3..e36bf979cb4 100644 --- a/src/Sheets/DeveloperMetadataLocation.php +++ b/src/Sheets/DeveloperMetadataLocation.php @@ -62,7 +62,7 @@ class DeveloperMetadataLocation extends \Google\Model /** * Represents the row or column when metadata is associated with a dimension. - * The specified DimensionRange must represent a single row or column; it + * The specified DimensionRange must represent a single row or column. It * cannot be unbounded or span multiple rows or columns. * * @param DimensionRange $dimensionRange diff --git a/src/Sheets/DeveloperMetadataLookup.php b/src/Sheets/DeveloperMetadataLookup.php index f8427591dc8..1f9481f43cf 100644 --- a/src/Sheets/DeveloperMetadataLookup.php +++ b/src/Sheets/DeveloperMetadataLookup.php @@ -92,7 +92,7 @@ class DeveloperMetadataLookup extends \Google\Model * associated on rows. If the field is left unspecified, all location types * are considered. This field cannot be specified as SPREADSHEET when the * locationMatchingStrategy is specified as INTERSECTING or when the - * metadataLocation is specified as a non-spreadsheet location: spreadsheet + * metadataLocation is specified as a non-spreadsheet location. Spreadsheet * metadata cannot intersect any other developer metadata location. This field * also must be left unspecified when the locationMatchingStrategy is * specified as EXACT. @@ -163,7 +163,7 @@ public function getLocationMatchingStrategy() * associated on rows. If the field is left unspecified, all location types * are considered. This field cannot be specified as SPREADSHEET when the * locationMatchingStrategy is specified as INTERSECTING or when the - * metadataLocation is specified as a non-spreadsheet location: spreadsheet + * metadataLocation is specified as a non-spreadsheet location. Spreadsheet * metadata cannot intersect any other developer metadata location. This field * also must be left unspecified when the locationMatchingStrategy is * specified as EXACT. diff --git a/src/Sheets/FilterCriteria.php b/src/Sheets/FilterCriteria.php index 1c13d86fa29..9a576430ed8 100644 --- a/src/Sheets/FilterCriteria.php +++ b/src/Sheets/FilterCriteria.php @@ -38,7 +38,7 @@ class FilterCriteria extends \Google\Collection protected $visibleForegroundColorStyleDataType = ''; /** - * A condition that must be true for values to be shown. (This does not + * A condition that must be `true` for values to be shown. (This does not * override hidden_values -- if a value is listed there, it will still be * hidden.) * diff --git a/src/Sheets/FilterView.php b/src/Sheets/FilterView.php index 84e9b5e00ec..ccd8ca32c7b 100644 --- a/src/Sheets/FilterView.php +++ b/src/Sheets/FilterView.php @@ -32,7 +32,7 @@ class FilterView extends \Google\Collection public $filterViewId; /** * The named range this filter view is backed by, if any. When writing, only - * one of range or named_range_id or table_id may be set. + * one of range, named_range_id, or table_id may be set. * * @var string */ @@ -43,7 +43,7 @@ class FilterView extends \Google\Collection protected $sortSpecsDataType = 'array'; /** * The table this filter view is backed by, if any. When writing, only one of - * range or named_range_id or table_id may be set. + * range, named_range_id, or table_id may be set. * * @var string */ @@ -76,9 +76,9 @@ public function getCriteria() return $this->criteria; } /** - * The filter criteria for showing/hiding values per column. Both criteria and - * filter_specs are populated in responses. If both fields are specified in an - * update request, this field takes precedence. + * The filter criteria for showing or hiding values per column. Both criteria + * and filter_specs are populated in responses. If both fields are specified + * in an update request, this field takes precedence. * * @param FilterSpec[] $filterSpecs */ @@ -111,7 +111,7 @@ public function getFilterViewId() } /** * The named range this filter view is backed by, if any. When writing, only - * one of range or named_range_id or table_id may be set. + * one of range, named_range_id, or table_id may be set. * * @param string $namedRangeId */ @@ -127,8 +127,8 @@ public function getNamedRangeId() return $this->namedRangeId; } /** - * The range this filter view covers. When writing, only one of range or - * named_range_id or table_id may be set. + * The range this filter view covers. When writing, only one of range, + * named_range_id, or table_id may be set. * * @param GridRange $range */ @@ -162,7 +162,7 @@ public function getSortSpecs() } /** * The table this filter view is backed by, if any. When writing, only one of - * range or named_range_id or table_id may be set. + * range, named_range_id, or table_id may be set. * * @param string $tableId */ diff --git a/src/Sheets/Resource/Spreadsheets.php b/src/Sheets/Resource/Spreadsheets.php index 2971d003229..94ff2cca4fe 100644 --- a/src/Sheets/Resource/Spreadsheets.php +++ b/src/Sheets/Resource/Spreadsheets.php @@ -111,16 +111,18 @@ public function get($spreadsheetId, $optParams = []) } /** * Returns the spreadsheet at the given ID. The caller must specify the - * spreadsheet ID. This method differs from GetSpreadsheet in that it allows - * selecting which subsets of spreadsheet data to return by specifying a - * dataFilters parameter. Multiple DataFilters can be specified. Specifying one - * or more data filters returns the portions of the spreadsheet that intersect - * ranges matched by any of the filters. By default, data within grids is not - * returned. You can include grid data one of 2 ways: * Specify a [field + * spreadsheet ID. For more information, see [Read, write, and search metadata]( + * https://developers.google.com/workspace/sheets/api/guides/metadata). This + * method differs from GetSpreadsheet in that it allows selecting which subsets + * of spreadsheet data to return by specifying a dataFilters parameter. Multiple + * DataFilters can be specified. Specifying one or more data filters returns the + * portions of the spreadsheet that intersect ranges matched by any of the + * filters. By default, data within grids is not returned. You can include grid + * data in one of two ways: * Specify a [field * mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) - * listing your desired fields using the `fields` URL parameter in HTTP * Set - * the includeGridData parameter to true. If a field mask is set, the - * `includeGridData` parameter is ignored For large spreadsheets, as a best + * listing your desired fields using the `fields` URL parameter in HTTP. * Set + * the includeGridData parameter to `true`. If a field mask is set, the + * `includeGridData` parameter is ignored. For large spreadsheets, as a best * practice, retrieve only the specific spreadsheet fields that you want. * (spreadsheets.getByDataFilter) * diff --git a/src/Sheets/Resource/SpreadsheetsDeveloperMetadata.php b/src/Sheets/Resource/SpreadsheetsDeveloperMetadata.php index ad0a060cf91..334c7a42195 100644 --- a/src/Sheets/Resource/SpreadsheetsDeveloperMetadata.php +++ b/src/Sheets/Resource/SpreadsheetsDeveloperMetadata.php @@ -33,8 +33,9 @@ class SpreadsheetsDeveloperMetadata extends \Google\Service\Resource { /** * Returns the developer metadata with the specified ID. The caller must specify - * the spreadsheet ID and the developer metadata's unique metadataId. - * (developerMetadata.get) + * the spreadsheet ID and the developer metadata's unique metadataId. For more + * information, see [Read, write, and search metadata](https://developers.google + * .com/workspace/sheets/api/guides/metadata). (developerMetadata.get) * * @param string $spreadsheetId The ID of the spreadsheet to retrieve metadata * from. @@ -50,12 +51,13 @@ public function get($spreadsheetId, $metadataId, $optParams = []) return $this->call('get', [$params], DeveloperMetadata::class); } /** - * Returns all developer metadata matching the specified DataFilter. If the - * provided DataFilter represents a DeveloperMetadataLookup object, this will - * return all DeveloperMetadata entries selected by it. If the DataFilter - * represents a location in a spreadsheet, this will return all developer - * metadata associated with locations intersecting that region. - * (developerMetadata.search) + * Returns all developer metadata matching the specified DataFilter. For more + * information, see [Read, write, and search metadata](https://developers.google + * .com/workspace/sheets/api/guides/metadata). If the provided DataFilter + * represents a DeveloperMetadataLookup object, this will return all + * DeveloperMetadata entries selected by it. If the DataFilter represents a + * location in a spreadsheet, this will return all developer metadata associated + * with locations intersecting that region. (developerMetadata.search) * * @param string $spreadsheetId The ID of the spreadsheet to retrieve metadata * from. diff --git a/src/Sheets/Resource/SpreadsheetsValues.php b/src/Sheets/Resource/SpreadsheetsValues.php index 2cca6cd39ae..0bf245f15f5 100644 --- a/src/Sheets/Resource/SpreadsheetsValues.php +++ b/src/Sheets/Resource/SpreadsheetsValues.php @@ -103,11 +103,13 @@ public function batchClear($spreadsheetId, BatchClearValuesRequest $postBody, $o return $this->call('batchClear', [$params], BatchClearValuesResponse::class); } /** - * 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 filters will be cleared. Only values are cleared -- all - * other properties of the cell (such as formatting, data validation, etc..) are - * kept. (values.batchClearByDataFilter) + * Clears one or more ranges of values from a spreadsheet. For more information, + * see [Read, write, and search metadata](https://developers.google.com/workspac + * e/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and + * one or more DataFilters. Ranges matching any of the specified data filters + * will be cleared. Only values are cleared -- all other properties of the cell + * (such as formatting, data validation, etc.) are kept. + * (values.batchClearByDataFilter) * * @param string $spreadsheetId The ID of the spreadsheet to update. * @param BatchClearValuesByDataFilterRequest $postBody @@ -152,9 +154,10 @@ public function batchGet($spreadsheetId, $optParams = []) } /** * 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 the request will be returned. - * (values.batchGetByDataFilter) + * For more information, see [Read, write, and search metadata](https://develope + * rs.google.com/workspace/sheets/api/guides/metadata). The caller must specify + * the spreadsheet ID and one or more DataFilters. Ranges that match any of the + * data filters in the request will be returned. (values.batchGetByDataFilter) * * @param string $spreadsheetId The ID of the spreadsheet to retrieve data from. * @param BatchGetValuesByDataFilterRequest $postBody @@ -186,9 +189,11 @@ public function batchUpdate($spreadsheetId, BatchUpdateValuesRequest $postBody, return $this->call('batchUpdate', [$params], BatchUpdateValuesResponse::class); } /** - * Sets values in one or more ranges of a spreadsheet. The caller must specify - * the spreadsheet ID, a valueInputOption, and one or more - * DataFilterValueRanges. (values.batchUpdateByDataFilter) + * Sets values in one or more ranges of a spreadsheet. For more information, see + * [Read, write, and search metadata](https://developers.google.com/workspace/sh + * eets/api/guides/metadata). The caller must specify the spreadsheet ID, a + * valueInputOption, and one or more DataFilterValueRanges. + * (values.batchUpdateByDataFilter) * * @param string $spreadsheetId The ID of the spreadsheet to update. * @param BatchUpdateValuesByDataFilterRequest $postBody