Method: spreadsheets.get
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Muestra la hoja de cálculo en el ID determinado. El llamador debe especificar el ID de la hoja de cálculo.
De forma predeterminada, no se muestran los datos dentro de las cuadrículas. Puedes incluir datos de cuadrícula de una de las siguientes 2 maneras:
Especifica una máscara de campo en la que se enumeren los campos que deseas con el parámetro de URL fields en HTTP.
Establece el parámetro de URL includeGridData como verdadero. Si se establece una máscara de campo, se ignora el parámetro includeGridData.
En el caso de las hojas de cálculo grandes, se recomienda recuperar solo los campos específicos que desees.
Para recuperar solo subconjuntos de datos de la hoja de cálculo, usa el parámetro de URL ranges. Los rangos se especifican con la notación A1. Puedes definir una sola celda (por ejemplo, A1) o varias celdas (por ejemplo, A1:D5). También puedes obtener celdas de otras hojas dentro de la misma hoja de cálculo (por ejemplo, Sheet2!A1:C4) o recuperar varios rangos a la vez (por ejemplo, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Si limitas el rango, se muestran solo las partes de la hoja de cálculo que se cruzan con los rangos solicitados.
Solicitud HTTP
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
spreadsheetId |
string
La hoja de cálculo que se debe solicitar.
|
Parámetros de consulta
| Parámetros |
ranges[] |
string
Los rangos que se recuperarán de la hoja de cálculo.
|
includeGridData |
boolean
Es verdadero si se deben mostrar datos de cuadrícula. Este parámetro se ignora si se configuró una máscara de campo en la solicitud.
|
excludeTablesInBandedRanges |
boolean
Es verdadero si se deben excluir las tablas en los rangos con bandas. Es falso si no se establece.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Spreadsheet.
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
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
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-04-29 (UTC)
[null,null,["Última actualización: 2025-04-29 (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)."]]
