Method: spreadsheets.values.batchUpdateByDataFilter

Define os 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

string

O código 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 (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Campos
valueInputOption

enum (ValueInputOption)

Como os dados de entrada devem ser interpretados.
data[]

object (DataFilterValueRange)

Os novos valores a serem aplicados à planilha. Se mais de um intervalo for correspondido pelo DataFilter especificado, os valores especificados serão aplicados a todos esses intervalos.
includeValuesInResponse

boolean

Determina se a resposta da 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 updatedData dentro de cada BatchUpdateValuesResponse.responses contém os valores atualizados. Se o intervalo a ser gravado for maior que o intervalo realmente gravado, a resposta incluirá todos os valores no intervalo solicitado (excluindo linhas e colunas vazias no final).
responseValueRenderOption

enum (ValueRenderOption)

Determina como os valores na resposta devem ser renderizados. A opção de renderização padrão é FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Determina como datas, horas e durações na resposta devem ser renderizadas. Isso será ignorado se responseValueRenderOption for FORMATTED_VALUE. A opção de renderização padrão de data e hora é SERIAL_NUMBER.

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 (UpdateValuesByDataFilterResponse)
    }
  ]
}
Campos
spreadsheetId

string

A planilha à qual as atualizações foram aplicadas.
totalUpdatedRows

integer

O número total de linhas em que pelo menos uma célula da linha foi atualizada.
totalUpdatedColumns

integer

O número total de colunas em que pelo menos uma célula foi atualizada.
totalUpdatedCells

integer

O número total de células atualizado.
totalUpdatedSheets

integer

O número total de páginas em que pelo menos uma célula foi atualizada.
responses[]

object (UpdateValuesByDataFilterResponse)

A resposta para cada intervalo foi atualizada.

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.

DataFilterValueRange

Um intervalo de valores com um local especificado por um DataFilter.

Representação JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Campos
dataFilter

object (DataFilter)

O filtro de dados que descreve a localização dos valores na planilha.
majorDimension

enum (Dimension)

A dimensão principal dos valores.
values[]

array (ListValue format)

Os dados a serem gravados. Se os valores fornecidos excederem algum dos intervalos correspondidos pelo 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 (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Campos
updatedRange

string

O intervalo (em notação A1) em que as atualizações foram aplicadas.
updatedRows

integer

O número de linhas em que pelo menos uma célula da linha foi atualizada.
updatedColumns

integer

O número de colunas em que pelo menos uma célula foi atualizada.
updatedCells

integer

O número de células atualizado.
dataFilter

object (DataFilter)

O filtro de dados que selecionou o intervalo que foi atualizado.
updatedData

object (ValueRange)

Os valores das células no intervalo que correspondem ao dataFilter após todas as atualizações terem sido aplicadas. Isso só será incluído se o campo includeValuesInResponse da solicitação for true.