Method: spreadsheets.getByDataFilter

Trả về bảng tính theo mã nhận dạng đã cho. Người gọi phải chỉ định mã nhận dạng 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.

Phương thức này khác với spreadsheets.get ở chỗ cho phép chọn những tập hợp con dữ liệu bảng tính cần trả về bằng cách chỉ định một tham số dataFilters. Bạn có thể chỉ định nhiều DataFilters. Khi chỉ định một hoặc nhiều bộ lọc dữ liệu, bạn sẽ nhận được những phần của bảng tính có dải ô trùng khớp với bất kỳ bộ lọc nào.

Theo mặc định, dữ liệu trong lưới không được trả về. Bạn có thể thêm dữ liệu lưới theo một trong hai cách:

  • Chỉ định một mặt nạ trường liệt kê các trường bạn muốn bằng cách sử dụng tham số URL fields trong HTTP.

  • Đặt tham số includeGridData thành true. Nếu bạn đặt một mặt nạ trường, thì tham số includeGridData sẽ bị bỏ qua.

Đối với các bảng tính lớn, tốt nhất là bạn chỉ nên truy xuất những trường cụ thể mà bạn muốn trong bảng tính.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Thông số
spreadsheetId

string

Bảng tính cần yêu cầu.

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
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
Trường
dataFilters[]

object (DataFilter)

DataFilters dùng để chọn dải ô cần truy xuất từ bảng tính.

includeGridData

boolean

Giá trị true nếu dữ liệu lưới cần được trả về. Tham số này sẽ bị bỏ qua nếu bạn đặt một mặt nạ trường trong yêu cầu.

excludeTablesInBandedRanges

boolean

True nếu bạn muốn loại trừ các bảng trong dải ô có màu. Sai nếu không được đặt.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của Spreadsheet.

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.