Method: spreadsheets.values.batchUpdateByDataFilter

Đặt giá trị trong một hoặc nhiều dải ô của bảng tính. Phương thức gọi phải chỉ định mã nhận dạng bảng tính, valueInputOption và một hoặc nhiều DataFilterValueRanges.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
spreadsheetId

string

Mã của bảng tính cần cập nhật.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc như sau:

Biểu diễn dưới dạng JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Các trường
valueInputOption

enum (ValueInputOption)

Cách diễn giải dữ liệu đầu vào.
data[]

object (DataFilterValueRange)

Các giá trị mới sẽ áp dụng cho bảng tính. Nếu có nhiều dải ô khớp với DataFilter được chỉ định thì các giá trị đã chỉ định sẽ được áp dụng cho tất cả các dải ô đó.
includeValuesInResponse

boolean

Xác định xem phản hồi cập nhật có bao gồm giá trị của các ô đã được cập nhật hay không. Theo mặc định, phản hồi không bao gồm các giá trị được cập nhật. Trường updatedData trong mỗi BatchUpdateValuesResponse.responses chứa các giá trị đã được cập nhật. Nếu dải ô cần viết lớn hơn dải ô thực tế được ghi thì phản hồi sẽ bao gồm tất cả các giá trị trong dải ô được yêu cầu (không bao gồm các hàng và cột trống ở cuối).
responseValueRenderOption

enum (ValueRenderOption)

Xác định cách hiển thị các giá trị trong phản hồi. Tùy chọn hiển thị mặc định là FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Xác định cách hiển thị ngày, giờ và thời lượng trong phản hồi. Giá trị này sẽ bị bỏ qua nếu responseValueRenderOption là FORMATTED_VALUE. Tuỳ chọn kết xuất dateTime mặc định là SERIAL_NUMBER.

Nội dung phản hồi

Phản hồi khi cập nhật một dải ô giá trị trong một bảng tính.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
Các trường
spreadsheetId

string

Bảng tính đã áp dụng bản cập nhật.
totalUpdatedRows

integer

Tổng số hàng đã cập nhật ít nhất một ô trong hàng.
totalUpdatedColumns

integer

Tổng số cột đã cập nhật ít nhất một ô trong cột.
totalUpdatedCells

integer

Tổng số ô được cập nhật.
totalUpdatedSheets

integer

Tổng số trang tính có ít nhất một ô trong trang tính đã được cập nhật.
responses[]

object (UpdateValuesByDataFilterResponse)

Đã cập nhật phản hồi cho mỗi dải ô.

Phạm vi ủy quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn ủy quyền.

Giá trị bộ lọc dữ liệu

Dải ô giá trị có vị trí được DataFilter chỉ định.

Biểu diễn dưới dạng JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Các trường
dataFilter

object (DataFilter)

Bộ lọc dữ liệu mô tả vị trí của các giá trị trong bảng tính.
majorDimension

enum (Dimension)

Thứ nguyên chính của các giá trị.
values[]

array (ListValue format)

Dữ liệu cần ghi. Nếu các giá trị đã cung cấp vượt quá bất kỳ phạm vi nào khớp với bộ lọc dữ liệu thì yêu cầu không thành công. Nếu giá trị đã cho nhỏ hơn phạm vi phù hợp, chỉ giá trị được chỉ định được ghi, giá trị hiện tại trong phạm vi phù hợp sẽ không bị ảnh hưởng.

UpdateValuesByDataFilterResponse

Phản hồi khi cập nhật một dải giá trị bằng bộ lọc dữ liệu trong bảng tính.

Biểu diễn dưới dạng JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Các trường
updatedRange

string

Dải ô (trong ký hiệu A1) đã áp dụng bản cập nhật.
updatedRows

integer

Số lượng hàng mà ít nhất một ô trong hàng đã được cập nhật.
updatedColumns

integer

Số cột mà ít nhất một ô trong cột đã được cập nhật.
updatedCells

integer

Số ô đã cập nhật.
dataFilter

object (DataFilter)

Bộ lọc dữ liệu đã chọn dải ô được cập nhật.
updatedData

object (ValueRange)

Giá trị của các ô trong dải ô được phù hợp bởi dataFilter sau khi tất cả các cập nhật được áp dụng. Điều này chỉ được bao gồm nếu trường includeValuesInResponse của yêu cầu là true.