Package google.maps.routeoptimization.v1

int32

Количество выполненных отправок. Обратите внимание, что пара "забор и доставка" учитывается только один раз.

Duration

Общая продолжительность поездки по маршруту или решению.

Duration

Общее время ожидания маршрута или решения.

Duration

Общая продолжительность задержки для данного маршрута или решения.

Duration

Общая продолжительность перерыва для маршрута или решения.

Duration

Общая продолжительность посещения для конкретного маршрута или решения.

Duration

Общая продолжительность должна быть равна сумме всех указанных выше продолжительностей. Для маршрутов это также соответствует:

[ShipmentRoute.vehicle_end_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_end_time] - [ShipmentRoute.vehicle_start_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_start_time]

double

Общее пройденное расстояние по маршруту или решению.

map<string, VehicleLoad >

Максимальная нагрузка, достигнутая на всем маршруте (соответственно, решение), для каждой из величин на этом маршруте (соответственно, решение), вычисляется как максимум по всем Transition.vehicle_loads (соответственно, ShipmentRoute.metrics.max_loads ).

int32

Количество выполненных обязательных отгрузок.

Экспериментальный: Поведение или существование данной области может измениться в будущем.

double

Сумма значений Shipment.penalty_cost по выполненным отгрузкам.

Экспериментальный: Поведение или существование данной области может измениться в будущем.

string

Обязательно. Целевой проект и местоположение для звонка.

Формат:

• projects/{project-id}
• projects/{project-id}/locations/{location-id}

Если местоположение не указано, регион будет выбран автоматически.

AsyncModelConfig

Обязательно. Информация о входных/выходных данных для каждой модели покупки, такая как пути к файлам и форматы данных.

string

Необязательно. Задается пользователем имя модели, которое может использоваться в качестве псевдонима для отслеживания моделей.

InputConfig

Обязательно. Информация о входной модели.

OutputConfig

Обязательно. Информация о желаемом месте вывода.

BreakRequest

Последовательность прерываний. См. сообщение BreakRequest .

FrequencyConstraint

Может применяться несколько FrequencyConstraint . Все они должны удовлетворяться запросами BreakRequest ) данного BreakRule . См. FrequencyConstraint .

Timestamp

Обязательно. Нижняя граница (включительно) на начало перерыва.

Timestamp

Обязательно. Верхняя граница (включительно) на начало перерыва.

Duration

Обязательно. Минимальная продолжительность перерыва. Должен быть положительным.

Duration

Обязательно. Минимальная продолжительность перерыва для этого ограничения. Неотрицательное значение. См. описание параметра FrequencyConstraint .

Duration

Обязательно. Максимально допустимый интервал времени на маршруте, не включающий хотя бы частично перерыв duration >= min_break_duration . Должно быть положительным.

int64

Жесткое ограничение, устанавливающее расстояние не более max_meters. Предел должен быть неотрицательным.

int64

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

Если параметр soft_max_meters задан, он должен быть меньше max_meters и неотрицательным.

double

Стоимость за километр, увеличивающаяся до значения soft_max_meters , рассчитывается по формуле:

  min(distance_meters, soft_max_meters) / 1000.0 *
  cost_per_kilometer_below_soft_max.

Данная стоимость не поддерживается в route_distance_limit .

double

Стоимость за километр взимается, если расстояние превышает лимит soft_max_meters . Дополнительная стоимость равна 0, если расстояние меньше лимита, в противном случае используется следующая формула для расчета стоимости:

  (distance_meters - soft_max_meters) / 1000.0 *
  cost_per_kilometer_above_soft_max.

Стоимость должна быть неотрицательной.

string

Обязательно. URI Google Cloud Storage.

string

Обязательно. URI объекта Google Cloud Storage в формате gs://bucket/path/to/object .

ShipmentRoute

Маршруты вводимого решения. Некоторые маршруты могут быть опущены из исходного решения. Маршруты и пропущенные поставки должны удовлетворять основным предположениям о допустимости, указанным для injected_first_solution_routes .

SkippedShipment

Пропущенные поставки раствора для инъекций. Некоторые из них могут отсутствовать в исходном растворе. См. поле routes .

ConstraintRelaxation

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

Relaxation

Все послабления ограничений на посещения, которые будут применяться к посещениям маршрутов с транспортными средствами, указанными в vehicle_indices .

int32

Указывает индексы транспортных средств, к которым применяются relaxations ограничений посещения. Если поле пустое, это считается значением по умолчанию, и relaxations применяются ко всем транспортным средствам, которые не указаны в других constraint_relaxations . Может быть не более одного значения по умолчанию, т.е. допускается не более одного пустого поля vehicle_indices для ослабления ограничений. Индекс транспортного средства может быть указан только один раз, даже в нескольких constraint_relaxations .

Индекс транспортного средства сопоставляется так же, как ShipmentRoute.vehicle_index , если interpret_injected_solutions_using_labels имеет значение true (см. комментарий fields ).

Level

Уровень ослабления ограничений, применяемый при выполнении условий, действующих в момент threshold_time или после него, И при условии, что выполняется как минимум threshold_visit_count .

Timestamp

Время, после которого может быть применен level послаблений.

int32

Количество посещений, после которых может быть применен level смягчения ограничений. Если threshold_visit_count равен 0 (или не задан), level может быть применен непосредственно при запуске транспортного средства.

Если значение равно route.visits_size() + 1 , level может применяться только к транспортному средству. Если значение больше route.visits_size() + 1 , level для данного маршрута вообще не применяется.

DataFormat

Обязательно. Формат входных данных.

GcsSource

Местоположение в Google Cloud Storage. Это должен быть один объект (файл).

LatLng

Географические координаты контрольной точки.

int32

Направление по компасу, связанное с направлением движения транспорта. Это значение используется для указания стороны дороги, используемой для посадки и высадки пассажиров. Значения направления могут быть от 0 до 360, где 0 означает направление строго на север, 90 — направление строго на восток и т. д.

string

Обязательно. Целевой проект или местоположение для совершения звонка.

Формат:

• projects/{project-id}
• projects/{project-id}/locations/{location-id}

Если местоположение не указано, регион будет выбран автоматически.

Duration

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

Для асинхронных запросов сервер сгенерирует решение (если это возможно) до истечения времени ожидания.

ShipmentModel

Модель доставки, которую необходимо решить.

SolvingMode

По умолчанию режим решения — DEFAULT_SOLVE (0).

SearchMode

Для решения запроса использовался режим поиска.

ShipmentRoute

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

Модель ограничена на момент построения первого решения. Любые отгрузки, не выполненные по маршруту, неявно пропускаются в первом решении, но могут быть выполнены в последующих решениях.

Решение должно удовлетворять ряду основных предположений о его достоверности:

• Для всех маршрутов vehicle_index должно находиться в допустимом диапазоне и не должно дублироваться.
• Для всех посещений shipment_index и visit_request_index должны находиться в допустимом диапазоне.
• Один груз может быть указан только на одном маршруте.
• Забор груза, подлежащего доставке, должен быть осуществлен до доставки.
• Допускается выполнение не более одного варианта забора или доставки груза.
• Для всех маршрутов время увеличивается (т. е. vehicle_start_time <= visits[0].start_time <= visits[1].start_time ... <= vehicle_end_time ).
• Отправка может быть осуществлена ​​только на транспортном средстве, которое разрешено. Транспортное средство разрешено, если Shipment.allowed_vehicle_indices пустое или его vehicle_index включено в Shipment.allowed_vehicle_indices .

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

InjectedSolutionConstraint

Ограничьте алгоритм оптимизации, чтобы найти окончательное решение, аналогичное предыдущему. Например, это может использоваться для замораживания участков маршрутов, которые уже завершены или которые должны быть завершены, но не должны быть изменены.

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

ShipmentRoute

Если поле не пустое, указанные маршруты будут обновлены без изменения последовательности посещений или времени в пути: будут обновлены только другие детали. Это не решает задачу модели.

Начиная с ноября 2020 года, эта функция заполняет полилинии только непустых маршрутов и требует, чтобы populate_polylines был установлен в значение true.

Поля route_polyline переданных маршрутов могут не соответствовать transitions маршрутов.

Это поле нельзя использовать вместе с injected_first_solution_routes или injected_solution_constraint .

Shipment.ignore и Vehicle.ignore не влияют на поведение. Полилинии остаются заполненными между всеми посещениями во всех непустых маршрутах, независимо от того, игнорируются ли соответствующие грузы или транспортные средства.

bool

Если это правда:

• Использует ShipmentRoute.vehicle_label вместо vehicle_index для сопоставления маршрутов во внедренном решении с транспортными средствами в запросе; повторно использует сопоставление исходного ShipmentRoute.vehicle_index с новым ShipmentRoute.vehicle_index для обновления ConstraintRelaxation.vehicle_indices , если оно не пустое, но сопоставление должно быть однозначным (т.е. несколько ShipmentRoute не должны иметь один и тот же исходный vehicle_index ).
• Вместо shipment_index используется ShipmentRoute.Visit.shipment_label для сопоставления посещений во внедренном решении с отправлениями в запросе;
• Вместо SkippedShipment.index используется SkippedShipment.label для сопоставления пропущенных отправок во внедренном решении с запрошенными отправками.

Данная интерпретация применяется к полям injected_first_solution_routes , injected_solution_constraint и refresh_details_routes . Она может использоваться, когда индексы отгрузок или транспортных средств в запросе изменились с момента создания решения, например, из-за удаления или добавления отгрузок или транспортных средств в запрос.

Если это так, то метки в следующих категориях должны встречаться в своей категории не более одного раза:

• Vehicle.label в запросе;
• Shipment.label в запросе;
• ShipmentRoute.vehicle_label в используемом растворе;
• В внедряемом решении следует пропустить SkippedShipment.label и ShipmentRoute.Visit.shipment_label (за исключением пар «посещение/доставка», для которых shipment_label должен встречаться дважды).

Если метка vehicle_label во внедренном решении не соответствует запрошенному транспортному средству, соответствующий маршрут удаляется из решения вместе с его посещениями. Если shipment_label во внедренном решении не соответствует запрошенной отправке, соответствующее посещение удаляется из решения. Если метка SkippedShipment.label во внедренном решении не соответствует запрошенной отправке, SkippedShipment удаляется из решения.

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

ПРИМЕЧАНИЕ: Вызывающая сторона должна убедиться, что каждый Vehicle.label (соответственно, Shipment.label ) однозначно идентифицирует сущность транспортного средства (соответственно, груза), используемую в двух соответствующих запросах: в предыдущем запросе, который сформировал OptimizeToursResponse используемый во внедренном решении, и в текущем запросе, который включает внедренное решение. Описанных выше проверок на уникальность недостаточно для обеспечения выполнения этого требования.

bool

Учитывайте оценку трафика при вычислении полей ShipmentRoute Transition.travel_duration , Visit.start_time и vehicle_end_time ; при установке поля ShipmentRoute.has_traffic_infeasibilities и при вычислении поля OptimizeToursResponse.total_cost .

bool

Если это так, полилинии будут заполнены в ответ на запрос ShipmentRoute .

bool

Если значение истинно, полилинии и токены маршрута будут заполнены в ответе ShipmentRoute.transitions .

bool

Если этот параметр установлен, то запрос может иметь крайний срок (см. https://grpc.io/blog/deadlines ) до 60 минут. В противном случае максимальный срок составляет всего 30 минут. Обратите внимание, что длительные запросы сопряжены со значительно большим (но все еще небольшим) риском прерывания.

bool

Если это так, то расстояния в пути будут вычисляться с использованием геодезических расстояний вместо расстояний Google Maps, а время в пути будет вычисляться с использованием геодезических расстояний со скоростью, определяемой параметром geodesic_meters_per_second .

string

Метка, которая может использоваться для идентификации этого запроса, сообщается в объекте OptimizeToursResponse.request_label .

double

Если значение use_geodesic_distances равно true, это поле должно быть установлено и определять скорость, применяемую для расчета времени в пути. Его значение должно быть не менее 1,0 метра/секунду.

int32

Усекает количество возвращаемых ошибок валидации. Эти ошибки обычно добавляются к полезной нагрузке ошибки INVALID_ARGUMENT в качестве подробной информации об ошибке BadRequest ( https://cloud.google.com/apis/design/errors#error_details) , если только solving_mode=VALIDATE_ONLY: см. поле OptimizeToursResponse.validation_errors . По умолчанию это значение равно 100, а максимальное — 10 000.

ShipmentRoute

Маршруты рассчитаны для каждого транспортного средства; i-й маршрут соответствует i-му транспортному средству в модели.

string

Копия файла OptimizeToursRequest.label , если метка была указана в запросе.

SkippedShipment

Список всех пропущенных отправок.

OptimizeToursValidationError

Список всех ошибок валидации, которые нам удалось обнаружить независимо. См. пояснение к сообщению OptimizeToursValidationError в разделе "МНОЖЕСТВЕННЫЕ ОШИБКИ". Вместо ошибок здесь будут указаны предупреждения, если solving_mode имеет значение DEFAULT_SOLVE .

OptimizeToursRequest

В некоторых случаях мы изменяем входящий запрос перед его обработкой, например, добавляем затраты. Если solving_mode == TRANSFORM_AND_RETURN_REQUEST, измененный запрос возвращается здесь.

Экспериментальная функция: подробности см. на странице https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request .

Metrics

Показатели продолжительности, расстояния и использования данного решения.

AggregatedMetrics

Показатели агрегируются по маршрутам. Каждый показатель представляет собой сумму (или максимум для грузов) по всем полям ShipmentRoute.metrics с одинаковым именем.

int32

Количество пропущенных обязательных поставок.

int32

Количество использованных транспортных средств. Примечание: если маршрут транспортного средства пуст и Vehicle.used_if_route_is_empty имеет значение true, транспортное средство считается использованным.

Timestamp

Самое раннее время начала движения подержанного автомобиля, вычисленное как минимальное значение по всем подержанным автомобилям, заданное параметром ShipmentRoute.vehicle_start_time .

Timestamp

Самое позднее время окончания доставки подержанного автомобиля, вычисленное как максимальное значение по всем подержанным автомобилям из набора ShipmentRoute.vehicle_end_time .

map<string, double>

Стоимость решения, разбитая по полям запроса, связанным со стоимостью. Ключами являются пути прототипов относительно входного параметра OptimizeToursRequest, например, "model.shipments.pickups.cost", а значениями — общая стоимость, сгенерированная соответствующим полем стоимости, агрегированная по всему решению. Другими словами, costs["model.shipments.pickups.cost"] — это сумма всех затрат на погрузку и разгрузку по всему решению. Все затраты, определенные в модели, подробно указаны здесь, за исключением затрат, связанных с TransitionAttributes, которые по состоянию на январь 2022 года отображаются только в агрегированном виде.

double

Общая стоимость решения. Сумма всех значений на карте затрат.

string

Обязательно. Целевой проект или местоположение для совершения звонка.

Формат:

• projects/{project-id}
• projects/{project-id}/locations/{location-id}

Если местоположение не указано, регион будет выбран автоматически.

Uri

Обязательно. URI объекта Cloud Storage, содержащего OptimizeToursRequest .

Uri

Обязательно. URI объекта Cloud Storage, который будет содержать OptimizeToursResponse .

Uri

Необязательно. URI объекта Cloud Storage, содержащего OptimizeToursResponse , закодированный в формате JSON или textproto. Если объект закодирован в формате JSON, расширение имени объекта будет .json . Если объект закодирован в формате textproto, расширение имени объекта будет .txtpb .

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

int32

Ошибка валидации определяется парой ( code , display_name ), которая всегда присутствует.

Поля, следующие за этим разделом, содержат более подробную информацию об ошибке.

МНОЖЕСТВЕННЫЕ ОШИБКИ : При наличии нескольких ошибок процесс проверки пытается вывести несколько из них. Как и компилятор, это несовершенный процесс. Некоторые ошибки проверки могут быть «фатальными», то есть они останавливают весь процесс проверки. Это относится, в частности, к ошибкам display_name="UNSPECIFIED" . Некоторые ошибки могут привести к тому, что процесс проверки пропустит другие ошибки.

СТАБИЛЬНОСТЬ : code и display_name должны быть очень стабильными. Однако со временем могут появляться новые коды и отображаемые имена, что может привести к тому, что в результате некорректного запроса будет получена другая пара ( code , display_name ), поскольку новая ошибка скрыла старую. Например, см. раздел "МНОЖЕСТВЕННЫЕ ОШИБКИ".

string

Название ошибки, отображаемое на экране.

FieldReference

Контекст ошибки может включать 0, 1 (в большинстве случаев) или более полей. Например, ссылка на транспортное средство №4 и первую погрузку груза №2 может быть сделана следующим образом:

fields { name: "vehicles" index: 4}
fields { name: "shipments" index: 2 sub_field {name: "pickups" index: 0} }

Однако следует отметить, что количество fields не должно меняться для данного кода ошибки.

string

Human-readable string describing the error. There is a 1:1 mapping between code and error_message (when code != "UNSPECIFIED").

STABILITY : Not stable: the error message associated to a given code may change (hopefully to clarify it) over time. Please rely on the display_name and code instead.

string

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.

string

Name of the field, eg, "vehicles".

FieldReference

Recursively nested sub-field, if needed.

int32

Index of the field if repeated.

string

Key if the field is a map.

DataFormat

Required. The output data format.

GcsDestination

The Google Cloud Storage location to write the output to.

bool

Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes.

bool

Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes.

bool

Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes.

bool

Optional. Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the WALKING travel mode.

string

The user-defined display name of the shipment. It can be up to 63 characters long and may use UTF-8 characters.

VisitRequest

Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries.

VisitRequest

Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups.

map<string, Load >

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.

int32

The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the ShipmentModel 's vehicles list.

double

Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER:

• the same number of elements as costs_per_vehicle_indices . costs_per_vehicle[i] corresponds to vehicle costs_per_vehicle_indices[i] of the model.
• the same number of elements as there are vehicles in the model. The i-th element corresponds to vehicle #i of the model.

These costs must be in the same unit as penalty_cost and must not be negative. Leave this field empty, if there are no such costs.

int32

Indices of the vehicles to which costs_per_vehicle applies. If non-empty, it must have the same number of elements as costs_per_vehicle . A vehicle index may not be specified more than once. If a vehicle is excluded from costs_per_vehicle_indices , its cost is zero.

Duration

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 pickup_to_delivery_absolute_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
t + pickup_to_delivery_absolute_detour_limit

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.

Duration

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.

string

Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between shipment_types (see shipment_type_incompatibilities and shipment_type_requirements in ShipmentModel ).

Differs from visit_types which is specified for a single visit: All pickup/deliveries belonging to the same shipment share the same shipment_type .

string

Specifies a label for this shipment. This label is reported in the response in the shipment_label of the corresponding ShipmentRoute.Visit .

bool

If true, skip this shipment, but don't apply a penalty_cost .

Ignoring a shipment results in a validation error when there are any shipment_type_requirements in the model.

Ignoring a shipment that is performed in injected_first_solution_routes or injected_solution_constraint is permitted; the solver removes the related pickup/delivery visits from the performing route. precedence_rules that reference ignored shipments will also be ignored.

double

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.

double

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 pickup_to_delivery_relative_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
std::ceil(t * (1.0 + pickup_to_delivery_relative_detour_limit))

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.

int64

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.

LatLng

The geo-location where the vehicle arrives when performing this VisitRequest . If the shipment model has duration distance matrices, arrival_location must not be specified.

Waypoint

The waypoint where the vehicle arrives when performing this VisitRequest . If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

LatLng

The geo-location where the vehicle departs after completing this VisitRequest . Can be omitted if it is the same as arrival_location . If the shipment model has duration distance matrices, departure_location must not be specified.

Waypoint

The waypoint where the vehicle departs after completing this VisitRequest . Can be omitted if it is the same as arrival_waypoint . If the shipment model has duration distance matrices, departure_waypoint must not be specified.

string

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

TimeWindow

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 TimeWindow.start_time .

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, ie no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

Duration

Duration of the visit, ie time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows ).

double

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 Shipment.penalty_cost and must not be negative.

map<string, Load >

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment . The demands listed here are added to the demands listed in Shipment.load_demands .

string

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type ).

A type can only appear once.

string

Specifies a label for this VisitRequest . This label is reported in the response as visit_label in the corresponding ShipmentRoute.Visit .

bool

Specifies whether U-turns should be avoided in driving routes at this location. U-turn avoidance is best effort and complete avoidance is not guaranteed. This is an experimental feature and behavior is subject to change.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request for more details.

Shipment

Set of shipments which must be performed in the model.

Vehicle

Set of vehicles which can be used to perform visits.

Objective

The set of objectives for this model, that we will transform into costs. If not empty, the input model has to be costless. To obtain the modified request, please use solving_mode = TRANSFORM_AND_RETURN_REQUEST. Note that the request will not be solved in this case. See corresponding documentation.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request for more details.

Timestamp

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 global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (ie seconds: 0, nanos: 0) is used as default.

Timestamp

If unset, 00:00:00 UTC, January 1, 1971 (ie seconds: 31536000, nanos: 0) is used as default.

double

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 Shipment.penalty_cost .

DurationDistanceMatrix

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 use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Примеры использования:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.
• 1 pickup visit request at locB.

model {
  vehicles { start_tags: "locA"  end_tags: "locA" }
  shipments { pickups { tags: "locB" } }
  duration_distance_matrix_src_tags: "locA"
  duration_distance_matrix_src_tags: "locB"
  duration_distance_matrix_dst_tags: "locA"
  duration_distance_matrix_dst_tags: "locB"
  duration_distance_matrices {
    rows {  # from: locA
      durations { seconds: 0 }   meters: 0    # to: locA
      durations { seconds: 100 } meters: 1000 # to: locB
    }
    rows {  # from: locB
      durations { seconds: 102 } meters: 990 # to: locA
      durations { seconds: 0 }   meters: 0   # to: locB
    }
  }
}

• There are three locations: locA, locB and locC.
• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".
• 1 pickup visit request at locC.

model {
  vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" }
  vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" }
  vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" }
  shipments { pickups { tags: "locC" } }
  duration_distance_matrix_src_tags: "locA"
  duration_distance_matrix_src_tags: "locB"
  duration_distance_matrix_src_tags: "locC"
  duration_distance_matrix_dst_tags: "locB"
  duration_distance_matrix_dst_tags: "locC"
  duration_distance_matrices {
    vehicle_start_tag: "fast"
    rows {  # from: locA
      durations { seconds: 1000 } meters: 2000 # to: locB
      durations { seconds: 600 }  meters: 1000 # to: locC
    }
    rows {  # from: locB
      durations { seconds: 0 }   meters: 0    # to: locB
      durations { seconds: 700 } meters: 1200 # to: locC
    }
    rows {  # from: locC
      durations { seconds: 702 } meters: 1190 # to: locB
      durations { seconds: 0 }   meters: 0    # to: locC
    }
  }
  duration_distance_matrices {
    vehicle_start_tag: "slow"
    rows {  # from: locA
      durations { seconds: 1800 } meters: 2001 # to: locB
      durations { seconds: 900 }  meters: 1002 # to: locC
    }
    rows {  # from: locB
      durations { seconds: 0 }    meters: 0    # to: locB
      durations { seconds: 1000 } meters: 1202 # to: locC
    }
    rows {  # from: locC
      durations { seconds: 1001 } meters: 1195 # to: locB
      durations { seconds: 0 }    meters: 0    # to: locC
    }
  }
}

string

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags . A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle 's source, destination and matrix tags may be the same; similarly a VisitRequest 's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

string

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags . A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle 's source, destination and matrix tags may be the same; similarly a VisitRequest 's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

TransitionAttributes

Transition attributes added to the model.

ShipmentTypeIncompatibility

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility ).

ShipmentTypeRequirement

Sets of shipment_type requirements (see ShipmentTypeRequirement ).

PrecedenceRule

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.

int32

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.

Row

Specifies the rows of the duration and distance matrix. It must have as many elements as ShipmentModel.duration_distance_matrix_src_tags .

string

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 start_tags field must match the vehicle_start_tag of a matrix (and of that matrix only).

All matrices must have a different vehicle_start_tag .

Duration

Duration values for a given row. It must have as many elements as ShipmentModel.duration_distance_matrix_dst_tags .

double

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

Type

The type of the objective.

double

How much this objective should count relatively to the others. This can be any non-negative number, weights do not have to sum to 1. Weights default to 1.0.

bool

Indicates if the "first" event is a delivery.

bool

Indicates if the "second" event is a delivery.

Duration

The offset between the "first" and "second" event. It can be negative.

int32

Shipment index of the "first" event. This field must be specified.

int32

Shipment index of the "second" event. This field must be specified.

int32

Vehicle performing the route, identified by its index in the source ShipmentModel .

string

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label , if specified.

Timestamp

Time at which the vehicle starts its route.

Timestamp

Time at which the vehicle finishes its route.

Visit

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.

Transition

Ordered list of transitions for the route.

bool

When OptimizeToursRequest.consider_road_traffic , is set to true, this field indicates that inconsistencies in route timings are predicted using traffic-based travel duration estimates. There may be insufficient time to complete traffic-adjusted travel, delays, and breaks between visits, before the first visit, or after the last visit, while still satisfying the visit and vehicle time windows. For example,

  start_time(previous_visit) + duration(previous_visit) +
  travel_duration(previous_visit, next_visit) > start_time(next_visit)

Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel time travel_duration(previous_visit, next_visit) due to traffic. Also, a break may be forced to overlap with a visit due to an increase in travel time estimates and visit or break time window restrictions.

EncodedPolyline

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

Break

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

AggregatedMetrics

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits , depending on the context.

VehicleFullness

VehicleFullness field for computing how close the capped metrics are to their respective vehicle limits. Its fields are ratios between a capped metric field (eg AggregatedMetrics.travel_distance_meters ) and the related vehicle limit (eg Vehicle.route_distance_limit ).

Experimental: This field's behavior or existence may change in future.

map<string, double>

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.

double

Total cost of the route. The sum of all costs in the cost map.

Timestamp

Start time of a break.

Duration

Duration of a break.

string

String representing encoded points of the polyline.

Duration

Travel duration during this transition.

double

Distance traveled during the transition.

bool

When traffic is requested via OptimizeToursRequest.consider_road_traffic , and the traffic info couldn't be retrieved for a Transition , this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location).

Duration

Sum of the delay durations applied to this transition. If any, the delay starts exactly delay_duration seconds before the next event (visit or vehicle end). See TransitionAttributes.delay .

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 ShipmentRoute.breaks .

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.

Duration

Total duration of the transition, provided for convenience. It is equal to:

• next visit start_time (or vehicle_end_time if this is the last transition) - this transition's start_time ;
• if ShipmentRoute.has_traffic_infeasibilities is false, the following additionally holds: `total_duration = travel_duration + delay_duration
• break_duration + wait_duration`.

Timestamp

Start time of this transition.

EncodedPolyline

The encoded polyline representation of the route followed during the transition. This field is only populated if populate_transition_polylines is set to true.

string

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 populate_transition_polylines is set to true.

map<string, VehicleLoad >

Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits , or that have non-zero Shipment.load_demands on some shipment performed on this route.

The loads during the first transition are the starting loads of the vehicle route. Then, after each visit, the visit's load_demands are either added or subtracted to get the next transition's loads, depending on whether the visit was a pickup or a delivery.

int64

The amount of load on the vehicle, for the given type. The unit of load is usually indicated by the type. See Transition.vehicle_loads .

int32

Index of the shipments field in the source ShipmentModel .

bool

If true the visit corresponds to a pickup of a Shipment . Otherwise, it corresponds to a delivery.

int32

Index of VisitRequest in either the pickup or delivery field of the Shipment (see is_pickup ).

Timestamp

Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the ShipmentModel .

map<string, Load >

Total visit load demand as the sum of the shipment and the visit request load_demands . The values are negative if the visit is a delivery. Demands are reported for the same types as the Transition.loads (see this field).

Duration

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:

start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).

Otherwise, it is computed from the vehicle start_location and is equal to:

start_time - vehicle_start_time - travel duration from
the vehicle's `start_location` to the visit.

string

Copy of the corresponding Shipment.label , if specified in the Shipment .

string

Copy of the corresponding VisitRequest.label , if specified in the VisitRequest .

int32

An opaque token representing information about a visit location.

This field may be populated in the result routes' visits when VisitRequest.avoid_u_turns was set to true for this visit or if ShipmentModel.avoid_u_turns was set to true in the request OptimizeToursRequest .

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request for more details.

string

List of incompatible types. Two shipments having different shipment_types among those listed are "incompatible".

IncompatibilityMode

Mode applied to the incompatibility.

string

List of alternative shipment types required by the dependent_shipment_types .

string

All shipments with a type in the dependent_shipment_types field require at least one shipment of type required_shipment_type_alternatives to be visited on the same route.

NOTE: Chains of requirements such that a shipment_type depends on itself are not allowed.

RequirementMode

Mode applied to the requirement.

int32

The index corresponds to the index of the shipment in the source ShipmentModel .

string

Copy of the corresponding Shipment.label , if specified in the Shipment .

Reason

A list of reasons that explain why the shipment was skipped. See comment above Reason . If we are unable to understand why a shipment was skipped, reasons will not be set.

double

This is a copy of the Shipment.penalty_cost , included here to make it easier to see the severity of a skipped shipment.

Experimental: This field's behavior or existence may change in future.

double

Estimated ratio of vehicles that cannot perform this shipment for at least one of the reasons below. Note: this is only filled when reasons involve a vehicle.

Experimental: This field's behavior or existence may change in future.

Code

Refer to the comments of Code.

int32

Same as example_vehicle_index except that we provide the list of multiple identified vehicles. This list is not necessarily exhaustive. This is only filled if [fill_example_vehicle_indices_in_skipped_reasons][] is true.

Experimental: This field's behavior or existence may change in future.

string

If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY , documents one capacity type that is exceeded.

int32

If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

Timestamp

The hard time window start time. If unspecified it will be set to ShipmentModel.global_start_time .

Timestamp

The hard time window end time. If unspecified it will be set to ShipmentModel.global_end_time .

Timestamp

The soft start time of the time window.

Timestamp

The soft end time of the time window.

double

A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:

   max(0, soft_start_time - t.seconds)
                          * cost_per_hour_before_soft_start_time / 3600,
t being the time of the event.

This cost must be positive, and the field can only be set if soft_start_time has been set.

double

A cost per hour added to other costs in the model if the event occurs after soft_end_time , computed as:

   max(0, t.seconds - soft_end_time.seconds)
                    * cost_per_hour_after_soft_end_time / 3600,
t being the time of the event.

This cost must be positive, and the field can only be set if soft_end_time has been set.

string

Tags defining the set of (src->dst) transitions these attributes apply to.

A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains src_tag or does not contain excluded_src_tag (depending on which of these two fields is non-empty).

string

See src_tag . Exactly one of src_tag and excluded_src_tag must be non-empty.

string

A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains dst_tag or does not contain excluded_dst_tag (depending on which of these two fields is non-empty).

string

See dst_tag . Exactly one of dst_tag and excluded_dst_tag must be non-empty.

double

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.

double

Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any Vehicle.cost_per_kilometer specified on vehicles.

DistanceLimit

Specifies a limit on the distance traveled while performing this transition.

As of 2021/06, only soft limits are supported.

Duration

Specifies a delay incurred when performing this transition.

This delay always occurs after finishing the source visit and before starting the destination visit.

string

The URI of the resource. The resource may not yet exist.

The contents of the resource are encoded as either JSON or textproto. Only Google Cloud Storage resources are supported. If the resource is encoded as JSON, the resource name must be suffixed with .json . If the resource is encoded as textproto, the resource name must be suffixed with .txtpb . For example, a Google Cloud Storage URI to a JSON encoded file might look like: gs://bucket/path/input/object.json .

string

The user-defined display name of the vehicle. It can be up to 63 characters long and may use UTF-8 characters.

TravelMode

The travel mode which affects the roads usable by the vehicle and its speed. See also travel_duration_multiple .

RouteModifiers

A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.

LatLng

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_location must not be specified.

Waypoint

Waypoint representing a geographic location where the vehicle starts before picking up any shipments. If neither start_waypoint nor start_location is specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_waypoint must not be specified.

LatLng

Geographic location where the vehicle ends after it has completed its last VisitRequest . If not specified the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest . If the shipment model has duration and distance matrices, end_location must not be specified.

Waypoint

Waypoint representing a geographic location where the vehicle ends after it has completed its last VisitRequest . If neither end_waypoint nor end_location is specified, the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest . If the shipment model has duration and distance matrices, end_waypoint must not be specified.

string

Specifies tags attached to the start of the vehicle's route.

Empty or duplicate strings are not allowed.

string

Specifies tags attached to the end of the vehicle's route.

Empty or duplicate strings are not allowed.

TimeWindow

Time windows during which the vehicle may depart its start location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits.

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.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

TimeWindow

Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits.

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.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

UnloadingPolicy

Unloading policy enforced on the vehicle.

map<string, LoadLimit >

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 Shipment.load_demands field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.

double

Vehicle costs: all costs add up and must be in the same unit as Shipment.penalty_cost .

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_hour instead of just cost_per_traveled_hour may result in additional latency.

double

Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (ie, that reported in ShipmentRoute.transitions ), and excludes waiting time and visit time.

double

Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the ShipmentRoute.transitions and does not apply to any distance implicitly traveled from the arrival_location to the departure_location of a single VisitRequest .

double

Fixed cost applied if this vehicle is used to handle a shipment.

bool

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 break_rule or delay (from TransitionAttributes ) are scheduled for this vehicle. In this case, the vehicle's ShipmentRoute doesn't contain any information except for the vehicle index and label.

DurationLimit

Limit applied to the total duration of the vehicle's route. In a given OptimizeToursResponse , the route duration of a vehicle is the difference between its vehicle_end_time and vehicle_start_time .

DurationLimit

Limit applied to the travel duration of the vehicle's route. In a given OptimizeToursResponse , the route travel duration is the sum of all its transitions.travel_duration .

DistanceLimit

Limit applied to the total distance of the vehicle's route. In a given OptimizeToursResponse , the route distance is the sum of all its transitions.travel_distance_meters .

map<string, Duration >

Specifies a map from visit_types strings to durations. The duration is time in addition to VisitRequest.duration to be taken at visits with the specified visit_types . This extra visit duration adds cost if cost_per_hour is specified. Keys (ie visit_types ) cannot be empty strings.

If a visit request has multiple types, a duration will be added for each type in the map.

BreakRule

Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.

string

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute .

bool

If true, used_if_route_is_empty must be false, and this vehicle will remain unused.

If a shipment is performed by an ignored vehicle in injected_first_solution_routes , it is skipped in the first solution but is free to be performed in the response.

If a shipment is performed by an ignored vehicle in injected_solution_constraint and any related pickup/delivery is constrained to remain on the vehicle (ie, not relaxed to level RELAX_ALL_AFTER_THRESHOLD ), it is skipped in the response. If a shipment has a non-empty allowed_vehicle_indices field and all of the allowed vehicles are ignored, it is skipped in the response.

double

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 cost_per_hour or cost_per_traveled_hour are specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle is standard, and this multiple is considered 1.0.

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 extra_visit_duration_for_visit_type below.

Duration

A hard limit constraining the duration to be at most max_duration.

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, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

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 quadratic_soft_max_duration is set, the following conditions must be met:

• It must be non-negative.
• max_duration must be defined.
• quadratic_soft_max_duration must be less than max_duration .
• The difference must be no more than one day: max_duration - quadratic_soft_max_duration <= 86400 seconds

double

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

  cost_per_hour_after_soft_max * (duration - soft_max_duration)

The cost must be nonnegative.

double

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

  cost_per_square_hour_after_quadratic_soft_max *
  (duration - quadratic_soft_max_duration)^2

The cost must be nonnegative.

int64

A soft limit of the load. See cost_per_unit_above_soft_max .

double

If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load ) * cost_per_unit_above_soft_max . All costs add up and must be in the same unit as Shipment.penalty_cost . Soft limits may only be defined on types that apply to either pickups only or deliveries only throughout the model.

Interval

The acceptable load interval of the vehicle at the start of the route.

Interval

The acceptable load interval of the vehicle at the end of the route.

int64

The maximum acceptable amount of load.

LoadCost

Cost of moving one unit of load over one kilometer for this vehicle. This can be used as a proxy for fuel consumption: if the load is a weight (in Newtons), then load*kilometer has the dimension of an energy.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request for more details.

LoadCost

Cost of traveling with a unit of load during one hour for this vehicle.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request for more details.

int64

A minimum acceptable load. Must be ≥ 0. If they're both specified, min must be ≤ max .

int64

A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum load is unrestricted by this message. If they're both specified, min must be ≤ max .

int64

Amount of load above which the cost of moving a unit of load changes from cost_per_unit_below_threshold to cost_per_unit_above_threshold. Must be >= 0.

double

Cost of moving a unit of load, for each unit between 0 and threshold. Must be a finite value, and >= 0.

double

Cost of moving a unit of load, for each unit above threshold. In the special case threshold = 0, this is a fixed cost per unit. Must be a finite value, and >= 0.

double

Maximum of all other fields in this message.

double

The ratio between AggregatedMetrics.travel_distance_meters and Vehicle.route_distance_limit . If Vehicle.route_distance_limit is unset, this field will be unset.

double

The ratio between [AggregatedMetrics.travel_duration_seconds][] and Vehicle.travel_duration_limit . If Vehicle.travel_duration_limit is unset, this field will be unset.

double

The ratio between [AggregatedMetrics.total_duration_seconds][] and Vehicle.route_duration_limit . If Vehicle.route_duration_limit is unset, this field will be unset.

double

The maximum ratio among all types of [AggregatedMetrics.max_load][] and their respective Vehicle.load_limits . If all Vehicle.load_limits fields are unset, this field will be unset.

double

The ratio (vehicle_end_time - vehicle_start_time) / (latest_vehicle_end_time - earliest_vehicle_start_time) for a given vehicle. If the denominator is not present, it uses ( ShipmentModel.global_end_time - ShipmentModel.global_start_time ) instead.

bool

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

bool

Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pick up or drop off. This option works only for the 'DRIVING' travel mode, and when the 'location_type' is 'location'.

Experimental: This field's behavior or existence may change in future.

Location

A point specified using geographic coordinates, including an optional heading.

string

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.