Google Sheets Bubble

Google Sheets integration for spreadsheet operations

Quick Start

import { GoogleSheetsBubble } from '@bubblelab/bubble-core';
import { CredentialType } from '@bubblelab/shared-schemas';
const result = await new GoogleSheetsBubble({
  operation: 'read_values',
  credentials: {
    [CredentialType.GOOGLE_SHEETS_CRED]: process.env.GOOGLE_SHEETS_CRED as string,
  },
}).action();

Operation Details

read_values

Input Schema

operation 'read_values' required

Read values from a range

spreadsheet_id string required

Google Sheets spreadsheet ID

range string required

A1 notation range (e.g., "Sheet1!A1:B10")

major_dimension 'ROWS' | 'COLUMNS'

Major dimension for the values

value_render_option 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA'

How values should be represented in the output

date_time_render_option 'SERIAL_NUMBER' | 'FORMATTED_STRING'

How date/time values should be rendered

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'read_values' required

Read values from a range

success boolean required

Whether the operation was successful

range string

The range that was read

values unknown[][]

The values that were read

major_dimension string

Major dimension of the returned values

error string required

Error message if operation failed

write_values

Input Schema

operation 'write_values' required

Write values to a range

spreadsheet_id string required

Google Sheets spreadsheet ID

range string required

A1 notation range (e.g., "Sheet1!A1:B10")

values unknown[][] required

Data to write as array of arrays

major_dimension 'ROWS' | 'COLUMNS'

Major dimension for the values

value_input_option 'RAW' | 'USER_ENTERED'

How input data should be interpreted

include_values_in_response boolean

Include updated values in response

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'write_values' required

Write values to a range

success boolean required

Whether the operation was successful

updated_range string

The range that was updated

updated_rows number

Number of rows updated

updated_columns number

Number of columns updated

updated_cells number

Number of cells updated

updated_data object

Updated data if requested

error string required

Error message if operation failed

update_values

Input Schema

operation 'update_values' required

Update values in a specific range

spreadsheet_id string required

Google Sheets spreadsheet ID

range string required

A1 notation range (e.g., "Sheet1!A1:B10")

values unknown[][] required

Data to update as array of arrays

major_dimension 'ROWS' | 'COLUMNS'

Major dimension for the values

value_input_option 'RAW' | 'USER_ENTERED'

How input data should be interpreted

include_values_in_response boolean

Include updated values in response

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'update_values' required

Update values in a specific range

success boolean required

Whether the operation was successful

updated_range string

The range that was updated

updated_rows number

Number of rows updated

updated_columns number

Number of columns updated

updated_cells number

Number of cells updated

updated_data object

Updated data if requested

error string required

Error message if operation failed

append_values

Input Schema

operation 'append_values' required

Append values to the end of a table

spreadsheet_id string required

Google Sheets spreadsheet ID

range string required

A1 notation range to search for table (e.g., "Sheet1!A:A")

values unknown[][] required

Data to append as array of arrays

major_dimension 'ROWS' | 'COLUMNS'

Major dimension for the values

value_input_option 'RAW' | 'USER_ENTERED'

How input data should be interpreted

insert_data_option 'OVERWRITE' | 'INSERT_ROWS'

How data should be inserted

include_values_in_response boolean

Include appended values in response

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'append_values' required

Append values to the end of a table

success boolean required

Whether the operation was successful

table_range string

The table range values were appended to

updated_range string

The range that was updated

updated_rows number

Number of rows updated

updated_columns number

Number of columns updated

updated_cells number

Number of cells updated

error string required

Error message if operation failed

clear_values

Input Schema

operation 'clear_values' required

Clear values from a range

spreadsheet_id string required

Google Sheets spreadsheet ID

range string required

A1 notation range (e.g., "Sheet1!A1:B10")

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'clear_values' required

Clear values from a range

success boolean required

Whether the operation was successful

cleared_range string

The range that was cleared

error string required

Error message if operation failed

batch_read_values

Input Schema

operation 'batch_read_values' required

Read multiple ranges at once

spreadsheet_id string required

Google Sheets spreadsheet ID

ranges string[] required

Array of A1 notation ranges

major_dimension 'ROWS' | 'COLUMNS'

Major dimension for the values

value_render_option 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA'

How values should be represented in the output

date_time_render_option 'SERIAL_NUMBER' | 'FORMATTED_STRING'

How date/time values should be rendered

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'batch_read_values' required

Read multiple ranges at once

success boolean required

Whether the operation was successful

value_ranges object[]

Array of value ranges that were read

error string required

Error message if operation failed

batch_update_values

Input Schema

operation 'batch_update_values' required

Update multiple ranges at once

spreadsheet_id string required

Google Sheets spreadsheet ID

value_ranges object[] required

Array of value ranges to update

value_input_option 'RAW' | 'USER_ENTERED'

How input data should be interpreted

include_values_in_response boolean

Include updated values in response

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'batch_update_values' required

Update multiple ranges at once

success boolean required

Whether the operation was successful

total_updated_rows number

Total number of rows updated across all ranges

total_updated_columns number

Total number of columns updated across all ranges

total_updated_cells number

Total number of cells updated across all ranges

total_updated_sheets number

Total number of sheets updated

responses object[]

Individual update responses

error string required

Error message if operation failed

get_spreadsheet_info

Input Schema

operation 'get_spreadsheet_info' required

Get spreadsheet metadata and properties

spreadsheet_id string required

Google Sheets spreadsheet ID

include_grid_data boolean

Include grid data in response

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'get_spreadsheet_info' required

Get spreadsheet metadata and properties

success boolean required

Whether the operation was successful

spreadsheet object

Spreadsheet information

error string required

Error message if operation failed

create_spreadsheet

Input Schema

operation 'create_spreadsheet' required

Create a new spreadsheet

title string required

Title for the new spreadsheet

sheet_titles string[]

Titles for the initial sheets

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'create_spreadsheet' required

Create a new spreadsheet

success boolean required

Whether the operation was successful

spreadsheet object

Created spreadsheet information

error string required

Error message if operation failed

add_sheet

Input Schema

operation 'add_sheet' required

Add a new sheet to spreadsheet

spreadsheet_id string required

Google Sheets spreadsheet ID

sheet_title string required

Title for the new sheet

row_count number

Number of rows in the new sheet

column_count number

Number of columns in the new sheet

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'add_sheet' required

Add a new sheet to spreadsheet

success boolean required

Whether the operation was successful

sheet_id number

ID of the added sheet

sheet_title string

Title of the added sheet

error string required

Error message if operation failed

delete_sheet

Input Schema

operation 'delete_sheet' required

Delete a sheet from spreadsheet

spreadsheet_id string required

Google Sheets spreadsheet ID

sheet_id number required

ID of the sheet to delete

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

operation 'delete_sheet' required

Delete a sheet from spreadsheet

success boolean required

Whether the operation was successful

deleted_sheet_id number

ID of the deleted sheet

error string required

Error message if operation failed