- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ส่งคำขอ
- ReplaceAllTextRequest
- SubstringMatchCriteria
- TabsCriteria
- InsertTextRequest
- ตำแหน่ง
- EndOfSegmentLocation
- UpdateTextStyleRequest
- CreateParagraphBulletsRequest
- BulletGlyphPreset
- DeleteParagraphBulletsRequest
- CreateNamedRangeRequest
- DeleteNamedRangeRequest
- UpdateParagraphStyleRequest
- DeleteContentRangeRequest
- InsertInlineImageRequest
- InsertTableRequest
- InsertTableRowRequest
- TableCellLocation
- InsertTableColumnRequest
- DeleteTableRowRequest
- DeleteTableColumnRequest
- InsertPageBreakRequest
- DeletePositionedObjectRequest
- UpdateTableColumnPropertiesRequest
- UpdateTableCellStyleRequest
- TableRange
- UpdateTableRowStyleRequest
- ReplaceImageRequest
- ImageReplaceMethod
- UpdateDocumentStyleRequest
- MergeTableCellsRequest
- UnmergeTableCellsRequest
- CreateHeaderRequest
- HeaderFooterType
- CreateFooterRequest
- CreateFootnoteRequest
- ReplaceNamedRangeContentRequest
- UpdateSectionStyleRequest
- InsertSectionBreakRequest
- DeleteHeaderRequest
- DeleteFooterRequest
- PinTableHeaderRowsRequest
- WriteControl
- การตอบกลับ
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetsChartResponse
- CreateHeaderResponse
- CreateFooterResponse
- CreateFootnoteResponse
- ลองใช้งาน
ใช้การอัปเดตอย่างน้อย 1 รายการกับเอกสาร
request
แต่ละรายการจะได้รับการตรวจสอบก่อนนำไปใช้ หากมีคำขอที่ไม่ถูกต้อง คำขอทั้งหมดจะล้มเหลวและจะไม่มีการนำไปใช้
คำขอบางรายการมีreplies
เพื่อให้ข้อมูลบางอย่างแก่คุณเกี่ยวกับวิธีนำไปใช้ คำขออื่นๆ ไม่จำเป็นต้องแสดงข้อมูล โดยแต่ละรายการจะแสดงการตอบกลับว่าง ลําดับของคําตอบจะตรงกับลําดับของคําขอ
ตัวอย่างเช่น สมมติว่าคุณเรียก setUpdate ด้วยการอัปเดต 4 รายการ และโค้ดรายการเดียวส่งคืนข้อมูล การตอบกลับจะมีคำตอบว่างเปล่า 2 รายการ ได้แก่ การตอบกลับคำขอที่ 3 และการตอบกลับว่างเปล่าอีกรายการตามลำดับดังกล่าว
เนื่องจากผู้ใช้รายอื่นอาจแก้ไขเอกสารอยู่ เอกสารจึงอาจไม่ได้ตรงกับการเปลี่ยนแปลงของคุณทุกประการ โดยอาจมีการเปลี่ยนแปลงตามการเปลี่ยนแปลงของผู้ทำงานร่วมกัน หากไม่มีผู้ทำงานร่วมกัน เอกสารควรแสดงการเปลี่ยนแปลงของคุณ ไม่ว่าในกรณีใด เราจะรับประกันว่าระบบจะใช้การอัปเดตในคำขอของคุณร่วมกัน
คำขอ HTTP
POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
documentId |
รหัสของเอกสารที่จะอัปเดต |
เนื้อหาของคำขอ
เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "requests": [ { object ( |
ช่อง | |
---|---|
requests[] |
รายการอัปเดตที่จะใช้กับเอกสาร |
writeControl |
ควบคุมวิธีดำเนินการกับคำขอเขียน |
เนื้อหาการตอบกลับ
ข้อความตอบกลับจากคำขอ documents.batchUpdate
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "documentId": string, "replies": [ { object ( |
ช่อง | |
---|---|
documentId |
รหัสของเอกสารที่ใช้การอัปเดต |
replies[] |
การตอบกลับการอัปเดต ซึ่งจะเชื่อมโยงกับข้อมูลอัปเดตแบบ 1:1 แม้ว่าการตอบกลับคำขอบางรายการอาจว่างเปล่า |
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 กำหนดการแก้ไขของเอกสารที่จะเขียนถึง และลักษณะการทํางานของคําขอหากการแก้ไขนั้นไม่ใช่การแก้ไขปัจจุบันของเอกสาร ถ้าไม่ได้ระบุช่องใดไว้เลย การอัปเดตจะใช้กับการแก้ไขล่าสุด control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
requiredRevisionId |
เมื่อมีการแสดงรหัสการแก้ไขที่จำเป็นในคำตอบ รหัสนั้นจะระบุรหัสการแก้ไขของเอกสารหลังจากที่ส่งคำขอ |
targetRevisionId |
หากการเปลี่ยนแปลงของผู้ทำงานร่วมกันเกิดขึ้นหลังจากที่อ่านเอกสารโดยใช้ API การเปลี่ยนแปลงที่เกิดจากคำขอเขียนนี้จะมีผลกับการเปลี่ยนแปลงของผู้ทำงานร่วมกัน การดำเนินการดังกล่าวจะส่งผลให้เกิดการแก้ไขใหม่ของเอกสาร ซึ่งประกอบด้วยการเปลี่ยนแปลงของผู้ทำงานร่วมกันและการเปลี่ยนแปลงในคำขอ โดยเซิร์ฟเวอร์เอกสารจะแก้ไขปัญหาการเปลี่ยนแปลงที่ขัดแย้งกัน เมื่อใช้รหัสการแก้ไขเป้าหมาย ไคลเอ็นต์ API อาจถือเป็นผู้ทำงานร่วมกันอีกคนหนึ่งของเอกสาร รหัสการแก้ไขเป้าหมายจะใช้ได้กับการเขียนลงในเอกสารเวอร์ชันล่าสุดเท่านั้น หากการแก้ไขเป้าหมายล้าหลังกว่าการแก้ไขล่าสุดมาก ระบบจะไม่ประมวลผลคําขอและแสดงข้อผิดพลาด 400 Bad Request คำขอจะได้รับการลองอีกครั้งหลังจากเรียกเอกสารเวอร์ชันล่าสุดแล้ว โดยปกติแล้วรหัสการแก้ไขจะยังคงใช้งานได้สำหรับการใช้เป็นเวอร์ชันเป้าหมายเป็นเวลาหลายนาทีหลังจากที่อ่านแล้ว แต่สำหรับเอกสารที่มีการแก้ไขบ่อย กรอบเวลานี้อาจสั้นลง |