使用字段掩码

字段掩码是 API 调用方列出请求应返回或更新的字段的方式。使用 FieldMask 可让 API 避免执行不必要的工作并提高性能。字段掩码适用于 Google 表格 API 中的读取和更新方法。

使用字段掩码进行读取

电子表格可能很大，并且您通常不需要读取请求返回的 Spreadsheet 资源的每个部分。您可以使用 fields 网址参数限制 Google 表格 API 响应中返回的内容。为了获得最佳性能，请在回复中仅明确列出您需要的字段。

fields 参数的格式与 FieldMask 的 JSON 编码相同。简而言之，多个不同的字段以英文逗号分隔，子字段以英文句点分隔。字段名称可以采用 camelCase 或 separated_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
            }
          }
        }
      }
    }
  ]
}