Method: spreadsheets.values.batchGet
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie une ou plusieurs plages de valeurs à partir d'une feuille de calcul. L'appelant doit spécifier l'ID de la feuille de calcul et une ou plusieurs plages.
Requête HTTP
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
spreadsheetId |
string
ID de la feuille de calcul à partir de laquelle récupérer les données.
|
Paramètres de requête
| Paramètres |
ranges[] |
string
Notation A1 ou R1C1 de la plage à partir de laquelle récupérer les valeurs.
|
majorDimension |
enum (Dimension)
Dimension principale que les résultats doivent utiliser. Par exemple, si les données de la feuille de calcul sont A1=1,B1=2,A2=3,B2=4, la requête ranges=["A1:B2"],majorDimension=ROWS renvoie [[1,2],[3,4]], tandis que la requête ranges=["A1:B2"],majorDimension=COLUMNS renvoie [[1,3],[2,4]].
|
valueRenderOption |
enum (ValueRenderOption)
Comment les valeurs doivent être représentées dans la sortie. L'option de rendu par défaut est ValueRenderOption.FORMATTED_VALUE.
|
dateTimeRenderOption |
enum (DateTimeRenderOption)
Comment les dates, les heures et les durées doivent être représentées dans la sortie Cette valeur est ignorée si valueRenderOption est FORMATTED_VALUE. L'option de rendu dateTime par défaut est SERIAL_NUMBER.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse renvoyée lors de la récupération de plusieurs plages de valeurs dans une feuille de calcul.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"spreadsheetId": string,
"valueRanges": [
{
object (ValueRange)
}
]
} |
| Champs |
spreadsheetId |
string
ID de la feuille de calcul à partir de laquelle les données ont été récupérées.
|
valueRanges[] |
object (ValueRange)
Valeurs demandées. L'ordre des ValueRanges est le même que celui des plages demandées.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.readonlyhttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/spreadsheetshttps://www.googleapis.com/auth/spreadsheets.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/03/22 (UTC).
[null,null,["Dernière mise à jour le 2025/03/22 (UTC)."],[],[],null,["# Method: spreadsheets.values.batchGet\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetValuesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.\n\n### HTTP request\n\n`GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|-----------------------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet to retrieve data from. |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ranges[]` | `string` The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. |\n| `majorDimension` | `enum (`[Dimension](/workspace/sheets/api/reference/rest/v4/Dimension)`)` The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. |\n| `valueRenderOption` | `enum (`[ValueRenderOption](/workspace/sheets/api/reference/rest/v4/ValueRenderOption)`)` How values should be represented in the output. The default render option is [ValueRenderOption.FORMATTED_VALUE](/workspace/sheets/api/reference/rest/v4/ValueRenderOption#ENUM_VALUES.FORMATTED_VALUE). |\n| `dateTimeRenderOption` | `enum (`[DateTimeRenderOption](/workspace/sheets/api/reference/rest/v4/DateTimeRenderOption)`)` How dates, times, and durations should be represented in the output. This is ignored if [valueRenderOption](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchGet#body.QUERY_PARAMETERS.value_render_option) is [FORMATTED_VALUE](/workspace/sheets/api/reference/rest/v4/ValueRenderOption). The default dateTime render option is [SERIAL_NUMBER](/workspace/sheets/api/reference/rest/v4/DateTimeRenderOption). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response when retrieving more than one range of values in a spreadsheet.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"spreadsheetId\": string, \"valueRanges\": [ { object (/workspace/sheets/api/reference/rest/v4/spreadsheets.values#ValueRange) } ] } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet the data was retrieved from. |\n| `valueRanges[]` | `object (`[ValueRange](/workspace/sheets/api/reference/rest/v4/spreadsheets.values#ValueRange)`)` The requested values. The order of the ValueRanges is the same as the order of the requested ranges. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `https://www.googleapis.com/auth/drive.readonly`\n- `https://www.googleapis.com/auth/drive.file`\n- `https://www.googleapis.com/auth/spreadsheets`\n- `https://www.googleapis.com/auth/spreadsheets.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
