- คำขอ 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
เพื่อให้ข้อมูลบางอย่างแก่คุณเกี่ยวกับวิธีนำไปใช้ คำขออื่นๆ ไม่จำเป็นต้องส่งคืนข้อมูล แต่ละรายการจะแสดงการตอบกลับที่ว่างเปล่า ลำดับของการตอบกลับตรงกับลำดับของคำขอ
ตัวอย่างเช่น สมมติว่าคุณเรียก groupUpdate ด้วยการอัปเดต 4 รายการ แต่รายการที่สามส่งคืนข้อมูล การตอบกลับจะมีการตอบกลับที่ว่างเปล่า 2 การตอบกลับ ได้แก่ การตอบกลับคำขอที่ 3 และการตอบกลับที่ว่างเปล่าอีก 1 รายการตามลำดับ
เนื่องจากผู้ใช้รายอื่นอาจแก้ไขเอกสารอยู่ เอกสารจึงอาจไม่ได้ตรงกับการเปลี่ยนแปลงของคุณทุกประการ โดยอาจมีการเปลี่ยนแปลงตามการเปลี่ยนแปลงของผู้ทำงานร่วมกัน หากไม่มีผู้ทำงานร่วมกัน เอกสารควรจะแสดงการเปลี่ยนแปลงของคุณ ไม่ว่าในกรณีใดก็ตาม การอัปเดตในคำขอของคุณจะนําไปใช้ร่วมกันได้ในระดับที่ต่างกัน
คำขอ 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 คำขอจะได้รับการลองอีกครั้งหลังจากเรียกเอกสารเวอร์ชันล่าสุดแล้ว โดยปกติ รหัสการแก้ไขจะยังคงสามารถใช้ได้เป็นการแก้ไขเป้าหมายเป็นเวลาหลายนาทีหลังจากที่อ่านแล้ว แต่สำหรับเอกสารที่แก้ไขบ่อย หน้าต่างนี้อาจสั้นลง |