Gửi yêu cầu hàng loạt

Tài liệu này trình bày cách phân nhóm các lệnh gọi API với nhau để giảm số lượng kết nối HTTP mà khách hàng của bạn phải thực hiện.

Tài liệu này trình bày cụ thể về việc thực hiện một yêu cầu hàng loạt bằng cách gửi Yêu cầu HTTP. Thay vào đó, nếu bạn đang sử dụng thư viện ứng dụng của Google để thực hiện yêu cầu hàng loạt, hãy xem tài liệu của thư viện ứng dụng.

Tổng quan

Mỗi kết nối HTTP mà ứng dụng của bạn tạo ra sẽ dẫn đến một mức hao tổn nhất định. Directory API hỗ trợ việc phân lô, để cho phép ứng dụng của bạn đặt nhiều lệnh gọi API vào một yêu cầu HTTP duy nhất.

Ví dụ về những trường hợp mà bạn có thể cần sử dụng tính năng phân lô:

• Bạn mới bắt đầu sử dụng API và có nhiều dữ liệu để tải lên.
• Người dùng đã thực hiện các thay đổi đối với dữ liệu trong khi ứng dụng của bạn ngoại tuyến (bị ngắt kết nối khỏi Internet), vì vậy, ứng dụng của bạn cần đồng bộ hóa dữ liệu cục bộ với máy chủ bằng cách gửi nhiều bản cập nhật và xóa.

Trong mỗi trường hợp, thay vì gửi riêng từng lệnh gọi, bạn có thể nhóm các lệnh gọi đó lại với nhau thành một yêu cầu HTTP duy nhất. Tất cả yêu cầu nội bộ phải đến cùng một API Google.

Bạn chỉ được có tối đa 1.000 lệnh gọi trong một yêu cầu hàng loạt. Nếu bạn phải thực hiện nhiều lệnh gọi hơn số lượng đó, hãy sử dụng nhiều yêu cầu theo lô.

Lưu ý: Hệ thống lô cho Directory API sử dụng cú pháp giống như hệ thống xử lý theo lô OData, nhưng ngữ nghĩa thì khác.

Chi tiết gói

Yêu cầu hàng loạt bao gồm nhiều lệnh gọi API kết hợp lại thành một yêu cầu HTTP. Yêu cầu này có thể được gửi đến batchPath được chỉ định trong tài liệu về khám phá API. Đường dẫn mặc định là /batch/api_name/api_version. Phần này mô tả chi tiết cú pháp lô; sau này sẽ có ví dụ.

Lưu ý: Một tập hợp n yêu cầu được nhóm cùng nhau sẽ được tính vào hạn mức sử dụng của bạn dưới dạng n yêu cầu chứ không phải một yêu cầu. Yêu cầu hàng loạt được tách thành một nhóm yêu cầu trước khi xử lý.

Định dạng của một yêu cầu hàng loạt

Yêu cầu hàng loạt là một yêu cầu HTTP tiêu chuẩn duy nhất chứa nhiều lệnh gọi API Thư mục, sử dụng loại nội dung multipart/mixed. Trong yêu cầu HTTP chính đó, mỗi phần đều chứa một yêu cầu HTTP lồng nhau.

Mỗi phần bắt đầu bằng tiêu đề HTTP Content-Type: application/http riêng. Tệp này cũng có thể có một tiêu đề Content-ID không bắt buộc. Tuy nhiên, các tiêu đề phần chỉ ở đó để đánh dấu phần đầu của phần này; chúng sẽ tách biệt với yêu cầu lồng nhau. Sau khi máy chủ khám phá yêu cầu theo lô thành các yêu cầu riêng biệt, tiêu đề của từng phần sẽ bị bỏ qua.

Phần nội dung của mỗi phần là một yêu cầu HTTP hoàn chỉnh, với động từ, URL, tiêu đề và nội dung riêng. Yêu cầu HTTP chỉ được chứa phần đường dẫn của URL; URL đầy đủ không được phép trong các yêu cầu hàng loạt.

Tiêu đề HTTP cho yêu cầu hàng loạt bên ngoài, ngoại trừ các tiêu đề Content- như Content-Type, áp dụng cho mọi yêu cầu trong lô. Nếu bạn chỉ định một tiêu đề HTTP nhất định trong cả yêu cầu bên ngoài và lệnh gọi riêng lẻ, thì giá trị của tiêu đề lệnh gọi riêng lẻ sẽ ghi đè giá trị của tiêu đề của yêu cầu hàng loạt bên ngoài. Tiêu đề cho từng cuộc gọi chỉ áp dụng cho cuộc gọi đó.

Ví dụ: nếu bạn cung cấp tiêu đề Uỷ quyền cho một lệnh gọi cụ thể thì tiêu đề đó chỉ áp dụng cho lệnh gọi đó. Nếu bạn cung cấp tiêu đề Uỷ quyền cho yêu cầu bên ngoài thì tiêu đề đó sẽ áp dụng cho tất cả các lệnh gọi riêng lẻ trừ phi chúng ghi đè tiêu đề Uỷ quyền bằng tiêu đề Uỷ quyền của chính họ.

Khi máy chủ nhận được yêu cầu theo lô, máy chủ sẽ áp dụng các tiêu đề và tham số truy vấn của yêu cầu bên ngoài (nếu phù hợp) cho từng phần, sau đó xử lý từng phần như thể đó là một yêu cầu HTTP riêng biệt.

Phản hồi yêu cầu hàng loạt

Phản hồi của máy chủ là phản hồi HTTP tiêu chuẩn duy nhất có loại nội dung multipart/mixed; mỗi phần là phản hồi cho một trong các yêu cầu trong yêu cầu theo lô, theo cùng thứ tự như các yêu cầu.

Giống như các phần trong yêu cầu, mỗi phần phản hồi chứa phản hồi HTTP hoàn chỉnh, bao gồm mã trạng thái, tiêu đề và nội dung. Và cũng giống như các phần trong yêu cầu, mỗi phần phản hồi đều được đứng sau một tiêu đề Content-Type đánh dấu điểm bắt đầu của phần đó.

Nếu một phần nhất định của yêu cầu có tiêu đề Content-ID, thì phần tương ứng của phản hồi cũng có tiêu đề Content-ID phù hợp, trong đó giá trị ban đầu đứng trước chuỗi response-, như trong ví dụ sau.

Lưu ý: Máy chủ có thể thực hiện các lệnh gọi của bạn theo thứ tự bất kỳ. Không tính đến việc các mô-đun này sẽ được thực thi theo thứ tự mà bạn đã chỉ định. Nếu muốn đảm bảo rằng 2 lệnh gọi xảy ra theo một thứ tự nhất định, bạn không thể gửi các lệnh gọi đó trong một yêu cầu duy nhất; thay vào đó, hãy tự gửi tin nhắn đầu tiên, sau đó đợi phản hồi cho tin nhắn đầu tiên rồi mới gửi tin nhắn thứ hai.

Ví dụ:

Ví dụ sau đây cho thấy việc sử dụng tính năng phân lô bằng một API minh hoạ chung (giả tưởng) được gọi là Farm API (API Trang trại). Tuy nhiên, các khái niệm tương tự cũng áp dụng cho API Thư mục.

Ví dụ về yêu cầu hàng loạt

POST /batch/farm/v1 HTTP/1.1
Authorization: Bearer your_auth_token
Host: www.googleapis.com
Content-Type: multipart/mixed; boundary=batch_foobarbaz
Content-Length: total_content_length

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item1:[e-mail]>

GET /farm/v1/animals/pony

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item2:[e-mail]>

PUT /farm/v1/animals/sheep
Content-Type: application/json
Content-Length: part_content_length
If-Match: "etag/sheep"

{
  "animalName": "sheep",
  "animalAge": "5"
  "peltColor": "green",
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item3:[e-mail]>

GET /farm/v1/animals
If-None-Match: "etag/animals"

--batch_foobarbaz--

Ví dụ về phản hồi hàng loạt

Đây là phản hồi cho yêu cầu mẫu trong phần trước.

HTTP/1.1 200
Content-Length: response_total_content_length
Content-Type: multipart/mixed; boundary=batch_foobarbaz

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item1:[e-mail]>

HTTP/1.1 200 OK
Content-Type application/json
Content-Length: response_part_1_content_length
ETag: "etag/pony"

{
  "kind": "farm#animal",
  "etag": "etag/pony",
  "selfLink": "/farm/v1/animals/pony",
  "animalName": "pony",
  "animalAge": 34,
  "peltColor": "white"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item2:[e-mail]>

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: response_part_2_content_length
ETag: "etag/sheep"

{
  "kind": "farm#animal",
  "etag": "etag/sheep",
  "selfLink": "/farm/v1/animals/sheep",
  "animalName": "sheep",
  "animalAge": 5,
  "peltColor": "green"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item3:[e-mail]>

HTTP/1.1 304 Not Modified
ETag: "etag/animals"

--batch_foobarbaz--