Sử dụng mặt nạ trường

Mặt nạ trường là cách để phương thức gọi API liệt kê các trường mà yêu cầu trả lại hoặc cập nhật. Sử dụng FieldMask cho phép API tránh các công việc không cần thiết và cải thiện hiệu suất. Mặt nạ trường được dùng cho cả phương pháp đọc và cập nhật trong API Google Trang tính.

Đọc bằng mặt nạ trường

Bảng tính có thể lớn và thường bạn không cần tất cả các phần của Spreadsheet được yêu cầu đọc trả về. Bạn có thể giới hạn dữ liệu được trả về trong một Phản hồi của API Trang tính, sử dụng tham số URL fields. Tốt nhất hiệu suất chỉ liệt kê rõ ràng những trường bạn cần trong câu trả lời.

Định dạng của tham số trường giống với Mã hoá JSON của Mặt nạ trường. Nói ngắn gọn, nhiều trường khác nhau được phân tách bằng dấu phẩy và các trường phụ được phân tách được phân tách bằng dấu chấm. Bạn có thể chỉ định tên trường theo quy tắc camelCase hoặc separated_by_underscores. Để thuận tiện, nhiều trường phụ từ cùng một type (loại) có thể được liệt kê trong dấu ngoặc đơn.

Nội dung sau đây Yêu cầu spreadsheets.get Ví dụ này sử dụng mặt nạ trường của sheets.properties(sheetId,title,sheetType,gridProperties) để chỉ tìm nạp ID trang tính, tiêu đề SheetType và GridProperties của một SheetProperties đối tượng trên tất cả các trang tính trong bảng tính:

GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)

Phản hồi cho lệnh gọi phương thức này là một Spreadsheet đối tượng chứa các thành phần được yêu cầu trong mặt nạ trường. Lưu ý rằng sheetType=OBJECT không chứa gridProperties:

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 1000,
          "columnCount": 25
        }
      }
    },
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "OBJECT"
      }
    }
  ]
}

Cập nhật bằng mặt nạ trường

Đôi khi, bạn chỉ cần cập nhật một số trường nhất định trong một đối tượng trong khi vẫn giữ nguyên các trường khác không thay đổi. Cập nhật yêu cầu bên trong một spreadsheets.batchUpdate hoạt động sử dụng mặt nạ trường để cho API biết những trường nào đang được thay đổi. Chiến lược phát hành đĩa đơn yêu cầu cập nhật sẽ bỏ qua mọi trường chưa được chỉ định trong mặt nạ trường, để chúng với giá trị hiện tại.

Bạn cũng có thể bỏ thiết lập một trường bằng cách không chỉ định trường đó trong thông báo cập nhật, nhưng thêm trường này vào mặt nạ. Thao tác này sẽ xoá mọi giá trị mà trường trước đó đã có.

Cú pháp của mặt nạ trường cập nhật giống như mặt nạ trường đọc.

Ví dụ sau đây sử dụng phương thức AddSheetRequest để thêm trang tính mới thuộc loại Grid, hãy cố định hàng đầu tiên và tô màu trang tính mới tab của trang tính màu đỏ:

POST https://sheets.googleapis.com/v1/spreadsheets/spreadsheetId:batchUpdate
{
  "spreadsheetId": "SPREADSHEET_ID",
  "replies": [
    {
      "addSheet": {
        "properties": {
          "sheetId": SHEET_ID,
          "title": "TITLE",
          "index": 6,
          "sheetType": "GRID",
          "gridProperties": {
            "rowCount": 1000,
            "columnCount": 26,
            "frozenRowCount": 1
          },
          "tabColor": {
            "red": 0.003921569
          },
          "tabColorStyle": {
            "rgbColor": {
              "red": 0.003921569
            }
          }
        }
      }
    }
  ]
}