欄位遮罩是 API 呼叫端列出要求應傳回或更新欄位的方法。使用 FieldMask 可讓 API 避免不必要的工作並提升效能。在 GoogleSheet API 中，讀取和更新方法都會使用欄位遮罩。
使用欄位遮罩讀取
試算表可以龐大，通常不需要讀取要求傳回的 Spreadsheet 資源中的所有部分。您可以使用 fields 網址參數限制 Sheets API 回應傳回的內容。為獲得最佳效能，請在回覆中明確列出您需要的欄位。
欄位參數的格式與 FieldMask 的 JSON 編碼相同。簡單來說，多個不同欄位都以半形逗號分隔，子欄位則以半形句號分隔。欄位名稱可使用 camelCase 或 split_by_underscores 指定。為了方便起見，您可以在括號內列出相同類型的多個子欄位。
以下 spreadsheets.get 要求範例會使用 sheets.properties(sheetId,title,sheetType,gridProperties) 的欄位遮罩，在試算表的所有工作表中，只擷取 SheetProperties 物件的工作表 ID、標題、SheetType 和 GridProperties：
GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)
這個方法呼叫的回應是一個 Spreadsheet 物件，其中包含欄位遮罩中要求的元件。請注意，sheetType=OBJECT 不包含 gridProperties：
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 25
}
}
},
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "OBJECT"
}
}
]
}
以欄位遮罩更新
有時候，您只需要更新物件的特定欄位，其他欄位則保持不變。更新 spreadsheets.batchUpdate 作業使用欄位遮罩內的要求，讓 API 知道哪些欄位要變更。更新要求會忽略未在欄位遮罩中指定的任何欄位，並保留這些欄位目前的值。
您也可以取消設定欄位，只要在更新後的訊息中未指定欄位，並將欄位新增至遮罩中即可。這樣做會清除欄位先前使用的任何值。
更新欄位遮罩的語法與讀取欄位遮罩相同。
以下範例使用 AddSheetRequest 新增 Grid 類型的工作表、凍結第一列，並將新工作表分頁的紅色顏色：
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
}
}
}
}
}
]
}