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,
  "commentsViewMode": enum (CommentsViewMode)
}
欄位
requests[]

object (Request)

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

boolean

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

string

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

boolean

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

enum (CommentsViewMode)

要套用至試算表的註解檢視模式。這樣就能查看試算表，並選擇是否要顯示註解。如未指定，則會使用 COMMENTS_VIEW_MODE_OMITTED。只有在 includeSpreadsheetInResponse 為「true」時才有意義。

回應主體

用於批次更新試算表的回覆。

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

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

string

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

object (Response)

更新的回覆。這與更新內容的對應關係為 1:1，但部分要求的回覆內容可能為空白。
updatedSpreadsheet

object (Spreadsheet)

套用更新後的試算表。只有在 BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response 為 true 時，才會設定這個值。
commentUpdateState

enum (CommentUpdateState)

批次要求中是否套用留言更新。

授權範圍

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

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

詳情請參閱授權指南。

CommentUpdateState

批次要求中註解更新的狀態。

列舉
COMMENT_UPDATE_STATE_UNSPECIFIED 未指定註解更新狀態。
NO_UPDATES_REQUESTED 批次要求中未要求更新任何留言。
ALL_SAVED 批次要求中已套用所有要求的註解更新。
ALL_FAILED_UNKNOWN_REASON 所有要求的註解更新作業都失敗。