Method: spreadsheets.getByDataFilter

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

Este método difiere desheets.get en que permite seleccionar qué subconjuntos de datos de la hoja de cálculo se mostrarán mediante la especificación de un parámetro dataFilters. Se pueden especificar varias DataFilters. Si especificas uno o más filtros de datos, se mostrarán las partes de la hoja de cálculo que cruzan rangos que coincidan con cualquiera de los filtros.

De forma predeterminada, no se muestran los datos 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 deseados con el parámetro de URL fields en HTTP.

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

En el caso de hojas de cálculo grandes, se recomienda recuperar 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

string

La hoja de cálculo que se 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 utiliza para seleccionar qué rangos se deben recuperar de la hoja de cálculo
includeGridData

boolean

Es verdadero si se deben mostrar los 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 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.