Method: spreadsheets.batchUpdate

ใช้การอัปเดตอย่างน้อย 1 รายการกับสเปรดชีต

requestแต่ละรายการจะได้รับการตรวจสอบก่อนนำไปใช้ หากคำขอใดไม่ถูกต้อง คำขอทั้งหมดจะไม่สำเร็จและจะไม่มีการดำเนินการใดๆ

คำขอบางรายการมี replies เพื่อให้ข้อมูลเกี่ยวกับวิธีใช้ คำตอบจะเหมือนกับคำขอ ตัวอย่างเช่น หากคุณใช้การอัปเดต 4 รายการและรายการที่ 3 มีการตอบกลับ การตอบกลับจะมีคำตอบที่ว่างเปล่า 2 รายการ คำตอบจริง และคำตอบที่ว่างเปล่าอีก 1 รายการตามลำดับ

เนื่องจากสเปรดชีตเป็นเครื่องมือที่ใช้ทำงานร่วมกัน เราจึงไม่รับประกันว่าสเปรดชีตจะแสดงการเปลี่ยนแปลงของคุณอย่างถูกต้องหลังจากดำเนินการเสร็จสมบูรณ์ แต่เรารับประกันว่าการอัปเดตในคำขอจะนำไปใช้ร่วมกันแบบอะตอม การเปลี่ยนแปลงของคุณอาจมีการปรับเปลี่ยนตามการเปลี่ยนแปลงของผู้ทำงานร่วมกัน หากไม่มีผู้ทำงานร่วมกัน สเปรดชีตควรแสดงการเปลี่ยนแปลงของคุณ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
spreadsheetId

string

สเปรดชีตที่จะใช้การอัปเดต

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
ช่อง
requests[]

object (Request)

รายการการอัปเดตที่จะใช้กับสเปรดชีต ระบบจะใช้คำขอตามลำดับที่ระบุ หากคำขอใดไม่ถูกต้อง ระบบจะไม่นำคำขอใดๆ ไปใช้
includeSpreadsheetInResponse

boolean

กำหนดว่าการตอบกลับการอัปเดตควรรวมทรัพยากรสเปรดชีตหรือไม่
responseRanges[]

string

จำกัดช่วงที่รวมอยู่ในสเปรดชีตคำตอบ มีผลเฉพาะเมื่อ includeSpreadsheetInResponse เป็น "จริง"
responseIncludeGridData

boolean

เป็นจริงหากควรแสดงผลข้อมูลตารางกริด มีผลเฉพาะเมื่อ includeSpreadsheetInResponse เป็น "จริง" ระบบจะไม่สนใจพารามิเตอร์นี้หากมีการตั้งค่ามาสก์ฟิลด์ในคำขอ
commentsViewMode

enum (CommentsViewMode)

โหมดมุมมองความคิดเห็นที่จะใช้กับสเปรดชีต ซึ่งจะช่วยให้ดูสเปรดชีตโดยไม่แสดงความคิดเห็นหรือแสดงความคิดเห็นได้ หากไม่ได้ระบุ ระบบจะใช้ COMMENTS_VIEW_MODE_OMITTED มีผลเฉพาะเมื่อ includeSpreadsheetInResponse เป็น "จริง"

เนื้อหาการตอบกลับ

การตอบกลับสำหรับการอัปเดตสเปรดชีตแบบเป็นกลุ่ม

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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

สถานะของการอัปเดตความคิดเห็นในคำขอแบบกลุ่ม

Enum
COMMENT_UPDATE_STATE_UNSPECIFIED ไม่ได้ระบุสถานะการอัปเดตความคิดเห็น
NO_UPDATES_REQUESTED ไม่มีการขออัปเดตความคิดเห็นในคำขอแบบกลุ่ม
ALL_SAVED การอัปเดตความคิดเห็นที่ขอทั้งหมดมีผลในคำขอแบบกลุ่มแล้ว
ALL_FAILED_UNKNOWN_REASON การอัปเดตความคิดเห็นที่ขอทั้งหมดไม่สำเร็จ