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

Mặt nạ trường là một cách để người gọi API liệt kê các trường mà một yêu cầu sẽ trả về hoặc cập nhật. Việc sử dụng FieldMask giúp API tránh được những 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 thức đọ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ể có kích thước lớn và thường thì bạn không cần mọi phần của tài nguyên Spreadsheet do yêu cầu đọc trả về. Bạn có thể giới hạn những gì được trả về trong phản hồi của Sheets API bằng cách sử dụng tham số URL fields. Để có hiệu suất tốt nhất, hãy 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ố fields giống với mã hoá JSON của FieldMask. Nói tóm lại, nhiều trường khác nhau được phân tách bằng dấu phẩy và các trường con được phân tách bằng dấu chấm. Bạn có thể chỉ định tên trường theo kiểu camelCase hoặc separated_by_underscores. Để thuận tiện, bạn có thể liệt kê nhiều trường con thuộc cùng một loại trong dấu ngoặc đơn.

Ví dụ về yêu cầu spreadsheets.get sau đây sử dụng mặt nạ trường sheets.properties(sheetId,title,sheetType,gridProperties) để chỉ tìm nạp mã nhận dạng trang tính, tiêu đề, SheetType và GridProperties của đối tượng SheetProperties trên tất cả các trang tính trong một 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 đối tượng Spreadsheet chứa các thành phần được yêu cầu trong mặt nạ trường. Xin 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 mà không thay đổi các trường khác. Các yêu cầu cập nhật trong thao tác spreadsheets.batchUpdate sử dụng mặt nạ trường để cho API biết những trường đang được thay đổi. Yêu cầu cập nhật sẽ bỏ qua mọi trường không được chỉ định trong mặt nạ trường, để các trường đó giữ nguyên giá trị hiện tại.

Bạn cũng có thể huỷ đặt 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 hãy thêm trường đó vào mặt nạ. Thao tác này sẽ xoá mọi giá trị mà trường này có trước đó.

Cú pháp cho mặt nạ trường cập nhật giống với mặt nạ trường đọc.

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

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
            }
          }
        }
      }
    }
  ]
}