# Google Sheets

<!-- Generated by tools/catalogue/generate.py from flow.service.workflow 5.0.0-beta.39. Don't edit by hand. -->

# Google Sheets

The Google Sheets category has 8 tasks. Each entry shows the task's latest revision, the one the palette adds. See [Reading an entry](https://www.useboomerang.io/docs/flow/main/catalogue/overview#reading-an-entry).

## Add Sheet

Add new sheet to a Google spreadsheet.

- **Slug:** `add-sheet`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet ID | `spreadsheetId` | Text | Yes |  | The ID of the desired spreadsheet |
| Sheet Title | `title` | Text | Yes |  | The title of the new sheet |

No results.

## Append Data

Append data to an existing Google spreadsheet.
The supported range notations are A1 notation and R1C1 notation.

- **Slug:** `append-data`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet ID | `spreadsheetId` | Text | Yes |  | The ID of the desired spreadsheet |
| Data Range | `range` | Text | Yes |  | The desired data range |
| Cell Data | `values` | Text Area | Yes |  | Input data |

**Results**

| Name | Description |
| --- | --- |
| `response` | Append information |

## Clear Data

Clear the cell data in the specified range from a Google spreadsheet.
The supported range notations are A1 notation and R1C1 notation.

- **Slug:** `clear-data`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet ID | `spreadsheetId` | Text | Yes |  | The ID of the desired spreadsheet |
| Data Ranges | `ranges` | Text | Yes |  | The data ranges to clear separated by a comma |

No results.

## Copy Sheet To Another Spreadsheet

Copy a sheet from a spreadsheet to another.

- **Slug:** `copy-sheet-to-another-spreadsheet`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Source Spreadsheet ID | `fromSpreadsheetId` | Text | Yes |  | The ID of the spreadsheet containing the sheet |
| Destination Spreadsheet ID | `toSpreadsheetId` | Text | Yes |  | The ID of the spreadsheet where we copy the sheet |
| Sheet ID | `sheetId` | Number | Yes |  | The ID of the sheet we want to copy |

No results.

## Create Spreadsheet

Create a new Google Spreadsheet with the provided name.

- **Slug:** `create-spreadsheet`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet Title | `title` | Text | Yes |  | The new spreadsheet's title |

**Results**

| Name | Description |
| --- | --- |
| `spreadsheet` | Newly created spreadsheet information |

## Delete Sheet

Delete a sheet from a Google spreadsheet.

- **Slug:** `delete-sheet`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet ID | `spreadsheetId` | Text | Yes |  | The ID of the desired spreadsheet |
| Sheet ID | `sheetId` | Number | Yes |  | The ID of the sheet to delete |

No results.

## Get Data

Get the cell data in the specified range from a Google spreadsheet.
The supported range notations are A1 notation and R1C1 notation.

- **Slug:** `get-data`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet ID | `spreadsheetId` | Text | Yes |  | The ID of the desired spreadsheet |
| Data Ranges | `ranges` | Text | Yes |  | The desired data ranges separated by comma |

**Results**

| Name | Description |
| --- | --- |
| `rows` | The list of row cell data from the provided ranges |

## Update Data

Update cell data from a Google spreadsheet.
The supported range notations are A1 notation and R1C1 notation.

- **Slug:** `update-data`
- **Type:** `template`
- **Revision:** 4
- **Image:** Default task image.

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Service Account Key | `serviceAccountKey` | Secured | No | `$(workspace.params.google-service-account-key)` | The service account's whole JSON key file, pasted as-is. Replaces Client Email and Private Key |
| Private Key | `privateKey` | Secured | No |  | The service account's private key. Not needed when Service Account Key is set |
| Client Email | `clientEmail` | Text | No |  | The service account's client email. Not needed when Service Account Key is set |
| Spreadsheet ID | `spreadsheetId` | Text | Yes |  | The ID of the desired spreadsheet |
| Data Range | `range` | Text | Yes |  | The desired data range |
| Cell Data | `values` | Text Area | Yes |  | Input data |

**Results**

| Name | Description |
| --- | --- |
| `response` | Update information |