Wysyłanie żądań zbiorczych

W tej wersji interfejsu API żądanie zbiorcze jest używane tylko w przypadku przeniesienia subskrypcji. Poza tym pole zbiorcze Content-ID nie jest wypełniane w żądaniu zbiorczym interfejsu API.

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

Ten dokument dotyczy tworzenia żądań zbiorczych poprzez wysyłanie żądań HTTP. Jeśli zamiast tego używasz biblioteki klienta Google do wysyłania żądań zbiorczych, zapoznaj się z dokumentacją biblioteki klienta.

Przegląd

Każde połączenie HTTP realizowane przez Twojego klienta wiąże się z określonym obciążeniem. Interfejs API pakietu Admin SDK obsługuje grupy, 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ż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 (odłączona od internetu), więc musi ona synchronizować swoje dane lokalne z serwerem, wysyłając dużo aktualizacji i usunięć.

W każdym z tych przypadków zamiast wysyłać każde wywołanie oddzielnie, możesz zgrupować je w jedno żądanie HTTP. Wszystkie żądania wewnętrzne muszą trafiać do tego samego interfejsu API Google.

Jedno żądanie zbiorcze może wykonać maksymalnie 1000 wywołań. Jeśli musisz wykonać więcej wywołań, używaj wielu żądań zbiorczych.

Uwaga: system wsadowy interfejsu API Admin SDK używa tej samej składni co system przetwarzania zbiorczego OData, ale jego semantyka jest inna.

Szczegóły wsadu

Żądanie zbiorcze składa się z kilku wywołań interfejsu API połączonych w 1 żądanie HTTP, które można wysłać do interfejsu batchPath określonego w dokumencie opisującym interfejs API. Domyślną ścieżką jest /batch/api_name/api_version. W tej sekcji szczegółowo opisujemy składnię wsadu, a w dalszej części podajemy przykład.

Uwaga: zgrupowane żądania n wliczają się do limitu wykorzystania jako żądania n, a nie jako jedno żądanie. Przed przetworzeniem żądanie zbiorcze jest dzielone na zbiór żądań.

Format żądania zbiorczego

Żądanie zbiorcze to pojedyncze standardowe żądanie HTTP zawierające wiele wywołań interfejsu API pakietu Admin SDK korzystających z typu treści multipart/mixed. Każda część głównego żądania HTTP zawiera zagnieżdżone żądanie HTTP.

Każda część zaczyna się od własnego nagłówka HTTP Content-Type: application/http. Może też zawierać opcjonalny nagłówek Content-ID. Nagłówki części służą jednak tylko do oznaczenia początku części – są odrębne od zagnieżdżonych żądań. Gdy serwer wyodrębni żądanie zbiorcze w 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 może zawierać tylko część ścieżki adresu URL. W żądaniach zbiorczych nie można używać pełnych adresów 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 grupie. Jeśli określisz nagłówek HTTP zarówno w żądaniu zewnętrznym, jak i w pojedynczym wywołaniu, wartość poszczególnych nagłówków zastąpi wartość nagłówka zewnętrznego żądania zbiorczego. Nagłówki pojedynczego połączenia mają zastosowanie tylko do tego połączenia.

Jeśli na przykład dla określonego wywołania podasz nagłówek Authorization, będzie on odnosił się tylko do tego wywołania. Jeśli dla zewnętrznego żądania udostępnisz nagłówek autoryzacji, będzie on stosowany do wszystkich poszczególnych wywołań, chyba że zastąpi je własnymi nagłówkami autoryzacji.

Gdy serwer otrzyma żądanie zbiorcze, stosuje do każdej części parametry zapytania i nagłówki żądania zewnętrznego (stosownie do sytuacji), a następnie traktuje każdą część tak, jakby było to osobne żądanie HTTP.

Odpowiedź na żądanie zbiorcze

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

Podobnie jak części żądania, każda część odpowiedzi zawiera pełną odpowiedź HTTP wraz z kodem stanu, nagłówkami i treścią. Podobnie jak w przypadku części żądania, każda część odpowiedzi jest poprzedzona nagłówkiem Content-Type wskazującym początek części.

Jeśli dana część żądania miała nagłówek Content-ID, odpowiadająca jej część odpowiedzi ma zgodny nagłówek Content-ID z pierwotną wartością poprzedzoną ciągiem response-, jak w poniższym przykładzie.

Uwaga: serwer może wykonywać wywołania w dowolnej kolejności. Nie licz na ich wykonanie w kolejności, w jakiej zostały określone. Jeśli chcesz mieć pewność, że 2 wywołania będą występować w określonej kolejności, nie możesz wysłać ich w ramach jednego żądania. Zamiast tego wyślij pierwsze z nich samodzielnie, a następnie poczekaj na odpowiedź pierwszego z nich, a dopiero później wyślij drugie.

Przykład

Przykład poniżej pokazuje użycie grupowania za pomocą interfejsu API pakietu Admin SDK.

Przykładowe żądanie zbiorcze


/*This example uses comments and variables for clarity.*/
/*These are not used in JSON. Do not include these comments or verbatim*/
/*variable strings in your batch request.*/
/*To batch multiple requests in one call, use the following*/
/*                                                         */
/*POST HTTP request, and use the following request body syntax.*/
/*                                                  */
/*POST https://www.googleapis.com/batch*/

--batch_foobar--

Przykładowa odpowiedź wsadowa

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:12930812@barnyard.example.com>

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:12930812@barnyard.example.com>

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:12930812@barnyard.example.com>

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

--batch_foobarbaz--