Индекс
-
RouteOptimization
(интерфейс) -
AggregatedMetrics
(сообщение) -
BatchOptimizeToursMetadata
(сообщение) -
BatchOptimizeToursRequest
(сообщение) -
BatchOptimizeToursRequest.AsyncModelConfig
(сообщение) -
BatchOptimizeToursResponse
(сообщение) -
BreakRule
(сообщение) -
BreakRule.BreakRequest
(сообщение) -
BreakRule.FrequencyConstraint
(сообщение) -
DataFormat
(перечисление) -
DistanceLimit
(сообщение) -
GcsDestination
(сообщение) -
GcsSource
(сообщение) -
InjectedSolutionConstraint
(сообщение) -
InjectedSolutionConstraint.ConstraintRelaxation
(сообщение) -
InjectedSolutionConstraint.ConstraintRelaxation.Relaxation
(сообщение) -
InjectedSolutionConstraint.ConstraintRelaxation.Relaxation.Level
(перечисление) -
InputConfig
(сообщение) -
Location
(сообщение) -
OptimizeToursRequest
(сообщение) -
OptimizeToursRequest.SearchMode
(перечисление) -
OptimizeToursRequest.SolvingMode
(перечисление) -
OptimizeToursResponse
(сообщение) -
OptimizeToursResponse.Metrics
(сообщение) -
OptimizeToursValidationError
(сообщение) -
OptimizeToursValidationError.FieldReference
(сообщение) -
OutputConfig
(сообщение) -
RouteModifiers
(сообщение) -
Shipment
(сообщение) -
Shipment.Load
(сообщение) -
Shipment.VisitRequest
(сообщение) -
ShipmentModel
(сообщение) -
ShipmentModel.DurationDistanceMatrix
(сообщение) -
ShipmentModel.DurationDistanceMatrix.Row
(сообщение) -
ShipmentModel.PrecedenceRule
(сообщение) -
ShipmentRoute
(сообщение) -
ShipmentRoute.Break
(сообщение) -
ShipmentRoute.EncodedPolyline
(сообщение) -
ShipmentRoute.Transition
(сообщение) -
ShipmentRoute.VehicleLoad
(сообщение) -
ShipmentRoute.Visit
(сообщение) -
ShipmentTypeIncompatibility
(сообщение) -
ShipmentTypeIncompatibility.IncompatibilityMode
(перечисление) -
ShipmentTypeRequirement
(сообщение) -
ShipmentTypeRequirement.RequirementMode
(перечисление) -
SkippedShipment
(сообщение) -
SkippedShipment.Reason
(сообщение) -
SkippedShipment.Reason.Code
(перечисление) -
TimeWindow
(сообщение) -
TransitionAttributes
(сообщение) -
Vehicle
(сообщение) -
Vehicle.DurationLimit
(сообщение) -
Vehicle.LoadLimit
(сообщение) -
Vehicle.LoadLimit.Interval
(сообщение) -
Vehicle.TravelMode
(перечисление) -
Vehicle.UnloadingPolicy
(перечисление) -
Waypoint
(сообщение)
Оптимизация маршрута
Сервис для оптимизации автомобильных туров.
Срок действия определенных типов полей:
-
google.protobuf.Timestamp
- Время указано в формате Unix: секунды с 1970-01-01T00:00:00+00:00.
- секунды должны быть в формате [0, 253402300799], т.е. в формате [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
- nanos должен быть отключен или установлен на 0.
-
google.protobuf.Duration
- секунды должны быть в формате [0, 253402300799], т.е. в формате [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
- nanos должен быть отключен или установлен на 0.
-
google.type.LatLng
- широта должна быть в диапазоне [-90.0, 90.0].
- долгота должна быть в диапазоне [-180,0, 180,0].
- хотя бы одно из значений широты и долготы должно быть ненулевым.
Пакетная оптимизация туров |
---|
Оптимизирует автомобильные туры для одного или нескольких сообщений Этот метод представляет собой длительную операцию (LRO). Входные данные для оптимизации (сообщения Пользователь может опросить Если поле LRO Если поле
|
ОптимизироватьТуры |
---|
Отправляет Модель Цель состоит в том, чтобы обеспечить назначение
|
Агрегированные метрики
Агрегированные показатели для ShipmentRoute
(соответственно для OptimizeToursResponse
по всем элементам Transition
и/или Visit
(соответственно по всем элементам ShipmentRoute
).
Поля | |
---|---|
performed_ shipment_ count | Количество выполненных отгрузок. Обратите внимание, что пара самовывоза и доставки засчитывается только один раз. |
travel_ duration | Общая продолжительность путешествия по маршруту или решению. |
wait_ duration | Общая продолжительность ожидания маршрута или решения. |
delay_ duration | Общая продолжительность задержки маршрута или решения. |
break_ duration | Общая продолжительность перерыва для маршрута или решения. |
visit_ duration | Общая продолжительность посещения маршрута или решения. |
total_ duration | Общая продолжительность должна быть равна сумме всех указанных выше длительностей. Для маршрутов это также соответствует:
|
travel_ distance_ meters | Общее расстояние перемещения по маршруту или решению. |
max_ loads | Максимальная нагрузка, достигнутая на всем маршруте (соответственно решение), для каждого количества на этом маршруте (соответственно решение), вычисляемая как максимум по всем |
Пакетная оптимизация туровМетаданные
Этот тип не имеет полей.
Метаданные операции для вызовов BatchOptimizeToursRequest
.
Пакетная оптимизацияЗапрос туров
Запрос на пакетную оптимизацию туров как асинхронную операцию. Каждый входной файл должен содержать один OptimizeToursRequest
, а каждый выходной файл — один OptimizeToursResponse
. Запрос содержит информацию для чтения/записи и анализа файлов. Все входные и выходные файлы должны находиться в одном проекте.
Поля | |
---|---|
parent | Необходимый. Целевой проект и место для звонка. Формат: * Если местоположение не указано, регион будет выбран автоматически. |
model_ configs[] | Необходимый. Информация ввода/вывода для каждой модели покупки, например пути к файлам и форматы данных. |
АсинкМоделКонфиг
Информация для асинхронного решения одной модели оптимизации.
Поля | |
---|---|
display_ name | Необязательный. Определяемое пользователем имя модели может использоваться пользователями в качестве псевдонима для отслеживания моделей. |
input_ config | Необходимый. Информация о входной модели. |
output_ config | Необходимый. Требуемая информация о местоположении вывода. |
Пакетная оптимизацияToursResponse
Этот тип не имеет полей.
Ответ на BatchOptimizeToursRequest
. Он возвращается в длительной операции после завершения операции.
BreakRule
Правила создания временных перерывов для транспортного средства (например, перерывы на обед). Перерыв — это непрерывный период времени, в течение которого транспортное средство простаивает на своем текущем месте и не может совершить ни одного визита. Обрыв может произойти:
- во время путешествия между двумя посещениями (включая время непосредственно перед или сразу после посещения, но не в середине посещения), и в этом случае продлевается соответствующее транзитное время между посещениями,
- или перед запуском автомобиля (автомобиль может не завестись в середине перерыва), в этом случае это не влияет на время запуска автомобиля.
- или после окончания транспортного средства (то же самое, со временем окончания транспортного средства).
Поля | |
---|---|
break_ requests[] | Последовательность перерывов. См. сообщение |
frequency_ constraints[] | Могут применяться несколько |
Запрос на перерыв
Последовательность перерывов (т.е. их количество и порядок), применимых к каждому транспортному средству, должна быть известна заранее. Повторяющиеся BreakRequest
определяют эту последовательность в том порядке, в котором они должны происходить. Их временные окна ( earliest_start_time
/ latest_start_time
) могут перекрываться, но они должны быть совместимы с порядком (это отмечено).
Поля | |
---|---|
earliest_ start_ time | Необходимый. Нижняя граница (включительно) на начало перерыва. |
latest_ start_ time | Необходимый. Верхняя граница (включительно) на начало перерыва. |
min_ duration | Необходимый. Минимальная продолжительность перерыва. Должно быть позитивным. |
Частотное ограничение
Можно дополнительно ограничить частоту и продолжительность перерывов, указанных выше, установив минимальную частоту перерывов, например: «Перерыв должен быть не менее 1 часа каждые 12 часов». Если предположить, что это можно интерпретировать как «В пределах любого скользящего временного окна продолжительностью 12 часов должен быть хотя бы один перерыв продолжительностью не менее одного часа», этот пример можно перевести в следующий FrequencyConstraint
:
{
min_break_duration { seconds: 3600 } # 1 hour.
max_inter_break_duration { seconds: 39600 } # 11 hours (12 - 1 = 11).
}
Время и продолжительность перерывов в решении будут учитывать все подобные ограничения в дополнение к временным окнам и минимальной длительности, уже указанным в BreakRequest
.
FrequencyConstraint
на практике может применяться к непоследовательным перерывам. Например, следующий график учитывает пример «1 час каждые 12 часов»:
04:00 vehicle start
.. performing travel and visits ..
09:00 1 hour break
10:00 end of the break
.. performing travel and visits ..
12:00 20-min lunch break
12:20 end of the break
.. performing travel and visits ..
21:00 1 hour break
22:00 end of the break
.. performing travel and visits ..
23:59 vehicle end
Поля | |
---|---|
min_ break_ duration | Необходимый. Минимальная продолжительность перерыва для этого ограничения. Неотрицательный. См. описание |
max_ inter_ break_ duration | Необходимый. Максимально допустимый интервал любого интервала времени в маршруте, который не включает хотя бы частично перерыв |
Формат данных
Форматы данных для входных и выходных файлов.
Перечисления | |
---|---|
DATA_FORMAT_UNSPECIFIED | Недопустимое значение. Формат не должен быть UNSPECIFIED. |
JSON | Обозначение объектов JavaScript. |
PROTO_TEXT | Текстовый формат протокольных буферов. См. https://protobuf.dev/reference/protobuf/textformat-spec/. |
Предел расстояния
Предел, определяющий максимальное расстояние, которое можно преодолеть. Он может быть как твердым, так и мягким.
Если определен мягкий предел, как soft_max_meters
, так и cost_per_kilometer_above_soft_max
должны быть определены и быть неотрицательными.
Поля | |
---|---|
max_ meters | Жесткий предел, ограничивающий расстояние не более max_meters. Предел должен быть неотрицательным. |
soft_ max_ meters | Мягкое ограничение не обеспечивает соблюдение ограничения максимального расстояния, но его нарушение приводит к затратам, которые суммируются с другими затратами, определенными в модели, в той же единице измерения. Если определено, soft_max_meters должно быть меньше max_meters и должно быть неотрицательным. |
cost_ per_ kilometer_ below_ soft_ max | Стоимость понесенного километража увеличивается до
Эта стоимость не поддерживается в |
cost_ per_ kilometer_ above_ soft_ max | Стоимость за километр, если расстояние превышает предел
Стоимость должна быть неотрицательной. |
GcsDestination
Местоположение Google Cloud Storage, куда будут записаны выходные файлы.
Поля | |
---|---|
uri | Необходимый. URI облачного хранилища Google. |
GcsИсточник
Местоположение Google Cloud Storage, из которого будет считываться входной файл.
Поля | |
---|---|
uri | Необходимый. URI объекта Google Cloud Storage в формате |
Ограничение введенного решения
Решение, добавленное в запрос, включая информацию о том, какие посещения следует ограничить и как их следует ограничить.
Поля | |
---|---|
routes[] | Пути введения раствора. Некоторые маршруты могут быть исключены из исходного решения. Маршруты и пропущенные поставки должны удовлетворять основным предположениям достоверности, перечисленным для |
skipped_ shipments[] | Пропущены поставки раствора для инъекций. Некоторые из них могут быть исключены из исходного решения. См. поле |
constraint_ relaxations[] | Для нуля или более групп транспортных средств указывает, когда и насколько ослаблять ограничения. Если это поле пусто, все непустые маршруты транспортных средств полностью ограничены. |
ОграничениеРелаксация
Для группы транспортных средств указывается, при каком пороге(ах) ограничения на посещение будут смягчены и до какого уровня. Отгрузки, перечисленные в поле skipped_shipment
, могут быть пропущены; т. е. они не могут быть выполнены.
Поля | |
---|---|
relaxations[] | Все ослабления ограничений на посещение, которые будут применяться к посещениям маршрутов с транспортными средствами в |
vehicle_ indices[] | Указывает индексы транспортных средств, к которым применяются Индекс транспортного средства отображается так же, как |
Релаксация
Если relaxations
пусто, время начала и последовательность всех посещений routes
полностью ограничиваются, и никакие новые посещения не могут быть вставлены или добавлены к этим маршрутам. Кроме того, время начала и окончания движения транспортного средства на routes
полностью ограничено, если только транспортное средство не пусто (т. е. не имеет посещений и для used_if_route_is_empty
в модели установлено значение false).
relaxations(i).level
определяет уровень ослабления ограничений, применяемый к посещению #j, который удовлетворяет:
-
route.visits(j).start_time >= relaxations(i).threshold_time
И -
j + 1 >= relaxations(i).threshold_visit_count
Аналогично, запуск транспортного средства расслабляется до relaxations(i).level
если он удовлетворяет:
-
vehicle_start_time >= relaxations(i).threshold_time
И -
relaxations(i).threshold_visit_count == 0
, и конец транспортного средства расслабляется доrelaxations(i).level
, если он удовлетворяет: -
vehicle_end_time >= relaxations(i).threshold_time
И -
route.visits_size() + 1 >= relaxations(i).threshold_visit_count
Чтобы применить уровень релаксации, если посещение соответствует threshold_visit_count
ИЛИ threshold_time
добавьте два relaxations
с одним и тем же level
: один с установленным только threshold_visit_count
, а другой с установленным только threshold_time
. Если посещение удовлетворяет условиям многократного relaxations
, применяется наиболее расслабленный уровень. В результате от начала движения транспортного средства до посещения маршрута до конца транспортного средства уровень релаксации становится более расслабленным: т.е. уровень релаксации не снижается по мере прохождения маршрута.
Время и последовательность посещений маршрута, которые не удовлетворяют пороговым условиям каких-либо relaxations
, полностью ограничены, и никакие посещения не могут быть вставлены в эти последовательности. Также, если начало или конец транспортного средства не удовлетворяет условиям какого-либо расслабления, время фиксируется, если только транспортное средство не пустое.
Поля | |
---|---|
level | Уровень ослабления ограничений, который применяется, когда условия в |
threshold_ time | Время, в течение которого или после которого может быть применен |
threshold_ visit_ count | Количество посещений, во время или после которого может быть применен Если это |
Уровень
Выражает различные уровни ослабления ограничений, которые применяются к посещению и после него, когда оно удовлетворяет пороговым условиям.
Ниже перечислено в порядке возрастания релаксации.
Перечисления | |
---|---|
LEVEL_UNSPECIFIED | Неявный уровень ослабления по умолчанию: никакие ограничения не ослабляются, т. е. все посещения полностью ограничены. Это значение не должно быть явно использовано в |
RELAX_VISIT_TIMES_AFTER_THRESHOLD | Время начала посещений и время начала/окончания посещения транспортных средств будут смягчены, но каждое посещение остается привязанным к одному и тому же транспортному средству, и необходимо соблюдать последовательность посещений: ни одно посещение не может быть вставлено между ними или перед ними. |
RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD | То же, что RELAX_VISIT_TIMES_AFTER_THRESHOLD , но последовательность посещений также смягчена: посещения могут выполняться только этим транспортным средством, но потенциально могут стать невыполненными. |
RELAX_ALL_AFTER_THRESHOLD | То же, что RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD , но транспортное средство также расслаблено: посещения полностью бесплатны в пороговое время или после него и потенциально могут стать невыполненными. |
Инпутконфиг
Укажите входные данные для [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours].
Поля | |
---|---|
data_ format | Необходимый. Формат входных данных. |
source поля Союза. Необходимый. source может быть только одним из следующих: | |
gcs_ source | Местоположение облачного хранилища Google. Это должен быть один объект (файл). |
Расположение
Инкапсулирует местоположение (географическую точку и необязательный заголовок).
Поля | |
---|---|
lat_ lng | Географические координаты путевой точки. |
heading | Курс компаса связан с направлением потока транспорта. Это значение используется для указания стороны дороги, которая будет использоваться для посадки и высадки. Значения курса могут быть от 0 до 360, где 0 указывает направление на север, 90 указывает направление на восток и т. д. |
ОптимизироватьТурЗапрос
Запрос должен быть передан специалисту по оптимизации туров, который определяет модель доставки для решения, а также параметры оптимизации.
Поля | |
---|---|
parent | Необходимый. Целевой проект или место для звонка. Формат: * Если местоположение не указано, регион будет выбран автоматически. |
timeout | Если этот тайм-аут установлен, сервер возвращает ответ до истечения периода тайм-аута или достижения крайнего срока сервера для синхронных запросов, в зависимости от того, что наступит раньше. Для асинхронных запросов сервер сгенерирует решение (если возможно) до истечения времени ожидания. |
model | Модель отгрузки, которую нужно решить. |
solving_ mode | По умолчанию режим решения |
search_ mode | Режим поиска, используемый для решения запроса. |
injected_ first_ solution_ routes[] | Помогите алгоритму оптимизации найти первое решение, похожее на предыдущее. Модель ограничена при построении первого решения. Любые перевозки, не осуществляемые по маршруту, неявно пропускаются в первом решении, но могут выполняться в последующих решениях. Решение должно удовлетворять некоторым основным предположениям достоверности:
Если введенное решение невозможно, ошибка проверки не обязательно возвращается, вместо этого может быть возвращена ошибка, указывающая на невозможность. |
injected_ solution_ constraint | Ограничьте алгоритм оптимизации поиском окончательного решения, похожего на предыдущее решение. Например, это можно использовать для заморозки частей маршрутов, которые уже завершены или которые должны быть завершены, но не должны быть изменены. Если введенное решение невозможно, ошибка проверки не обязательно возвращается, вместо этого может быть возвращена ошибка, указывающая на невозможность. |
refresh_ details_ routes[] | Если поле не пусто, данные маршруты будут обновлены без изменения базовой последовательности посещений или времени в пути: будут обновлены только другие сведения. Это не решает модель. Начиная с 2020/11 года, это заполняет только полилинии непустых маршрутов и требует, чтобы Поля Это поле не должно использоваться вместе с |
interpret_ injected_ solutions_ using_ labels | Если это правда:
Эта интерпретация применяется к полям Если это правда, метки в следующих категориях должны появляться не более одного раза в своей категории:
Если Удаление посещений маршрута или целых маршрутов из внедренного решения может повлиять на подразумеваемые ограничения, что может привести к изменению решения, ошибкам проверки или неосуществимости. ПРИМЕЧАНИЕ. Вызывающий объект должен гарантировать, что каждый |
consider_ road_ traffic | Учитывайте оценку трафика при вычислении полей |
populate_ polylines | Если это правда, полилинии будут заполнены в ответах |
populate_ transition_ polylines | Если это правда, полилинии и токены маршрута будут заполнены в ответе |
allow_ large_ deadline_ despite_ interruption_ risk | Если этот параметр установлен, то срок выполнения запроса (см. https://grpc.io/blog/deadlines ) может составлять до 60 минут. В противном случае максимальный срок составляет всего 30 минут. Обратите внимание, что долгоживущие запросы имеют значительно больший (но все же небольшой) риск прерывания. |
use_ geodesic_ distances | Если это правда, расстояния путешествия будут рассчитываться с использованием геодезических расстояний вместо расстояний Google Maps, а время в пути будет рассчитываться с использованием геодезических расстояний со скоростью, определяемой |
label | Метка, которая может использоваться для идентификации этого запроса, указана в |
geodesic_ meters_ per_ second | Если |
max_ validation_ errors | Усекает количество возвращаемых ошибок проверки. Эти ошибки обычно прикрепляются к полезным данным ошибки INVALID_ARGUMENT в виде сведений об ошибке BadRequest ( https://cloud.google.com/apis/design/errors#error_details) , за исключением случаев, когда solve_mode=VALIDATE_ONLY: см. поле |
Режим поиска
Режим, определяющий поведение поиска, компромисс между задержкой и качеством решения. Во всех режимах применяется глобальный крайний срок запроса.
Перечисления | |
---|---|
SEARCH_MODE_UNSPECIFIED | Неуказанный режим поиска, эквивалентный RETURN_FAST . |
RETURN_FAST | Остановите поиск после того, как найдете первое хорошее решение. |
CONSUME_ALL_AVAILABLE_TIME | Потратьте все свободное время на поиск лучших решений. |
Режим решения
Определяет, как решатель должен обрабатывать запрос. Во всех режимах, кроме VALIDATE_ONLY
, если запрос недействителен, вы получите ошибку INVALID_REQUEST
. См. max_validation_errors
, чтобы ограничить количество возвращаемых ошибок.
Перечисления | |
---|---|
DEFAULT_SOLVE | Решите модель. Предупреждения могут быть выданы в [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]. |
VALIDATE_ONLY | Только проверяет модель, не решая ее: заполняет как можно больше OptimizeToursResponse.validation_errors . |
DETECT_SOME_INFEASIBLE_SHIPMENTS | Заполняет только ВАЖНО : сюда возвращаются не все невозможные отправки, а только те, которые определены как невозможные в ходе предварительной обработки. |
OptimizeToursResponse
Ответ после решения задачи оптимизации тура, содержащий маршруты, по которым движется каждое транспортное средство, пропущенные поставки и общую стоимость решения.
Поля | |
---|---|
routes[] | Маршруты рассчитываются для каждого транспортного средства; i-й маршрут соответствует i-му транспортному средству в модели. |
request_ label | Копия |
skipped_ shipments[] | Список всех отправлений пропущен. |
validation_ errors[] | Список всех ошибок валидации, которые нам удалось обнаружить самостоятельно. См. объяснение «НЕСКОЛЬКО ОШИБОК» для сообщения |
metrics | Показатели продолжительности, расстояния и использования для этого решения. |
Метрики
Общие показатели, агрегированные по всем маршрутам.
Поля | |
---|---|
aggregated_ route_ metrics | Агрегировано по маршрутам. Каждая метрика представляет собой сумму (или максимум для загрузок) по всем одноименным полям |
skipped_ mandatory_ shipment_ count | Количество пропущенных обязательных отправок. |
used_ vehicle_ count | Количество используемых автомобилей. Примечание. Если маршрут транспортного средства пуст и |
earliest_ vehicle_ start_ time | Самое раннее время начала подержанного автомобиля, вычисляемое как минимальное для всех подержанных автомобилей |
latest_ vehicle_ end_ time | Самое позднее время окончания для подержанного автомобиля, вычисляемое как максимальное для всех подержанных автомобилей |
costs | Стоимость решения с разбивкой по полям запроса, связанным со стоимостью. Ключи — это пути прототипов относительно входных данных OptimizeToursRequest, например «model.shipments.pickups.cost», а значения — это общая стоимость, сгенерированная соответствующим полем стоимости, агрегированная по всему решению. Другими словами, затраты["model.shipments.pickups.cost"] — это сумма всех затрат на самовывоз в рамках решения. Здесь подробно представлены все затраты, определенные в модели, за исключением затрат, связанных с TransitionAttributes, которые по состоянию на 2022/01 г. сообщаются только в агрегированном виде. |
total_ cost | Полная стоимость решения. Сумма всех значений на карте затрат. |
Оптимизетурсвалидатионеррор
Описывает ошибку или предупреждение, возникающее при проверке OptimizeToursRequest
.
Поля | |
---|---|
code | Ошибка проверки определяется парой ( Поля, следующие за этим разделом, предоставляют дополнительную информацию об ошибке. НЕСКОЛЬКО ОШИБОК : при наличии нескольких ошибок процесс проверки пытается вывести несколько из них. Как и компилятор, это несовершенный процесс. Некоторые ошибки проверки будут «фатальными», то есть они останавливают весь процесс проверки. Это относится, среди прочего, к ошибкам СТАБИЛЬНОСТЬ : |
display_ name | Отображаемое имя ошибки. |
fields[] | Контекст ошибки может включать 0, 1 (в большинстве случаев) или более полей. Например, обращение к транспортному средству № 4 и первому забору груза № 2 можно выполнить следующим образом:
Однако обратите внимание, что количество |
error_ message | Читаемая человеком строка, описывающая ошибку. Между СТАБИЛЬНОСТЬ : Нестабильно: сообщение об ошибке, связанное с данным |
offending_ values | Может содержать значения полей. Это не всегда доступно. На него совершенно не следует полагаться и использовать его только для ручной отладки модели. |
ПолеReference
Указывает контекст для ошибки проверки. FieldReference
всегда ссылается на данное поле в этом файле и имеет одну и ту же иерархическую структуру. Например, мы можем указать элемент №2 в start_time_windows
транспортного средства №5, используя:
name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 }
Однако мы опускаем объекты верхнего уровня, такие как OptimizeToursRequest
или ShipmentModel
чтобы не перегружать сообщение.
Поля | |
---|---|
name | Имя поля, например, «транспортные средства». |
sub_ field | Рекурсивно вложенное подполе, если необходимо. |
Поле объединения | |
index | Индекс поля, если оно повторяется. |
key | Ключ, если поле является картой. |
Выходная конфигурация
Укажите место назначения для результатов [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours].
Поля | |
---|---|
data_ format | Необходимый. Формат выходных данных. |
destination поля Союза. Необходимый. destination может быть только одним из следующих: | |
gcs_ destination | Местоположение Google Cloud Storage, в которое можно записать выходные данные. |
Модификаторы маршрута
Инкапсулирует набор дополнительных условий, которые необходимо выполнить при расчете маршрутов транспортных средств. Это похоже на RouteModifiers
в предпочтительном API маршрутов платформы Google Maps; см.: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers .
Поля | |
---|---|
avoid_ tolls | Указывает, следует ли избегать платных дорог, где это возможно. Предпочтение будет отдано маршрутам, не содержащим платных дорог. Применяется только к моторизованным режимам движения. |
avoid_ highways | Указывает, следует ли избегать шоссе, где это возможно. Предпочтение будет отдано маршрутам, не содержащим автомобильных дорог. Применяется только к моторизованным режимам движения. |
avoid_ ferries | Указывает, следует ли избегать паромов, где это возможно. Предпочтение будет отдано маршрутам, не предполагающим переезды на паромах. Применяется только к моторизованным режимам движения. |
avoid_ indoor | Необязательный. Указывает, следует ли избегать навигации в помещении, где это возможно. Предпочтение будет отдано маршрутам, не содержащим внутренней навигации. Применяется только к режиму движения |
Отгрузка
Отгрузка одного товара от одного его получения до одной из доставок. Чтобы отгрузка считалась выполненной, уникальное транспортное средство должно посетить один из пунктов выдачи (и соответственно уменьшить свои запасные мощности), а затем посетить один из пунктов доставки позже (и, следовательно, соответствующим образом повторно увеличить свои запасные мощности).
Поля | |
---|---|
display_ name | Определяемое пользователем отображаемое имя отправления. Он может иметь длину до 63 символов и может использовать символы UTF-8. |
pickups[] | Набор вариантов получения, связанных с отправкой. Если не указано иное, транспортному средству необходимо посетить только место, соответствующее доставке. |
deliveries[] | Набор альтернатив доставки, связанных с отправкой. Если не указано иное, транспортному средству необходимо посетить только место, соответствующее пикапу. |
load_ demands | Требования к загрузке груза (например, вес, объем, количество поддонов и т. д.). Ключами в карте должны быть идентификаторы, описывающие тип соответствующей нагрузки, в идеале также включающие единицы измерения. Например: «вес_кг», «объем_галлонов», «поддон_количество» и т. д. Если данный ключ не отображается на карте, соответствующая нагрузка считается нулевой. |
allowed_ vehicle_ indices[] | Набор транспортных средств, которые могут выполнить данную перевозку. Если пусто, все транспортные средства могут это сделать. Транспортные средства задаются по их индексу в списке |
costs_ per_ vehicle[] | Указывает затраты, возникающие при доставке груза каждым транспортным средством. Если указано, оно должно иметь ЛИБО:
Эти затраты должны быть в той же единице, что и |
costs_ per_ vehicle_ indices[] | Индексы транспортных средств, к которым применяется |
pickup_ to_ delivery_ absolute_ detour_ limit | Указывает максимальное абсолютное время обхода по сравнению с кратчайшим пути от пикапа до доставки. Если указано, он должен быть неотрицательным, а отгрузка должна содержать хотя бы пикап и доставку. Например, пусть t - самое короткое время, необходимое, чтобы перейти из выбранной альтернативы пикапа непосредственно к выбранной альтернативе доставки. Затем настройка
Если как относительные, так и абсолютные пределы указаны на одной и той же отгрузке, более ограниченный предел используется для каждой возможной пары пикапа/доставки. По состоянию на 2017/10 объезд поддерживаются только тогда, когда продолжительность путешествий не зависят от транспортных средств. |
pickup_ to_ delivery_ time_ limit | Указывает максимальную продолжительность от начала пикапа для начала доставки отгрузки. Если указано, он должен быть неотрицательным, а отгрузка должна содержать хотя бы пикап и доставку. Это не зависит от того, какие альтернативы выбраны для получения и доставки, а также от скорости автомобиля. Это может быть указано наряду с максимальными ограничениями обхода: решение будет уважать обе технические характеристики. |
shipment_ type | Непустые строки, указывающая «тип» для этой партии. Эта функция может быть использована для определения несовместимости или требований между Отличается от |
label | Определяет этикетку для этой партии. Эта ярлыка сообщается в ответе в |
ignore | Если это правда, пропустите эту партию, но не применяйте Игнорирование отгрузки приводит к ошибке проверки, когда в модели есть какая -либо Игнорирование отгрузки, которая выполняется в |
penalty_ cost | Если отправка не завершена, этот штраф добавляется к общей стоимости маршрутов. Отгрузка считается завершенной, если посещается одна из его альтернативы по доставке. Стоимость может быть выражена в одной и той же единице, используемом для всех других связанных с затратами полей в модели, и должна быть положительной. Важно : если этот штраф не указан, оно считается бесконечным, то есть отгрузка должна быть завершена. |
pickup_ to_ delivery_ relative_ detour_ limit | Указывает максимальное относительное время обхода по сравнению с кратчайшим пути от пикапа до доставки. Если указано, он должен быть неотрицательным, а отгрузка должна содержать хотя бы пикап и доставку. Например, пусть t - самое короткое время, необходимое, чтобы перейти из выбранной альтернативы пикапа непосредственно к выбранной альтернативе доставки. Затем настройка
Если как относительные, так и абсолютные пределы указаны на одной и той же отгрузке, более ограниченный предел используется для каждой возможной пары пикапа/доставки. По состоянию на 2017/10 объезд поддерживаются только тогда, когда продолжительность путешествий не зависят от транспортных средств. |
Нагрузка
При выполнении посещения предопределенная сумма может быть добавлена в нагрузку автомобиля, если это пикап, или вычитается, если это доставка. Это сообщение определяет такую сумму. Смотрите load_demands
.
Поля | |
---|---|
amount | Сумма, по которой груз транспортного средства, выполняющего соответствующий посещение, будет варьироваться. Поскольку это целое число, пользователям рекомендуется выбрать подходящую единицу, чтобы избежать потери точности. Должен быть ≥ 0. |
Визит
Запрос на посещение, которое может быть совершено транспортным средством: он имеет гео-расположение (или два, см. Ниже), время открытия и закрытия, представленное временными окнами, и время продолжительности обслуживания (время, проведенное транспортным средством после того, как он прибыл на получение или сброс товаров).
Поля | |
---|---|
arrival_ location | Гео-локация, где автомобиль прибывает при выполнении этого |
arrival_ waypoint | Путь, где автомобиль прибывает при выполнении этого |
departure_ location | Гео-локация, где автомобиль уходит после завершения этого |
departure_ waypoint | Путь, где автомобиль уходит после завершения этого |
tags[] | Определяет теги, прикрепленные к запросу посещения. Пустые или дублирующие строки не допускаются. |
time_ windows[] | Временные окна, которые ограничивают время прибытия при посещении. Обратите внимание, что транспортное средство может вылететь за пределами окна времени прибытия, то есть время прибытия + продолжительность не нужно находиться внутри временного окна. Это может привести к времени ожидания, если автомобиль прибывает до Отсутствие Временные окна должны быть не смешаны, т.е. ни одно временное окно не должно перекрываться или быть рядом с другим, и они должны находиться в растущем порядке. |
duration | Продолжительность посещения, то есть время, проведенное транспортным средством между прибытием и отъездом (должно быть добавлено в возможное время ожидания; см. |
cost | Стоимость обслуживания этого запроса посещения на маршруте автомобиля. Это может быть использовано для оплаты разных затрат для каждого альтернативного пикапа или доставки отгрузки. Эта стоимость должна быть в той же единице, что и |
load_ demands | Требования нагрузки этого запроса на посещение. Это похоже на поле |
visit_ types[] | Указывает типы визита. Это может использоваться для выделения дополнительного времени, необходимого для автомобиля, чтобы завершить это посещение (см. Тип может появиться только один раз. |
label | Определяет этикетку для этого |
ShipmentModel
Модель отгрузки содержит набор поставок, которые должны выполняться набором транспортных средств, при этом минимизируя общую стоимость, которая является суммой:
- Стоимость маршрутизации транспортных средств (сумма стоимости за общее время, стоимость за время в пути и фиксированная стоимость по всем транспортным средствам).
- Неопроверженные штрафы отгрузки.
- стоимость глобальной продолжительности поставок
Поля | |
---|---|
shipments[] | Набор поставок, которые должны быть выполнены в модели. |
vehicles[] | Набор транспортных средств, которые можно использовать для выполнения посещений. |
global_ start_ time | Глобальное время начала и окончания модели: НЕТ ВРЕМЕННЫЕ ВРЕМЕНИ ВРЕМЯ этого диапазона нельзя считать действительным. Пролет времени модели должен составлять менее года, то есть При использовании полей |
global_ end_ time | Если unset, 00:00:00 UTC, 1 января 1971 года (то есть секунд: 31536000, нано: 0) используется в качестве дефолта. |
global_ duration_ cost_ per_ hour | «Глобальная продолжительность» общего плана - это разница между самым ранним эффективным временем начала и последним эффективным временем окончания всех транспортных средств. Пользователи могут назначать стоимость в час этому количеству, чтобы попытаться оптимизировать, например, для самого раннего завершения работы. Эта стоимость должна быть в той же единице, что и |
duration_ distance_ matrices[] | Определяет матрицы продолжительности и расстояния, используемых в модели. Если это поле пустое, вместо этого будут использоваться карты Google или геодезические расстояния, в зависимости от значения поля Примеры использования:
|
duration_ distance_ matrix_ src_ tags[] | Теги, определяющие источники продолжительности и матриц расстояния; Теги соответствуют |
duration_ distance_ matrix_ dst_ tags[] | Теги, определяющие направления по прочтению и дистанционным матрицам; Теги соответствуют |
transition_ attributes[] | Переходные атрибуты добавлены в модель. |
shipment_ type_ incompatibilities[] | Наборы несовместимой отгрузки_types (см. |
shipment_ type_ requirements[] | Наборы требований |
precedence_ rules[] | Набор правил приоритета, которые должны быть применены в модели. Важно : использование правил приоритета ограничивает размер проблемы, которая может быть оптимизирована. Запросы с использованием правил приоритета, которые включают в себя многие поставки, могут быть отклонены. |
max_ active_ vehicles | Ограничивает максимальное количество активных транспортных средств. Автомобиль активен, если его маршрут выполняет по крайней мере одну отправку. Это может быть использовано для ограничения количества маршрутов в случае, когда водителей меньше, чем транспортных средств, и что парк транспортных средств является неоднородным. Затем оптимизация выберет наилучшее подмножество транспортных средств для использования. Должен быть строго положительным. |
DurationDistanceMatrix
Определяет матрицу продолжительности и расстояния от мест посещения и запуска автомобиля для посещения и местоположения автомобиля.
Поля | |
---|---|
rows[] | Указывает ряды матрицы продолжительности и расстояния. У него должно быть столько элементов, сколько и |
vehicle_ start_ tag | Определение тега, к которому применяются транспортные средства. Если это пусто, это относится ко всем транспортным средствам, и там может быть только одна матрица. Каждый старт автомобиля должен соответствовать ровской матрице, т.е. точно одно из их поля Все матрицы должны иметь другой |
Ряд
Указывает ряд матрицы продолжительности и расстояния.
Поля | |
---|---|
durations[] | Значения продолжительности для данной строки. У него должно быть столько элементов, сколько и |
meters[] | Значения расстояния для данной строки. Если никакие затраты или ограничения относятся к расстояниям в модели, это можно оставить пустым; В противном случае он должен иметь столько элементов, сколько и |
Предшествующий
Правило приоритета между двумя событиями (каждое событие - это пикап или доставка отгрузки): событие «Второе» должно начать, по крайней мере, offset_duration
после начала «первого».
Несколько предложений могут ссылаться на те же (или связанные) события, например, «пикап B происходит после доставки« и «пикап C происходит после пикапа B».
Кроме того, предыдущие средства применяются только тогда, когда обе поставки выполняются и в противном случае игнорируются.
Поля | |
---|---|
first_ is_ delivery | Указывает, является ли «первое» событие доставкой. |
second_ is_ delivery | Указывает, является ли событие «второе» доставкой. |
offset_ duration | Смещение между «первым» и «вторым» событием. Это может быть отрицательным. |
first_ index | Индекс отправки "первого" события. Это поле должно быть указано. |
second_ index | Индекс отправки "второго" события. Это поле должно быть указано. |
Отгрузка
Маршрут транспортного средства может быть разложен, вдоль оси временной, как это (мы предполагаем, что есть n визитов):
| | | | | T[2], | | |
| Transition | Visit #0 | | | V[2], | | |
| #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] |
| aka T[0] | V[0] | | | V[n-2],| | |
| | | | | T[n-1] | | |
^ ^ ^ ^ ^ ^ ^ ^
vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle
start (arrival) (departure) start end start end end
Обратите внимание, что мы имеем разницу между:
- «пунктуальные события», такие как начало и запуск автомобиля, и начало и конец каждого посещения (он же прибытие и отъезд). Они случаются на данную секунду.
- «интервалы времени», такие как сами визиты, и переход между посещениями. Хотя временные интервалы могут иногда иметь нулевую продолжительность, то есть запуска и заканчиваться в ту же секунду, они часто имеют положительную продолжительность.
Инварианты:
- Если есть n посещений, есть n+1 переходов.
- Визит всегда окружен переходом перед ним (тот же индекс) и переходом после него (индекс + 1).
- За запуском автомобиля всегда следует переход № 0.
- Конец автомобиля всегда предшествует переход #N.
Увеличение, вот что происходит во время Transition
и Visit
:
---+-------------------------------------+-----------------------------+-->
| TRANSITION[i] | VISIT[i] |
| | |
| * TRAVEL: the vehicle moves from | PERFORM the visit: |
| VISIT[i-1].departure_location to | |
| VISIT[i].arrival_location, which | * Spend some time: |
| takes a given travel duration | the "visit duration". |
| and distance | |
| | * Load or unload |
| * BREAKS: the driver may have | some quantities from the |
| breaks (e.g. lunch break). | vehicle: the "demand". |
| | |
| * WAIT: the driver/vehicle does | |
| nothing. This can happen for | |
| many reasons, for example when | |
| the vehicle reaches the next | |
| event's destination before the | |
| start of its time window | |
| | |
| * DELAY: *right before* the next | |
| arrival. E.g. the vehicle and/or | |
| driver spends time unloading. | |
| | |
---+-------------------------------------+-----------------------------+-->
^ ^ ^
V[i-1].end V[i].start V[i].end
Наконец, вот как могут быть организованы путешествия, перерывы, задержка и ожидание во время перехода.
- Они не перекрываются.
- Задержка уникальна и должна быть смежный период времени прямо перед следующим посещением (или конец автомобиля). Таким образом, достаточно знать продолжительность задержки, чтобы узнать его время начала и окончания.
- Перерывы являются смежными, не перекрывающимися периодами времени. Ответ указывает время начала и продолжительность каждого перерыва.
- Путешествие и ожидание «превентивные»: их можно прервать несколько раз во время этого перехода. Клиенты могут предположить, что путешествие происходит «как можно скорее», и что «подождать» заполняет оставшееся время.
A (комплексный) пример:
TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
|| | | | | | | ||
|| T | B | T | | B | | D ||
|| r | r | r | W | r | W | e ||
|| a | e | a | a | e | a | l ||
|| v | a | v | i | a | i | a ||
|| e | k | e | t | k | t | y ||
|| l | | l | | | | ||
|| | | | | | | ||
--++-----------------------------------------------------------------++-->
Поля | |
---|---|
vehicle_ index | Транспортное средство, выполняющее маршрут, идентифицированный по его индексу в исходной |
vehicle_ label | Метка транспортного средства, выполняющего этот маршрут, равный |
vehicle_ start_ time | Время, в которое автомобиль начинает свой маршрут. |
vehicle_ end_ time | Время, в которое автомобиль заканчивает свой маршрут. |
visits[] | Упорядоченная последовательность посещений, представляющих маршрут. Посещения [i] это визит на маршруте. Если это поле пустое, транспортное средство считается неиспользованным. |
transitions[] | Заказанный список переходов для маршрута. |
has_ traffic_ infeasibilities | Когда
Прибытие в next_visit, вероятно, произойдет позже, чем его текущее временное окно из -за повышенной оценки Travel Time |
route_ polyline | Кодированное полилиновое представление маршрута. Это поле заполнено только если |
breaks[] | Перерывы запланированы для автомобиля, выполняющего этот маршрут. Последовательность |
metrics | Продолжительность, показатели расстояния и нагрузки для этого маршрута. Поля |
route_ costs | Стоимость маршрута, разбитая по областям запроса, связанных с затратами. Ключи - это прото -пути, по сравнению с входным оптимизацией, например, «model.shipments.pickups.cost», и значения являются общей стоимостью, полученной по соответствующему полю затрат, агрегированным по всему маршруту. Другими словами, затраты ["model.shipments.pickups.cost"] - это сумма всех затрат на получение по маршруту. Все затраты, определенные в модели, подробно сообщаются здесь, за исключением затрат, связанных с переходными атмосферами, которые сообщаются только агрегированным образом по состоянию на 2022/01. |
route_ total_ cost | Общая стоимость маршрута. Сумма всех затрат на карте затрат. |
Перерыв
Данные, представляющие выполнение перерыва.
Поля | |
---|---|
start_ time | Время начала перерыва. |
duration | Продолжительность перерыва. |
Кодидополилайн
Кодированное представление полилинии. Более подробную информацию о кодировании полилины можно найти здесь: https://developers.google.com/maps/documentation/uteliets/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding .
Поля | |
---|---|
points | Строка, представляющая кодируемые точки полилинии. |
Переход
Переход между двумя событиями на маршруте. См. Описание ShipmentRoute
.
Если транспортное средство не имеет start_location
и/или end_location
, соответствующие метрики движения составляют 0.
Поля | |
---|---|
travel_ duration | Продолжительность путешествий во время этого перехода. |
travel_ distance_ meters | Расстояние проходило во время перехода. |
traffic_ info_ unavailable | Когда трафик запрашивается с помощью |
delay_ duration | Сумма длительности задержки применяется к этому переходу. Если таковые имеются, задержка начинается точно по сравнению |
break_ duration | Сумма продолжительности разрывов, возникающих во время этого перехода, если таковые имеются. Подробная информация о времени начала и продолжительности каждого перерыва хранится в |
wait_ duration | Время, проведенное в ожидании во время этого перехода. Продолжительность ожидания соответствует временю простоя и не включает время перерыва. Также обратите внимание, что это время ожидания может быть разделено на несколько непосредственных интервалов. |
total_ duration | Общая продолжительность перехода, предоставлена для удобства. Это равно:
|
start_ time | Время начала этого перехода. |
route_ polyline | Кодированное полилиновое представление маршрута, последовавшего во время перехода. Это поле заполнено только если |
route_ token | Только вывод. Непрозрачный токен, который можно передать в SDK навигации для восстановления маршрута во время навигации, и, в случае перенаправления, соблюдайте первоначальное намерение, когда был создан маршрут. Обратитесь к этому токен как непрозрачный каплей. Не сравнивайте его значение по запросам, так как его значение может измениться, даже если служба возвращает тот же маршрут. Это поле заполнено только если |
vehicle_ loads | Загрузка транспортных средств во время этого перехода, для каждого типа, который либо появляется в автомобиле этого Нагрузки во время первого перехода являются начальные нагрузки маршрута автомобиля. Затем, после каждого посещения, посещение |
Автомобильная загрузка
Сообщает фактическую нагрузку транспортного средства в какой -то момент вдоль маршрута, для данного типа (см. Transition.vehicle_loads
).
Поля | |
---|---|
amount | Количество нагрузки на автомобиль, для данного типа. Единица нагрузки обычно обозначается типом. См. |
Посещать
Визит, выполненный на маршруте. Этот визит соответствует пикапу или доставке Shipment
.
Поля | |
---|---|
shipment_ index | Индекс поля |
is_ pickup | Если это правда, посещение соответствует выводу |
visit_ request_ index | Индекс |
start_ time | Время, в которое начинается визит. Обратите внимание, что автомобиль может прибыть раньше, чем в месте посещения. Времена согласуются с |
load_ demands | Общее спрос на загрузку посещения в качестве суммы отгрузки и запроса на посещение |
detour | Дополнительное время обхода из -за поставки, посещаемых на маршруте перед посещением, и потенциального времени ожидания, вызванного временными окнами. Если посещение является доставкой, объезд вычисляется из соответствующего посещения пикапа и равна:
В противном случае он вычисляется из
|
shipment_ label | Копия соответствующей |
visit_ label | Копия соответствующего |
Отгрузка
Определяет несовместимости между поставками в зависимости от их отгрузки_type. Появление несовместимых поставки на том же маршруте ограничено на основе режима несовместимости.
Поля | |
---|---|
types[] | Список несовместимых типов. Две отправки, имеющие разные |
incompatibility_ mode | Режим применяется к несовместимости. |
Несовместимость
Режимы, определяющие, как появление несовместимых поставки ограничено на одном и том же маршруте.
Перечисление | |
---|---|
INCOMPATIBILITY_MODE_UNSPECIFIED | Неуказанный режим несовместимости. Это значение никогда не должно использоваться. |
NOT_PERFORMED_BY_SAME_VEHICLE | В этом режиме две поставки с несовместимыми типами никогда не могут разделить один и тот же автомобиль. |
NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY | Для двух поставок с несовместимыми типами с помощью режима несовместимости
|
Отгрузка
Определяет требования между поставками на основе их отгрузки_type. Специфика требования определяется режимом требований.
Поля | |
---|---|
required_ shipment_ type_ alternatives[] | Список альтернативных типов отгрузки, необходимых для |
dependent_ shipment_ types[] | Все поставки с типом в поле ПРИМЕЧАНИЕ. Цепочки требований, так что |
requirement_ mode | Режим применяется к требованию. |
Требование
Режимы, определяющие внешний вид зависимых отгрузок на маршруте.
Перечисление | |
---|---|
REQUIREMENT_MODE_UNSPECIFIED | Неуказанный режим требования. Это значение никогда не должно использоваться. |
PERFORMED_BY_SAME_VEHICLE | В этом режиме все «зависимые» поставки должны иметь то же автомобиль, что и по крайней мере одна из их «требуемых» поставки. |
IN_SAME_VEHICLE_AT_PICKUP_TIME | В режиме Таким образом, «зависимый» выписка должен иметь либо:
|
IN_SAME_VEHICLE_AT_DELIVERY_TIME | То же, что и раньше, за исключением того, что «зависимые» поставки должны иметь «обязательную» отправку на их транспортное средство во время их доставки . |
Пропущенная
Определяет подробную информацию о неэффективных постах в решении. Для тривиальных случаев и/или, если мы можем определить причину для прохождения, мы сообщаем о причине здесь.
Поля | |
---|---|
index | Индекс соответствует индексу отгрузки в исходной |
label | Копия соответствующей |
reasons[] | Список причин, которые объясняют, почему отправка была пропущена. См. Комментарий выше |
Причина
Если мы сможем объяснить, почему отправка была пропущена, здесь будут перечислены причины. Если причина не совпадает для всех транспортных средств, reason
будет иметь более 1 элемента. Пропущенная отгрузка не может иметь дублирования причин, т.е. там, где все поля одинаковы, за исключением, например, example_vehicle_index
. Пример:
reasons {
code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
example_vehicle_index: 1
example_exceeded_capacity_type: "Apples"
}
reasons {
code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
example_vehicle_index: 3
example_exceeded_capacity_type: "Pears"
}
reasons {
code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
example_vehicle_index: 1
}
Пропущенная партия несовместима со всеми транспортными средствами. Причины могут быть разными для всех транспортных средств, но, по крайней мере, будет превышена вместимость «яблоков» одного транспортного средства (включая транспортное средство 1), по крайней мере, будет превышена пропускная способность одного транспортного средства (включая транспортное средство 3), и, по крайней мере, ограничение расстояния одного транспортного средства (включая транспортное средство 1).
Поля | |
---|---|
code | Обратитесь к комментариям кода. |
example_ exceeded_ capacity_ type | Если код причины является |
example_ vehicle_ index | Если причина связана с несовместимостью транспортных средств отгрузки, это поле предоставляет индекс одного соответствующего транспортного средства. |
Код
Код идентифицирует тип причины. Порядок здесь бессмыслен. В частности, это не дает никаких признаков того, появится ли данная причина в другой в решении, если оба применяются.
Перечисление | |
---|---|
CODE_UNSPECIFIED | Это никогда не следует использовать. |
NO_VEHICLE | В модели нет транспортного средства, делающего все поставки невозможными. |
DEMAND_EXCEEDS_VEHICLE_CAPACITY | Требование отгрузки превышает емкость транспортного средства для некоторых типов емкости, один из которых является example_exceeded_capacity_type . |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT | Минимальное расстояние, необходимое для выполнения этой партии, то есть от Обратите внимание, что для этого вычисления мы используем геодезические расстояния. |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT | Минимальное время, необходимое для выполнения этой доставки, включая время в пути, время ожидания и время обслуживания, превышает Примечание. Время в пути вычисляется в лучшем сценарии, а именно в виде геодезического расстояния x 36 м/с (примерно 130 км/час). |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT | То же, что и выше, но мы сравниваем только минимальное время в пути и транспортное средство travel_duration_limit . |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS | Автомобиль не может выполнить эту партию в сценарии с наилучшим образом (см. CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT для вычисления времени), если он начнется в самое раннее время начала: общее время сделает транспортное средство после его последнего времени окончания. |
VEHICLE_NOT_ALLOWED | Поле allowed_vehicle_indices отгрузки не является пустым, и это транспортное средство не принадлежит ему. |
TimeWindow
Временные окна ограничивают время события, например, время прибытия в посещение или время начала и окончания транспортного средства.
Границы окна трудного времени, start_time
и end_time
, обеспечивают самое раннее и последнее время события, так что start_time <= event_time <= end_time
. Мягкое временное окно, нижняя граница, soft_start_time
, выражает предпочтение события, которое произойдет на или после или после soft_start_time
, затрачивая стоимость, пропорциональную тому, как долго до того, как произойдет событие. Верхняя граница с мягким временным окном, soft_end_time
, выражает предпочтение события, которое произойдет на или до или до soft_end_time
, затрачивая стоимость, пропорциональную тому, как долго после soft_end_time
событие происходит. start_time
, end_time
, soft_start_time
и soft_end_time
должен находиться в глобальных временных пределах (см. ShipmentModel.global_start_time
и ShipmentModel.global_end_time
) и должен уважать:
0 <= `start_time` <= `end_time` and
0 <= `start_time` <= `soft_start_time` and
0 <= `soft_end_time` <= `end_time`.
Поля | |
---|---|
start_ time | Трудное время начала окна. Если не указано, это будет установлено на |
end_ time | Трудное время окончания окна. Если не указано, это будет установлено на |
soft_ start_ time | Мягкое время начала временного окна. |
soft_ end_ time | Мягкое время окончания временного окна. |
cost_ per_ hour_ before_ soft_ start_ time | Стоимость в час, добавленная к другим затратам в модели, если событие происходит перед Soft_Start_Time, вычисляется как:
Эта стоимость должна быть положительной, и поле можно установить только в том случае, если установлен Soft_start_time. |
cost_ per_ hour_ after_ soft_ end_ time | Стоимость в час, добавленная к другим затратам в модели, если событие происходит после
Эта стоимость должна быть положительной, и поле можно установить только в том случае, если установлен |
Transitionattributes
Определяет атрибуты переходов между двумя последовательными посещениями по маршруту. Несколько TransitionAttributes
могут применяться к одному и тому же переходу: в этом случае все дополнительные затраты увеличиваются, и применяется строгое ограничение или ограничение (после естественной »и« семантики).
Поля | |
---|---|
src_ tag | Теги, определяющие набор (SRC-> DST) переходов, к этим атрибутам применяется. Посещение источника или начало транспортного средства совпадает с тем, что его |
excluded_ src_ tag | Смотрите |
dst_ tag | Посещение пункта назначения или конец транспортного средства совпадает с тем, что его |
excluded_ dst_ tag | Смотрите |
cost | Определяет стоимость выполнения этого перехода. Это в той же единице, что и все другие затраты в модели, и не должно быть отрицательным. Он применяется поверх всех других существующих затрат. |
cost_ per_ kilometer | Определяет стоимость за километр, применяемый на расстояние, пройденное при выполнении этого перехода. Это добавляется к любому транспортному средству. |
distance_ limit | Определяет ограничение на расстояние, пройденное во время выполнения этого перехода. По состоянию на 2021/06 поддерживаются только мягкие пределы. |
delay | Указывает задержку, понесенную при выполнении этого перехода. Эта задержка всегда происходит после завершения посещения источника и перед началом посещения пункта назначения. |
Транспортное средство
Моделируют транспортное средство в проблеме отгрузки. Решение проблемы отгрузки построит маршрут, начиная с start_location
и заканчивается на end_location
для этого автомобиля. Маршрут - это последовательность посещений (см ShipmentRoute
).
Поля | |
---|---|
display_ name | Пользовательское имя отображаемого автомобиля. Это может быть до 63 символов в длину и может использовать символы UTF-8. |
travel_ mode | Режим путешествий, который влияет на дороги, пригодные для автомобиля и его скорость. См. Также |
route_ modifiers | Набор условий, чтобы удовлетворить, как это влияет на то, как рассчитывается маршруты для данного транспортного средства. |
start_ location | Географическое местоположение, где автомобиль начинается, прежде чем забрать любые поставки. Если не указано, автомобиль начинается с первого пикапа. Если модель отгрузки имеет матрицы продолжительности и расстояния, |
start_ waypoint | Путь, представляющая географическое местоположение, где автомобиль начинается, прежде чем забрать любые поставки. Если не указано ни |
end_ location | Географическое расположение, где транспортное средство заканчивается после того, как он завершил свой последний |
end_ waypoint | Путь, представляющая географическое местоположение, где транспортное средство заканчивается после того, как он завершил свой последний |
start_ tags[] | Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed. |
end_ tags[] | Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed. |
start_ time_ windows[] | Time windows during which the vehicle may depart its start location. They must be within the global time limits (see Time windows belonging to the same repeated field must be disjoint, ie no time window can overlap with or be adjacent to another, and they must be in chronological order. |
end_ time_ windows[] | Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see Time windows belonging to the same repeated field must be disjoint, ie no time window can overlap with or be adjacent to another, and they must be in chronological order. |
unloading_ policy | Unloading policy enforced on the vehicle. |
load_ limits | Capacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the |
cost_ per_ hour | Vehicle costs: all costs add up and must be in the same unit as Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using |
cost_ per_ traveled_ hour | Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (ie, that reported in |
cost_ per_ kilometer | Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the |
fixed_ cost | Fixed cost applied if this vehicle is used to handle a shipment. |
used_ if_ route_ is_ empty | This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case. If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account. Otherwise, it doesn't travel from its start to its end location, and no |
route_ duration_ limit | Limit applied to the total duration of the vehicle's route. In a given |
travel_ duration_ limit | Limit applied to the travel duration of the vehicle's route. In a given |
route_ distance_ limit | Limit applied to the total distance of the vehicle's route. In a given |
extra_ visit_ duration_ for_ visit_ type | Specifies a map from visit_types strings to durations. The duration is time in addition to If a visit request has multiple types, a duration will be added for each type in the map. |
break_ rule | Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle. |
label | Specifies a label for this vehicle. This label is reported in the response as the |
ignore | If true, If a shipment is performed by an ignored vehicle in If a shipment is performed by an ignored vehicle in |
travel_ duration_ multiple | Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision. See also |
DurationLimit
A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.
When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.
Поля | |
---|---|
max_ duration | A hard limit constraining the duration to be at most max_duration. |
soft_ max_ duration | A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit. If defined, |
quadratic_ soft_ max_ duration | A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit. If defined, |
cost_ per_ hour_ after_ soft_ max | Cost per hour incurred if the
The cost must be nonnegative. |
cost_ per_ square_ hour_ after_ quadratic_ soft_ max | Cost per square hour incurred if the The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:
The cost must be nonnegative. |
LoadLimit
Defines a load limit applying to a vehicle, eg "this truck may only carry up to 3500 kg". See load_limits
.
Поля | |
---|---|
soft_ max_ load | A soft limit of the load. See |
cost_ per_ unit_ above_ soft_ max | If the load ever exceeds |
start_ load_ interval | The acceptable load interval of the vehicle at the start of the route. |
end_ load_ interval | The acceptable load interval of the vehicle at the end of the route. |
max_ load | The maximum acceptable amount of load. |
Интервал
Interval of acceptable load amounts.
Поля | |
---|---|
min | A minimum acceptable load. Must be ≥ 0. If they're both specified, |
max | A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum load is unrestricted by this message. If they're both specified, |
TravelMode
Travel modes which can be used by vehicles.
These should be a subset of the Google Maps Platform Routes API travel modes, see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteTravelMode
Note: WALKING
routes are in beta and might sometimes be missing clear sidewalks or pedestrian paths. You must display this warning to the user for all walking routes that you display in your app.
Enums | |
---|---|
TRAVEL_MODE_UNSPECIFIED | Unspecified travel mode, equivalent to DRIVING . |
DRIVING | Travel mode corresponding to driving directions (car, ...). |
WALKING | Travel mode corresponding to walking directions. |
UnloadingPolicy
Policy on how a vehicle can be unloaded. Applies only to shipments having both a pickup and a delivery.
Other shipments are free to occur anywhere on the route independent of unloading_policy
.
Enums | |
---|---|
UNLOADING_POLICY_UNSPECIFIED | Unspecified unloading policy; deliveries must just occur after their corresponding pickups. |
LAST_IN_FIRST_OUT | Deliveries must occur in reverse order of pickups |
FIRST_IN_FIRST_OUT | Deliveries must occur in the same order as pickups |
Waypoint
Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.
Поля | |
---|---|
side_ of_ road | Необязательный. Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode. |
Union field location_type . Different ways to represent a location. location_type can be only one of the following: | |
location | A point specified using geographic coordinates, including an optional heading. |
place_ id | The POI place ID associated with the waypoint. When using a place ID to specify arrival or departure location of a VisitRequest, use a place ID that is specific enough to determine a LatLng location for navigation to the place. For example, a place ID representing a building is suitable, but a place ID representing a road is discouraged. |
Индекс
-
RouteOptimization
(interface) -
AggregatedMetrics
(message) -
BatchOptimizeToursMetadata
(message) -
BatchOptimizeToursRequest
(message) -
BatchOptimizeToursRequest.AsyncModelConfig
(message) -
BatchOptimizeToursResponse
(message) -
BreakRule
(message) -
BreakRule.BreakRequest
(message) -
BreakRule.FrequencyConstraint
(message) -
DataFormat
(enum) -
DistanceLimit
(message) -
GcsDestination
(message) -
GcsSource
(message) -
InjectedSolutionConstraint
(message) -
InjectedSolutionConstraint.ConstraintRelaxation
(message) -
InjectedSolutionConstraint.ConstraintRelaxation.Relaxation
(message) -
InjectedSolutionConstraint.ConstraintRelaxation.Relaxation.Level
(enum) -
InputConfig
(message) -
Location
(message) -
OptimizeToursRequest
(message) -
OptimizeToursRequest.SearchMode
(enum) -
OptimizeToursRequest.SolvingMode
(enum) -
OptimizeToursResponse
(message) -
OptimizeToursResponse.Metrics
(message) -
OptimizeToursValidationError
(message) -
OptimizeToursValidationError.FieldReference
(message) -
OutputConfig
(message) -
RouteModifiers
(message) -
Shipment
(message) -
Shipment.Load
(message) -
Shipment.VisitRequest
(message) -
ShipmentModel
(message) -
ShipmentModel.DurationDistanceMatrix
(message) -
ShipmentModel.DurationDistanceMatrix.Row
(message) -
ShipmentModel.PrecedenceRule
(message) -
ShipmentRoute
(message) -
ShipmentRoute.Break
(message) -
ShipmentRoute.EncodedPolyline
(message) -
ShipmentRoute.Transition
(message) -
ShipmentRoute.VehicleLoad
(message) -
ShipmentRoute.Visit
(message) -
ShipmentTypeIncompatibility
(message) -
ShipmentTypeIncompatibility.IncompatibilityMode
(enum) -
ShipmentTypeRequirement
(message) -
ShipmentTypeRequirement.RequirementMode
(enum) -
SkippedShipment
(message) -
SkippedShipment.Reason
(message) -
SkippedShipment.Reason.Code
(enum) -
TimeWindow
(message) -
TransitionAttributes
(message) -
Vehicle
(message) -
Vehicle.DurationLimit
(message) -
Vehicle.LoadLimit
(message) -
Vehicle.LoadLimit.Interval
(message) -
Vehicle.TravelMode
(enum) -
Vehicle.UnloadingPolicy
(enum) -
Waypoint
(message)
RouteOptimization
A service for optimizing vehicle tours.
Validity of certain types of fields:
-
google.protobuf.Timestamp
- Times are in Unix time: seconds since 1970-01-01T00:00:00+00:00.
- seconds must be in [0, 253402300799], ie in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
- nanos must be unset or set to 0.
-
google.protobuf.Duration
- seconds must be in [0, 253402300799], ie in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
- nanos must be unset or set to 0.
-
google.type.LatLng
- latitude must be in [-90.0, 90.0].
- longitude must be in [-180.0, 180.0].
- at least one of latitude and longitude must be non-zero.
BatchOptimizeTours |
---|
Optimizes vehicle tours for one or more This method is a Long Running Operation (LRO). The inputs for optimization ( The user can poll If the LRO If the LRO's
|
OptimizeTours |
---|
Sends an A The goal is to provide an assignment of
|
AggregatedMetrics
Aggregated metrics for ShipmentRoute
(resp. for OptimizeToursResponse
over all Transition
and/or Visit
(resp. over all ShipmentRoute
) elements.
Поля | |
---|---|
performed_ shipment_ count | Number of shipments performed. Note that a pickup and delivery pair only counts once. |
travel_ duration | Total travel duration for a route or a solution. |
wait_ duration | Total wait duration for a route or a solution. |
delay_ duration | Total delay duration for a route or a solution. |
break_ duration | Total break duration for a route or a solution. |
visit_ duration | Total visit duration for a route or a solution. |
total_ duration | The total duration should be equal to the sum of all durations above. For routes, it also corresponds to:
|
travel_ distance_ meters | Total travel distance for a route or a solution. |
max_ loads | Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all |
BatchOptimizeToursMetadata
This type has no fields.
Operation metadata for BatchOptimizeToursRequest
calls.
BatchOptimizeToursRequest
Request to batch optimize tours as an asynchronous operation. Each input file should contain one OptimizeToursRequest
, and each output file will contain one OptimizeToursResponse
. The request contains information to read/write and parse the files. All the input and output files should be under the same project.
Поля | |
---|---|
parent | Необходимый. Target project and location to make a call. Format: * If no location is specified, a region will be chosen automatically. |
model_ configs[] | Необходимый. Input/Output information each purchase model, such as file paths and data formats. |
AsyncModelConfig
Information for solving one optimization model asynchronously.
Поля | |
---|---|
display_ name | Необязательный. User defined model name, can be used as alias by users to keep track of models. |
input_ config | Необходимый. Information about the input model. |
output_ config | Необходимый. The desired output location information. |
BatchOptimizeToursResponse
This type has no fields.
Response to a BatchOptimizeToursRequest
. This is returned in the Long Running Operation after the operation is complete.
BreakRule
Rules to generate time breaks for a vehicle (eg lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur:
- during the travel between two visits (which includes the time right before or right after a visit, but not in the middle of a visit), in which case it extends the corresponding transit time between the visits,
- or before the vehicle start (the vehicle may not start in the middle of a break), in which case it does not affect the vehicle start time.
- or after the vehicle end (ditto, with the vehicle end time).
Поля | |
---|---|
break_ requests[] | Sequence of breaks. See the |
frequency_ constraints[] | Several |
BreakRequest
The sequence of breaks (ie their number and order) that apply to each vehicle must be known beforehand. The repeated BreakRequest
s define that sequence, in the order in which they must occur. Their time windows ( earliest_start_time
/ latest_start_time
) may overlap, but they must be compatible with the order (this is checked).
Поля | |
---|---|
earliest_ start_ time | Необходимый. Lower bound (inclusive) on the start of the break. |
latest_ start_ time | Необходимый. Upper bound (inclusive) on the start of the break. |
min_ duration | Необходимый. Minimum duration of the break. Must be positive. |
FrequencyConstraint
One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that this can be interpreted as "Within any sliding time window of 12h, there must be at least one break of at least one hour", that example would translate to the following FrequencyConstraint
:
{
min_break_duration { seconds: 3600 } # 1 hour.
max_inter_break_duration { seconds: 39600 } # 11 hours (12 - 1 = 11).
}
The timing and duration of the breaks in the solution will respect all such constraints, in addition to the time windows and minimum durations already specified in the BreakRequest
.
A FrequencyConstraint
may in practice apply to non-consecutive breaks. For example, the following schedule honors the "1h every 12h" example:
04:00 vehicle start
.. performing travel and visits ..
09:00 1 hour break
10:00 end of the break
.. performing travel and visits ..
12:00 20-min lunch break
12:20 end of the break
.. performing travel and visits ..
21:00 1 hour break
22:00 end of the break
.. performing travel and visits ..
23:59 vehicle end
Поля | |
---|---|
min_ break_ duration | Необходимый. Minimum break duration for this constraint. Nonnegative. See description of |
max_ inter_ break_ duration | Необходимый. Maximum allowed span of any interval of time in the route that does not include at least partially a break of |
DataFormat
Data formats for input and output files.
Enums | |
---|---|
DATA_FORMAT_UNSPECIFIED | Invalid value, format must not be UNSPECIFIED. |
JSON | JavaScript Object Notation. |
PROTO_TEXT | Protocol Buffers text format. See https://protobuf.dev/reference/protobuf/textformat-spec/ |
DistanceLimit
A limit defining a maximum distance which can be traveled. It can be either hard or soft.
If a soft limit is defined, both soft_max_meters
and cost_per_kilometer_above_soft_max
must be defined and be nonnegative.
Поля | |
---|---|
max_ meters | A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative. |
soft_ max_ meters | A soft limit not enforcing a maximum distance limit, but when violated results in a cost which adds up to other costs defined in the model, with the same unit. If defined soft_max_meters must be less than max_meters and must be nonnegative. |
cost_ per_ kilometer_ below_ soft_ max | Cost per kilometer incurred, increasing up to
This cost is not supported in |
cost_ per_ kilometer_ above_ soft_ max | Cost per kilometer incurred if distance is above
The cost must be nonnegative. |
GcsDestination
The Google Cloud Storage location where the output file(s) will be written to.
Поля | |
---|---|
uri | Необходимый. Google Cloud Storage URI. |
GcsSource
The Google Cloud Storage location where the input file will be read from.
Поля | |
---|---|
uri | Необходимый. URI of a Google Cloud Storage object with the format |
InjectedSolutionConstraint
Solution injected in the request including information about which visits must be constrained and how they must be constrained.
Поля | |
---|---|
routes[] | Routes of the solution to inject. Some routes may be omitted from the original solution. The routes and skipped shipments must satisfy the basic validity assumptions listed for |
skipped_ shipments[] | Skipped shipments of the solution to inject. Some may be omitted from the original solution. See the |
constraint_ relaxations[] | For zero or more groups of vehicles, specifies when and how much to relax constraints. If this field is empty, all non-empty vehicle routes are fully constrained. |
ConstraintRelaxation
For a group of vehicles, specifies at what threshold(s) constraints on visits will be relaxed and to which level. Shipments listed in the skipped_shipment
field are constrained to be skipped; ie, they cannot be performed.
Поля | |
---|---|
relaxations[] | All the visit constraint relaxations that will apply to visits on routes with vehicles in |
vehicle_ indices[] | Specifies the vehicle indices to which the visit constraint A vehicle index is mapped the same as |
Relaxation
If relaxations
is empty, the start time and sequence of all visits on routes
are fully constrained and no new visits may be inserted or added to those routes. Also, a vehicle's start and end time in routes
is fully constrained, unless the vehicle is empty (ie, has no visits and has used_if_route_is_empty
set to false in the model).
relaxations(i).level
specifies the constraint relaxation level applied to a visit #j that satisfies:
-
route.visits(j).start_time >= relaxations(i).threshold_time
AND -
j + 1 >= relaxations(i).threshold_visit_count
Similarly, the vehicle start is relaxed to relaxations(i).level
if it satisfies:
-
vehicle_start_time >= relaxations(i).threshold_time
AND -
relaxations(i).threshold_visit_count == 0
and the vehicle end is relaxed torelaxations(i).level
if it satisfies: -
vehicle_end_time >= relaxations(i).threshold_time
AND -
route.visits_size() + 1 >= relaxations(i).threshold_visit_count
To apply a relaxation level if a visit meets the threshold_visit_count
OR the threshold_time
add two relaxations
with the same level
: one with only threshold_visit_count
set and the other with only threshold_time
set. If a visit satisfies the conditions of multiple relaxations
, the most relaxed level applies. As a result, from the vehicle start through the route visits in order to the vehicle end, the relaxation level becomes more relaxed: ie, the relaxation level is non-decreasing as the route progresses.
The timing and sequence of route visits that do not satisfy the threshold conditions of any relaxations
are fully constrained and no visits may be inserted into these sequences. Also, if a vehicle start or end does not satisfy the conditions of any relaxation the time is fixed, unless the vehicle is empty.
Поля | |
---|---|
level | The constraint relaxation level that applies when the conditions at or after |
threshold_ time | The time at or after which the relaxation |
threshold_ visit_ count | The number of visits at or after which the relaxation If it is |
Уровень
Expresses the different constraint relaxation levels, which are applied for a visit and those that follow when it satisfies the threshold conditions.
The enumeration below is in order of increasing relaxation.
Enums | |
---|---|
LEVEL_UNSPECIFIED | Implicit default relaxation level: no constraints are relaxed, ie, all visits are fully constrained. This value must not be explicitly used in |
RELAX_VISIT_TIMES_AFTER_THRESHOLD | Visit start times and vehicle start/end times will be relaxed, but each visit remains bound to the same vehicle and the visit sequence must be observed: no visit can be inserted between them or before them. |
RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD | Same as RELAX_VISIT_TIMES_AFTER_THRESHOLD , but the visit sequence is also relaxed: visits can only be performed by this vehicle, but can potentially become unperformed. |
RELAX_ALL_AFTER_THRESHOLD | Same as RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD , but the vehicle is also relaxed: visits are completely free at or after the threshold time and can potentially become unperformed. |
InputConfig
Specify an input for [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours].
Поля | |
---|---|
data_ format | Необходимый. The input data format. |
Union field source . Необходимый. source can be only one of the following: | |
gcs_ source | A Google Cloud Storage location. This must be a single object (file). |
Расположение
Encapsulates a location (a geographic point, and an optional heading).
Поля | |
---|---|
lat_ lng | The waypoint's geographic coordinates. |
heading | The compass heading associated with the direction of the flow of traffic. This value is used to specify the side of the road to use for pickup and drop-off. Heading values can be from 0 to 360, where 0 specifies a heading of due North, 90 specifies a heading of due East, etc. |
OptimizeToursRequest
Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters.
Поля | |
---|---|
parent | Необходимый. Target project or location to make a call. Format: * If no location is specified, a region will be chosen automatically. |
timeout | If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner. For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed. |
model | Shipment model to solve. |
solving_ mode | By default, the solving mode is |
search_ mode | Search mode used to solve the request. |
injected_ first_ solution_ routes[] | Guide the optimization algorithm in finding a first solution that is similar to a previous solution. The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions. The solution must satisfy some basic validity assumptions:
If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead. |
injected_ solution_ constraint | Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified. If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead. |
refresh_ details_ routes[] | If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model. As of 2020/11, this only populates the polylines of non-empty routes and requires that The This field must not be used together with |
interpret_ injected_ solutions_ using_ labels | If true:
This interpretation applies to the If true, labels in the following categories must appear at most once in their category:
If a Removing route visits or entire routes from an injected solution may have an effect on the implied constraints, which may lead to change in solution, validation errors, or infeasibility. NOTE: The caller must ensure that each |
consider_ road_ traffic | Consider traffic estimation in calculating |
populate_ polylines | If true, polylines will be populated in response |
populate_ transition_ polylines | If true, polylines and route tokens will be populated in response |
allow_ large_ deadline_ despite_ interruption_ risk | If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines ) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption. |
use_ geodesic_ distances | If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by |
label | Label that may be used to identify this request, reported back in the |
geodesic_ meters_ per_ second | When |
max_ validation_ errors | Truncates the number of validation errors returned. These errors are typically attached to an INVALID_ARGUMENT error payload as a BadRequest error detail ( https://cloud.google.com/apis/design/errors#error_details) , unless solving_mode=VALIDATE_ONLY: see the |
SearchMode
Mode defining the behavior of the search, trading off latency versus solution quality. In all modes, the global request deadline is enforced.
Enums | |
---|---|
SEARCH_MODE_UNSPECIFIED | Unspecified search mode, equivalent to RETURN_FAST . |
RETURN_FAST | Stop the search after finding the first good solution. |
CONSUME_ALL_AVAILABLE_TIME | Spend all the available time to search for better solutions. |
SolvingMode
Defines how the solver should handle the request. In all modes but VALIDATE_ONLY
, if the request is invalid, you will receive an INVALID_REQUEST
error. See max_validation_errors
to cap the number of errors returned.
Enums | |
---|---|
DEFAULT_SOLVE | Solve the model. Warnings may be issued in [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]. |
VALIDATE_ONLY | Only validates the model without solving it: populates as many OptimizeToursResponse.validation_errors as possible. |
DETECT_SOME_INFEASIBLE_SHIPMENTS | Only populates IMPORTANT : not all infeasible shipments are returned here, but only the ones that are detected as infeasible during preprocessing. |
OptimizeToursResponse
Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution.
Поля | |
---|---|
routes[] | Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model. |
request_ label | Copy of the |
skipped_ shipments[] | The list of all shipments skipped. |
validation_ errors[] | List of all the validation errors that we were able to detect independently. See the "MULTIPLE ERRORS" explanation for the |
metrics | Duration, distance and usage metrics for this solution. |
Метрики
Overall metrics, aggregated over all routes.
Поля | |
---|---|
aggregated_ route_ metrics | Aggregated over the routes. Each metric is the sum (or max, for loads) over all |
skipped_ mandatory_ shipment_ count | Number of mandatory shipments skipped. |
used_ vehicle_ count | Number of vehicles used. Note: if a vehicle route is empty and |
earliest_ vehicle_ start_ time | The earliest start time for a used vehicle, computed as the minimum over all used vehicles of |
latest_ vehicle_ end_ time | The latest end time for a used vehicle, computed as the maximum over all used vehicles of |
costs | Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, eg "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01. |
total_ cost | Total cost of the solution. The sum of all values in the costs map. |
OptimizeToursValidationError
Describes an error or warning encountered when validating an OptimizeToursRequest
.
Поля | |
---|---|
code | A validation error is defined by the pair ( The fields following this section provide more context about the error. MULTIPLE ERRORS : When there are multiple errors, the validation process tries to output several of them. Much like a compiler, this is an imperfect process. Some validation errors will be "fatal", meaning that they stop the entire validation process. This is the case for STABILITY : |
display_ name | The error display name. |
fields[] | An error context may involve 0, 1 (most of the time) or more fields. For example, referring to vehicle #4 and shipment #2's first pickup can be done as follows:
Note, however, that the cardinality of |
error_ message | Human-readable string describing the error. There is a 1:1 mapping between STABILITY : Not stable: the error message associated to a given |
offending_ values | May contain the value(s) of the field(s). This is not always available. You should absolutely not rely on it and use it only for manual model debugging. |
FieldReference
Specifies a context for the validation error. A FieldReference
always refers to a given field in this file and follows the same hierarchical structure. For example, we may specify element #2 of start_time_windows
of vehicle #5 using:
name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 }
We however omit top-level entities such as OptimizeToursRequest
or ShipmentModel
to avoid crowding the message.
Поля | |
---|---|
name | Name of the field, eg, "vehicles". |
sub_ field | Recursively nested sub-field, if needed. |
Union field | |
index | Index of the field if repeated. |
key | Key if the field is a map. |
OutputConfig
Specify a destination for [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours] results.
Поля | |
---|---|
data_ format | Необходимый. The output data format. |
Union field destination . Необходимый. destination can be only one of the following: | |
gcs_ destination | The Google Cloud Storage location to write the output to. |
RouteModifiers
Encapsulates a set of optional conditions to satisfy when calculating vehicle routes. This is similar to RouteModifiers
in the Google Maps Platform Routes Preferred API; see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers .
Поля | |
---|---|
avoid_ tolls | Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes. |
avoid_ highways | Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes. |
avoid_ ferries | Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes. |
avoid_ indoor | Необязательный. Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the |
Отгрузка
The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly).
Поля | |
---|---|
display_ name | The user-defined display name of the shipment. It can be up to 63 characters long and may use UTF-8 characters. |
pickups[] | Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries. |
deliveries[] | Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups. |
load_ demands | Load demands of the shipment (for example weight, volume, number of pallets etc). The keys in the map should be identifiers describing the type of the corresponding load, ideally also including the units. For example: "weight_kg", "volume_gallons", "pallet_count", etc. If a given key does not appear in the map, the corresponding load is considered as null. |
allowed_ vehicle_ indices[] | The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the |
costs_ per_ vehicle[] | Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER:
These costs must be in the same unit as |
costs_ per_ vehicle_ indices[] | Indices of the vehicles to which |
pickup_ to_ delivery_ absolute_ detour_ limit | Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting
If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles. |
pickup_ to_ delivery_ time_ limit | Specifies the maximum duration from start of pickup to start of delivery of a shipment. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. This does not depend on which alternatives are selected for pickup and delivery, nor on vehicle speed. This can be specified alongside maximum detour constraints: the solution will respect both specifications. |
shipment_ type | Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between Differs from |
label | Specifies a label for this shipment. This label is reported in the response in the |
ignore | If true, skip this shipment, but don't apply a Ignoring a shipment results in a validation error when there are any Ignoring a shipment that is performed in |
penalty_ cost | If the shipment is not completed, this penalty is added to the overall cost of the routes. A shipment is considered completed if one of its pickup and delivery alternatives is visited. The cost may be expressed in the same unit used for all other cost-related fields in the model and must be positive. IMPORTANT : If this penalty is not specified, it is considered infinite, ie the shipment must be completed. |
pickup_ to_ delivery_ relative_ detour_ limit | Specifies the maximum relative detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting
If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles. |
Нагрузка
When performing a visit, a predefined amount may be added to the vehicle load if it's a pickup, or subtracted if it's a delivery. This message defines such amount. See load_demands
.
Поля | |
---|---|
amount | The amount by which the load of the vehicle performing the corresponding visit will vary. Since it is an integer, users are advised to choose an appropriate unit to avoid loss of precision. Must be ≥ 0. |
VisitRequest
Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).
Поля | |
---|---|
arrival_ location | The geo-location where the vehicle arrives when performing this |
arrival_ waypoint | The waypoint where the vehicle arrives when performing this |
departure_ location | The geo-location where the vehicle departs after completing this |
departure_ waypoint | The waypoint where the vehicle departs after completing this |
tags[] | Specifies tags attached to the visit request. Empty or duplicate strings are not allowed. |
time_ windows[] | Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, ie arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before The absence of Time windows must be disjoint, ie no time window must overlap with or be adjacent to another, and they must be in increasing order. |
duration | Duration of the visit, ie time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see |
cost | Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as |
load_ demands | Load demands of this visit request. This is just like |
visit_ types[] | Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see A type can only appear once. |
label | Specifies a label for this |
ShipmentModel
A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of:
- the cost of routing the vehicles (sum of cost per total time, cost per travel time, and fixed cost over all vehicles).
- the unperformed shipment penalties.
- the cost of the global duration of the shipments
Поля | |
---|---|
shipments[] | Set of shipments which must be performed in the model. |
vehicles[] | Set of vehicles which can be used to perform visits. |
global_ start_ time | Global start and end time of the model: no times outside of this range can be considered valid. The model's time span must be less than a year, ie the When using |
global_ end_ time | If unset, 00:00:00 UTC, January 1, 1971 (ie seconds: 31536000, nanos: 0) is used as default. |
global_ duration_ cost_ per_ hour | The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as |
duration_ distance_ matrices[] | Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the Usage examples:
|
duration_ distance_ matrix_ src_ tags[] | Tags defining the sources of the duration and distance matrices; Tags correspond to |
duration_ distance_ matrix_ dst_ tags[] | Tags defining the destinations of the duration and distance matrices; Tags correspond to |
transition_ attributes[] | Transition attributes added to the model. |
shipment_ type_ incompatibilities[] | Sets of incompatible shipment_types (see |
shipment_ type_ requirements[] | Sets of |
precedence_ rules[] | Set of precedence rules which must be enforced in the model. IMPORTANT : Use of precedence rules limits the size of problem that can be optimized. Requests using precedence rules that include many shipments may be rejected. |
max_ active_ vehicles | Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive. |
DurationDistanceMatrix
Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations.
Поля | |
---|---|
rows[] | Specifies the rows of the duration and distance matrix. It must have as many elements as |
vehicle_ start_ tag | Tag defining to which vehicles this duration and distance matrix applies. If empty, this applies to all vehicles, and there can only be a single matrix. Each vehicle start must match exactly one matrix, ie exactly one of their All matrices must have a different |
Ряд
Specifies a row of the duration and distance matrix.
Поля | |
---|---|
durations[] | Duration values for a given row. It must have as many elements as |
meters[] | Distance values for a given row. If no costs or constraints refer to distances in the model, this can be left empty; otherwise it must have as many elements as |
PrecedenceRule
A precedence rule between two events (each event is the pickup or the delivery of a shipment): the "second" event has to start at least offset_duration
after "first" has started.
Several precedences can refer to the same (or related) events, eg, "pickup of B happens after delivery of A" and "pickup of C happens after pickup of B".
Furthermore, precedences only apply when both shipments are performed and are otherwise ignored.
Поля | |
---|---|
first_ is_ delivery | Indicates if the "first" event is a delivery. |
second_ is_ delivery | Indicates if the "second" event is a delivery. |
offset_ duration | The offset between the "first" and "second" event. It can be negative. |
first_ index | Shipment index of the "first" event. This field must be specified. |
second_ index | Shipment index of the "second" event. This field must be specified. |
ShipmentRoute
A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits):
| | | | | T[2], | | |
| Transition | Visit #0 | | | V[2], | | |
| #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] |
| aka T[0] | V[0] | | | V[n-2],| | |
| | | | | T[n-1] | | |
^ ^ ^ ^ ^ ^ ^ ^
vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle
start (arrival) (departure) start end start end end
Note that we make a difference between:
- "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second.
- "time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, ie start and end at the same second, they often have a positive duration.
Invariants:
- If there are n visits, there are n+1 transitions.
- A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1).
- The vehicle start is always followed by transition #0.
- The vehicle end is always preceded by transition #n.
Zooming in, here is what happens during a Transition
and a Visit
:
---+-------------------------------------+-----------------------------+-->
| TRANSITION[i] | VISIT[i] |
| | |
| * TRAVEL: the vehicle moves from | PERFORM the visit: |
| VISIT[i-1].departure_location to | |
| VISIT[i].arrival_location, which | * Spend some time: |
| takes a given travel duration | the "visit duration". |
| and distance | |
| | * Load or unload |
| * BREAKS: the driver may have | some quantities from the |
| breaks (e.g. lunch break). | vehicle: the "demand". |
| | |
| * WAIT: the driver/vehicle does | |
| nothing. This can happen for | |
| many reasons, for example when | |
| the vehicle reaches the next | |
| event's destination before the | |
| start of its time window | |
| | |
| * DELAY: *right before* the next | |
| arrival. E.g. the vehicle and/or | |
| driver spends time unloading. | |
| | |
---+-------------------------------------+-----------------------------+-->
^ ^ ^
V[i-1].end V[i].start V[i].end
Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged during a transition.
- They don't overlap.
- The DELAY is unique and must be a contiguous period of time right before the next visit (or vehicle end). Thus, it suffice to know the delay duration to know its start and end time.
- The BREAKS are contiguous, non-overlapping periods of time. The response specifies the start time and duration of each break.
- TRAVEL and WAIT are "preemptable": they can be interrupted several times during this transition. Clients can assume that travel happens "as soon as possible" and that "wait" fills the remaining time.
A (complex) example:
TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
|| | | | | | | ||
|| T | B | T | | B | | D ||
|| r | r | r | W | r | W | e ||
|| a | e | a | a | e | a | l ||
|| v | a | v | i | a | i | a ||
|| e | k | e | t | k | t | y ||
|| l | | l | | | | ||
|| | | | | | | ||
--++-----------------------------------------------------------------++-->
Поля | |
---|---|
vehicle_ index | Vehicle performing the route, identified by its index in the source |
vehicle_ label | Label of the vehicle performing this route, equal to |
vehicle_ start_ time | Time at which the vehicle starts its route. |
vehicle_ end_ time | Time at which the vehicle finishes its route. |
visits[] | Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused. |
transitions[] | Ordered list of transitions for the route. |
has_ traffic_ infeasibilities | When
Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel time |
route_ polyline | The encoded polyline representation of the route. This field is only populated if |
breaks[] | Breaks scheduled for the vehicle performing this route. The |
metrics | Duration, distance and load metrics for this route. The fields of |
route_ costs | Cost of the route, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, eg "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole route. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the route. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01. |
route_ total_ cost | Total cost of the route. The sum of all costs in the cost map. |
Перерыв
Data representing the execution of a break.
Поля | |
---|---|
start_ time | Start time of a break. |
duration | Duration of a break. |
EncodedPolyline
The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding .
Поля | |
---|---|
points | String representing encoded points of the polyline. |
Переход
Transition between two events on the route. See the description of ShipmentRoute
.
If the vehicle does not have a start_location
and/or end_location
, the corresponding travel metrics are 0.
Поля | |
---|---|
travel_ duration | Travel duration during this transition. |
travel_ distance_ meters | Distance traveled during the transition. |
traffic_ info_ unavailable | When traffic is requested via |
delay_ duration | Sum of the delay durations applied to this transition. If any, the delay starts exactly |
break_ duration | Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in |
wait_ duration | Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals. |
total_ duration | Total duration of the transition, provided for convenience. It is equal to:
|
start_ time | Start time of this transition. |
route_ polyline | The encoded polyline representation of the route followed during the transition. This field is only populated if |
route_ token | Output only. An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route. This field is only populated if |
vehicle_ loads | Vehicle loads during this transition, for each type that either appears in this vehicle's The loads during the first transition are the starting loads of the vehicle route. Then, after each visit, the visit's |
VehicleLoad
Reports the actual load of the vehicle at some point along the route, for a given type (see Transition.vehicle_loads
).
Поля | |
---|---|
amount | The amount of load on the vehicle, for the given type. The unit of load is usually indicated by the type. See |
Посещать
A visit performed during a route. This visit corresponds to a pickup or a delivery of a Shipment
.
Поля | |
---|---|
shipment_ index | Index of the |
is_ pickup | If true the visit corresponds to a pickup of a |
visit_ request_ index | Index of |
start_ time | Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the |
load_ demands | Total visit load demand as the sum of the shipment and the visit request |
detour | Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to:
Otherwise, it is computed from the vehicle
|
shipment_ label | Copy of the corresponding |
visit_ label | Copy of the corresponding |
ShipmentTypeIncompatibility
Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode.
Поля | |
---|---|
types[] | List of incompatible types. Two shipments having different |
incompatibility_ mode | Mode applied to the incompatibility. |
IncompatibilityMode
Modes defining how the appearance of incompatible shipments are restricted on the same route.
Enums | |
---|---|
INCOMPATIBILITY_MODE_UNSPECIFIED | Unspecified incompatibility mode. This value should never be used. |
NOT_PERFORMED_BY_SAME_VEHICLE | In this mode, two shipments with incompatible types can never share the same vehicle. |
NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY | For two shipments with incompatible types with the
|
ShipmentTypeRequirement
Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode.
Поля | |
---|---|
required_ shipment_ type_ alternatives[] | List of alternative shipment types required by the |
dependent_ shipment_ types[] | All shipments with a type in the NOTE: Chains of requirements such that a |
requirement_ mode | Mode applied to the requirement. |
RequirementMode
Modes defining the appearance of dependent shipments on a route.
Enums | |
---|---|
REQUIREMENT_MODE_UNSPECIFIED | Unspecified requirement mode. This value should never be used. |
PERFORMED_BY_SAME_VEHICLE | In this mode, all "dependent" shipments must share the same vehicle as at least one of their "required" shipments. |
IN_SAME_VEHICLE_AT_PICKUP_TIME | With the A "dependent" shipment pickup must therefore have either:
|
IN_SAME_VEHICLE_AT_DELIVERY_TIME | Same as before, except the "dependent" shipments need to have a "required" shipment on their vehicle at the time of their delivery . |
SkippedShipment
Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here.
Поля | |
---|---|
index | The index corresponds to the index of the shipment in the source |
label | Copy of the corresponding |
reasons[] | A list of reasons that explain why the shipment was skipped. See comment above |
Причина
If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, reason
will have more than 1 element. A skipped shipment cannot have duplicate reasons, ie where all fields are the same except for example_vehicle_index
. Пример:
reasons {
code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
example_vehicle_index: 1
example_exceeded_capacity_type: "Apples"
}
reasons {
code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
example_vehicle_index: 3
example_exceeded_capacity_type: "Pears"
}
reasons {
code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
example_vehicle_index: 1
}
The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1).
Поля | |
---|---|
code | Refer to the comments of Code. |
example_ exceeded_ capacity_ type | If the reason code is |
example_ vehicle_ index | If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle. |
Код
Code identifying the reason type. The order here is meaningless. In particular, it gives no indication of whether a given reason will appear before another in the solution, if both apply.
Enums | |
---|---|
CODE_UNSPECIFIED | This should never be used. |
NO_VEHICLE | There is no vehicle in the model making all shipments infeasible. |
DEMAND_EXCEEDS_VEHICLE_CAPACITY | The demand of the shipment exceeds a vehicle's capacity for some capacity types, one of which is example_exceeded_capacity_type . |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT | The minimum distance necessary to perform this shipment, ie from the vehicle's Note that for this computation we use the geodesic distances. |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT | The minimum time necessary to perform this shipment, including travel time, wait time and service time exceeds the vehicle's Note: travel time is computed in the best-case scenario, namely as geodesic distance x 36 m/s (roughly 130 km/hour). |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT | Same as above but we only compare minimum travel time and the vehicle's travel_duration_limit . |
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS | The vehicle cannot perform this shipment in the best-case scenario (see CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT for time computation) if it starts at its earliest start time: the total time would make the vehicle end after its latest end time. |
VEHICLE_NOT_ALLOWED | The allowed_vehicle_indices field of the shipment is not empty and this vehicle does not belong to it. |
TimeWindow
Time windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle.
Hard time window bounds, start_time
and end_time
, enforce the earliest and latest time of the event, such that start_time <= event_time <= end_time
. The soft time window lower bound, soft_start_time
, expresses a preference for the event to happen at or after soft_start_time
by incurring a cost proportional to how long before soft_start_time the event occurs. The soft time window upper bound, soft_end_time
, expresses a preference for the event to happen at or before soft_end_time
by incurring a cost proportional to how long after soft_end_time
the event occurs. start_time
, end_time
, soft_start_time
and soft_end_time
should be within the global time limits (see ShipmentModel.global_start_time
and ShipmentModel.global_end_time
) and should respect:
0 <= `start_time` <= `end_time` and
0 <= `start_time` <= `soft_start_time` and
0 <= `soft_end_time` <= `end_time`.
Поля | |
---|---|
start_ time | The hard time window start time. If unspecified it will be set to |
end_ time | The hard time window end time. If unspecified it will be set to |
soft_ start_ time | The soft start time of the time window. |
soft_ end_ time | The soft end time of the time window. |
cost_ per_ hour_ before_ soft_ start_ time | A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:
This cost must be positive, and the field can only be set if soft_start_time has been set. |
cost_ per_ hour_ after_ soft_ end_ time | A cost per hour added to other costs in the model if the event occurs after
This cost must be positive, and the field can only be set if |
TransitionAttributes
Specifies attributes of transitions between two consecutive visits on a route. Several TransitionAttributes
may apply to the same transition: in that case, all extra costs add up and the strictest constraint or limit applies (following natural "AND" semantics).
Поля | |
---|---|
src_ tag | Tags defining the set of (src->dst) transitions these attributes apply to. A source visit or vehicle start matches iff its |
excluded_ src_ tag | See |
dst_ tag | A destination visit or vehicle end matches iff its |
excluded_ dst_ tag | See |
cost | Specifies a cost for performing this transition. This is in the same unit as all other costs in the model and must not be negative. It is applied on top of all other existing costs. |
cost_ per_ kilometer | Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any |
distance_ limit | Specifies a limit on the distance traveled while performing this transition. As of 2021/06, only soft limits are supported. |
delay | Specifies a delay incurred when performing this transition. This delay always occurs after finishing the source visit and before starting the destination visit. |
Транспортное средство
Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from start_location
and ending at end_location
for this vehicle. A route is a sequence of visits (see ShipmentRoute
).
Поля | |
---|---|
display_ name | The user-defined display name of the vehicle. It can be up to 63 characters long and may use UTF-8 characters. |
travel_ mode | The travel mode which affects the roads usable by the vehicle and its speed. See also |
route_ modifiers | A set of conditions to satisfy that affect the way routes are calculated for the given vehicle. |
start_ location | Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, |
start_ waypoint | Waypoint representing a geographic location where the vehicle starts before picking up any shipments. If neither |
end_ location | Geographic location where the vehicle ends after it has completed its last |
end_ waypoint | Waypoint representing a geographic location where the vehicle ends after it has completed its last |
start_ tags[] | Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed. |
end_ tags[] | Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed. |
start_ time_ windows[] | Time windows during which the vehicle may depart its start location. They must be within the global time limits (see Time windows belonging to the same repeated field must be disjoint, ie no time window can overlap with or be adjacent to another, and they must be in chronological order. |
end_ time_ windows[] | Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see Time windows belonging to the same repeated field must be disjoint, ie no time window can overlap with or be adjacent to another, and they must be in chronological order. |
unloading_ policy | Unloading policy enforced on the vehicle. |
load_ limits | Capacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the |
cost_ per_ hour | Vehicle costs: all costs add up and must be in the same unit as Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using |
cost_ per_ traveled_ hour | Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (ie, that reported in |
cost_ per_ kilometer | Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the |
fixed_ cost | Fixed cost applied if this vehicle is used to handle a shipment. |
used_ if_ route_ is_ empty | This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case. If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account. Otherwise, it doesn't travel from its start to its end location, and no |
route_ duration_ limit | Limit applied to the total duration of the vehicle's route. In a given |
travel_ duration_ limit | Limit applied to the travel duration of the vehicle's route. In a given |
route_ distance_ limit | Limit applied to the total distance of the vehicle's route. In a given |
extra_ visit_ duration_ for_ visit_ type | Specifies a map from visit_types strings to durations. The duration is time in addition to If a visit request has multiple types, a duration will be added for each type in the map. |
break_ rule | Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle. |
label | Specifies a label for this vehicle. This label is reported in the response as the |
ignore | If true, If a shipment is performed by an ignored vehicle in If a shipment is performed by an ignored vehicle in |
travel_ duration_ multiple | Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision. See also |
DurationLimit
A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.
When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.
Поля | |
---|---|
max_ duration | A hard limit constraining the duration to be at most max_duration. |
soft_ max_ duration | A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit. If defined, |
quadratic_ soft_ max_ duration | A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit. If defined, |
cost_ per_ hour_ after_ soft_ max | Cost per hour incurred if the
The cost must be nonnegative. |
cost_ per_ square_ hour_ after_ quadratic_ soft_ max | Cost per square hour incurred if the The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:
The cost must be nonnegative. |
LoadLimit
Defines a load limit applying to a vehicle, eg "this truck may only carry up to 3500 kg". See load_limits
.
Поля | |
---|---|
soft_ max_ load | A soft limit of the load. See |
cost_ per_ unit_ above_ soft_ max | If the load ever exceeds |
start_ load_ interval | The acceptable load interval of the vehicle at the start of the route. |
end_ load_ interval | The acceptable load interval of the vehicle at the end of the route. |
max_ load | The maximum acceptable amount of load. |
Интервал
Interval of acceptable load amounts.
Поля | |
---|---|
min | A minimum acceptable load. Must be ≥ 0. If they're both specified, |
max | A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum load is unrestricted by this message. If they're both specified, |
TravelMode
Travel modes which can be used by vehicles.
These should be a subset of the Google Maps Platform Routes API travel modes, see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteTravelMode
Note: WALKING
routes are in beta and might sometimes be missing clear sidewalks or pedestrian paths. You must display this warning to the user for all walking routes that you display in your app.
Enums | |
---|---|
TRAVEL_MODE_UNSPECIFIED | Unspecified travel mode, equivalent to DRIVING . |
DRIVING | Travel mode corresponding to driving directions (car, ...). |
WALKING | Travel mode corresponding to walking directions. |
UnloadingPolicy
Policy on how a vehicle can be unloaded. Applies only to shipments having both a pickup and a delivery.
Other shipments are free to occur anywhere on the route independent of unloading_policy
.
Enums | |
---|---|
UNLOADING_POLICY_UNSPECIFIED | Unspecified unloading policy; deliveries must just occur after their corresponding pickups. |
LAST_IN_FIRST_OUT | Deliveries must occur in reverse order of pickups |
FIRST_IN_FIRST_OUT | Deliveries must occur in the same order as pickups |
Waypoint
Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.
Поля | |
---|---|
side_ of_ road | Необязательный. Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode. |
Union field location_type . Different ways to represent a location. location_type can be only one of the following: | |
location | A point specified using geographic coordinates, including an optional heading. |
place_ id | The POI place ID associated with the waypoint. When using a place ID to specify arrival or departure location of a VisitRequest, use a place ID that is specific enough to determine a LatLng location for navigation to the place. For example, a place ID representing a building is suitable, but a place ID representing a road is discouraged. |