Method: spreadsheets.values.batchUpdateByDataFilter

Đặt giá trị trong một hoặc nhiều dải ô của bảng tính. Để biết thêm thông tin, hãy xem bài viết Đọc, ghi và tìm kiếm siêu dữ liệu.

Người gọi phải chỉ định mã nhận dạng bảng tính, một 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

Thông 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 sau:

Biểu diễn dưới dạng JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
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 cần áp dụng cho bảng tính. Nếu nhiều dải được DataFilter chỉ định khớp, thì các giá trị được 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ó nên bao gồm giá trị của các ô đã được cập nhật hay không. Theo mặc định, các phản hồi không bao gồm các giá trị đã cập nhật. Trường updatedData trong mỗi BatchUpdateValuesResponse.responses chứa các giá trị đã cập nhật. Nếu dải ô cần ghi lớn hơn dải ô thực tế đã 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. Lựa chọn kết xuất mặc định là FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Xác định cách hiển thị ngày, giờ và khoảng thời gian trong phản hồi. Tham số này sẽ bị bỏ qua nếu responseValueRenderOption là FORMATTED_VALUE. Lựa chọn hiển thị 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 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)
    }
  ]
}
Trường
spreadsheetId

string

Bảng tính mà nội dung cập nhật được áp dụng.
totalUpdatedRows

integer

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

integer

Tổng số cột có ít nhất một ô được cập nhậ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 ô được cập nhật.
responses[]

object (UpdateValuesByDataFilterResponse)

Nội dung phản hồi cho từng dải ô đã được cập nhật.

Phạm vi uỷ 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 uỷ quyền.

DataFilterValueRange

Một dải giá trị có vị trí được chỉ định bằng DataFilter.

Biểu diễn dưới dạng JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
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)

Phương diệ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ị được cung cấp vượt quá bất kỳ phạm vi nào mà bộ lọc dữ liệu khớp, thì yêu cầu sẽ không thành công. Nếu các giá trị được cung cấp nhỏ hơn các dải ô được so khớp, thì chỉ các giá trị được chỉ định mới được ghi, các giá trị hiện có trong các dải ô được so khớp sẽ không bị ảnh hưởng.

UpdateValuesByDataFilterResponse

Phản hồi khi cập nhật một dải giá trị theo 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)
  }
}
Trường
updatedRange

string

Dải ô (theo ký hiệu A1) mà các nội dung cập nhật đã được áp dụng.
updatedRows

integer

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

integer

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

integer

Số lượng ô đã được 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 ô mà dataFilter khớp sau khi áp dụng tất cả nội dung cập nhật. Tham số này chỉ được đưa vào nếu trường includeValuesInResponse của yêu cầu là true.