本頁面由 Cloud Translation API 翻譯而成。

工作表作業

您可以透過 Google Sheets API 建立、清除、複製和刪除工作表，也可以控制相關資源本頁的範例將說明如何執行一些常見的 Google 試算表作業試算表 API。

這些範例是以 HTTP 要求的形式呈現中立。如要瞭解如何使用 Google API 用戶端程式庫，請參閱試算表。

在這些範例中，預留位置 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 屬性資訊來源：試算表，由 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
        }
      },
      ...
  ],
}