- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Retorna a planilha no ID fornecido. O autor da chamada precisa especificar o ID da planilha.
Esse método é diferente de Sheets.get porque permite selecionar quais subconjuntos de dados da planilha retornar ao especificar um parâmetro dataFilters
. Vários DataFilters
podem ser especificados. Especificar um ou mais filtros de dados retorna as partes da planilha que cruzam os intervalos correspondidos por qualquer um dos filtros.
Por padrão, os dados dentro das grades não são retornados. É possível incluir dados de grade de duas maneiras:
Especifique uma máscara de campo listando os campos desejados usando o parâmetro de URL
fields
em HTTPDefina o parâmetro
includeGridData
como verdadeiro. Se uma máscara de campo for definida, o parâmetroincludeGridData
será ignorado
Para planilhas grandes, como prática recomendada, recupere apenas os campos específicos da planilha que você deseja.
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 |
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 ( |
Campos | |
---|---|
dataFilters[] |
O |
includeGridData |
Verdadeiro se os dados da grade precisarem ser retornados. Esse parâmetro será ignorado se uma máscara de campo tiver sido definida na solicitação. |
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.