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

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