要求與回應

本指南介紹了構成 Google Docs API,以及如何批次更新文件。

您可以透過 HTTP 要求或使用方法叫用 Google Docs API 叫用特定語言用戶端程式庫。 這兩項指標相當大同小異。

Google Docs API 會傳回 HTTP 回應,當中通常包含 叫用清單。使用用戶端程式庫發出要求時, 會以特定語言的方式傳回回應。

要求方法

Docs API 支援下列方法:

  • documents.create:建立 空白的 Google 文件。
  • documents.get:傳回 完整擷取指定文件的內容您可以剖析傳回的 JSON 以擷取文件內容、格式設定和其他功能。
  • documents.batchUpdate:提交編輯要求清單,以便以原子方式套用至文件,並傳回結果清單。

documents.getdocuments.batchUpdate 方法需要 documentId 做為指定目標文件的參數。documents.create 方法 會傳回所建立文件的例項,您可以從中讀取 documentId。如要進一步瞭解 documentId,請參閱「文件 ID

批次更新

documents.batchUpdate 方法會採用 request 物件的清單,每個物件都會指定要執行的單一要求。例如為段落設定格式 新增內嵌圖片每個請求在套用前都會經過驗證, 系統會依據要求在批次要求中的顯示順序處理。

系統會以不可分割的形式套用批次更新中的所有要求。也就是說,如果任何要求皆無效,則整個更新作業都會失敗,且不會套用任何 (可能的依附) 變更。

某些 documents.batchUpdate 方法會提供回應,其中包含已套用要求的相關資訊。這些方法會傳回回應 內文 包含 response 清單 如需儲存大量結構化物件 建議使用 Cloud Bigtable其他要求則不需要傳回資訊,且會將空白顯示為 回覆。回應清單中的物件具有與 對應的要求

以下是提出批次要求的熱門模式:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

如要進一步瞭解如何批次處理 Google 文件 API 呼叫,請參閱批次要求最佳做法,以及documents.batchUpdate 的參考說明文件,瞭解要求和回應類型。

批次更新作業

批次更新要求有多種類型,接下來是 要求類型,分組到 不同的類別

物件 新增 / 插入 更新 / 更換 刪除
文字 InsertTextRequest ReplaceAllTextRequest
樣式 CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
已命名範圍 CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
圖片 InsertInlineImageRequest ReplaceImageRequest
表格 InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
頁面物件 (包括頁首頁尾) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest