Method: documents.batchUpdate

ใช้การอัปเดตกับเอกสาร

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

คําขอบางฉบับมี replies เพื่อให้ข้อมูลเกี่ยวกับวิธีการนําไปใช้ คําขออื่นๆ ไม่จําเป็นต้องส่งคืนข้อมูล คําขอเหล่านี้จะส่งการตอบกลับที่ว่างเปล่า ลําดับของการตอบกลับจะตรงกับลําดับของคําขอ

ตัวอย่างเช่น สมมติว่าคุณเรียก bundleUpdate ที่มีการอัปเดตสี่รายการ และมีเพียงการอัปเดตครั้งที่สามเท่านั้นที่ส่งคืนข้อมูล คําตอบจะมีการตอบกลับที่ว่างเปล่า 2 รายการ การตอบกลับคําขอที่สาม และการตอบกลับที่ว่างเปล่าอีกรายการตามลําดับ

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

คำขอ HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

URL ใช้ไวยากรณ์ gRPC Transcoding

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

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

string

รหัสของเอกสารที่จะอัปเดต

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

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

การแสดง JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
ช่อง
requests[]

object (Request)

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

object (WriteControl)

ให้การควบคุมวิธีการเรียกใช้คําขอเขียน

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

ข้อความตอบกลับจากคําขอ documents.batchUpdate

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

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

string

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

object (Response)

การตอบกลับการอัปเดต การดําเนินการนี้จะจับคู่การอัปเดตแบบ 1:1 กับการอัปเดต แต่การตอบกลับคําขอบางรายการอาจว่างเปล่า
writeControl

object (WriteControl)

การควบคุมการเขียนที่อัปเดตหลังจากใช้คําขอ

ขอบเขตการให้สิทธิ์

ต้องการขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

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

การควบคุมการเขียน

ให้การควบคุมวิธีการเรียกใช้คําขอเขียน

การแสดง JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
ช่อง
ช่อง Union control พิจารณาการแก้ไขเอกสารที่จะเขียนและลักษณะการทํางานของคําขอหากการแก้ไขนั้นไม่ใช่การแก้ไขปัจจุบันในเอกสาร หากไม่มีการระบุทั้ง 2 ช่อง ระบบจะใช้การอัปเดตกับการแก้ไขล่าสุด control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
requiredRevisionId

string

revision ID ที่ไม่บังคับของเอกสารที่ใช้กับคําขอเขียน หากนี่ไม่ใช่การแก้ไขเอกสารครั้งล่าสุด คําขอจะไม่ได้รับการดําเนินการและแสดงข้อผิดพลาด 400 คําขอที่ไม่ถูกต้อง

เมื่อมีการส่งคืนรหัสการแก้ไขที่ต้องระบุในการตอบกลับ รหัสการตรวจสอบของเอกสารจะแสดงหลังจากที่ใช้คําขอ
targetRevisionId

string

เป้าหมายที่ไม่บังคับ revision ID ของเอกสารที่ใช้เขียนคําขอ

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

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