- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- 要求
- ReplaceAllTextRequest
- SubstringMatchCriteria
- TabsCriteria
- InsertTextRequest
- Location
- 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
- 試試看!
為文件套用一或多項更新。
每個 request
都會先經過驗證,才能套用。如果任何要求無效,整個要求都會失敗,系統不會套用任何要求。
有些要求會附上 replies
,讓您瞭解套用方式的相關資訊。其他要求則不需要傳回資訊。每則回應都會傳回空白回覆回覆的順序與要求的順序相符。
舉例來說,假設您使用 4 次更新來呼叫 batchUpdate,且只有第三個更新傳回資訊。回應包含兩個空白回覆、第三個要求回覆,以及另一個空白回覆。
由於其他使用者可能在編輯文件,因此文件內容可能不會確切反映您所做的變更:系統可能會根據協作者的變更來修改您所做的變更。如果沒有任何協作者,則文件會反映你所做的變更。無論如何,您要求的更新都會以不可分割的形式一起套用。
HTTP 要求
POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
documentId |
要更新的文件 ID。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "requests": [ { object ( |
欄位 | |
---|---|
requests[] |
要套用至文件的更新清單。 |
writeControl |
提供寫入要求的執行方式控制。 |
回應主體
來自 documents.batchUpdate
要求的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "documentId": string, "replies": [ { object ( |
欄位 | |
---|---|
documentId |
要套用更新的文件 ID。 |
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 |
可套用寫入要求的文件 (選用) 如果回應中傳回必要的修訂版本 ID,它會指出套用要求後的文件修訂版本 ID。 |
targetRevisionId |
套用寫入要求的文件選用目標 在使用 API 讀取文件後,如果協作者發生了變更,這項寫入要求產生的變更就會套用至協作者的變更。這會產生新的文件修訂版本,同時納入協作者變更與要求變更,同時解決衝突的變更。使用目標修訂版本 ID 時,API 用戶端可視為文件的其他協作者。 目標修訂版本 ID 只能用於寫入文件的近期版本。如果目標修訂版本過於接近最新修訂版本,系統就不會處理該要求,並傳回 400 錯誤要求錯誤。擷取最新版本的文件後,系統應重新嘗試要求。一般而言,修訂版本 ID 經過讀取後仍然有效,可當做目標修訂版本使用,但對於經常編輯的文件,這個視窗可能較短。 |