- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- DataFilterValueRange
- UpdateValuesByDataFilterResponse
- Faça um teste
Define valores em um ou mais intervalos de uma planilha. O autor da chamada precisa especificar o ID da planilha, um valueInputOption
e um ou mais DataFilterValueRanges
.
Solicitação HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
spreadsheetId |
O ID da planilha a ser atualizada. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "valueInputOption": enum ( |
Campos | |
---|---|
valueInputOption |
Como os dados de entrada devem ser interpretados. |
data[] |
Os novos valores a serem aplicados à planilha. Se mais de um intervalo for correspondido pelo |
includeValuesInResponse |
Determina se a resposta de atualização deve incluir os valores das células que foram atualizadas. Por padrão, as respostas não incluem os valores atualizados. O campo |
responseValueRenderOption |
Determina como os valores na resposta devem ser renderizados. A opção de renderização padrão é |
responseDateTimeRenderOption |
Determina como as datas, as horas e as durações na resposta devem ser renderizadas. Isso será ignorado se |
Corpo da resposta
A resposta ao atualizar um intervalo de valores em uma planilha.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"spreadsheetId": string,
"totalUpdatedRows": integer,
"totalUpdatedColumns": integer,
"totalUpdatedCells": integer,
"totalUpdatedSheets": integer,
"responses": [
{
object ( |
Campos | |
---|---|
spreadsheetId |
A planilha em que as atualizações foram aplicadas. |
totalUpdatedRows |
O número total de linhas em que pelo menos uma célula foi atualizada. |
totalUpdatedColumns |
O número total de colunas em que pelo menos uma célula foi atualizada. |
totalUpdatedCells |
O número total de células atualizadas. |
totalUpdatedSheets |
O número total de páginas em que pelo menos uma célula foi atualizada. |
responses[] |
A resposta de cada intervalo atualizado. |
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.
DataFilterValueRange
Um intervalo de valores com o local especificado por um DataFilter
.
Representação JSON |
---|
{ "dataFilter": { object ( |
Campos | |
---|---|
dataFilter |
O filtro de dados que descreve a localização dos valores na planilha. |
majorDimension |
A dimensão principal dos valores. |
values[] |
Os dados a serem gravados. Se os valores fornecidos excederem qualquer um dos intervalos que correspondem ao filtro de dados, a solicitação falhará. Se os valores fornecidos forem menores que os intervalos correspondentes, somente os valores especificados serão gravados, os valores existentes nos intervalos correspondentes não serão afetados. |
UpdateValuesByDataFilterResponse
A resposta ao atualizar um intervalo de valores por um filtro de dados em uma planilha.
Representação JSON |
---|
{ "updatedRange": string, "updatedRows": integer, "updatedColumns": integer, "updatedCells": integer, "dataFilter": { object ( |
Campos | |
---|---|
updatedRange |
O intervalo (na notação A1) em que as atualizações foram aplicadas. |
updatedRows |
O número de linhas em que pelo menos uma célula foi atualizada. |
updatedColumns |
O número de colunas em que pelo menos uma célula foi atualizada. |
updatedCells |
O número de células atualizadas. |
dataFilter |
O filtro de dados que selecionou o intervalo que foi atualizado. |
updatedData |
Os valores das células no intervalo que corresponderam ao dataFilter depois de todas as atualizações terem sido aplicadas. Isso só vai ser incluído se o campo |