Yêu cầu theo lô

Tài liệu này cho biết cách kết hợp các lệnh gọi API để giảm số lượng kết nối mà ứng dụng của bạn phải thực hiện. Tính năng xử lý hàng loạt có thể cải thiện hiệu quả của ứng dụng bằng cách giảm số lượt truy cập mạng và tăng thông lượng.

Tổng quan

Mỗi kết nối mà ứng dụng của bạn thực hiện sẽ dẫn đến một mức hao tổn nhất định. API Google Tài liệu hỗ trợ tính năng tạo lô để cho phép ứng dụng của bạn đặt nhiều đối tượng yêu cầu, mỗi đối tượng chỉ định một loại yêu cầu cần thực hiện, vào một yêu cầu hàng loạt. Yêu cầu hàng loạt có thể tăng hiệu suất bằng cách kết hợp nhiều yêu cầu con vào một lệnh gọi duy nhất đến máy chủ, truy xuất một phản hồi duy nhất.

Người dùng nên luôn tạo nhiều yêu cầu cùng một lúc. Dưới đây là một số ví dụ về trường hợp bạn có thể sử dụng tính năng xử lý hàng loạt:

  • Bạn mới bắt đầu sử dụng API và có nhiều dữ liệu cần tải lên.
  • Bạn cần cập nhật siêu dữ liệu hoặc thuộc tính, chẳng hạn như định dạng, trên nhiều đối tượng.
  • Bạn cần xoá nhiều đối tượng.

Những điều cần cân nhắc về giới hạn, quyền uỷ quyền và phần phụ thuộc

Dưới đây là danh sách các mục khác cần cân nhắc khi sử dụng tính năng cập nhật hàng loạt:

  • Mỗi yêu cầu hàng loạt, bao gồm cả tất cả các yêu cầu phụ, được tính là một yêu cầu API đối với giới hạn sử dụng của bạn.
  • Yêu cầu hàng loạt được xác thực một lần. Lượt xác thực này áp dụng cho tất cả đối tượng cập nhật hàng loạt trong yêu cầu.
  • Máy chủ xử lý các yêu cầu con theo thứ tự xuất hiện trong yêu cầu theo lô. Các yêu cầu phụ sau này có thể phụ thuộc vào các hành động được thực hiện trong các yêu cầu phụ trước đó. Ví dụ: trong cùng một yêu cầu hàng loạt, người dùng có thể chèn văn bản vào một tài liệu hiện có rồi định kiểu cho văn bản đó.

Chi tiết gói

Yêu cầu hàng loạt bao gồm một lệnh gọi phương thức batchUpdate với nhiều yêu cầu phụ, chẳng hạn như thêm rồi định dạng một tài liệu.

Mỗi yêu cầu đều được xác thực trước khi được áp dụng. Tất cả các yêu cầu con trong bản cập nhật hàng loạt đều được áp dụng một cách nguyên tử. Tức là nếu có bất kỳ yêu cầu nào không hợp lệ thì toàn bộ quá trình cập nhật sẽ không thành công và không có thay đổi nào (có thể phụ thuộc) được áp dụng.

Một số yêu cầu cung cấp phản hồi kèm theo thông tin về các yêu cầu đã áp dụng. Ví dụ: tất cả yêu cầu cập nhật hàng loạt để thêm đối tượng đều trả về phản hồi để bạn có thể truy cập vào siêu dữ liệu của đối tượng mới thêm, chẳng hạn như mã nhận dạng hoặc tiêu đề.

Với phương pháp này, bạn có thể tạo toàn bộ tài liệu trên Google bằng một yêu cầu cập nhật hàng loạt API với nhiều yêu cầu phụ.

Định dạng của yêu cầu theo lô

Yêu cầu là một yêu cầu JSON duy nhất chứa nhiều yêu cầu phụ lồng nhau với một thuộc tính bắt buộc: requests. Các yêu cầu được tạo trong một mảng gồm các yêu cầu riêng lẻ. Mỗi yêu cầu sử dụng JSON để biểu thị đối tượng yêu cầu và chứa các thuộc tính của đối tượng đó.

Định dạng của phản hồi hàng loạt

Định dạng phản hồi cho yêu cầu hàng loạt tương tự như định dạng yêu cầu. Phản hồi của máy chủ chứa một phản hồi đầy đủ của một đối tượng phản hồi.

Thuộc tính của đối tượng JSON chính có tên là replies. Các phản hồi được trả về trong một mảng, trong đó mỗi phản hồi cho một trong các yêu cầu chiếm cùng thứ tự chỉ mục với yêu cầu tương ứng. Một số yêu cầu không có phản hồi và phản hồi tại chỉ mục mảng đó trống.

Ví dụ:

Mã mẫu sau đây cho thấy cách sử dụng tính năng xử lý hàng loạt bằng API Tài liệu.

Yêu cầu

Yêu cầu theo lô mẫu này minh hoạ cách:

  • Chèn văn bản "Hello World" vào đầu một tài liệu hiện có, với chỉ mục location là 1, bằng cách sử dụng InsertTextRequest.

  • Cập nhật từ "Hello" (Xin chào) bằng UpdateTextStyleRequest. startIndex và endIndex xác định range của văn bản được định dạng trong phân đoạn.

  • Sử dụng textStyle, hãy đặt kiểu phông chữ thành đậm và màu thành xanh dương cho chỉ từ "Hello".

  • Bằng cách sử dụng trường WriteControl, bạn có thể kiểm soát cách thực thi các yêu cầu ghi. Để biết thêm thông tin, hãy xem phần Thiết lập tính nhất quán của trạng thái bằng 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"
  }
}

Thay thế TAB_ID và REQUIRED_REVISION_ID bằng mã thẻ và mã sửa đổi tương ứng của tài liệu mà yêu cầu ghi được áp dụng.

Phản hồi

Phản hồi theo lô mẫu này cho thấy thông tin về cách áp dụng từng yêu cầu phụ trong yêu cầu theo lô. Cả InsertTextRequest và UpdateTextStyleRequest đều không chứa phản hồi, vì vậy, các giá trị chỉ mục của mảng tại [0] và [1] bao gồm các dấu ngoặc nhọn trống. Yêu cầu hàng loạt hiển thị đối tượng WriteControl, cho biết cách thực thi các yêu cầu.

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