Method: spreadsheets.getByDataFilter

Retorna a planilha com o ID fornecido. O autor da chamada precisa especificar o ID da planilha.

Esse método é diferente de spreadsheets.get porque permite selecionar quais subconjuntos de dados da planilha serão retornados ao especificar um parâmetro dataFilters. Várias DataFilters podem ser especificadas. A especificação de um ou mais filtros de dados retorna as partes da planilha que cruzam os intervalos correspondentes a qualquer um dos filtros.

Por padrão, os dados em grades não são retornados. É possível incluir dados de grade de duas maneiras:

  • Especifique uma máscara de campo que liste os campos desejados usando o parâmetro de URL fields no HTTP.

  • Defina o parâmetro includeGridData como verdadeiro. Se uma máscara de campo for definida, o parâmetro includeGridData será ignorado.

Para planilhas grandes, uma prática recomendada é recuperar apenas os campos específicos que você quer.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
spreadsheetId

string

A planilha a ser solicitada.

Corpo da solicitação

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

Representação JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
Campos
dataFilters[]

object (DataFilter)

O DataFilters usado para selecionar quais intervalos extrair da planilha.
includeGridData

boolean

Verdadeiro se os dados da grade devem ser retornados. Esse parâmetro é ignorado se uma máscara de campo tiver sido definida na solicitação.
excludeTablesInBandedRanges

boolean

Verdadeiro se as tabelas precisam ser excluídas nos intervalos agrupados. Falso se não for definido.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Spreadsheet.

Escopos de autorização

Requer um dos seguintes escopos do 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.