Method: spreadsheets.batchUpdate

Menerapkan satu atau beberapa update ke spreadsheet.

Setiap request divalidasi sebelum diterapkan. Jika ada permintaan yang tidak valid, seluruh permintaan akan gagal dan tidak ada yang akan diterapkan.

Beberapa permintaan memiliki replies untuk memberi Anda beberapa informasi tentang cara penerapannya. Balasan akan mencerminkan permintaan. Misalnya, jika Anda menerapkan 4 pembaruan dan pembaruan ke-3 memiliki balasan, maka respons akan memiliki 2 balasan kosong, balasan sebenarnya, dan balasan kosong lainnya, dalam urutan tersebut.

Karena sifat kolaboratif spreadsheet, tidak ada jaminan bahwa spreadsheet akan mencerminkan perubahan Anda secara persis setelah permintaan ini selesai, tetapi ada jaminan bahwa pembaruan dalam permintaan akan diterapkan bersama secara atomik. Perubahan Anda dapat diubah sehubungan dengan perubahan kolaborator. Jika tidak ada kolaborator, spreadsheet akan mencerminkan perubahan Anda.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
spreadsheetId

string

Spreadsheet tempat pembaruan akan diterapkan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
Kolom
requests[]

object (Request)

Daftar pembaruan yang akan diterapkan ke spreadsheet. Permintaan akan diterapkan sesuai urutan yang ditentukan. Jika ada permintaan yang tidak valid, tidak ada permintaan yang akan diterapkan.
includeSpreadsheetInResponse

boolean

Menentukan apakah respons pembaruan harus menyertakan resource spreadsheet.
responseRanges[]

string

Membatasi rentang yang disertakan dalam spreadsheet respons. Hanya berguna jika includeSpreadsheetInResponse adalah 'true'.
responseIncludeGridData

boolean

Benar jika data petak harus ditampilkan. Hanya berguna jika includeSpreadsheetInResponse adalah 'true'. Parameter ini diabaikan jika mask kolom ditetapkan dalam permintaan.
commentsViewMode

enum (CommentsViewMode)

Mode tampilan komentar yang akan diterapkan ke spreadsheet. Hal ini memungkinkan melihat spreadsheet dengan komentar yang dihilangkan atau disertakan. Jika tidak ditentukan, COMMENTS_VIEW_MODE_OMITTED akan digunakan. Hanya berguna jika includeSpreadsheetInResponse adalah 'true'.

Isi respons

Balasan untuk memperbarui spreadsheet secara batch.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Kolom
spreadsheetId

string

Spreadsheet tempat pembaruan diterapkan.
replies[]

object (Response)

Balasan pembaruan. Hal ini dipetakan 1:1 dengan pembaruan, meskipun balasan untuk beberapa permintaan mungkin kosong.
updatedSpreadsheet

object (Spreadsheet)

Spreadsheet setelah pembaruan diterapkan. Ini hanya disetel jika BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response adalah true.
commentUpdateState

enum (CommentUpdateState)

Apakah pembaruan komentar diterapkan dalam permintaan batch.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.

CommentUpdateState

Status pembaruan komentar dalam permintaan batch.

Enum
COMMENT_UPDATE_STATE_UNSPECIFIED Status pembaruan komentar tidak ditentukan.
NO_UPDATES_REQUESTED Tidak ada pembaruan komentar yang diminta dalam permintaan batch.
ALL_SAVED Semua pembaruan komentar yang diminta diterapkan dalam permintaan batch.
ALL_FAILED_UNKNOWN_REASON Semua pembaruan komentar yang diminta gagal.