Синхронные и асинхронные конечные точки

Разработчики из Европейской экономической зоны (ЕЭЗ)

API оптимизации маршрутов предоставляет два метода:

  • OptimizeTours — это синхронный метод, который возвращает оптимизированный маршрут в ответ на запрос OptimizeToursRequest . Клиенты должны поддерживать открытое соединение с API оптимизации маршрутов до тех пор, пока запрос не будет обработан и не будет возвращено сообщение OptimizeToursResponse или ошибка.
  • BatchOptimizeTours — это асинхронный метод, который принимает URI для одного или нескольких OptimizeToursRequest и соответствующих сообщений OptimizeToursResponse , возвращая имя ресурса длительной операции (LRO) ( REST , gRPC ), используемой для проверки завершения пакета. Запросы OptimizeToursRequest обрабатываются в фоновом режиме, поэтому клиенты поддерживают открытое соединение с API оптимизации маршрутов только на время, достаточное для отправки запроса BatchOptimizeToursRequest или вызова GetOperation для проверки статуса LRO. BatchOptimizeTours считывает запросы из Google Cloud Storage и записывает ответы в него.

Варианты использования

OptimizeTours удобен для решения небольших и простых запросов, а также для запросов, время решения которых составляет несколько минут или меньше. Поддержание длительных соединений с API оптимизации маршрутов увеличивает риск прерывания до того, как будет получено решение.

BatchOptimizeTours может обрабатывать более крупные запросы и запросы с более длительным временем решения, поскольку не требует длительного подключения к API оптимизации маршрутов.

Долгосрочные операции

LRO считываются из API оптимизации маршрутов с помощью метода GetOperation для проверки статуса завершения пакета. LRO содержат свойство done , указывающее, завершена ли обработка всего пакета, и поле error , сообщающее об ошибках, возникших во время обработки. Если done имеет значение true и error нет, пакет успешно завершен. Наличие error указывает на то, что обработка части или всего пакета завершилась неудачей.

Типичный жизненный цикл запроса BatchOptimizeTours выглядит следующим образом:

  1. Отправьте запрос BatchOptimizeToursRequest в API оптимизации маршрутов, который вернет имя ресурса LRO.
  2. Опрашивайте GetOperation используя возвращенное имя ресурса LRO, до тех пор, пока в ответе LRO не появятся свойства done или error .
  3. Если done истинно и ошибок нет, прочитайте OptimizeToursResponses из URI Google Cloud Storage, указанных в запросе BatchOptimizeTours . Если обнаружена error , проанализируйте её, обновите объекты OptimizeToursRequest в Google Cloud Storage и повторите попытку в зависимости от обнаруженной ошибки.

Вы можете отправлять запросы OptimizeTours и BatchOptimizeTours различными способами, как из командной строки, так и с помощью клиентской библиотеки.

Далее: отправьте API-запрос.