Method: spreadsheets.values.batchUpdateByDataFilter

Ustawia wartości w jednym lub kilku zakresach arkusza kalkulacyjnego. Wywołujący musi podać identyfikator arkusza kalkulacyjnego, valueInputOption i co najmniej 1 DataFilterValueRanges.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
spreadsheetId

string

Identyfikator arkusza kalkulacyjnego do zaktualizowania.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Pola
valueInputOption

enum (ValueInputOption)

Sposób interpretacji danych wejściowych.
data[]

object (DataFilterValueRange)

Nowe wartości do zastosowania w arkuszu kalkulacyjnym. Jeśli określony DataFilter odpowiada więcej niż 1 zakresowi, określone wartości są stosowane do wszystkich tych zakresów.
includeValuesInResponse

boolean

Określa, czy odpowiedź na aktualizację powinna zawierać wartości zaktualizowanych komórek. Domyślnie odpowiedzi nie zawierają zaktualizowanych wartości. Pole updatedData w każdym elemencie BatchUpdateValuesResponse.responses zawiera zaktualizowane wartości. Jeśli zapisywany zakres był większy niż rzeczywiście zapisany zakres, odpowiedź będzie zawierać wszystkie wartości z żądanego zakresu (oprócz końcowych pustych wierszy i kolumn).
responseValueRenderOption

enum (ValueRenderOption)

Określa sposób renderowania wartości w odpowiedzi. Domyślna opcja renderowania to FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Określa sposób renderowania dat, godzin i czasu trwania odpowiedzi. Ta wartość jest ignorowana, jeśli responseValueRenderOption ma wartość FORMATTED_VALUE. Domyślna opcja renderowania dateTime to SERIAL_NUMBER.

Treść odpowiedzi

Odpowiedź podczas aktualizowania zakresu wartości w arkuszu kalkulacyjnym.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
Pola
spreadsheetId

string

Arkusz kalkulacyjny, do którego zastosowano zmiany.
totalUpdatedRows

integer

Łączna liczba wierszy, w których zaktualizowano co najmniej 1 komórkę w wierszu.
totalUpdatedColumns

integer

Łączna liczba kolumn, w których została zaktualizowana co najmniej 1 komórka w kolumnie.
totalUpdatedCells

integer

Łączna liczba zaktualizowanych komórek.
totalUpdatedSheets

integer

Łączna liczba arkuszy, w których co najmniej jedna komórka w arkuszu została zaktualizowana.
responses[]

object (UpdateValuesByDataFilterResponse)

Odpowiedź dla każdego zakresu została zaktualizowana.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

DataFilterValueRange

Zakres wartości, których lokalizację określa DataFilter.

Zapis JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Pola
dataFilter

object (DataFilter)

Filtr danych opisujący lokalizację wartości w arkuszu kalkulacyjnym.
majorDimension

enum (Dimension)

Główny wymiar wartości.
values[]

array (ListValue format)

Dane do zapisu. Jeśli podane wartości przekraczają dowolny z zakresów dopasowanych przez filtr danych, żądanie kończy się niepowodzeniem. Jeśli podane wartości są mniejsze niż dopasowane zakresy, zapisywane są tylko określone wartości, nie będzie to miało wpływu na istniejące wartości w dopasowanych zakresach.

UpdateValuesByDataFilterResponse

Odpowiedź podczas aktualizowania zakresu wartości za pomocą filtra danych w arkuszu kalkulacyjnym.

Zapis JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Pola
updatedRange

string

Zakres (w notacji A1), do którego zostały zastosowane aktualizacje.
updatedRows

integer

Liczba wierszy, w których zaktualizowano co najmniej 1 komórkę w wierszu.
updatedColumns

integer

Liczba kolumn, w których zaktualizowano co najmniej 1 komórkę w kolumnie.
updatedCells

integer

Liczba zaktualizowanych komórek.
dataFilter

object (DataFilter)

Filtr danych, który wybrał zaktualizowany zakres.
updatedData

object (ValueRange)

Wartości w komórkach zakresu dopasowanych przez filtr dataFilter po zastosowaniu wszystkich aktualizacji. Jest on uwzględniany tylko wtedy, gdy w polu includeValuesInResponse żądania znajduje się wartość true.