批次處理要求

本文說明如何批次處理 API 呼叫,以減少用戶端必須建立的連線數量。批次處理可減少網路往返次數並提高總處理量,進而提升應用程式的效率。

總覽

用戶端建立的每個連線都會造成一定程度的負擔。 Google 文件 API 支援批次處理作業,可讓用戶端將多個要求物件放入單一批次要求中,每個要求物件都會指定要執行的單一要求類型。批次要求可將多個子要求合併為單一對伺服器的呼叫,並擷取單一回應,進而提升效能。

我們建議使用者一律批次處理多個要求。以下列舉一些可使用批次作業的狀況範例:

  • 您剛開始使用 API,但有大量資料需要上傳。
  • 您需要在多個物件上更新中繼資料或屬性 (例如格式)。
  • 您需要刪除許多物件。

限制、授權和相依性考量

以下列出採用批次更新時應考量的其他事項:

  • 每個批次要求 (包括所有子要求) 都會計入您的用量限制,視為一個 API 要求。
  • 批次要求只會驗證一次。這項單一驗證作業會套用至要求中的所有批次更新物件。
  • 伺服器會依照子要求在批次要求中顯示的順序處理這些要求。後續子要求可能會依據先前子要求執行的動作而定。舉例來說,在同一個批次要求中,使用者可以將文字插入現有文件中,然後設定樣式。

批次詳細資料

批次要求包含一個 batchUpdate 方法呼叫,以及多個子要求,例如新增及設定文件格式。

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

部分要求會在回應中提供已提出要求的相關資訊。舉例來說,所有新增物件的批次更新要求都會傳回回應,讓您存取新新增物件的中繼資料,例如 ID 或標題。

透過這種方法,您可以使用包含多個子要求的單一 API 批次更新要求,建構整份 Google 文件。

批次要求的格式

要求是單一 JSON 要求,其中包含多個巢狀子要求,且具有一個必要屬性:requests。要求會以個別要求陣列的形式建構。每個要求都會使用 JSON 代表要求物件,並包含其屬性。

批次回應的格式

批次要求的回應格式與要求格式類似。伺服器的回應包含單一回應物件的完整回覆。

主要 JSON 物件的屬性名稱為 replies。回應會以陣列的形式傳回,其中每個回應都會與某個要求相關,並與對應要求的索引順序相同。部分要求沒有回應,且該陣列索引的回應為空白。

範例

以下程式碼範例說明如何使用 Docs API 進行批次處理。

要求

這個批次要求範例說明如何執行下列操作:

  • 使用 InsertTextRequest,將「Hello World」文字插入現有文件的開頭,並使用 1 的索引 location

  • 使用 UpdateTextStyleRequest 更新「Hello」一詞。startIndexendIndex 會定義片段中格式化文字的 range

  • 使用 textStyle,將「Hello」字詞的字型樣式設為粗體,並將顏色設為藍色。

  • 您可以使用 WriteControl 欄位,控制寫入要求的執行方式。詳情請參閱「使用 WriteControl 建立狀態一致性」。

{
   "requests":[
      {
         "insertText":{
            "location":{
               "index":1,
               "tabId":TAB_ID
            },
            "text":"Hello World"
         }
      },
      {
         "updateTextStyle":{
            "range":{
               "startIndex":1,
               "endIndex":6
            },
            "textStyle":{
               "bold":true,
               "foregroundColor":{
                  "color":{
                     "rgbColor":{
                        "blue":1
                     }
                  }
               }
            },
            "fields":"bold,foreground_color"
         }
      }
   ],
   "writeControl": {
      "requiredRevisionId": "REQUIRED_REVISION_ID"
  }
}

TAB_IDREQUIRED_REVISION_ID 分別替換為要套用寫入要求的文件的分頁 ID 和修訂 ID。

回應

這個批次回應範例會顯示批次要求中每個子要求的套用方式。InsertTextRequestUpdateTextStyleRequest 都沒有包含回應,因此 [0] 和 [1] 陣列的索引值由空白的捲號組成。批次要求會顯示 WriteControl 物件,說明要求的執行方式。

{
   "replies":[
      {},
      {}
   ],
   "writeControl":{
      "requiredRevisionId":`REQUIRED_REVISION_ID`
   },
   "documentId":`DOCUMENT_ID`
}