此页面由 Cloud Translation API 翻译。

表格操作

借助 Google Sheets API，您可以创建、清除、复制和删除工作表，还可以控制其属性。本页面上的示例说明了如何使用 Sheets API。

这些示例以 HTTP 请求的形式呈现，中性。了解如何使用请参阅更新电子表格。

在这些示例中，占位符 SPREADSHEET_ID 和 SHEET_ID 指明提供这些 ID 的位置。您可以在电子表格 ID。您可以获得工作表 ID spreadsheets.get 方法。通过范围使用 A1 表示法指定。一个示例范围是“Sheet1!A1:D5”。

添加工作表

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 AddSheetRequest 可向电子表格添加工作表，同时还可设置标题、网格大小和标签颜色。

该响应包含 AddSheetResponse、该对象包含具有所创建工作表属性的对象（如其 SHEET_ID）。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "addSheet": {
        "properties": {
          "title": "Deposits",
          "gridProperties": {
            "rowCount": 20,
            "columnCount": 12
          },
          "tabColor": {
            "red": 1.0,
            "green": 0.3,
            "blue": 0.4
          }
        }
      }
    }
  ]
}

清除工作表中的所有值，同时保留格式

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 UpdateCellsRequest 可移除工作表中的所有值，同时保留格式不变。

指定 userEnteredValue 字段则视为清除值的指令范围内。此设置也可用于其他字段。例如：将 fields 值更改为 userEnteredFormat 移除 Sheets API 支持的所有格式但单元格值保持不变。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "updateCells": {
        "range": {
          "sheetId": SHEET_ID
        },
        "fields": "userEnteredValue"
      }
    }
  ]
}

将工作表从一个电子表格复制到另一个电子表格

以下 spreadsheet.sheets.copyTo 代码示例展示了如何复制 SHEET_ID 指定的单个工作表从一个电子表格复制到另一个电子表格。

请求正文中的 TARGET_SPREADSHEET_ID 变量指定目标电子表格。副本会保留所有值、格式、公式和与原始图片的其他属性保持一致将复制的工作表的标题设置为“复制” [原始工作表标题]”。

该响应包含 SheetProperties 对象，用于描述所创建工作表的属性。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo

{
  "destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}

删除工作表

以下 spreadsheets.batchUpdate 代码示例展示了如何使用 DeleteSheetRequest 用于删除 SHEET_ID 指定的工作表。

请求协议如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "deleteSheet": {
        "sheetId": SHEET_ID
      }
    }
  ]
}

读取工作表数据

以下 spreadsheets.get 代码示例展示了如何获取工作表属性信息来自由 SHEET_ID 指定的电子表格和 SPREADSHEET_ID。此方法通常用于确定特定电子表格中所有工作表的元数据，以便执行其他操作。定位这些工作表fields 查询参数仅指定工作表属性数据（而不是单元格值数据或与）。

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties

该响应包含 Spreadsheet 资源，其中包含 Sheet 对象，其中包含 SheetProperties 元素。如果给定响应字段设置为默认值，则系统会忽略该字段。

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "Sheet1",
        "index": 0,
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 100,
          "columnCount": 20,
          "frozenRowCount": 1
        }
        "tabColor": {
          "blue": 1.0
        }
      },
      ...
  ],
}