Method: spreadsheets.values.batchGetByDataFilter

Devuelve uno o más rangos de valores que coinciden con los filtros de datos especificados. Para obtener más información, consulta Cómo leer, escribir y buscar metadatos.

La persona que llama debe especificar el ID de la hoja de cálculo y uno o más DataFilters. Se devolverá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

Parámetros
spreadsheetId

string

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)

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

enum (Dimension)

Es 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 devuelve [[1,2],[3,4]], mientras que una solicitud que establece majorDimension=COLUMNS devuelve [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

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

enum (DateTimeRenderOption)

Indica 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 de renderización predeterminada 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

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

object (MatchedValueRange)

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

Permisos 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

Es un rango de valores que coincidió con uno o más filtros de datos.

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

object (ValueRange)

Son los valores que coinciden con el DataFilter.
dataFilters[]

object (DataFilter)

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