基本格式

Google Sheets API 可讓您更新試算表中的儲存格和範圍格式設定。本頁面的範例說明如何利用 Sheets API 完成一些常見的格式設定作業。您可以在條件式格式設定方案頁面中找到更多條件式格式設定範例。

更新試算表時,某些類型的要求可能會傳回回應。 這些字串會以陣列傳回,且每項回應都會佔用與對應要求相同的索引。部分要求沒有回應,因此這些回應為空白。這些範例的回應結構位於 spreadsheets.batchUpdate 下方。

這些範例以 HTTP 要求的形式呈現,可達成語言中立的目標。如要瞭解如何使用 Google API 用戶端程式庫,以不同語言實作批次更新,請參閱「更新試算表」。

在這些範例中,預留位置 SPREADSHEET_IDSHEET_ID 會指出您會在哪些位置提供這些 ID。你可以在試算表網址中找到試算表 ID。您可以使用 spreadsheets.get 方法取得工作表 ID。範圍是使用 A1 標記法來指定。範例範圍是 Sheet1!A1:D5。

在上述影片中,您將瞭解如何透過多種方式設定試算表儲存格的格式,包括建立凍結列、將儲存格粗體、使用貨幣格式設定、驗證儲存格值,以及限制儲存格值。

編輯儲存格框線

下列 spreadsheets.batchUpdate 程式碼範例說明如何使用 UpdateBordersRequest,為 A1:F10 範圍內的每個儲存格加上虛線、藍色頂端和下框線。innerHorizontal 欄位會在範圍的內部建立水平框線。如果省略此欄位,則邊框只會新增到整個範圍的頂端和底部。

表格含有 3 x 3 的表格,每個儲存格中都有虛線、上部和下框線。
圖 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 欄位中省略資料欄索引,會使整個資料列格式化。第二個要求會調整工作表屬性,以凍結標題列。

表格內含已設定格式標題列的 3 x 3 表格。
圖 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 中的資料欄,並將資料列分開。

表格含有合併的儲存格,格式為 3 乘 3 的表格。
圖 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」。

工作表中的 3 x 3 表格,並使用自訂日期時間與數字格式。
圖 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"
      }
    }
  ]
}