Żądania wsadowe

Z tego dokumentu dowiesz się, jak grupować wywołania interfejsu API, aby zmniejszyć liczbę połączeń HTTP, które musi nawiązać klient.

Ten dokument dotyczy wysyłania żądania zbiorczego przez wysłanie żądania HTTP. Jeśli zamiast tego używasz biblioteki klienta Google do wysyłania operacji grupowych, zapoznaj się z dokumentacją biblioteki klienta.

Omówienie

Każde połączenie HTTP nawiązywane przez klienta powoduje pewien narzut. Interfejs API Gmaila obsługuje tworzenie wsad, co pozwala klientowi umieszczać kilka wywołań interfejsu API w jednym żądaniu HTTP.

Przykłady sytuacji, w których warto użyć grupowania:

• dopiero zaczynasz korzystać z interfejsu API i masz dużo danych do przesłania.
• Użytkownik wprowadził zmiany w danych, gdy aplikacja była offline (nie miała połączenia z internetem), więc aplikacja musi zsynchronizować dane lokalne z serwerem, wysyłając wiele aktualizacji i usunąć.

W obu przypadkach zamiast wysyłać każde wywołanie osobno możesz je pogrupować w pojedyncze żądanie HTTP. Wszystkie żądania wewnętrzne muszą być kierowane do tego samego interfejsu Google API.

W jednym żądaniu zbiorczym możesz utworzyć maksymalnie 100 wywołań. Jeśli musisz wykonać więcej połączeń, użyj wielu zbiorczych próśb.

Uwaga: system przetwarzania zbiorczego interfejsu Gmail API używa tej samej składni co system przetwarzania zbiorczego OData, ale ma inną semantykę.

Uwaga: większe rozmiary partii mogą powodować ograniczanie szybkości. Nie zalecamy wysyłania partii większych niż 50 żądań.

Szczegóły wsadu

Żądanie zbiorcze składa się z kilku wywołań interfejsu API połączonych w jedno żądanie HTTP, które można wysłać do batchPath określonego w dokumencie z informacjami o interfejsie API. Ścieżka domyślna to /batch/api_name/api_version. W tej sekcji szczegółowo opisaliśmy składnię poleceń zbiorczych. Poniżej znajdziesz przykład.

Uwaga: zestaw n żądań zebranych w jedną grupę jest liczony jako n żądań, a nie jako jedno żądanie. Przed przetworzeniem żądanie zbiorcze jest dzielone na zestaw żądań.

Format żądania zbiorczego

Żądanie zbiorcze to jedno standardowe żądanie HTTP zawierające wiele wywołań interfejsu Gmail API przy użyciu typu treści multipart/mixed. W ramach tego głównego żądania HTTP każda część zawiera zagnieżdżone żądanie HTTP.

Każda część zaczyna się od własnego nagłówka Content-Type: application/http HTTP. Może też zawierać opcjonalny nagłówek Content-ID. Nagłówki części służą jednak tylko do oznaczania początku części i są oddzielone od zagnieżdżonego żądania. Gdy serwer rozpakuje żądanie zbiorcze na osobne żądania, nagłówki części są ignorowane.

Treść każdej części to kompletne żądanie HTTP z własnym czasownikiem, adresem URL, nagłówkami i treścią. Żądanie HTTP musi zawierać tylko ścieżkę adresu URL. W żądaniach zbiorczych nie można używać pełnych adresów URL.

Nagłówki HTTP żądania zbiorczego zewnętrznego, z wyjątkiem nagłówków Content-, np. Content-Type, mają zastosowanie do każdego żądania w zbiorczym żądaniu. Jeśli dany nagłówek HTTP jest określony zarówno w żądaniu zewnętrznym, jak i w poszczególnym wywołaniu, wartość nagłówka pojedynczego wywołania zastąpi wartość nagłówka zewnętrznego żądania zbiorczego. Nagłówki pojedynczego połączenia dotyczą tylko tego połączenia.

Jeśli na przykład podasz nagłówek Authorization w przypadku konkretnego wywołania, będzie on dotyczył tylko tego wywołania. Jeśli w żądaniu zewnętrznym podasz nagłówek Authorization, będzie on dotyczył wszystkich poszczególnych wywołań, chyba że zostaną zastąpione przez własne nagłówki Authorization.

Gdy serwer otrzyma żądanie zbiorcze, zastosuje parametry zapytania i nagłówki żądania zewnętrznego (w odpowiednich przypadkach) do każdej części, a potem potraktuje każdą część tak, jakby była osobnym żądaniem HTTP.

Odpowiedź na żądanie zbiorcze

Odpowiedź serwera to pojedyncza standardowa odpowiedź HTTP z typem treści multipart/mixed. Każda część jest odpowiedzią na jedno z żądań w żądaniu zbiorczym, w tej samej kolejności co żądania.

Podobnie jak części żądania, każda część odpowiedzi zawiera pełną odpowiedź HTTP, w tym kod stanu, nagłówki i treść. Podobnie jak w przypadku części żądania, każdą część odpowiedzi poprzedza nagłówek Content-Type, który wskazuje początek części.

Jeśli dana część żądania zawierała nagłówek Content-ID, odpowiadająca jej część odpowiedzi zawiera pasujący nagłówek Content-ID, a pierwotna wartość jest poprzedzona ciągiem znaków response-, jak w tym przykładzie.

Uwaga: serwer może wykonywać wywołania w dowolnej kolejności. Nie oczekuj, że będą one wykonywane w kolejności, w jakiej je podano. Jeśli chcesz, aby 2 wywołania były wykonywane w określonej kolejności, nie możesz wysyłać ich w jednym żądaniu. Zamiast tego najpierw wyślij pierwsze wywołanie, a potem poczekaj na odpowiedź na nie, zanim wyślesz drugie.

Przykład

Ten przykład pokazuje użycie grupowania w ogólnym (fikcyjnym) interfejsie API o nazwie Farm API. Jednak te same pojęcia są używane w interfejsie Gmail API.

Przykładowe żądanie zbiorcze

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--

Przykład odpowiedzi zbiorczej

Oto odpowiedź na przykładowe żądanie z poprzedniej sekcji.

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--