- 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 código da planilha.
Esse método é diferente de spreadsheets.get porque permite selecionar quais subconjuntos de dados serão retornados especificando um parâmetro dataFilters
. Vários DataFilters
podem ser especificados. A especificação de um ou mais filtros de dados retorna as partes da planilha que cruzam intervalos correspondentes a qualquer um dos filtros.
Por padrão, os dados das grades não são retornados. Você pode incluir dados de grade de duas maneiras:
Especifique uma máscara de campo listando os campos desejados com 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 somente os campos de planilha específicos que desejar.
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 forem 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 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.