Method: spreadsheets.getByDataFilter

Devuelve la hoja de cálculo en el ID especificado. El emisor debe especificar el ID de la hoja de cálculo.

La diferencia de este método con este tipo de hojas de cálculo es que permite seleccionar los subconjuntos de datos de la hoja de cálculo que se mostrarán mediante la especificación de un parámetro dataFilters. Se pueden especificar varios DataFilters. Al especificar uno o más filtros de datos, se devuelven las partes de la hoja de cálculo que se cruzan con rangos coincidentes con 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 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 las hojas de cálculo grandes, te recomendamos que recuperes solo los campos específicos que desees de la hoja de cálculo.

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 usa para seleccionar qué rangos se recuperan 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 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.