Method: spreadsheets.getByDataFilter

Trả về bảng tính tại mã nhận dạng cho trước. Phương thức gọi phải chỉ định mã nhận dạng bảng tính.

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

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

  • Chỉ định mặt nạ trường (field mask) để liệt kê các trường mà 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 nạ cho trường (field mask), tham số includeGridData sẽ bị bỏ qua

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

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 yêu cầu.

Nội dung yêu cầu

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

Biểu diễn dưới dạng JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean
}
Trường
dataFilters[]

object (DataFilter)

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

boolean

Đúng nếu dữ liệu lưới sẽ được trả về. Tham số này sẽ bị bỏ qua nếu bạn đặt mặt nạ cho trường (field mask) trong yêu cầu.

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 phiên bản của Spreadsheet.

Phạm vi uỷ quyền

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

  • 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 bài viết Hướng dẫn uỷ quyền.