Yêu cầu theo lô

Tài liệu này trình bày cách kết hợp các lệnh gọi API với nhau để giảm số lượng kết nối mà ứng dụng của bạn phải thực hiện. Việc 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ền dữ liệu qua lại trên 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 lượng hao tổn nhất định. Google Slides API hỗ trợ việc tạo yêu cầu hàng loạt để 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 duy nhất 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 phụ thành 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 lúc. Sau đây là một số ví dụ về những 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 cá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.

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

Sau đây là danh sách những 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 trong giới hạn sử dụng.
  • Yêu cầu hàng loạt được xác thực một lần. Quy trình xác thực duy nhất này áp dụng cho tất cả cá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 phụ theo thứ tự xuất hiện trong yêu cầu hàng loạt. 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

Một 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 bản trình bày.

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 phụ trong bản cập nhật hàng loạt đều được áp dụng một cách riêng lẻ. Tức là nếu có yêu cầu 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ả các yêu cầu cập nhật hàng loạt để thêm đối tượng đều trả về các 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 được 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 theo lô của API có nhiều yêu cầu phụ.

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

request 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 các yêu cầu riêng lẻ. Mỗi yêu cầu đề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 một 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 câu trả lời hoàn chỉnh của đối tượng phản hồi duy nhất.

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 một thứ tự chỉ mục như 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 đó là 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 với Slides API.

Yêu cầu

Ví dụ về yêu cầu hàng loạt này minh hoạ cách:

  • Thêm tài nguyên presentations.pages vào bản trình bày hiện có, với insertionIndex là 1, bằng cách sử dụng phương thức CreateSlideRequest.

  • Thêm một shapeType thuộc loại TEXT_BOX vào trang trình bày mới bằng phương thức CreateShapeRequest.

  • Chèn văn bản "Xin chào thế giới" vào trường mới bằng phương thức InsertTextRequest.

{
   "requests":[
      {
         "createSlide":{
            "insertionIndex":1,
            "objectId":"newSlide"
         }
      },
      {
         "createShape":{
            "elementProperties":{
               "pageObjectId":"newSlide",
               "size":{
                  "height":{
                     "magnitude":50,
                     "unit":"PT"
                  },
                  "width":{
                     "magnitude":200,
                     "unit":"PT"
                  }
               }
            },
            "shapeType":"TEXT_BOX",
            "objectId":"newTextBox"
         }
      },
      {
         "insertText":{
            "objectId":"newTextBox",
            "text":"Hello World"
         }
      }
   ]
}

Phản hồi

Phản hồi hàng loạt 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 hàng loạt. Lưu ý rằng phương thức InsertTextRequest không chứa phản hồi nên giá trị chỉ mục của mảng tại [2] bao gồm các dấu ngoặc nhọn trống. Yêu cầu hàng loạt sẽ hiển thị thuộc tính WriteControl. Thuộc tính này cho biết cách thực hiện các yêu cầu ghi.

{
   "requiredRevisionId": ID
   "presentationId": "",
   "replies":[
      {
         "createSlide":{
            "objectId":"newSlide"
         }
      },
      {
         "createShape":{
            "objectId":"newTextBox"
         }
      },
      {
         
      }
   ],
   "writeControl":{
      "requiredRevisionId": REVISION_ID
   }
}