Method: spreadsheets.values.batchGetByDataFilter

Muestra uno o más rangos de valores que coinciden con los filtros de datos especificados. El llamador debe especificar el ID de la hoja de cálculo y uno o más DataFilters. Se mostrarán los rangos que coincidan con cualquiera de los filtros de datos de la solicitud.

Solicitud HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
spreadsheetId

string

El ID de la hoja de cálculo de la que se recuperarán los datos.

Cuerpo de la solicitud

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

Representación JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
Campos
dataFilters[]

object (DataFilter)

Los filtros de datos que se usan para hacer coincidir los rangos de valores que se recuperarán. Los rangos que coinciden con cualquiera de los filtros de datos especificados se incluyen en la respuesta.
majorDimension

enum (Dimension)

La dimensión principal que deben usar los resultados.

Por ejemplo, si los datos de la hoja de cálculo son A1=1,B1=2,A2=3,B2=4, una solicitud que selecciona ese rango y establece majorDimension=ROWS muestra [[1,2],[3,4]], mientras que una solicitud que establece majorDimension=COLUMNS muestra [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Cómo se deben representar los valores en el resultado La opción de renderización predeterminada es FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Cómo se deben representar las fechas, las horas y las duraciones en el resultado Se ignora si valueRenderOption es FORMATTED_VALUE. La opción predeterminada de renderización de dateTime es SERIAL_NUMBER.

Cuerpo de la respuesta

Es la respuesta cuando se recupera más de un rango de valores en una hoja de cálculo seleccionada por DataFilters.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Campos
spreadsheetId

string

ID de la hoja de cálculo de la que se recuperaron los datos.
valueRanges[]

object (MatchedValueRange)

Los valores solicitados con la lista de filtros de datos que coincidieron con ellos.

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.

MatchedValueRange

Un rango de valores que coincidió con uno o más archivadores de datos.

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

object (ValueRange)

Los valores que coinciden con DataFilter.
dataFilters[]

object (DataFilter)

El DataFilters de la solicitud que coincidió con el rango de valores.