Method: spreadsheets.batchUpdate

スプレッドシートに 1 つ以上の更新を適用します。

各 request は、適用される前に検証されます。リクエストが無効な場合、リクエスト全体が失敗し、何も適用されません。

一部のリクエストには、適用方法に関する情報を提供する replies があります。返信はリクエストをミラーリングします。たとえば、4 つの更新を適用し、3 つ目の更新に返信があった場合、レスポンスには 2 つの空の返信、実際の返信、別の空の返信がこの順序で含まれます。

スプレッドシートの共同編集の性質上、この処理が完了した後にスプレッドシートに正確に変更が反映されるとは限りませんが、リクエストの更新がアトミックに適用されることは保証されます。共同編集者の変更内容に応じて、変更内容が変更されることがあります。共同編集者がいない場合は、スプレッドシートに変更が反映されます。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 リクエストされたコメントの更新がすべて失敗しました。