Method: spreadsheets.batchUpdate

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

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

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

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

คำขอ HTTP

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

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

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

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

string

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

เนื้อหาของคำขอ

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

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

object (Request)

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

boolean

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

string

จำกัดช่วงที่รวมอยู่ในสเปรดชีตการตอบกลับ มีความหมายในกรณีที่ includeSpreadsheetInResponse เป็น "จริง" เท่านั้น
responseIncludeGridData

boolean

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

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

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

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

การแสดง JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
ช่อง
spreadsheetId

string

สเปรดชีตที่ใช้การอัปเดต
replies[]

object (Response)

การตอบกลับการอัปเดต แมปนี้เป็นแบบ 1:1 พร้อมการอัปเดต แม้ว่าการตอบกลับคำขอบางรายการอาจว่างเปล่า
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

โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์