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)

更新的回覆。這會與更新項目一對一對應，但某些要求的回覆可能會為空白。
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

詳情請參閱授權指南。