Method: documents.batchUpdate

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

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

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

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

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

คำขอ 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)
  },
  "suggestionResponses": [
    {
      object (SuggestionResponse)
    }
  ],
  "commentUpdateState": enum (CommentUpdateState)
}
ช่อง
documentId

string

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

object (Response)

การตอบกลับการอัปเดต ซึ่งจะสอดคล้องกับการอัปเดตแบบ 1:1 แม้ว่าการตอบกลับคำขอบางรายการอาจไม่มีข้อมูลก็ตาม
writeControl

object (WriteControl)

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

object (SuggestionResponse)

คำแนะนำที่ได้รับผลกระทบจากการอัปเดตแต่ละครั้ง ซึ่งจะสอดคล้องกับการอัปเดตแบบ 1:1

commentUpdateState

enum (CommentUpdateState)

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

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

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

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

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

WriteControl

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

การแสดง JSON 
{
  "writeMode": enum (WriteMode),

  "requiredRevisionId": string,
  "targetRevisionId": string
}
ช่อง
writeMode

enum (WriteMode)

วิธีใช้การอัปเดตคำขอในเอกสาร

หากไม่ได้ระบุไว้ ระบบจะใช้การอัปเดตคำขอเป็นการแก้ไขตามปกติ

ฟิลด์ Union control กำหนดการแก้ไขเอกสารที่จะเขียนและลักษณะการทำงานของคำขอหากการแก้ไขนั้นไม่ใช่การแก้ไขปัจจุบันของเอกสาร หากไม่ได้ระบุทั้ง 2 ฟิลด์ ระบบจะใช้การอัปเดตกับการแก้ไขล่าสุด control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
requiredRevisionId

string

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

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

string

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

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

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

WriteMode

กำหนดวิธีนำการอัปเดตคำขอไปใช้กับเอกสาร

Enum
WRITE_MODE_UNSPECIFIED ไม่ได้ระบุโหมดการเขียน ค่าเริ่มต้นคือลักษณะการทำงานของ EDIT
EDIT ใช้การอัปเดตทั้งหมดเป็นการแก้ไขตามปกติ
SUGGEST ใช้การอัปเดตทั้งหมดเป็นคำแนะนำ

SuggestionResponse

คำแนะนำที่ได้รับผลกระทบจากการอัปเดตที่ระบุ

การแสดง JSON 
{
  "createdSuggestionIds": [
    string
  ],
  "updatedSummarySuggestionIds": [
    string
  ],
  "deletedSuggestionIds": [
    string
  ],
  "acceptedSuggestionIds": [
    string
  ],
  "rejectedSuggestionIds": [
    string
  ]
}
ช่อง
createdSuggestionIds[]

string

รหัสของคำแนะนำที่สร้างขึ้นระหว่างการอัปเดต
updatedSummarySuggestionIds[]

string

รหัสของคำแนะนำที่มีการอัปเดตข้อมูลสรุประหว่างการอัปเดต
deletedSuggestionIds[]

string

รหัสของคำแนะนำที่ถูกลบระหว่างการอัปเดต
acceptedSuggestionIds[]

string

รหัสของคำแนะนำที่ได้รับการยอมรับระหว่างการอัปเดต
rejectedSuggestionIds[]

string

รหัสของคำแนะนำที่ถูกปฏิเสธระหว่างการอัปเดต

CommentUpdateState

สถานะของการอัปเดตความคิดเห็นในคำขอแบบกลุ่ม

Enum
COMMENT_UPDATE_STATE_UNSPECIFIED ไม่ได้ระบุสถานะการอัปเดตความคิดเห็น
NO_UPDATES_REQUESTED ไม่มีการขออัปเดตความคิดเห็นในคำขอแบบกลุ่ม
ALL_SAVED การอัปเดตความคิดเห็นที่ขอทั้งหมดมีผลในคำขอแบบกลุ่มแล้ว
ALL_FAILED_UNKNOWN_REASON การอัปเดตความคิดเห็นที่ขอทั้งหมดไม่สำเร็จ