> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Sheets

> Reference for the Tracecat Google Sheets integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Append values

Action ID: `tools.google_sheets.append_values`

Append rows to a Google Sheets range.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/append](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/append)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="range" type="string" required>
  A1 notation range to append to.
</ParamField>

<ParamField path="spreadsheet_id" type="string" required>
  Target spreadsheet ID.
</ParamField>

<ParamField path="values" type="array[array[string | integer | number | boolean | null]]" required>
  Two-dimensional array of values to append.
</ParamField>

<ParamField path="include_values_in_response" type="boolean">
  Include the appended values in the response payload.

  Default: `false`.
</ParamField>

<ParamField path="insert_data_option" type="string">
  How the input data should be inserted.

  Default: `"INSERT_ROWS"`.

  Allowed values: `OVERWRITE`, `INSERT_ROWS`.
</ParamField>

<ParamField path="major_dimension" type="string | null">
  Orientation of the values array.

  Default: `null`.
</ParamField>

<ParamField path="value_input_option" type="string">
  How input data should be interpreted.

  Default: `"USER_ENTERED"`.

  Allowed values: `RAW`, `USER_ENTERED`.
</ParamField>

## Batch clear values

Action ID: `tools.google_sheets.batch_clear_values`

Clear values from one or more ranges in a spreadsheet.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchClear](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchClear)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="ranges" type="array[string]" required>
  List of A1 notation ranges to clear.
</ParamField>

<ParamField path="spreadsheet_id" type="string" required>
  Spreadsheet ID to clear.
</ParamField>

## Batch get values

Action ID: `tools.google_sheets.batch_get_values`

Retrieve values from multiple ranges in a spreadsheet.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchGet](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchGet)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="ranges" type="array[string]" required>
  A1 notation ranges to retrieve.
</ParamField>

<ParamField path="spreadsheet_id" type="string" required>
  Spreadsheet ID to read from.
</ParamField>

<ParamField path="date_time_render_option" type="string | null">
  How dates and times should be represented.

  Default: `null`.
</ParamField>

<ParamField path="major_dimension" type="string | null">
  Orientation of the returned values.

  Default: `null`.
</ParamField>

<ParamField path="value_render_option" type="string | null">
  How values should be rendered in the response.

  Default: `null`.
</ParamField>

## Batch update values

Action ID: `tools.google_sheets.batch_update_values`

Update cell values across multiple ranges in one request.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="spreadsheet_id" type="string" required>
  Spreadsheet ID to update.
</ParamField>

<ParamField path="updates" type="array[object]" required>
  List of updates with range, values, and optional major\_dimension per entry.
</ParamField>

<ParamField path="include_values_in_response" type="boolean">
  Include the updated values in the response payload.

  Default: `false`.
</ParamField>

<ParamField path="response_date_time_render_option" type="string | null">
  How dates and times should be represented in the response.

  Default: `null`.
</ParamField>

<ParamField path="response_value_render_option" type="string | null">
  How updated values should be rendered in the response.

  Default: `null`.
</ParamField>

<ParamField path="value_input_option" type="string">
  How input data should be interpreted.

  Default: `"USER_ENTERED"`.

  Allowed values: `RAW`, `USER_ENTERED`.
</ParamField>

## Copy sheet

Action ID: `tools.google_sheets.copy_sheet`

Copy a sheet to another spreadsheet.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.sheets/copyTo](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.sheets/copyTo)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="destination_spreadsheet_id" type="string" required>
  Destination spreadsheet ID.
</ParamField>

<ParamField path="sheet_id" type="integer" required>
  ID of the sheet to copy.
</ParamField>

<ParamField path="spreadsheet_id" type="string" required>
  Source spreadsheet ID.
</ParamField>

## Create spreadsheet

Action ID: `tools.google_sheets.create_spreadsheet`

Create a new Google Spreadsheet with an optional set of sheets.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/create](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/create)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="title" type="string" required>
  Spreadsheet title.
</ParamField>

<ParamField path="sheet_titles" type="array[string] | null">
  Optional list of sheet titles to create.

  Default: `null`.
</ParamField>

## Get spreadsheet

Action ID: `tools.google_sheets.get_spreadsheet`

Retrieve spreadsheet metadata and optional grid data.

Reference: [https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get)

### Secrets

Optional secrets:

* `google_sheets_oauth`: OAuth token `GOOGLE_SHEETS_SERVICE_TOKEN`.

### Input fields

<ParamField path="spreadsheet_id" type="string" required>
  Spreadsheet ID to fetch.
</ParamField>

<ParamField path="include_grid_data" type="boolean">
  Return grid data along with metadata.

  Default: `false`.
</ParamField>

<ParamField path="ranges" type="array[string] | null">
  Optional A1 notation ranges to include.

  Default: `null`.
</ParamField>