Method: spreadsheets.getByDataFilter

Muestra la hoja de cálculo en el ID determinado. El llamador debe especificar el ID de la hoja de cálculo.

Este método difiere de spreadsheets.get en que permite seleccionar qué subconjuntos de datos de la hoja de cálculo se mostrarán especificando un parámetro dataFilters. Se pueden especificar varios DataFilters. Si especificas uno o más filtros de datos, se muestran las porciones de la hoja de cálculo que se cruzan con los rangos que coinciden con cualquiera de los filtros.

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 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 deseas.

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

string

La hoja de cálculo que se debe solicitar.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean
}
Campos
dataFilters[]

object (DataFilter)

El DataFilters que se usa para seleccionar qué rangos recuperar 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.

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/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.