Żądania wsadowe

W tym dokumencie pokazujemy, jak łączyć wywołania interfejsu API w żądania wsadowe, aby zmniejszyć liczbę połączeń HTTP, które musi nawiązać klient.

Ten dokument dotyczy konkretnie wysyłania żądania zbiorczego za pomocą żądania HTTP. Jeśli do wysyłania żądań zbiorczych używasz biblioteki klienta Google, zapoznaj się z dokumentacją biblioteki klienta.

Przegląd

Każde połączenie HTTP nawiązywane przez klienta wiąże się z określonym narzutem. Interfejs Gmail API obsługuje żądania wsadowe, dzięki czemu klient może umieścić kilka wywołań interfejsu API w jednym żądaniu HTTP.

Przykłady sytuacji, w których warto używać przetwarzania wsadowego:

  • 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 (odłączona od internetu), więc musi ona zsynchronizować dane lokalne z serwerem, wysyłając wiele aktualizacji i usunięć.

W każdym z tych przypadków zamiast wysyłać każde wywołanie osobno możesz zgrupować je w jednym żądaniu HTTP. Wszystkie żądania wewnętrzne muszą być kierowane do tego samego interfejsu API Google.

W jednym żądaniu zbiorczym możesz wykonać maksymalnie 100 wywołań. Jeśli musisz wykonać więcej wywołań, użyj kilku żądań zbiorczych.

Uwaga: system przetwarzania zbiorczego interfejsu Gmail API używa tej samej składni co system przetwarzania zbiorczego OData, ale różni się od niego semantyką.

Uwaga: większe rozmiary partii mogą powodować ograniczenie liczby żądań. Nie zalecamy wysyłania partii zawierających więcej 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 wykrywania interfejsu API. Ścieżka domyślna to /batch/api_name/api_version. W tej sekcji szczegółowo opisujemy składnię plików wsadowych. Przykład znajdziesz w dalszej części artykułu.

Uwaga: zestaw n żądań połączonych w pakiet jest liczony do limitu wykorzystania jako n żądania, a nie jako 1 żądanie. Przed przetworzeniem żądanie zbiorcze jest dzielone na zestaw żądań.

Format żądania zbiorczego

Żądanie zbiorcze to pojedyncze standardowe żądanie HTTP zawierające wiele wywołań interfejsu Gmail API, które korzysta z typu treści multipart/mixed. W tym głównym żądaniu HTTP każda z części zawiera zagnieżdżone żądanie HTTP.

Każda część zaczyna się od własnego Content-Type: application/http nagłówka HTTP. Może też zawierać opcjonalny Content-ID nagłówek. 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 są dozwolone pełne adresy URL.

Nagłówki HTTP zewnętrznego żądania zbiorczego, z wyjątkiem nagłówków Content-, takich jak Content-Type, mają zastosowanie do każdego żądania w partii. Jeśli podasz dany nagłówek HTTP zarówno w żądaniu zewnętrznym, jak i w pojedynczym 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 dla konkretnego wywołania, będzie on dotyczył tylko tego wywołania. Jeśli podasz nagłówek autoryzacji dla żądania zewnętrznego, będzie on obowiązywać we wszystkich poszczególnych wywołaniach, chyba że zastąpią go własne nagłówki autoryzacji.

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

Odpowiedź na żądanie zbiorcze

Odpowiedź serwera to pojedyncza standardowa odpowiedź HTTP o multipart/mixed typie treści. Każda jej 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 kompletną odpowiedź HTTP, w tym kod stanu, nagłówki i treść. Podobnie jak w przypadku części żądania, każda część odpowiedzi jest poprzedzona nagłówkiem Content-Type, który oznacza początek tej części.

Jeśli dana część żądania zawierała nagłówek Content-ID, odpowiednia część odpowiedzi zawiera pasujący nagłówek Content-ID, w którym przed pierwotną wartością znajduje się ciąg znaków response-, jak pokazano w przykładzie poniżej.

Uwaga: serwer może wykonywać wywołania w dowolnej kolejności. Nie zakładaj, że zostaną one wykonane w kolejności, w jakiej zostały określone. Jeśli chcesz mieć pewność, że 2 wywołania nastąpią w określonej kolejności, nie możesz wysłać ich w jednym żądaniu. Zamiast tego wyślij najpierw pierwsze wywołanie, a potem poczekaj na odpowiedź, zanim wyślesz drugie.

Przykład

Ten przykład przedstawia sposób użycia przetwarzania wsadowego w ogólnym (fikcyjnym) interfejsie API „Demo” 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:[email protected]>

GET /farm/v1/animals/pony

--batch_foobarbaz
Content-Type: application/http
Content-ID: <item2:[email protected]>

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:[email protected]>

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

--batch_foobarbaz--

Przykładowa odpowiedź zbiorcza

To jest 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:[email protected]>

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:[email protected]>

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:[email protected]>

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

--batch_foobarbaz--