Method: spreadsheets.getByDataFilter

Devuelve la hoja de cálculo con el ID determinado. La persona que llama debe especificar el ID de la hoja de cálculo. Para obtener más información, consulta Cómo leer, escribir y buscar metadatos.

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

De forma predeterminada, no se devuelven los datos dentro de las cuadrículas. Puedes incluir datos de cuadrícula de una de las siguientes dos maneras:

  • Especifica una máscara de campo que enumere los campos que deseas usar el parámetro de URL fields en HTTP.

  • Establece el parámetro includeGridData en true. Si se establece una máscara de campo, se ignora el parámetro includeGridData.

En el caso de 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

Parámetros
spreadsheetId

string

Es la hoja de cálculo que se solicita.

Cuerpo de la solicitud

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

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

object (DataFilter)

Es el DataFilters que se usa para seleccionar qué rangos se recuperarán de la hoja de cálculo.
includeGridData

boolean

Es verdadero si se deben devolver los datos de la cuadrícula. Este parámetro se ignora si se estableció una máscara de campo en la solicitud.
excludeTablesInBandedRanges

boolean

Es verdadero si se deben excluir las tablas en los rangos agrupados. Es falso si no se configura.

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.