> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# google-sheets
> Spreadsheet read, write, and formatting
**Server path:** `/google-sheets` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`google-sheets_add_column`](#google-sheets_add_column) | Adds a column to a sheet. If columnIndex is provided, inserts at that 0-based position; otherwise appends a column at the end. |
| [`google-sheets_append_values`](#google-sheets_append_values) | 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 the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. |
| [`google-sheets_batch_clear_values`](#google-sheets_batch_clear_values) | 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 formatting and data validation) are kept. |
| [`google-sheets_batch_get_values`](#google-sheets_batch_get_values) | Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. |
| [`google-sheets_batch_update`](#google-sheets_batch_update) | Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes. |
| [`google-sheets_batch_update_values`](#google-sheets_batch_update_values) | Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. |
| [`google-sheets_clear_cell`](#google-sheets_clear_cell) | Clears the value of a single cell in a spreadsheet. Only the value is cleared — formatting, data validation, and other properties are kept. |
| [`google-sheets_clear_rows`](#google-sheets_clear_rows) | Clear content from a range of rows in a spreadsheet. Only clears values, not formatting. |
| [`google-sheets_clear_values`](#google-sheets_clear_values) | Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. |
| [`google-sheets_copy_sheet_to`](#google-sheets_copy_sheet_to) | Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet. |
| [`google-sheets_create_sheet`](#google-sheets_create_sheet) | Creates a new sheet (tab) in a spreadsheet with the given title. |
| [`google-sheets_create_spreadsheet`](#google-sheets_create_spreadsheet) | Creates a spreadsheet, returning the newly created spreadsheet. |
| [`google-sheets_delete_sheet`](#google-sheets_delete_sheet) | Deletes a sheet (tab) from a spreadsheet by its name. |
| [`google-sheets_delete_spreadsheet`](#google-sheets_delete_spreadsheet) | Permanently deletes a spreadsheet using the Google Drive API. |
| [`google-sheets_edit_cell`](#google-sheets_edit_cell) | Edits the value of a single cell in a spreadsheet. Specify the cell address in A1 notation (e.g. "A1", "B5"). |
| [`google-sheets_edit_column`](#google-sheets_edit_column) | Edits values in a column of a spreadsheet. Specify the column letter, starting row, and an array of values to write down the column. |
| [`google-sheets_edit_row`](#google-sheets_edit_row) | Edits an entire row in a spreadsheet. Specify the 1-based row index and an array of values to set across the row. |
| [`google-sheets_find_row`](#google-sheets_find_row) | Searches a column for rows matching a given value. Returns the row indices and optionally the full row data for each match. |
| [`google-sheets_get_sheet_row_column_count`](#google-sheets_get_sheet_row_column_count) | Returns the total row and column count for a sheet. If sheetName is not provided, returns counts for the first sheet. |
| [`google-sheets_get_spreadsheet`](#google-sheets_get_spreadsheet) | Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: \* Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP \* Set the includeGridData URL 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. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges. |
| [`google-sheets_get_values`](#google-sheets_get_values) | Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. |
| [`google-sheets_insert_column`](#google-sheets_insert_column) | Inserts a column into a sheet. If columnLetter is provided (e.g. "A", "B"), inserts at that position and optionally fills with values. If no columnLetter and values are provided, appends a column with those values. If neither columnLetter nor values are provided, appends an empty column. |
| [`google-sheets_insert_comment`](#google-sheets_insert_comment) | Insert a comment on a specific cell in a spreadsheet. Uses the Google Drive API comments endpoint. |
| [`google-sheets_insert_row`](#google-sheets_insert_row) | Inserts a row into a sheet. If rowIndex (1-based) is provided, inserts at that position and optionally fills with values. If no rowIndex and values are provided, appends a row with those values. If neither rowIndex nor values are provided, appends an empty row. |
| [`google-sheets_list_sheets`](#google-sheets_list_sheets) | Lists all sheets (tabs) in a spreadsheet, returning each sheet's ID, title, and index. |
| [`google-sheets_read_col_headings`](#google-sheets_read_col_headings) | Reads the column headings (first row) of a sheet. Returns an array of heading values from row 1. |
| [`google-sheets_read_columns`](#google-sheets_read_columns) | Reads entire columns from a spreadsheet. Specify column letters (e.g. \["A", "C", "E"]) to read specific columns, or omit to read all columns. |
| [`google-sheets_read_rows`](#google-sheets_read_rows) | Reads rows from a spreadsheet. By default reads from row 2 (skipping the header row) to the end of the sheet. Use startRow and endRow to control the range. |
| [`google-sheets_rename_sheet`](#google-sheets_rename_sheet) | Renames a sheet (tab) in a spreadsheet. If sheetName is not provided, renames the first sheet. |
| [`google-sheets_rename_spreadsheet`](#google-sheets_rename_spreadsheet) | Renames a spreadsheet (changes its title). |
| [`google-sheets_update_formatting`](#google-sheets_update_formatting) | Updates the formatting of a range of cells in a spreadsheet. Supports bold, italic, text color, and background color. |
| [`google-sheets_update_values`](#google-sheets_update_values) | Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. |
***
## google-sheets\_add\_column
Adds a column to a sheet. If columnIndex is provided, inserts at that 0-based position; otherwise appends a column at the end.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | Yes | — | The name of the sheet to add the column to. |
| `columnIndex` | integer | No | — | The 0-based index at which to insert the column. If omitted, a column is appended at the end. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to add the column to."
},
"columnIndex": {
"type": "integer",
"description": "The 0-based index at which to insert the column. If omitted, a column is appended at the end."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName"
]
}
```
***
## google-sheets\_append\_values
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 the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `range` | string | Yes | — | The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. |
| `includeValuesInResponse` | boolean | No | — | Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. |
| `insertDataOption` | string | No | — | How the input data should be inserted. |
| `responseDateTimeRenderOption` | string | No | — | 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 SERIAL\_NUMBER. |
| `responseValueRenderOption` | string | No | — | Determines how values in the response should be rendered. The default render option is FORMATTED\_VALUE. |
| `valueInputOption` | string | Yes | — | How the input data should be interpreted. |
| `majorDimension` | string | No | — | The 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, it defaults to ROWS. |
| `values` | any\[]\[] | No | — | The 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"range": {
"type": "string",
"description": "The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table."
},
"includeValuesInResponse": {
"type": "boolean",
"description": "Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values."
},
"insertDataOption": {
"type": "string",
"description": "How the input data should be inserted.",
"enum": [
"OVERWRITE",
"INSERT_ROWS"
]
},
"responseDateTimeRenderOption": {
"type": "string",
"description": "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 SERIAL_NUMBER.",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
]
},
"responseValueRenderOption": {
"type": "string",
"description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
]
},
"valueInputOption": {
"type": "string",
"description": "How the input data should be interpreted.",
"enum": [
"INPUT_VALUE_OPTION_UNSPECIFIED",
"RAW",
"USER_ENTERED"
]
},
"majorDimension": {
"type": "string",
"description": "The 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, it defaults to ROWS.",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
]
},
"values": {
"type": "array",
"items": {
"type": "array"
},
"description": "The 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."
}
},
"required": [
"PCID",
"spreadsheetId",
"range",
"valueInputOption"
]
}
```
***
## google-sheets\_batch\_clear\_values
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 formatting and data validation) are kept.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `ranges` | string\[] | No | — | The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"ranges": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell)."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_batch\_get\_values
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to retrieve data from. |
| `dateTimeRenderOption` | string | No | — | How dates, times, and durations should be represented in the output. This is ignored if value\_render\_option is FORMATTED\_VALUE. The default dateTime render option is SERIAL\_NUMBER. |
| `majorDimension` | string | No | — | The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=["A1:B2"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. |
| `ranges` | string\[] | No | — | The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from. |
| `valueRenderOption` | string | No | — | How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED\_VALUE. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to retrieve data from."
},
"dateTimeRenderOption": {
"type": "string",
"description": "How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
]
},
"majorDimension": {
"type": "string",
"description": "The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
]
},
"ranges": {
"type": "array",
"items": {
"type": "string"
},
"description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from."
},
"valueRenderOption": {
"type": "string",
"description": "How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
]
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_batch\_update
Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `spreadsheetId` | string | Yes | — | The spreadsheet to apply the updates to. |
| `includeSpreadsheetInResponse` | boolean | No | — | Determines if the update response should include the spreadsheet resource. |
| `requests` | object\[] | No | — | A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied. |
| `responseIncludeGridData` | boolean | No | — | True if grid data should be returned. Meaningful only if include\_spreadsheet\_in\_response is 'true'. This parameter is ignored if a field mask was set in the request. |
| `responseRanges` | string\[] | No | — | Limits the ranges included in the response spreadsheet. Meaningful only if include\_spreadsheet\_in\_response is 'true'. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The spreadsheet to apply the updates to."
},
"includeSpreadsheetInResponse": {
"type": "boolean",
"description": "Determines if the update response should include the spreadsheet resource."
},
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"addBanding": {
"type": "object",
"description": "Adds a new banded range to the spreadsheet."
},
"addChart": {
"type": "object",
"description": "Adds a chart to a sheet in the spreadsheet."
},
"addConditionalFormatRule": {
"type": "object",
"description": "Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented."
},
"addDataSource": {
"type": "object",
"description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope."
},
"addDimensionGroup": {
"type": "object",
"description": "Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2]."
},
"addFilterView": {
"type": "object",
"description": "Adds a filter view."
},
"addNamedRange": {
"type": "object",
"description": "Adds a named range to the spreadsheet."
},
"addProtectedRange": {
"type": "object",
"description": "Adds a new protected range."
},
"addSheet": {
"type": "object",
"description": "Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet."
},
"addSlicer": {
"type": "object",
"description": "Adds a slicer to a sheet in the spreadsheet."
},
"appendCells": {
"type": "object",
"description": "Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary."
},
"appendDimension": {
"type": "object",
"description": "Appends rows or columns to the end of a sheet."
},
"autoFill": {
"type": "object",
"description": "Fills in more data based on existing data."
},
"autoResizeDimensions": {
"type": "object",
"description": "Automatically resizes one or more dimensions based on the contents of the cells in that dimension."
},
"clearBasicFilter": {
"type": "object",
"description": "Clears the basic filter, if any exists on the sheet."
},
"copyPaste": {
"type": "object",
"description": "Copies data from the source to the destination."
},
"createDeveloperMetadata": {
"type": "object",
"description": "A request to create developer metadata."
},
"cutPaste": {
"type": "object",
"description": "Moves data from the source to the destination."
},
"deleteBanding": {
"type": "object",
"description": "Removes the banded range with the given ID from the spreadsheet."
},
"deleteConditionalFormatRule": {
"type": "object",
"description": "Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented."
},
"deleteDataSource": {
"type": "object",
"description": "Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects."
},
"deleteDeveloperMetadata": {
"type": "object",
"description": "A request to delete developer metadata."
},
"deleteDimension": {
"type": "object",
"description": "Deletes the dimensions from the sheet."
},
"deleteDimensionGroup": {
"type": "object",
"description": "Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C."
},
"deleteDuplicates": {
"type": "object",
"description": "Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range."
},
"deleteEmbeddedObject": {
"type": "object",
"description": "Deletes the embedded object with the given ID."
},
"deleteFilterView": {
"type": "object",
"description": "Deletes a particular filter view."
},
"deleteNamedRange": {
"type": "object",
"description": "Removes the named range with the given ID from the spreadsheet."
},
"deleteProtectedRange": {
"type": "object",
"description": "Deletes the protected range with the given ID."
},
"deleteRange": {
"type": "object",
"description": "Deletes a range of cells, shifting other cells into the deleted area."
},
"deleteSheet": {
"type": "object",
"description": "Deletes the requested sheet."
},
"duplicateFilterView": {
"type": "object",
"description": "Duplicates a particular filter view."
},
"duplicateSheet": {
"type": "object",
"description": "Duplicates the contents of a sheet."
},
"findReplace": {
"type": "object",
"description": "Finds and replaces data in cells over a range, sheet, or all sheets."
},
"insertDimension": {
"type": "object",
"description": "Inserts rows or columns in a sheet at a particular index."
},
"insertRange": {
"type": "object",
"description": "Inserts cells into a range, shifting the existing cells over or down."
},
"mergeCells": {
"type": "object",
"description": "Merges all cells in the range."
},
"moveDimension": {
"type": "object",
"description": "Moves one or more rows or columns."
},
"pasteData": {
"type": "object",
"description": "Inserts data into the spreadsheet starting at the specified coordinate."
},
"randomizeRange": {
"type": "object",
"description": "Randomizes the order of the rows in a range."
},
"refreshDataSource": {
"type": "object",
"description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly."
},
"repeatCell": {
"type": "object",
"description": "Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing."
},
"setBasicFilter": {
"type": "object",
"description": "Sets the basic filter associated with a sheet."
},
"setDataValidation": {
"type": "object",
"description": "Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified."
},
"sortRange": {
"type": "object",
"description": "Sorts data in rows based on a sort order per column."
},
"textToColumns": {
"type": "object",
"description": "Splits a column of text into multiple columns, based on a delimiter in each cell."
},
"trimWhitespace": {
"type": "object",
"description": "Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. This request removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space. If the resulting trimmed text starts with a '+' or '=' character, the text remains as a string value and isn't interpreted as a formula."
},
"unmergeCells": {
"type": "object",
"description": "Unmerges cells in the given range."
},
"updateBanding": {
"type": "object",
"description": "Updates properties of the supplied banded range."
},
"updateBorders": {
"type": "object",
"description": "Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE."
},
"updateCells": {
"type": "object",
"description": "Updates all cells in a range with new data."
},
"updateChartSpec": {
"type": "object",
"description": "Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)"
},
"updateConditionalFormatRule": {
"type": "object",
"description": "Updates a conditional format rule at the given index, or moves a conditional format rule to another index."
},
"updateDataSource": {
"type": "object",
"description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope."
},
"updateDeveloperMetadata": {
"type": "object",
"description": "A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update."
},
"updateDimensionGroup": {
"type": "object",
"description": "Updates the state of the specified group."
},
"updateDimensionProperties": {
"type": "object",
"description": "Updates properties of dimensions within the specified range."
},
"updateEmbeddedObjectBorder": {
"type": "object",
"description": "Updates an embedded object's border property."
},
"updateEmbeddedObjectPosition": {
"type": "object",
"description": "Update an embedded object's position (such as a moving or resizing a chart or image)."
},
"updateFilterView": {
"type": "object",
"description": "Updates properties of the filter view."
},
"updateNamedRange": {
"type": "object",
"description": "Updates properties of the named range with the specified namedRangeId."
},
"updateProtectedRange": {
"type": "object",
"description": "Updates an existing protected range with the specified protectedRangeId."
},
"updateSheetProperties": {
"type": "object",
"description": "Updates properties of the sheet with the specified sheetId."
},
"updateSlicerSpec": {
"type": "object",
"description": "Updates a slicer's specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest."
},
"updateSpreadsheetProperties": {
"type": "object",
"description": "Updates properties of a spreadsheet."
}
}
},
"description": "A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied."
},
"responseIncludeGridData": {
"type": "boolean",
"description": "True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request."
},
"responseRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_batch\_update\_values
Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `data` | object\[] | No | — | The new values to apply to the spreadsheet. |
| `includeValuesInResponse` | boolean | No | — | 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). |
| `responseDateTimeRenderOption` | string | No | — | 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 SERIAL\_NUMBER. |
| `responseValueRenderOption` | string | No | — | Determines how values in the response should be rendered. The default render option is FORMATTED\_VALUE. |
| `valueInputOption` | string | No | — | How the input data should be interpreted. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"majorDimension": {
"type": "string",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
],
"description": "The 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, it defaults to ROWS."
},
"range": {
"type": "string",
"description": "The range the values cover, in [A1 notation](/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": {
"type": "array",
"items": {
"type": "array"
},
"description": "The 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."
}
}
},
"description": "The new values to apply to the spreadsheet."
},
"includeValuesInResponse": {
"type": "boolean",
"description": "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)."
},
"responseDateTimeRenderOption": {
"type": "string",
"description": "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 SERIAL_NUMBER.",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
]
},
"responseValueRenderOption": {
"type": "string",
"description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
]
},
"valueInputOption": {
"type": "string",
"description": "How the input data should be interpreted.",
"enum": [
"INPUT_VALUE_OPTION_UNSPECIFIED",
"RAW",
"USER_ENTERED"
]
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_clear\_cell
Clears the value of a single cell in a spreadsheet. Only the value is cleared — formatting, data validation, and other properties are kept.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `sheetName` | string | Yes | — | The name of the sheet containing the cell. |
| `cell` | string | Yes | — | The cell address in A1 notation (e.g. "A1", "B5"). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet containing the cell."
},
"cell": {
"type": "string",
"description": "The cell address in A1 notation (e.g. \"A1\", \"B5\")."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"cell"
]
}
```
***
## google-sheets\_clear\_rows
Clear content from a range of rows in a spreadsheet. Only clears values, not formatting.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | Yes | — | Name of the worksheet. |
| `startRow` | integer | Yes | — | Starting row number (1-based). |
| `endRow` | integer | Yes | — | Ending row number (1-based, inclusive). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "Name of the worksheet."
},
"startRow": {
"type": "integer",
"description": "Starting row number (1-based)."
},
"endRow": {
"type": "integer",
"description": "Ending row number (1-based, inclusive)."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"startRow",
"endRow"
]
}
```
***
## google-sheets\_clear\_values
Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `range` | string | Yes | — | The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"range": {
"type": "string",
"description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear."
}
},
"required": [
"PCID",
"spreadsheetId",
"range"
]
}
```
***
## google-sheets\_copy\_sheet\_to
Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet containing the sheet to copy. |
| `sheetId` | integer | Yes | — | The ID of the sheet to copy. |
| `destinationSpreadsheetId` | string | No | — | The ID of the spreadsheet to copy the sheet to. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet containing the sheet to copy."
},
"sheetId": {
"type": "integer",
"description": "The ID of the sheet to copy."
},
"destinationSpreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to copy the sheet to."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetId"
]
}
```
***
## google-sheets\_create\_sheet
Creates a new sheet (tab) in a spreadsheet with the given title.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `title` | string | Yes | — | The title for the new sheet. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"title": {
"type": "string",
"description": "The title for the new sheet."
}
},
"required": [
"PCID",
"spreadsheetId",
"title"
]
}
```
***
## google-sheets\_create\_spreadsheet
Creates a spreadsheet, returning the newly created spreadsheet.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | --------------------------------------------------------------- |
| `dataSources` | object\[] | No | — | A list of external data sources connected with the spreadsheet. |
| `dataSourceSchedules` | object\[] | No | — | Output only. A list of data source refresh schedules. |
| `developerMetadata` | object\[] | No | — | The developer metadata associated with a spreadsheet. |
| `namedRanges` | object\[] | No | — | The named ranges defined in a spreadsheet. |
| `properties` | object | No | — | Properties of a spreadsheet. |
| `sheets` | object\[] | No | — | The sheets that are part of a spreadsheet. |
| `spreadsheetId` | string | No | — | The ID of the spreadsheet. This field is read-only. |
| `spreadsheetUrl` | string | No | — | The url of the spreadsheet. This field is read-only. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"calculatedColumns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"formula": {
"type": "string",
"description": "The formula of the calculated column."
},
"reference": {
"type": "object",
"description": "An unique identifier that references a data source column."
}
}
},
"description": "All calculated columns in the data source."
},
"dataSourceId": {
"type": "string",
"description": "The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365."
},
"sheetId": {
"type": "integer",
"format": "int32",
"description": "The ID of the Sheet connected with the data source. The field cannot be changed once set. When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated."
},
"spec": {
"type": "object",
"description": "This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source."
}
}
},
"description": "A list of external data sources connected with the spreadsheet."
},
"dataSourceSchedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dailySchedule": {
"type": "object",
"description": "A schedule for data to refresh every day in a given time interval."
},
"enabled": {
"type": "boolean",
"description": "True if the refresh schedule is enabled, or false otherwise."
},
"monthlySchedule": {
"type": "object",
"description": "A monthly schedule for data to refresh on specific days in the month in a given time interval."
},
"nextRun": {
"type": "object",
"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time."
},
"refreshScope": {
"type": "string",
"enum": [
"DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED",
"ALL_DATA_SOURCES"
],
"description": "The scope of the refresh. Must be ALL_DATA_SOURCES."
},
"weeklySchedule": {
"type": "object",
"description": "A weekly schedule for data to refresh on specific days in a given time interval."
}
}
},
"description": "Output only. A list of data source refresh schedules."
},
"developerMetadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location": {
"type": "object",
"description": "A location where metadata may be associated in a spreadsheet."
},
"metadataId": {
"type": "integer",
"format": "int32",
"description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive."
},
"metadataKey": {
"type": "string",
"description": "The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified."
},
"metadataValue": {
"type": "string",
"description": "Data associated with the metadata's key."
},
"visibility": {
"type": "string",
"enum": [
"DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
"DOCUMENT",
"PROJECT"
],
"description": "The metadata visibility. Developer metadata must always have a visibility specified."
}
}
},
"description": "The developer metadata associated with a spreadsheet."
},
"namedRanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the named range."
},
"namedRangeId": {
"type": "string",
"description": "The ID of the named range."
},
"range": {
"type": "object",
"description": "A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`."
}
}
},
"description": "The named ranges defined in a spreadsheet."
},
"properties": {
"type": "object",
"description": "Properties of a spreadsheet.",
"properties": {
"autoRecalc": {
"type": "string",
"description": "The amount of time to wait before volatile functions are recalculated.",
"enum": [
"RECALCULATION_INTERVAL_UNSPECIFIED",
"ON_CHANGE",
"MINUTE",
"HOUR"
]
},
"defaultFormat": {
"type": "object",
"description": "The format of a cell."
},
"iterativeCalculationSettings": {
"type": "object",
"description": "Settings to control how circular dependencies are resolved with iterative calculation."
},
"locale": {
"type": "string",
"description": "The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported."
},
"spreadsheetTheme": {
"type": "object",
"description": "Represents spreadsheet theme"
},
"timeZone": {
"type": "string",
"description": "The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`."
},
"title": {
"type": "string",
"description": "The title of the spreadsheet."
}
}
},
"sheets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bandedRanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bandedRangeId": {
"type": "integer",
"description": "The ID of the banded range."
},
"columnProperties": {
"type": "object",
"description": "Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set."
},
"range": {
"type": "object",
"description": "A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`."
},
"rowProperties": {
"type": "object",
"description": "Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set."
}
}
},
"description": "The banded (alternating colors) ranges on this sheet."
},
"basicFilter": {
"type": "object",
"description": "The default filter associated with a sheet."
},
"charts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"border": {
"type": "object",
"description": "A border along an embedded object."
},
"chartId": {
"type": "integer",
"description": "The ID of the chart."
},
"position": {
"type": "object",
"description": "The position of an embedded object such as a chart."
},
"spec": {
"type": "object",
"description": "The specifications of a chart."
}
}
},
"description": "The specifications of every chart on this sheet."
},
"columnGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collapsed": {
"type": "boolean",
"description": "This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false."
},
"depth": {
"type": "integer",
"description": "The depth of the group, representing how many groups have a range that wholly contains the range of this group."
},
"range": {
"type": "object",
"description": "A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side."
}
}
},
"description": "All column groups on this sheet, ordered by increasing range start index, then by group depth."
},
"conditionalFormats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"booleanRule": {
"type": "object",
"description": "A rule that may or may not match, depending on the condition."
},
"gradientRule": {
"type": "object",
"description": "A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points."
},
"ranges": {
"type": "array",
"description": "The ranges that are formatted if the condition is true. All the ranges must be on the same grid."
}
}
},
"description": "The conditional format rules in this sheet."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"columnMetadata": {
"type": "array",
"description": "Metadata about the requested columns in the grid, starting with the column in start_column."
},
"rowData": {
"type": "array",
"description": "The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column."
},
"rowMetadata": {
"type": "array",
"description": "Metadata about the requested rows in the grid, starting with the row in start_row."
},
"startColumn": {
"type": "integer",
"description": "The first column this GridData refers to, zero-based."
},
"startRow": {
"type": "integer",
"description": "The first row this GridData refers to, zero-based."
}
}
},
"description": "Data 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 specific range, the GridData contains all the values."
},
"developerMetadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location": {
"type": "object",
"description": "A location where metadata may be associated in a spreadsheet."
},
"metadataId": {
"type": "integer",
"description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive."
},
"metadataKey": {
"type": "string",
"description": "The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified."
},
"metadataValue": {
"type": "string",
"description": "Data associated with the metadata's key."
},
"visibility": {
"type": "string",
"description": "The metadata visibility. Developer metadata must always have a visibility specified."
}
}
},
"description": "The developer metadata associated with a sheet."
},
"filterViews": {
"type": "array",
"items": {
"type": "object",
"properties": {
"criteria": {
"type": "object",
"description": "The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs."
},
"filterSpecs": {
"type": "array",
"description": "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."
},
"filterViewId": {
"type": "integer",
"description": "The ID of the filter view."
},
"namedRangeId": {
"type": "string",
"description": "The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set."
},
"range": {
"type": "object",
"description": "A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`."
},
"sortSpecs": {
"type": "array",
"description": "The sort order per column. Later specifications are used when values are equal in the earlier specifications."
},
"title": {
"type": "string",
"description": "The name of the filter view."
}
}
},
"description": "The filter views in this sheet."
},
"merges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endColumnIndex": {
"type": "integer",
"description": "The end column (exclusive) of the range, or not set if unbounded."
},
"endRowIndex": {
"type": "integer",
"description": "The end row (exclusive) of the range, or not set if unbounded."
},
"sheetId": {
"type": "integer",
"description": "The sheet this range is on."
},
"startColumnIndex": {
"type": "integer",
"description": "The start column (inclusive) of the range, or not set if unbounded."
},
"startRowIndex": {
"type": "integer",
"description": "The start row (inclusive) of the range, or not set if unbounded."
}
}
},
"description": "The ranges that are merged together."
},
"properties": {
"type": "object",
"description": "Properties of a sheet."
},
"protectedRanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description of this protected range."
},
"editors": {
"type": "object",
"description": "The editors of a protected range."
},
"namedRangeId": {
"type": "string",
"description": "The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set."
},
"protectedRangeId": {
"type": "integer",
"description": "The ID of the protected range. This field is read-only."
},
"range": {
"type": "object",
"description": "A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`."
},
"requestingUserCanEdit": {
"type": "boolean",
"description": "True if the user who requested this protected range can edit the protected area. This field is read-only."
},
"unprotectedRanges": {
"type": "array",
"description": "The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets."
},
"warningOnly": {
"type": "boolean",
"description": "True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document."
}
}
},
"description": "The protected ranges in this sheet."
},
"rowGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collapsed": {
"type": "boolean",
"description": "This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false."
},
"depth": {
"type": "integer",
"description": "The depth of the group, representing how many groups have a range that wholly contains the range of this group."
},
"range": {
"type": "object",
"description": "A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side."
}
}
},
"description": "All row groups on this sheet, ordered by increasing range start index, then by group depth."
},
"slicers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "object",
"description": "The position of an embedded object such as a chart."
},
"slicerId": {
"type": "integer",
"description": "The ID of the slicer."
},
"spec": {
"type": "object",
"description": "The specifications of a slicer."
}
}
},
"description": "The slicers on this sheet."
}
}
},
"description": "The sheets that are part of a spreadsheet."
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet. This field is read-only."
},
"spreadsheetUrl": {
"type": "string",
"description": "The url of the spreadsheet. This field is read-only."
}
},
"required": [
"PCID"
]
}
```
***
## google-sheets\_delete\_sheet
Deletes a sheet (tab) from a spreadsheet by its name.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | Yes | — | The name (title) of the sheet to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "The name (title) of the sheet to delete."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName"
]
}
```
***
## google-sheets\_delete\_spreadsheet
Permanently deletes a spreadsheet using the Google Drive API.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------ |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to delete."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_edit\_cell
Edits the value of a single cell in a spreadsheet. Specify the cell address in A1 notation (e.g. "A1", "B5").
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `sheetName` | string | Yes | — | The name of the sheet to update. |
| `cellAddress` | string | Yes | — | The cell address in A1 notation (e.g. "A1", "B5"). |
| `value` | string | Yes | — | The value to set in the cell. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to update."
},
"cellAddress": {
"type": "string",
"description": "The cell address in A1 notation (e.g. \"A1\", \"B5\")."
},
"value": {
"type": "string",
"description": "The value to set in the cell."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"cellAddress",
"value"
]
}
```
***
## google-sheets\_edit\_column
Edits values in a column of a spreadsheet. Specify the column letter, starting row, and an array of values to write down the column.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ---------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `sheetName` | string | Yes | — | The name of the sheet to update. |
| `columnLetter` | string | Yes | — | The column letter to edit (e.g. "A", "B", "AA"). |
| `values` | string\[] | Yes | — | Array of values to write down the column starting from startRow. |
| `startRow` | number | No | — | 1-based row number to start writing from. Defaults to 1. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to update."
},
"columnLetter": {
"type": "string",
"description": "The column letter to edit (e.g. \"A\", \"B\", \"AA\")."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of values to write down the column starting from startRow."
},
"startRow": {
"type": "number",
"description": "1-based row number to start writing from. Defaults to 1."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"columnLetter",
"values"
]
}
```
***
## google-sheets\_edit\_row
Edits an entire row in a spreadsheet. Specify the 1-based row index and an array of values to set across the row.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `sheetName` | string | Yes | — | The name of the sheet to update. |
| `rowIndex` | number | Yes | — | The 1-based row number to edit. |
| `values` | string\[] | Yes | — | Array of values to set across the row, starting from column A. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to update."
},
"rowIndex": {
"type": "number",
"description": "The 1-based row number to edit."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of values to set across the row, starting from column A."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"rowIndex",
"values"
]
}
```
***
## google-sheets\_find\_row
Searches a column for rows matching a given value. Returns the row indices and optionally the full row data for each match.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to search. |
| `sheetName` | string | Yes | — | The name of the sheet to search in. |
| `column` | string | Yes | — | The column letter to search (e.g. "A", "B"). |
| `value` | string | Yes | — | The value to search for in the specified column. |
| `exportRow` | boolean | No | — | If true, also returns the full row data for each match. Defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to search."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to search in."
},
"column": {
"type": "string",
"description": "The column letter to search (e.g. \"A\", \"B\")."
},
"value": {
"type": "string",
"description": "The value to search for in the specified column."
},
"exportRow": {
"type": "boolean",
"description": "If true, also returns the full row data for each match. Defaults to false."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"column",
"value"
]
}
```
***
## google-sheets\_get\_sheet\_row\_column\_count
Returns the total row and column count for a sheet. If sheetName is not provided, returns counts for the first sheet.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | No | — | The name of the sheet. Defaults to the first sheet if not provided. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet. Defaults to the first sheet if not provided."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_get\_spreadsheet
Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: \* Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP \* Set the includeGridData URL 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. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The spreadsheet to request. |
| `includeGridData` | boolean | No | — | True if grid data should be returned. This parameter is ignored if a field mask was set in the request. |
| `ranges` | string\[] | No | — | The ranges to retrieve from the spreadsheet. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The spreadsheet to request."
},
"includeGridData": {
"type": "boolean",
"description": "True if grid data should be returned. This parameter is ignored if a field mask was set in the request."
},
"ranges": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ranges to retrieve from the spreadsheet."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_get\_values
Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to retrieve data from. |
| `range` | string | Yes | — | The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from. |
| `dateTimeRenderOption` | string | No | — | How dates, times, and durations should be represented in the output. This is ignored if value\_render\_option is FORMATTED\_VALUE. The default dateTime render option is SERIAL\_NUMBER. |
| `majorDimension` | string | No | — | The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. |
| `valueRenderOption` | string | No | — | How values should be represented in the output. The default render option is FORMATTED\_VALUE. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to retrieve data from."
},
"range": {
"type": "string",
"description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from."
},
"dateTimeRenderOption": {
"type": "string",
"description": "How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
]
},
"majorDimension": {
"type": "string",
"description": "The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
]
},
"valueRenderOption": {
"type": "string",
"description": "How values should be represented in the output. The default render option is FORMATTED_VALUE.",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
]
}
},
"required": [
"PCID",
"spreadsheetId",
"range"
]
}
```
***
## google-sheets\_insert\_column
Inserts a column into a sheet. If columnLetter is provided (e.g. "A", "B"), inserts at that position and optionally fills with values. If no columnLetter and values are provided, appends a column with those values. If neither columnLetter nor values are provided, appends an empty column.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | No | — | The name of the sheet. Defaults to the first sheet if not provided. |
| `columnLetter` | string | No | — | The column letter at which to insert (e.g. "A", "B", "AA"). If omitted, the column is appended. |
| `values` | string\[] | No | — | Optional array of string values to fill the inserted column (one per row). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet. Defaults to the first sheet if not provided."
},
"columnLetter": {
"type": "string",
"description": "The column letter at which to insert (e.g. \"A\", \"B\", \"AA\"). If omitted, the column is appended."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of string values to fill the inserted column (one per row)."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_insert\_comment
Insert a comment on a specific cell in a spreadsheet. Uses the Google Drive API comments endpoint.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------ |
| `spreadsheetId` | string | Yes | — | Google Spreadsheet ID |
| `sheetName` | string | Yes | — | Name of the worksheet |
| `cell` | string | Yes | — | Cell reference in A1 notation (e.g., "A1", "B5") |
| `comment` | string | Yes | — | Comment text to add |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "Google Spreadsheet ID"
},
"sheetName": {
"type": "string",
"description": "Name of the worksheet"
},
"cell": {
"type": "string",
"description": "Cell reference in A1 notation (e.g., \"A1\", \"B5\")"
},
"comment": {
"type": "string",
"description": "Comment text to add"
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"cell",
"comment"
]
}
```
***
## google-sheets\_insert\_row
Inserts a row into a sheet. If rowIndex (1-based) is provided, inserts at that position and optionally fills with values. If no rowIndex and values are provided, appends a row with those values. If neither rowIndex nor values are provided, appends an empty row.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | No | — | The name of the sheet. Defaults to the first sheet if not provided. |
| `rowIndex` | integer | No | — | The 1-based row position at which to insert the row. |
| `values` | string\[] | No | — | Optional array of string values to fill the inserted row. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet. Defaults to the first sheet if not provided."
},
"rowIndex": {
"type": "integer",
"description": "The 1-based row position at which to insert the row."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of string values to fill the inserted row."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_list\_sheets
Lists all sheets (tabs) in a spreadsheet, returning each sheet's ID, title, and index.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
}
},
"required": [
"PCID",
"spreadsheetId"
]
}
```
***
## google-sheets\_read\_col\_headings
Reads the column headings (first row) of a sheet. Returns an array of heading values from row 1.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | --------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to read from. |
| `sheetName` | string | Yes | — | The name of the sheet to read from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to read from."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to read from."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName"
]
}
```
***
## google-sheets\_read\_columns
Reads entire columns from a spreadsheet. Specify column letters (e.g. \["A", "C", "E"]) to read specific columns, or omit to read all columns.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to read from. |
| `sheetName` | string | Yes | — | The name of the sheet to read from. |
| `columns` | string\[] | No | — | Array of column letters to read (e.g. \["A", "C", "E"]). If not provided, reads all columns. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to read from."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to read from."
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of column letters to read (e.g. [\"A\", \"C\", \"E\"]). If not provided, reads all columns."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName"
]
}
```
***
## google-sheets\_read\_rows
Reads rows from a spreadsheet. By default reads from row 2 (skipping the header row) to the end of the sheet. Use startRow and endRow to control the range.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to read from. |
| `sheetName` | string | Yes | — | The name of the sheet to read from. |
| `startRow` | number | No | — | 1-based row number to start reading from. Defaults to 2 (skipping the header row). |
| `endRow` | number | No | — | 1-based row number to stop reading at (inclusive). If not specified, reads to the end of the sheet. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to read from."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet to read from."
},
"startRow": {
"type": "number",
"description": "1-based row number to start reading from. Defaults to 2 (skipping the header row)."
},
"endRow": {
"type": "number",
"description": "1-based row number to stop reading at (inclusive). If not specified, reads to the end of the sheet."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName"
]
}
```
***
## google-sheets\_rename\_sheet
Renames a sheet (tab) in a spreadsheet. If sheetName is not provided, renames the first sheet.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `sheetName` | string | No | — | The current name of the sheet to rename. Defaults to the first sheet if not provided. |
| `newName` | string | Yes | — | The new name for the sheet. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"sheetName": {
"type": "string",
"description": "The current name of the sheet to rename. Defaults to the first sheet if not provided."
},
"newName": {
"type": "string",
"description": "The new name for the sheet."
}
},
"required": [
"PCID",
"spreadsheetId",
"newName"
]
}
```
***
## google-sheets\_rename\_spreadsheet
Renames a spreadsheet (changes its title).
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet. |
| `newName` | string | Yes | — | The new title for the spreadsheet. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet."
},
"newName": {
"type": "string",
"description": "The new title for the spreadsheet."
}
},
"required": [
"PCID",
"spreadsheetId",
"newName"
]
}
```
***
## google-sheets\_update\_formatting
Updates the formatting of a range of cells in a spreadsheet. Supports bold, italic, text color, and background color.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `sheetName` | string | Yes | — | The name of the sheet containing the range to format. |
| `range` | string | Yes | — | The range in A1 notation to format (e.g. "A1:B5"). |
| `bold` | boolean | No | — | Whether to make the text bold. |
| `italic` | boolean | No | — | Whether to make the text italic. |
| `backgroundColor` | string | No | — | Background color as a hex string (e.g. "#FF0000" for red). |
| `textColor` | string | No | — | Text color as a hex string (e.g. "#000000" for black). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"sheetName": {
"type": "string",
"description": "The name of the sheet containing the range to format."
},
"range": {
"type": "string",
"description": "The range in A1 notation to format (e.g. \"A1:B5\")."
},
"bold": {
"type": "boolean",
"description": "Whether to make the text bold."
},
"italic": {
"type": "boolean",
"description": "Whether to make the text italic."
},
"backgroundColor": {
"type": "string",
"description": "Background color as a hex string (e.g. \"#FF0000\" for red)."
},
"textColor": {
"type": "string",
"description": "Text color as a hex string (e.g. \"#000000\" for black)."
}
},
"required": [
"PCID",
"spreadsheetId",
"sheetName",
"range"
]
}
```
***
## google-sheets\_update\_values
Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `spreadsheetId` | string | Yes | — | The ID of the spreadsheet to update. |
| `range` | string | Yes | — | The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update. |
| `includeValuesInResponse` | boolean | No | — | 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 the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). |
| `responseDateTimeRenderOption` | string | No | — | 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 SERIAL\_NUMBER. |
| `responseValueRenderOption` | string | No | — | Determines how values in the response should be rendered. The default render option is FORMATTED\_VALUE. |
| `valueInputOption` | string | No | — | How the input data should be interpreted. |
| `majorDimension` | string | No | — | The 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, it defaults to ROWS. |
| `values` | any\[]\[] | No | — | The 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"spreadsheetId": {
"type": "string",
"description": "The ID of the spreadsheet to update."
},
"range": {
"type": "string",
"description": "The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update."
},
"includeValuesInResponse": {
"type": "boolean",
"description": "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 the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns)."
},
"responseDateTimeRenderOption": {
"type": "string",
"description": "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 SERIAL_NUMBER.",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
]
},
"responseValueRenderOption": {
"type": "string",
"description": "Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
]
},
"valueInputOption": {
"type": "string",
"description": "How the input data should be interpreted.",
"enum": [
"INPUT_VALUE_OPTION_UNSPECIFIED",
"RAW",
"USER_ENTERED"
]
},
"majorDimension": {
"type": "string",
"description": "The 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, it defaults to ROWS.",
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
]
},
"values": {
"type": "array",
"items": {
"type": "array"
},
"description": "The 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."
}
},
"required": [
"PCID",
"spreadsheetId",
"range"
]
}
```