Method: spreadsheets.batchUpdate

นําการอัปเดตไปใช้ในสเปรดชีต

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
}
ช่อง
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

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