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 sẽ trả về hoặc cập nhật. Việc 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 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ể 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 nội dung được trả về trong phản hồi của API Trang tính bằng cách dùng tham số URL fields. Để có hiệu suất tốt nhất, hãy chỉ liệt kê rõ ràng các 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, còn các trường phụ được phân tách bằng dấu chấm. Bạn có thể chỉ định tên trường trong camelCase hoặc Split_by_underscores. Để thuận tiện, bạn có thể liệt kê nhiều trường phụ từ 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 của sheets.properties(sheetId,title,sheetType,gridProperties) để chỉ tìm nạp mã trang tính, tiêu đề, SheetType và GridProperties của đối tượng SheetProperties trên tất 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 đố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 và giữ nguyên các trường khác. Các yêu cầu cập nhật bên trong một thao tác spreadsheets.batchUpdate sử dụng mặt nạ trường để cho API biết những trường nào đ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 đó có 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 thêm trường đó 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 AddSheetRequest để thêm trang tính mới thuộc loại Grid, cố định hàng đầu tiên và tô màu đỏ cho thẻ của trang tính 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
}
}
}
}
}
]
}