Method: spreadsheets.batchUpdate

為試算表套用一或多項更新。

每個 request 都會先經過驗證，才能套用。如果有任何要求無效，整個要求都會失敗，系統不會套用任何要求。

某些要求會附上 replies，讓您瞭解套用方式的相關資訊。回應內容會與要求完全相同。舉例來說，如果您套用了 4 項更新，而第 3 項有回覆，則回應會依序包含 2 個空白回覆、實際回覆和其他空白回覆。

由於試算表具有協作的特性，因此無法保證試算表會在完成後確實反映您所做的變更，但可以保證請求中的更新內容能以不可分割的形式一起套用。系統可能會根據協作者的變更調整您的變更。如果沒有任何協作者，試算表應該會反映你所做的變更。

HTTP 要求

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
spreadsheetId

string

要套用更新內容的試算表。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
欄位
requests[]

object (Request)

要套用至試算表的更新清單。系統會按照指定順序套用要求。如果任何要求無效，系統就不會套用任何要求。
includeSpreadsheetInResponse

boolean

決定更新回應是否應包含試算表資源。
responseRanges[]

string

限制回應試算表中包含的範圍。只有在 includeSpreadsheetInResponse 為「true」時才有意義。
responseIncludeGridData

boolean

如果應傳回格線資料，則為「true」。只有在 includeSpreadsheetInResponse 為「true」時才有意義。如果要求中設定了欄位遮罩，系統就會忽略這個參數。

回應主體

批次更新試算表的回覆。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
欄位
spreadsheetId

string

套用更新內容的試算表。
replies[]

object (Response)

更新回覆。此地圖與更新內容進行 1:1 對應，但某些要求的回覆可能是空白的。
updatedSpreadsheet

object (Spreadsheet)

套用更新後的試算表。這只會在 BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response 為 true 時設定。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

詳情請參閱授權指南。