Skip to main content

@swamp/gcp/sheets

v2026.04.23.1

Google Cloud sheets infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudsheetscloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/sheets

@swamp/gcp/sheets/spreadsheetsv2026.04.23.1spreadsheets.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
dataSourcesarray
developerMetadata?arrayThe developer metadata associated with a spreadsheet.
namedRangesarray
properties?objectProperties of a spreadsheet.
sheets?arrayThe default filter associated with a sheet. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).
charts?arrayThe specifications of every chart on this sheet.
columnGroups?arrayAll column groups on this sheet, ordered by increasing range start index, then by group depth.
conditionalFormats?arrayThe conditional format rules in this sheet.
data?arrayData in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D). For a DATA_SOURCE sheet, you can not request a spe
developerMetadata?arrayThe developer metadata associated with a sheet.
filterViewsarray
merges?arrayThe ranges that are merged together.
properties?objectProperties of a sheet.
protectedRangesarray
rowGroups?arrayAll row groups on this sheet, ordered by increasing range start index, then by group depth.
slicersarray
tablesarray
spreadsheetId?stringThe ID of the spreadsheet. This field is read-only.
spreadsheetUrl?stringThe url of the spreadsheet. This field is read-only.
createCreate a spreadsheets
getGet a spreadsheets
ArgumentTypeDescription
identifierstringThe name of the spreadsheets
syncSync spreadsheets state from GCP
batch_updatebatch update
ArgumentTypeDescription
includeSpreadsheetInResponse?any
requests?any
responseIncludeGridData?any
responseRanges?any
get_by_data_filterget by data filter
ArgumentTypeDescription
dataFilters?any
excludeTablesInBandedRanges?any
includeGridData?any

Resources

state(infinite)— Resource that represents a spreadsheet.
@swamp/gcp/sheets/spreadsheets-developermetadatav2026.04.23.1spreadsheets_developermetadata.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a developerMetadata
ArgumentTypeDescription
identifierstringThe name of the developerMetadata
syncSync developerMetadata state from GCP
searchsearch
ArgumentTypeDescription
dataFilters?any

Resources

state(infinite)— Developer metadata associated with a location or object in a spreadsheet. For...
@swamp/gcp/sheets/spreadsheets-valuesv2026.04.23.1spreadsheets_values.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
majorDimension?enumThe major dimension of the values. For output, 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 `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set,
range?stringThe range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
values?arrayThe data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
getGet a values
ArgumentTypeDescription
identifierstringThe name of the values
updateUpdate values attributes
syncSync values state from GCP
appendappend
ArgumentTypeDescription
majorDimension?any
range?any
values?any
batch_clearbatch clear
ArgumentTypeDescription
ranges?any
batch_clear_by_data_filterbatch clear by data filter
ArgumentTypeDescription
dataFilters?any
batch_getbatch get
batch_get_by_data_filterbatch get by data filter
ArgumentTypeDescription
dataFilters?any
dateTimeRenderOption?any
majorDimension?any
valueRenderOption?any
batch_updatebatch update
ArgumentTypeDescription
data?any
includeValuesInResponse?any
responseDateTimeRenderOption?any
responseValueRenderOption?any
valueInputOption?any
batch_update_by_data_filterbatch update by data filter
ArgumentTypeDescription
data?any
includeValuesInResponse?any
responseDateTimeRenderOption?any
responseValueRenderOption?any
valueInputOption?any
clearclear
ArgumentTypeDescription
ranges?any

Resources

state(infinite)— Data within a range of the spreadsheet.