Method: spreadsheets.values.batchGetByDataFilter

Retorna um ou mais intervalos de valores que correspondem aos filtros de dados especificados. O autor da chamada precisa especificar o ID da planilha e um ou mais DataFilters. Os intervalos que corresponderem a qualquer filtro de dados na solicitação serão retornados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
spreadsheetId

string

O código da planilha da qual os dados serão recuperados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
Campos
dataFilters[]

object (DataFilter)

Os filtros de dados usados para corresponder aos intervalos de valores a serem recuperados. Os intervalos que correspondem a qualquer um dos filtros de dados especificados são incluídos na resposta.
majorDimension

enum (Dimension)

A dimensão principal que os resultados devem usar.

Por exemplo, se os dados da planilha forem A1=1,B1=2,A2=3,B2=4, uma solicitação que seleciona esse intervalo e define majorDimension=ROWS retorna [[1,2],[3,4]], enquanto uma solicitação que define majorDimension=COLUMNS retorna [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Como os valores devem ser representados na saída. A opção de renderização padrão é FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Como datas, horas e durações devem ser representadas na saída. Isso será ignorado se valueRenderOption for FORMATTED_VALUE. A opção de renderização padrão de data e hora é SERIAL_NUMBER.

Corpo da resposta

A resposta ao recuperar mais de um intervalo de valores em uma planilha selecionada por DataFilters.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Campos
spreadsheetId

string

O código da planilha da qual os dados foram recuperados.
valueRanges[]

object (MatchedValueRange)

Os valores solicitados com a lista de filtros de dados correspondentes.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Para mais informações, consulte o Guia de autorização.

Intervalo de valores correspondentes

Um intervalo de valores correspondente a um ou mais arquivamentos de dados.

Representação JSON 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Campos
valueRange

object (ValueRange)

Os valores correspondentes aos DataFilter.
dataFilters[]

object (DataFilter)

O DataFilters da solicitação que correspondeu ao intervalo de valores.