- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Pruébala
Muestra la hoja de cálculo con el ID dado. El llamador debe especificar el ID de la hoja de cálculo.
Este método difiere de Sheets.get en que permite seleccionar qué subconjuntos de datos de hoja de cálculo se muestran mediante la especificación de un parámetro dataFilters
. Se pueden especificar varios DataFilters
. Si especificas uno o más filtros de datos, se muestran las partes de la hoja de cálculo que cruzan los rangos coincidentes por cualquiera de los filtros.
De forma predeterminada, no se muestran los datos de las cuadrículas. Puedes incluir datos de cuadrícula de 2 maneras:
Especifica una máscara de campo que enumere los campos que deseas con el parámetro de URL
fields
en HTTP.Establece el parámetro
includeGridData
como verdadero. Si se configura una máscara de campo, se ignora el parámetroincludeGridData
.
Para las hojas de cálculo grandes, como práctica recomendada, recupera solo los campos específicos de la hoja de cálculo que desees.
Solicitud HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
spreadsheetId |
La hoja de cálculo a solicitar. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"dataFilters": [
{
object ( |
Campos | |
---|---|
dataFilters[] |
El |
includeGridData |
Verdadero si se deben mostrar datos de la cuadrícula. Este parámetro se ignora si se estableció una máscara de campo en la solicitud. |
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Spreadsheet
.
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
Para obtener más información, consulta la Guía de autorización.