Method: spreadsheets.values.batchUpdateByDataFilter

Ustawia wartości w co najmniej 1 zakresie arkusza kalkulacyjnego. Wywołujący musi podać identyfikator arkusza valueInputOption oraz 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, który chcesz zaktualizować.

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 podany parametr DataFilter pasuje do więcej niż 1 zakresu, określone wartości są stosowane do wszystkich tych zakresów.

includeValuesInResponse

boolean

Określa, czy odpowiedź na aktualizację powinna zawierać wartości komórek, które zostały zaktualizowane. Domyślnie odpowiedzi nie zawierają zaktualizowanych wartości. Pole updatedData w każdym rekordzie BatchUpdateValuesResponse.responses zawiera zaktualizowane wartości. Jeśli zakres do zapisania był większy niż zakres faktycznie zapisany, odpowiedź zawiera wszystkie wartości w żądanym zakresie (z wyjątkiem pustych wierszy i kolumn na końcu).

responseValueRenderOption

enum (ValueRenderOption)

Określa sposób wyświetlania wartości w odpowiedzi. Domyślną opcją renderowania jest FORMATTED_VALUE.

responseDateTimeRenderOption

enum (DateTimeRenderOption)

Określa sposób wyświetlania dat, godzin i czasów trwania w odpowiedzi. Jest on ignorowany, jeśli responseValueRenderOption ma wartość FORMATTED_VALUE. Domyślną opcją renderowania daty i czasu jest SERIAL_NUMBER.

Treść odpowiedzi

Odpowiedź po zaktualizowaniu 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, w którym zastosowano aktualizacje.

totalUpdatedRows

integer

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

totalUpdatedColumns

integer

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

totalUpdatedCells

integer

Łączna liczba zaktualizowanych komórek.

totalUpdatedSheets

integer

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

responses[]

object (UpdateValuesByDataFilterResponse)

Odpowiedź dla każdego zaktualizowanego 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 dotyczącym autoryzacji.

DataFilterValueRange

Zakres wartości, których lokalizacja jest określona przez 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 wykraczają poza zakresy dopasowane przez filtr danych, żądanie nie zostanie wykonane. Jeśli podane wartości są mniejsze niż dopasowane zakresy, zapisywane są tylko określone wartości, a dotychczasowe wartości w dopasowanych zakresach pozostają bez zmian.

UpdateValuesByDataFilterResponse

Odpowiedź po zaktualizowaniu 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 zastosowano aktualizacje.

updatedRows

integer

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

updatedColumns

integer

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

updatedCells

integer

Liczba zaktualizowanych komórek.

dataFilter

object (DataFilter)

Filtr danych, który wybrał aktualizowany zakres.

updatedData

object (ValueRange)

Wartości komórek w zakresie dopasowanym przez funkcję dataFilter po zastosowaniu wszystkich zmian. Jest ono uwzględniane tylko wtedy, gdy pole includeValuesInResponse żądania ma wartość true.