Google Sheets API
Stay organized with collections
Save and categorize content based on your preferences.
Reads and writes Google Sheets.
Service: sheets.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://sheets.googleapis.com
| Methods |
batchUpdate |
POST /v4/spreadsheets/{spreadsheetId}:batchUpdate
Applies one or more updates to the spreadsheet. |
create |
POST /v4/spreadsheets
Creates a spreadsheet, returning the newly created spreadsheet. |
get |
GET /v4/spreadsheets/{spreadsheetId}
Returns the spreadsheet at the given ID. |
getByDataFilter |
POST /v4/spreadsheets/{spreadsheetId}:getByDataFilter
Returns the spreadsheet at the given ID. |
| Methods |
copyTo |
POST /v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo
Copies a single sheet from a spreadsheet to another spreadsheet. |
| Methods |
append |
POST /v4/spreadsheets/{spreadsheetId}/values/{range}:append
Appends values to a spreadsheet. |
batchClear |
POST /v4/spreadsheets/{spreadsheetId}/values:batchClear
Clears one or more ranges of values from a spreadsheet. |
batchClearByDataFilter |
POST /v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter
Clears one or more ranges of values from a spreadsheet. |
batchGet |
GET /v4/spreadsheets/{spreadsheetId}/values:batchGet
Returns one or more ranges of values from a spreadsheet. |
batchGetByDataFilter |
POST /v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
Returns one or more ranges of values that match the specified data filters. |
batchUpdate |
POST /v4/spreadsheets/{spreadsheetId}/values:batchUpdate
Sets values in one or more ranges of a spreadsheet. |
batchUpdateByDataFilter |
POST /v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
Sets values in one or more ranges of a spreadsheet. |
clear |
POST /v4/spreadsheets/{spreadsheetId}/values/{range}:clear
Clears values from a spreadsheet. |
get |
GET /v4/spreadsheets/{spreadsheetId}/values/{range}
Returns a range of values from a spreadsheet. |
update |
PUT /v4/spreadsheets/{spreadsheetId}/values/{range}
Sets values in a range of a spreadsheet. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-21 UTC.
[null,null,["Last updated 2025-03-21 UTC."],[],[],null,["# Google Sheets API\n\nReads and writes Google Sheets.\n\n- [REST Resource: v4.spreadsheets](#v4.spreadsheets)\n- [REST Resource: v4.spreadsheets.developerMetadata](#v4.spreadsheets.developerMetadata)\n- [REST Resource: v4.spreadsheets.sheets](#v4.spreadsheets.sheets)\n- [REST Resource: v4.spreadsheets.values](#v4.spreadsheets.values)\n\nService: sheets.googleapis.com\n------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://sheets.googleapis.com/$discovery/rest?version=v4\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://sheets.googleapis.com`\n\nREST Resource: [v4.spreadsheets](/workspace/sheets/api/reference/rest/v4/spreadsheets)\n--------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|\n| [batchUpdate](/workspace/sheets/api/reference/rest/v4/spreadsheets/batchUpdate) | `POST /v4/spreadsheets/{spreadsheetId}:batchUpdate` Applies one or more updates to the spreadsheet. |\n| [create](/workspace/sheets/api/reference/rest/v4/spreadsheets/create) | `POST /v4/spreadsheets` Creates a spreadsheet, returning the newly created spreadsheet. |\n| [get](/workspace/sheets/api/reference/rest/v4/spreadsheets/get) | `GET /v4/spreadsheets/{spreadsheetId}` Returns the spreadsheet at the given ID. |\n| [getByDataFilter](/workspace/sheets/api/reference/rest/v4/spreadsheets/getByDataFilter) | `POST /v4/spreadsheets/{spreadsheetId}:getByDataFilter` Returns the spreadsheet at the given ID. |\n\nREST Resource: [v4.spreadsheets.developerMetadata](/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata)\n--------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [get](/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/get) | `GET /v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}` Returns the developer metadata with the specified ID. |\n| [search](/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/search) | `POST /v4/spreadsheets/{spreadsheetId}/developerMetadata:search` Returns all developer metadata matching the specified [DataFilter](/workspace/sheets/api/reference/rest/v4/DataFilter). |\n\nREST Resource: [v4.spreadsheets.sheets](/workspace/sheets/api/reference/rest/v4/spreadsheets.sheets)\n----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|\n| [copyTo](/workspace/sheets/api/reference/rest/v4/spreadsheets.sheets/copyTo) | `POST /v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo` Copies a single sheet from a spreadsheet to another spreadsheet. |\n\nREST Resource: [v4.spreadsheets.values](/workspace/sheets/api/reference/rest/v4/spreadsheets.values)\n----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| [append](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/append) | `POST /v4/spreadsheets/{spreadsheetId}/values/{range}:append` Appends values to a spreadsheet. |\n| [batchClear](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchClear) | `POST /v4/spreadsheets/{spreadsheetId}/values:batchClear` Clears one or more ranges of values from a spreadsheet. |\n| [batchClearByDataFilter](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchClearByDataFilter) | `POST /v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter` Clears one or more ranges of values from a spreadsheet. |\n| [batchGet](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchGet) | `GET /v4/spreadsheets/{spreadsheetId}/values:batchGet` Returns one or more ranges of values from a spreadsheet. |\n| [batchGetByDataFilter](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchGetByDataFilter) | `POST /v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter` Returns one or more ranges of values that match the specified data filters. |\n| [batchUpdate](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate) | `POST /v4/spreadsheets/{spreadsheetId}/values:batchUpdate` Sets values in one or more ranges of a spreadsheet. |\n| [batchUpdateByDataFilter](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdateByDataFilter) | `POST /v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter` Sets values in one or more ranges of a spreadsheet. |\n| [clear](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/clear) | `POST /v4/spreadsheets/{spreadsheetId}/values/{range}:clear` Clears values from a spreadsheet. |\n| [get](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/get) | `GET /v4/spreadsheets/{spreadsheetId}/values/{range}` Returns a range of values from a spreadsheet. |\n| [update](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/update) | `PUT /v4/spreadsheets/{spreadsheetId}/values/{range}` Sets values in a range of a spreadsheet. |"]]
