Method: documents.batchUpdate

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

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

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

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

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

คำขอ HTTP

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

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

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

พารามิเตอร์
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

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

WriteControl

ให้การควบคุมวิธีดำเนินการกับคำขอเขียน

การแสดง 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.
}
ช่อง
ฟิลด์สหภาพ control กำหนดการแก้ไขของเอกสารที่จะเขียนถึง และลักษณะการทํางานของคําขอหากการแก้ไขนั้นไม่ใช่การแก้ไขปัจจุบันของเอกสาร หากไม่ได้ระบุฟิลด์ใดเลย ระบบจะใช้การอัปเดตกับเวอร์ชันล่าสุด control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
requiredRevisionId

string

revision ID ของเอกสารที่จะใช้คำขอเขียน (ไม่บังคับ) หากเอกสารนี้ไม่ใช่ฉบับแก้ไขล่าสุด ระบบจะไม่ประมวลผลคำขอและแสดงข้อผิดพลาด 400 Bad Request

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

string

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

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

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