Пакетные запросы

В этом документе показано, как объединять вызовы API в пакеты, чтобы уменьшить количество HTTP-соединений, которые должен устанавливать ваш клиент.

Этот документ посвящен выполнению пакетных запросов путем отправки HTTP-запроса. Если же вы используете клиентскую библиотеку Google для выполнения пакетных запросов, обратитесь к документации этой библиотеки .

Обзор

Каждое HTTP-соединение, устанавливаемое вашим клиентом, приводит к определённым накладным расходам. API Gmail поддерживает пакетную обработку, позволяя вашему клиенту объединять несколько вызовов API в один HTTP-запрос.

Примеры ситуаций, когда может потребоваться пакетная обработка:

• Вы только начали использовать API, и у вас много данных для загрузки.
• Пользователь внес изменения в данные, когда ваше приложение было отключено от сети (офлайн), поэтому вашему приложению необходимо синхронизировать локальные данные с сервером, отправляя множество запросов на обновление и удаление.

В каждом случае, вместо отправки каждого вызова по отдельности, вы можете объединить их в один HTTP-запрос. Все внутренние запросы должны направляться к одному и тому же API Google.

В одном пакетном запросе вы можете совершить не более 100 вызовов. Если вам необходимо совершить больше вызовов, используйте несколько пакетных запросов.

Примечание : Система пакетной обработки для API Gmail использует тот же синтаксис, что и система пакетной обработки OData , но семантика отличается.

Примечание : отправка пакетов большего размера может привести к ограничению скорости запросов. Не рекомендуется отправлять пакеты, содержащие более 50 запросов.

Детали партии

Пакетный запрос состоит из нескольких вызовов API, объединенных в один HTTP-запрос, который может быть отправлен по batchPath указанному в документе обнаружения API . Путь по умолчанию — /batch/ api_name / api_version . В этом разделе подробно описан синтаксис пакетного запроса; далее приведен пример .

Примечание : Пакет из n запросов, объединенных в один, учитывается в вашем лимите использования как n запросов, а не как один запрос. Пакет запросов разбивается на несколько отдельных запросов перед обработкой.

Формат пакетного запроса

Пакетный запрос — это один стандартный HTTP-запрос, содержащий несколько вызовов API Gmail с использованием типа содержимого multipart/mixed . Внутри этого основного HTTP-запроса каждая из его частей содержит вложенный HTTP-запрос.

Каждая часть начинается со своего HTTP-заголовка Content-Type: application/http . Она также может содержать необязательный заголовок Content-ID . Однако заголовки частей служат лишь для обозначения начала части; они отделены от вложенного запроса. После того, как сервер разделит пакетный запрос на отдельные запросы, заголовки частей игнорируются.

Тело каждой части запроса представляет собой полный HTTP-запрос, содержащий собственный глагол, URL-адрес, заголовки и сам запрос. HTTP-запрос должен содержать только путь к URL-адресу; полные URL-адреса в пакетных запросах не допускаются.

HTTP-заголовки для внешнего пакетного запроса, за исключением заголовков Content- , таких как Content-Type , применяются ко всем запросам в пакете. Если вы указываете определенный HTTP-заголовок как во внешнем запросе, так и в отдельном вызове, то значение заголовка отдельного вызова переопределяет значение заголовка внешнего пакетного запроса. Заголовки для отдельного вызова применяются только к этому вызову.

Например, если вы предоставляете заголовок Authorization для конкретного вызова, то этот заголовок применяется только к этому вызову. Если вы предоставляете заголовок Authorization для внешнего запроса, то этот заголовок применяется ко всем отдельным вызовам, если только они не переопределят его своими собственными заголовками Authorization.

Когда сервер получает пакетный запрос, он применяет параметры запроса и заголовки внешнего запроса (при необходимости) к каждой его части, а затем обрабатывает каждую часть так, как если бы это был отдельный HTTP-запрос.

Ответ на пакетный запрос

Ответ сервера представляет собой единый стандартный HTTP-ответ с типом содержимого multipart/mixed ; каждая часть является ответом на один из запросов в пакете, в том же порядке, что и запросы.

Подобно частям запроса, каждая часть ответа содержит полный HTTP-ответ, включая код состояния, заголовки и тело. И, как и в случае с частями запроса, каждой части ответа предшествует заголовок Content-Type , который отмечает начало этой части.

Если определенная часть запроса содержала заголовок Content-ID , то соответствующая часть ответа имеет совпадающий заголовок Content-ID , причем исходное значение предваряется строкой response- , как показано в следующем примере.

Примечание : Сервер может выполнять ваши вызовы в любом порядке. Не рассчитывайте на то, что они будут выполнены в том порядке, в котором вы их указали. Если вы хотите гарантировать выполнение двух вызовов в заданном порядке, вы не можете отправить их в одном запросе; вместо этого отправьте первый вызов отдельно, затем дождитесь ответа на первый вызов, прежде чем отправлять второй.

Пример

В следующем примере показано использование пакетной обработки с помощью универсального (вымышленного) демонстрационного API, называемого Farm API. Однако те же принципы применимы и к Gmail API.

Пример пакетного запроса

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

Пример пакетного ответа

Это ответ на пример запроса из предыдущего раздела.

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