透過 GoogleSheet API,您可以更新試算表中的儲存格和範圍格式設定。本頁的範例將說明如何使用試算表 API 完成某些常見的格式作業。您可以在條件式格式設定方案頁面中查看更多條件式格式設定範例。
更新試算表時,某些要求可能會傳回回應。這些會以陣列傳回,且每個回應都佔用與對應要求相同的索引。有些要求沒有回應,而這些要求為空白。您可以在 spreadsheets.batchUpdate
下方找到這些範例的回應結構。
這些範例是以 HTTP 要求形式呈現,採用不受語言限制。如要瞭解如何使用 Google API 用戶端程式庫以不同語言實作批次更新,請參閱「更新試算表」。
在這些範例中,預留位置 SPREADSHEET_ID 和 SHEET_ID 代表您提供這些 ID 的位置。你可以在試算表網址中找到試算表 ID。您可以使用 spreadsheets.get
方法取得工作表 ID。範圍是使用 A1 標記法指定。例如 Sheet1!A1:D5。
在上方影片中,您會學習如何以多種方式設定試算表儲存格的格式,包括:建立凍結列、將儲存格設為粗體、實作貨幣格式、執行儲存格驗證,以及限制儲存格值。
編輯儲存格框線
以下 spreadsheets.batchUpdate
程式碼範例說明如何使用 UpdateBordersRequest
,為 A1:F10 範圍中的每個儲存格加上虛線、藍色上、下邊框。innerHorizontal
欄位會在範圍內部建立水平框線。如果省略這個欄位,系統只會將邊界加到整個範圍的頂端和底部。
要求通訊協定如下所示。
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
欄位中省略資料欄索引後,整個資料列的格式就會改變。第二個要求會調整工作表屬性,使標頭列凍結。
要求通訊協定如下所示。
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 中的資料欄,而資料列保持分隔。
要求通訊協定如下所示。
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
。此格式的日期時間範例如下:「2016 年 4 月 3 日星期日下午 02:05:07」。
第二個要求會向 B1:B10 中的儲存格提供自訂數字格式 #,##0.0000
,這表示數字應以半形逗號分隔符分組,表示小數點後應有 4 位數,但應捨棄所有開頭的零。舉例來說,數字「3.14」顯示為「3.1400」,而「12345.12345」則顯示為「12,345.1235」。
要求通訊協定如下所示。
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" } } ] }