Method: spreadsheets.get
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie la feuille de calcul associée à l'ID donné. L'appelant doit spécifier l'ID de la feuille de calcul.
Par défaut, les données des grilles ne sont pas renvoyées. Vous pouvez inclure des données de grille de deux manières:
Spécifiez un masque de champ listant les champs souhaités à l'aide du paramètre d'URL fields en HTTP.
Définissez le paramètre d'URL includeGridData sur "true". Si un masque de champ est défini, le paramètre includeGridData est ignoré.
Pour les feuilles de calcul volumineuses, il est recommandé de ne récupérer que les champs spécifiques de la feuille de calcul qui vous intéressent.
Pour ne récupérer que des sous-ensembles de données de feuille de calcul, utilisez le paramètre d'URL ranges. Les plages sont spécifiées à l'aide de la notation A1. Vous pouvez définir une seule cellule (par exemple, A1) ou plusieurs cellules (par exemple, A1:D5). Vous pouvez également obtenir des cellules d'autres feuilles de la même feuille de calcul (par exemple, Sheet2!A1:C4) ou récupérer plusieurs plages à la fois (par exemple, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limiter la plage ne renvoie que les parties de la feuille de calcul qui se chevauchent avec les plages demandées.
Requête HTTP
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
spreadsheetId |
string
Feuille de calcul à demander.
|
Paramètres de requête
| Paramètres |
ranges[] |
string
Les plages à récupérer à partir de la feuille de calcul.
|
includeGridData |
boolean
"True" si les données de grille doivent être renvoyées. Ce paramètre est ignoré si un masque de champ a été défini dans la requête.
|
excludeTablesInBandedRanges |
boolean
"True" si les tableaux doivent être exclus des plages groupées. "False" si non défini.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de Spreadsheet.
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/04/30 (UTC).
[null,null,["Dernière mise à jour le 2025/04/30 (UTC)."],[],[],null,["# Method: spreadsheets.get\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.\n\nBy default, data within grids is not returned. You can include grid data in one of 2 ways:\n\n- Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP\n\n- Set the [includeGridData](/workspace/sheets/api/reference/rest/v4/spreadsheets/get#body.QUERY_PARAMETERS.include_grid_data) URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored\n\nFor large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.\n\nTo retrieve only subsets of spreadsheet data, use the [ranges](/workspace/sheets/api/reference/rest/v4/spreadsheets/get#body.QUERY_PARAMETERS.ranges) URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.\n\n### HTTP request\n\n`GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|--------------------------------------|\n| `spreadsheetId` | `string` The spreadsheet to request. |\n\n### Query parameters\n\n| Parameters ||\n|-------------------------------|-------------------------------------------------------------------------------------------------------------------|\n| `ranges[]` | `string` The ranges to retrieve from the spreadsheet. |\n| `includeGridData` | `boolean` True if grid data should be returned. This parameter is ignored if a field mask was set in the request. |\n| `excludeTablesInBandedRanges` | `boolean` True if tables should be excluded in the banded ranges. False if not set. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Spreadsheet](/workspace/sheets/api/reference/rest/v4/spreadsheets#Spreadsheet).\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)."]]
