The Google Sheets API (formerly called the Google Spreadsheets API) lets you develop client applications that read and modify worksheets and data in Google Sheets.
What can this API do?
This API is useful for:
- Managing the worksheets in a Google Sheets file
- Consuming the rows of a worksheet
- Managing cells in a worksheet by position
Common use cases
Common use cases for this API include:
- Computing financial data stored in an inaccessible system
- Presenting statistics to users in a web browser
- Consuming data entered into a spreadsheet by a user
Terminology used in this guide
Throughout this guide, a number of terms are used which are intended to have specific meanings.
- Google Sheets document, created with the Google Sheets user interface or with the Google Drive API.
- Named collection of cells within a spreadsheet. All spreadsheets must have at least one worksheet, and have one worksheet by default.
- list row
- Row of cells in a worksheet, represented as a key-value pair, where each key is a column name, and each value is the cell value. The first row of a worksheet is always considered the header row when using the API, and therefore is the row that defines the keys represented in each row.
- Single piece of data in a worksheet.
Which version of the API should be used?
Version 3.0 (the version described in this guide), is the only available version of the API. There are no advantages to using previous versions of the API. For this reason, we no longer document versions 1 or 2 of the Google Sheets API, as version 3.0 is a superset of versions 1 and 2.
Versions 1 and 2 are no longer available as of October 20, 2012. If your code still uses one of those versions, then change your code to stop specifying v1 or v2 with your requests.
Additional resources and information about this guide
Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on.