Method: spreadsheets.values.batchUpdateByDataFilter

Ustawia wartości w co najmniej jednym zakresie arkusza kalkulacyjnego. Element wywołujący musi określić identyfikator arkusza kalkulacyjnego, element valueInputOption i co najmniej 1 element 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)

Jak należy interpretować dane wejściowe.

data[]

object (DataFilterValueRange)

Nowe wartości, które zostaną zastosowane do arkusza kalkulacyjnego. Jeśli określony argument DataFilter pasuje do więcej niż 1 zakresu, określone wartości zostaną zastosowane do wszystkich tych zakresów.

includeValuesInResponse

boolean

Określa, czy odpowiedź dotycząca aktualizacji 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 zakres do zapisu był większy niż rzeczywiście zapisany zakres, odpowiedź zawiera wszystkie wartości z żądanego zakresu (z wyłączeniem końcowych pustych wierszy i kolumn).

responseValueRenderOption

enum (ValueRenderOption)

Określa sposób renderowania wartości w odpowiedzi. Domyślną opcją renderowania jest 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ślną opcją renderowania daty i godziny jest SERIAL_NUMBER.

Treść odpowiedzi

Odpowiedź wyświetlana 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 co najmniej 1 komórka w wierszu została zaktualizowana.

totalUpdatedColumns

integer

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

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)

Zaktualizowano odpowiedź dla każdego zakresu.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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 po autoryzacji.

DataFilterValueRange

Zakres wartości, których lokalizacja jest określana za pomocą atrybutu 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 zapisania. Jeśli podane wartości przekraczają dowolny z zakresów zgodnych z filtrem danych, żądanie się nie powiedzie. Jeśli podane wartości są mniejsze niż dopasowane zakresy, zapisywane są tylko określone wartości, istniejące wartości w dopasowanych zakresach pozostają bez zmian.

UpdateValuesByDataFilterResponse

Odpowiedź przy aktualizacji zakresu wartości przez filtr 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 co najmniej 1 komórka w wierszu została zaktualizowana.

updatedColumns

integer

Liczba kolumn, w których co najmniej 1 komórka w kolumnie została zaktualizowana.

updatedCells

integer

Liczba zaktualizowanych komórek.

dataFilter

object (DataFilter)

Filtr danych, który zaznaczył zaktualizowany zakres.

updatedData

object (ValueRange)

Wartości komórek w zakresie pasujących do filtra danych po zastosowaniu wszystkich aktualizacji. Jest to uwzględniane tylko wtedy, gdy pole includeValuesInResponse żądania miało wartość true.