基本書寫

您可以使用 Google 試算表 API,將值和公式寫入儲存格、範圍、範圍集和整個試算表。本頁面的範例說明如何使用 Sheets API 的 spreadsheets.values 資源,完成一些常見的寫入作業。

請注意,您也可以使用 spreadsheet.batchUpdate 方法寫入儲存格值。如果您想同時更新儲存格格式,或 spreadsheets.values 資源不會影響的其他屬性,這個方法就非常實用。舉例來說,如要將某個工作表的儲存格範圍複製到另一個工作表,並覆寫儲存格公式和格式,可以使用 UpdateCellsRequest 方法搭配 spreadsheet.batchUpdate

不過,如果是簡單的值寫入作業,使用 spreadsheets.values.update 方法或 spreadsheets.values.batchUpdate 方法會比較容易。

這些範例會以 HTTP 要求的形式呈現,不限於特定語言。如要瞭解如何使用 Google API 用戶端程式庫,以不同語言實作寫入作業,請參閱「讀取及寫入儲存格值」。

在這些範例中,預留位置 SPREADSHEET_ID 表示您要提供試算表 ID 的位置,該 ID 可從試算表網址中找到。寫入範圍是使用 A1 標記法指定。例如 Sheet1!A1:D5。

寫入單一範圍

從空白的新試算表開始,下列spreadsheets.values.update程式碼範例說明如何將值寫入範圍。ValueInputOption 查詢參數為必填,可決定是否要剖析寫入的值 (例如是否要將字串轉換為日期)。

要求主體是 ValueRange 物件,用於說明要寫入的範圍值。majorDimension 欄位表示陣列是依資料列排列的值清單。目標範圍中的現有值會遭到覆寫。

要求通訊協定如下所示。

PUT https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5?valueInputOption=VALUE_INPUT_OPTION
{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "3/1/2016"],
    ["Door", "$15", "2", "3/15/2016"],
    ["Engine", "$100", "1", "3/20/2016"],
    ["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"]
  ],
}

回應包含 UpdateValuesResponse 物件,例如:

{
  "spreadsheetId": SPREADSHEET_ID,
  "updatedRange": "Sheet1!A1:D5",
  "updatedRows": 5,
  "updatedColumns": 4,
  "updatedCells": 20,
}

產生的試算表如下所示:

A B C D
1 項目 費用 已備貨 出貨日期
2 車輪 $20.50 4 2016 年 3 月 1 日
3 $15 2 2016 年 3 月 15 日
4 引擎 $100 1 2016 年 3 月 20 日
5 總計 $135.5 7 2016 年 3 月 20 日

選擇性地寫入範圍

將值寫入範圍時,您可以將對應的陣列元素設為 null,避免變更部分現有儲存格。您也可以將空字串 ("") 寫入儲存格,藉此清除儲存格內容。

從包含上述範例產生相同資料的工作表開始,下列spreadsheets.values.update程式碼範例會說明如何將值寫入 B1:D4 範圍,選擇性地保留部分儲存格不變,並清除其他儲存格。ValueInputOption 查詢參數為必填,可決定是否要剖析寫入的值 (例如是否要將字串轉換為日期)。

要求主體是 ValueRange 物件,用於說明要寫入的範圍值。majorDimension 欄位表示陣列是依資料欄整理的值清單。

要求通訊協定如下所示。

PUT https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!B1?valueInputOption=VALUE_INPUT_OPTION
{
  "range": "Sheet1!B1",
  "majorDimension": "COLUMNS",
  "values": [
    [null,"$1","$2", ""],
    [],
    [null,"4/1/2016", "4/15/2016", ""]
  ]
}

這裡的 values 欄位會列出範圍內每個資料欄的變更。第一個陣列表示 B1 應維持不變 (由於 null 陣列元素),而 B4 應清除 (空字串)。B2 和 B3 的值已更新。第三個陣列對 D 欄執行相同作業,而第二個空白陣列表示 C 欄維持不變。

回應包含 UpdateValuesResponse 物件,例如:

{
  "spreadsheetId": SPREADSHEET_ID,
  "updatedRange": "Sheet1!B1:D5",
  "updatedRows": 3,
  "updatedColumns": 2,
  "updatedCells": 6,
}

產生的試算表如下所示:

A B C D
1 項目 費用 已備貨 出貨日期
2 車輪 $1.00 美元 4 2016 年 4 月 1 日
3 $2 美元 2 2016 年 4 月 15 日
4 引擎 1
5 總計 $3.00 美元 7 2016 年 4 月 15 日

請注意,「總計」列雖然不會直接受到這項要求影響,但由於其儲存格含有依附於變更儲存格的公式,因此也會隨之變更。

寫入多個範圍

從空白工作表開始,下列spreadsheets.values.batchUpdate程式碼範例說明如何將值寫入 Sheet1!A1:A4 和 Sheet1!B1:D2 範圍。目標範圍中的現有值會遭到覆寫。要求主體包含 ValueInputOption 物件,說明如何解讀輸入資料,以及對應於每個寫入範圍的 ValueRange 物件陣列。majorDimension 欄位會決定包含的陣列是否解讀為欄或列的陣列。

要求通訊協定如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchUpdate
{
  "valueInputOption": "VALUE_INPUT_OPTION",
  "data": [
    {
      "range": "Sheet1!A1:A4",
      "majorDimension": "COLUMNS",
      "values": [
        ["Item", "Wheel", "Door", "Engine"]
      ]
    },
    {
      "range": "Sheet1!B1:D2",
      "majorDimension": "ROWS",
      "values": [
        ["Cost", "Stocked", "Ship Date"],
        ["$20.50", "4", "3/1/2016"]
      ]
    }
  ]
}

回應包含一個物件,其中列出更新後的儲存格統計資料,以及 UpdateValuesResponse 物件陣列 (每個更新範圍各有一個物件)。例如:

{
  "spreadsheetId": SPREADSHEET_ID,
  "totalUpdatedRows": 4,
  "totalUpdatedColumns": 4,
  "totalUpdatedCells": 10,
  "totalUpdatedSheets": 1,
  "responses": [
    {
      "spreadsheetId": SPREADSHEET_ID,
      "updatedRange": "Sheet1!A1:A4",
      "updatedRows": 4,
      "updatedColumns": 1,
      "updatedCells": 4,
    },
    {
      "spreadsheetId": SPREADSHEET_ID,
      "updatedRange": "Sheet1!B1:D2",
      "updatedRows": 2,
      "updatedColumns": 3,
      "updatedCells": 6,
    }
  ],
}

產生的試算表如下所示:

A B C D
1 項目 費用 已備貨 出貨日期
2 車輪 $20.50 4 2016 年 3 月 1 日
3
4 引擎
5

寫入值 (不剖析)

從空白試算表開始,下列spreadsheets.values.update 程式碼範例說明如何將值寫入 Sheet1!A1:E1 範圍,但使用 RAW ValueInputOption 查詢參數,防止寫入的字串剖析為公式、布林值或數字。這些值會顯示為字串,且文字在工作表中的對齊方式為靠左對齊。

要求主體是 ValueRange 物件,用於說明要寫入的範圍值。majorDimension 欄位表示陣列是依資料列排列的值清單。目標範圍中的現有值會遭到覆寫。

要求通訊協定如下所示。

PUT https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:E1?valueInputOption=RAW
{
  "range": "Sheet1!A1:E1",
  "majorDimension": "ROWS",
  "values": [
    ["Data", 123.45, true, "=MAX(D2:D4)", "10"]
  ],
}

回應包含 UpdateValuesResponse 物件,例如:

{
  "spreadsheetId": SPREADSHEET_ID,
  "updatedRange": "Sheet1!A1:E1",
  "updatedRows": 1,
  "updatedColumns": 5,
  "updatedCells": 5,
}

產生的試算表如下所示:

A B C D E
1 資料 123.45 TRUE =MAX(D2:D4) 10
2

請注意,「TRUE」會置中顯示,且為布林值;「123.45」會靠右對齊,因為這是數字;「10」會靠左對齊,因為這是字串。公式不會經過剖析,且會顯示為字串。

附加值

首先,請使用類似下表的試算表:

A B C D
1 項目 費用 已備貨 出貨日期
2 車輪 $20.50 4 2016 年 3 月 1 日
3

下列spreadsheets.values.append程式碼範例說明如何從第 3 列開始新增兩列值。ValueInputOption 查詢參數為必填,可決定是否要剖析寫入的值 (例如是否要將字串轉換為日期)。

要求主體是 ValueRange 物件,用於說明要寫入的範圍值。majorDimension 欄位表示陣列是依資料列排列的值清單。

要求通訊協定如下所示。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:E1:append?valueInputOption=VALUE_INPUT_OPTION
{
  "range": "Sheet1!A1:E1",
  "majorDimension": "ROWS",
  "values": [
    ["Door", "$15", "2", "3/15/2016"],
    ["Engine", "$100", "1", "3/20/2016"],
  ],
}

回應包含 AppendValuesResponse 物件,例如:

{
  "spreadsheetId": SPREADSHEET_ID,
  "tableRange": "Sheet1!A1:D2",
  "updates": {
    "spreadsheetId": SPREADSHEET_ID,
    "updatedRange": "Sheet1!A3:D4",
    "updatedRows": 2,
    "updatedColumns": 4,
    "updatedCells": 8,
  }
}

產生的試算表如下所示:

A B C D
1 項目 費用 已備貨 出貨日期
2 車輪 $20.50 4 2016 年 3 月 1 日
3 $15 2 2016 年 3 月 15 日
4 引擎 $100 1 2016 年 3 月 20 日
5