基本格式

您可以使用 Google Sheets API 更新电子表格中单元格和范围的格式。本页中的示例展示了如何使用 Google Sheets API 实现一些常见的格式设置操作。您可以在条件格式 recipe 页面中找到更多条件格式示例。

更新电子表格时,某些类型的请求可能会返回响应。 这些响应以数组形式返回,每个响应占据的索引与相应请求相同。某些请求没有响应,对于这些请求,响应为空。这些示例的响应结构可在 spreadsheets.batchUpdate 下找到。

这些示例以 HTTP 请求的形式呈现,不涉及具体语言。如需了解如何使用 Google API 客户端库以不同语言实现批量更新,请参阅更新电子表格

在这些示例中,占位符 SPREADSHEET_IDSHEET_ID 表示您应在何处提供这些 ID。您可以在电子表格网址中找到电子表格 ID。 您可以使用 spreadsheets.get 方法获取工作表 ID。范围使用 A1 表示法指定。一个范围示例是 Sheet1!A1:D5。

在上面的视频中,您将学习如何以各种方式设置电子表格单元格的格式,包括:创建冻结行、将单元格设为粗体、实现币种格式设置、执行单元格验证以及限制单元格值。

修改单元格边框

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 UpdateBordersRequest 为 A1:F10 范围内的每个单元格设置虚线蓝色顶部和底部边框。innerHorizontal 字段会在范围的内部创建水平边框。如果省略此字段,则只会为整个范围的顶部和底部添加边框。

一个 3x3 表格,每个单元格都有虚线蓝色顶部和底部边框。
图 1. 在工作表中,为每个单元格设置虚线蓝色顶部和底部边框。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "updateBorders": {
        "range": {
          "sheetId": SHEET_ID,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 0,
          "endColumnIndex": 6
        },
        "top": {
          "style": "DASHED",
          "width": 1,
          "color": {
            "blue": 1.0
          },
        },
        "bottom": {
          "style": "DASHED",
          "width": 1,
          "color": {
            "blue": 1.0
          },
        },
        "innerHorizontal": {
          "style": "DASHED",
          "width": 1,
          "color": {
            "blue": 1.0
          },
        },
      }
    }
  ]
}

设置标题行的格式

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 RepeatCellRequest 格式化工作表中的标题行。第一个请求更新了文字颜色、背景颜色、文字字体大小和文字对齐方式,并将文字设为粗体。如果省略 range 字段中的列索引,则会导致整个行被格式化。第二个请求调整了工作表属性,使标题行处于冻结状态。

工作表中包含一个 3x3 的表格,其中包含一个设置了格式的标题行。
图 2. 设置工作表中标题行的格式。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "repeatCell": {
        "range": {
          "sheetId": SHEET_ID,
          "startRowIndex": 0,
          "endRowIndex": 1
        },
        "cell": {
          "userEnteredFormat": {
            "backgroundColor": {
              "red": 0.0,
              "green": 0.0,
              "blue": 0.0
            },
            "horizontalAlignment" : "CENTER",
            "textFormat": {
              "foregroundColor": {
                "red": 1.0,
                "green": 1.0,
                "blue": 1.0
              },
              "fontSize": 12,
              "bold": true
            }
          }
        },
        "fields": "userEnteredFormat(backgroundColor,textFormat,horizontalAlignment)"
      }
    },
    {
      "updateSheetProperties": {
        "properties": {
          "sheetId": SHEET_ID,
          "gridProperties": {
            "frozenRowCount": 1
          }
        },
        "fields": "gridProperties.frozenRowCount"
      }
    }
  ]
}

合并单元格

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 MergeCellsRequest 合并单元格。第一个请求将 A1:B2 范围合并为一个单元格。第二个请求会合并 A3:B6 中的列,同时保持行分隔。

工作表中包含合并单元格的 3x3 表格。
图 3. 合并工作表中的单元格。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "mergeCells": {
        "range": {
          "sheetId": SHEET_ID,
          "startRowIndex": 0,
          "endRowIndex": 2,
          "startColumnIndex": 0,
          "endColumnIndex": 2
        },
        "mergeType": "MERGE_ALL"
      }
    },
    {
      "mergeCells": {
        "range": {
          "sheetId": SHEET_ID,
          "startRowIndex": 2,
          "endRowIndex": 6,
          "startColumnIndex": 0,
          "endColumnIndex": 2
        },
        "mergeType": "MERGE_COLUMNS"
      }
    },
  ]
}

为范围设置自定义日期时间或小数格式

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 RepeatCellRequest 将单元格更新为具有自定义日期时间和数字格式。第一个请求会为 A1:A10 范围内的单元格设置自定义日期时间格式 hh:mm:ss am/pm, ddd mmm dd yyyy。此格式的日期时间示例为:“02:05:07 PM, Sun Apr 03 2016”。

第二个请求为 B1:B10 中的单元格指定了自定义数字格式 #,##0.0000,该格式表示数字应以逗号分隔符进行分组,小数点后应有 4 位数字,并且应舍弃除一个前导零之外的所有前导零。例如,数字“3.14”呈现为“3.1400”,而“12345.12345”呈现为“12,345.1235”。

如需了解详情,请参阅日期和数字格式

工作表中包含自定义日期时间和数字格式的 3x3 表格。
图 4. 更新工作表中的单元格,使其具有自定义的日期时间和数字格式。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "repeatCell": {
        "range": {
          "sheetId": SHEET_ID,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 0,
          "endColumnIndex": 1
        },
        "cell": {
          "userEnteredFormat": {
            "numberFormat": {
              "type": "DATE",
              "pattern": "hh:mm:ss am/pm, ddd mmm dd yyyy"
            }
          }
        },
        "fields": "userEnteredFormat.numberFormat"
      }
    },
    {
      "repeatCell": {
        "range": {
          "sheetId": SHEET_ID,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 1,
          "endColumnIndex": 2
        },
        "cell": {
          "userEnteredFormat": {
            "numberFormat": {
              "type": "NUMBER",
              "pattern": "#,##0.0000"
            }
          }
        },
        "fields": "userEnteredFormat.numberFormat"
      }
    }
  ]
}