Google Sheets

Read and write rows in Google Sheets workbooks.

Append cell to column

Append a single value to the end of a column.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`column_index`	number	Yes	1-based column index (1 -> A, 2 -> B, etc.)
`value`	string	Yes	The value to append
`value_input_option`	string	No	How the input data should be interpreted: 'RAW' or 'USER_ENTERED'

Response

{
  "status": "success"
}

Append row

Append a single row to the end of a Google Sheet.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab to append the row to
`row_values`	array	Yes	A list of values representing the row to append
`value_input_option`	string	No	How the input data should be interpreted: 'RAW' or 'USER_ENTERED'

Response

{
  "status": "success"
}

Clear row values

Clear values in a specific row without deleting the row itself.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`row_index`	number	Yes	1-based row number to clear

Response

{
  "status": "success"
}

Clear tab

Clear all cells within a sheet/tab.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab to clear

Response

{
  "status": "success"
}

Create column

Insert a new column at a specified position.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`column_index`	number	Yes	1-based column index where the new column will be inserted

Response

{
  "status": "success"
}

Create spreadsheet

Create a new Google Sheets spreadsheet.

Parameters

Parameter	Type	Required	Description
`title`	string	Yes	Title of the new spreadsheet
`locale`	string	No	Locale of the spreadsheet (e.g., en_US)
`time_zone`	string	No	Time zone of the spreadsheet (e.g., America/New_York)

Response

{
  "properties": {
    "locale": "en_US",
    "title": "My Spreadsheet"
  },
  "spreadsheet_id": "1AbCdEfGhIjKlMnOpQrStUvWxYz",
  "spreadsheet_url": "https://docs.google.com/spreadsheets/d/1AbCdEfGhIjKlMnOpQrStUvWxYz/edit"
}

Create tab

Create a new tab (sheet) within a spreadsheet.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	Name for the new tab
`sheet_index`	number	No	Position index for the new tab (0-based)

Response

{
  "index": 1,
  "sheet_id": 123456789,
  "title": "New Tab"
}

Delete column

Delete a single column from a sheet.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`column_index`	number	Yes	1-based column index to delete

Response

{
  "status": "success"
}

Delete row

Delete a single row from a sheet.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`row_index`	number	Yes	1-based row number to delete

Response

{
  "status": "success"
}

Delete spreadsheet

Delete a Google Sheets spreadsheet permanently.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet to delete

Response

{
  "status": "success"
}

Delete tab

Delete a tab (sheet) from a spreadsheet by name.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	Name of the tab to delete

Response

{
  "status": "success"
}

Get column values

Return all values from a specific column by index.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`column_index`	number	Yes	1-based column index (1 -> A, 2 -> B, etc.)

Response

[
  "Header",
  "Value1",
  "Value2",
  "Value3"
]

Get row values

Return all values from a specific row as a list.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`row_index`	number	Yes	1-based row number to read

Response

[
  "Name",
  "Email",
  "Status",
  "Date"
]

Read column

Read all values from a specific column.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`column`	string	Yes	Column letter (e.g., 'A', 'B', 'AA')

Response

[
  "Header",
  "Value1",
  "Value2",
  "Value3"
]

Rename tab

Rename an existing tab in a spreadsheet.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	Current name of the tab
`new_sheet_name`	string	Yes	New name for the tab

Response

{
  "sheet_id": 123456789,
  "title": "Renamed Tab"
}

Write row

Overwrite values in a specific row of the sheet.

Parameters

Parameter	Type	Required	Description
`spreadsheet_url`	string	Yes	The URL of the spreadsheet
`sheet_name`	string	Yes	The name of the sheet/tab
`row_index`	number	Yes	1-based row number to write to
`values`	array	Yes	A list of values to write into the row
`value_input_option`	string	No	How the input data should be interpreted: 'RAW' or 'USER_ENTERED'

Response

{
  "status": "success"
}

Google Sheets

On this page