ShipmentModel

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

  • стоимость маршрутизации транспортных средств (сумма затрат за общее время, стоимость за время в пути и фиксированная стоимость для всех транспортных средств).
  • штрафы за невыполненную отгрузку.
  • стоимость глобальной продолжительности поставок
JSON-представление
{
  "shipments": [
    {
      object (Shipment)
    }
  ],
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "globalStartTime": string,
  "globalEndTime": string,
  "globalDurationCostPerHour": number,
  "durationDistanceMatrices": [
    {
      object (DurationDistanceMatrix)
    }
  ],
  "durationDistanceMatrixSrcTags": [
    string
  ],
  "durationDistanceMatrixDstTags": [
    string
  ],
  "transitionAttributes": [
    {
      object (TransitionAttributes)
    }
  ],
  "shipmentTypeIncompatibilities": [
    {
      object (ShipmentTypeIncompatibility)
    }
  ],
  "shipmentTypeRequirements": [
    {
      object (ShipmentTypeRequirement)
    }
  ],
  "precedenceRules": [
    {
      object (PrecedenceRule)
    }
  ],
  "maxActiveVehicles": integer
}
Поля
shipments[]

object ( Shipment )

Набор перевозок, которые необходимо выполнить в модели.

vehicles[]

object ( Vehicle )

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

globalStartTime

string ( Timestamp format)

Глобальное время начала и окончания модели: никакое время вне этого диапазона не может считаться действительным.

Временной интервал модели должен быть меньше года, т. е. globalEndTime и globalStartTime должны отличаться друг от друга в пределах 31536000 секунд.

При использовании полей cost_per_*hour вы можете установить для этого окна меньший интервал, чтобы повысить производительность (например, если вы моделируете один день, вам следует установить глобальные ограничения по времени для этого дня). Если не установлено, по умолчанию используется 00:00:00 UTC, 1 января 1970 года (т. е. секунды: 0, нанос: 0).

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

globalEndTime

string ( Timestamp format)

Если значение не установлено, по умолчанию используется 00:00:00 UTC, 1 января 1971 года (т. е. секунды: 31536000, nanos: 0).

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

globalDurationCostPerHour

number

«Глобальная продолжительность» общего плана — это разница между самым ранним эффективным временем начала и самым поздним эффективным временем окончания для всех транспортных средств. Пользователи могут присвоить этому количеству стоимость часа, чтобы попытаться оптимизировать его, например, для скорейшего завершения задания. Эта стоимость должна быть в той же единице измерения, что и Shipment.penalty_cost .

durationDistanceMatrices[]

object ( DurationDistanceMatrix )

Задает матрицы длительности и расстояния, используемые в модели. Если это поле пусто, вместо него будут использоваться Карты Google или геодезические расстояния, в зависимости от значения поля useGeodesicDistances . Если он не пуст, useGeodesicDistances не может быть истинным, и ни durationDistanceMatrixSrcTags , ни durationDistanceMatrixDstTags не могут быть пустыми.

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

  • Есть два местоположения: locA и locB.
  • 1 транспортное средство начинает свой маршрут в locA и заканчивает его в locA.
  • 1 запрос на самовывоз в locB.
model {
  vehicles { startTags: "locA"  endTags: "locA" }
  shipments { pickups { tags: "locB" } }
  durationDistanceMatrixSrcTags: "locA"
  durationDistanceMatrixSrcTags: "locB"
  durationDistanceMatrixDstTags: "locA"
  durationDistanceMatrixDstTags: "locB"
  durationDistanceMatrices {
    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
    }
  }
}
  • Есть три местоположения: locA, locB и locC.
  • 1 транспортное средство начинает свой маршрут в locA и заканчивает его в locB, используя матрицу «быстро».
  • 1 транспортное средство начинает свой маршрут в locB и заканчивает его в locB, используя матрицу «медленно».
  • 1 транспортное средство начинает свой маршрут в locB и заканчивает его в locB, используя матрицу «быстро».
  • 1 запрос на самовывоз в locC.
model {
  vehicles { startTags: "locA" endTags: "locB" startTags: "fast" }
  vehicles { startTags: "locB" endTags: "locB" startTags: "slow" }
  vehicles { startTags: "locB" endTags: "locB" startTags: "fast" }
  shipments { pickups { tags: "locC" } }
  durationDistanceMatrixSrcTags: "locA"
  durationDistanceMatrixSrcTags: "locB"
  durationDistanceMatrixSrcTags: "locC"
  durationDistanceMatrixDstTags: "locB"
  durationDistanceMatrixDstTags: "locC"
  durationDistanceMatrices {
    vehicleStartTag: "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
    }
  }
  durationDistanceMatrices {
    vehicleStartTag: "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
    }
  }
}
durationDistanceMatrixSrcTags[]

string

Теги, определяющие источники матриц длительности и расстояния; durationDistanceMatrices(i).rows(j) определяет продолжительность и расстояние от посещений с тегом durationDistanceMatrixSrcTags(j) до других посещений в матрице i.

Теги соответствуют VisitRequest.tags или Vehicle.start_tags . Данный VisitRequest или Vehicle должен соответствовать ровно одному тегу в этом поле. Обратите внимание, что теги источника, назначения и матрицы Vehicle могут совпадать; аналогично теги источника и назначения VisitRequest могут совпадать. Все теги должны быть разными и не могут быть пустыми строками. Если это поле не пусто, то durationDistanceMatrices не должно быть пустым.

durationDistanceMatrixDstTags[]

string

Теги, определяющие назначения матриц длительности и расстояния; durationDistanceMatrices(i).rows(j).durations(k) (соответственно durationDistanceMatrices(i).rows(j).meters(k)) определяет продолжительность (соответственно расстояние) путешествия из посещений с тегом durationDistanceMatrixSrcTags(j) посещениям с тегом durationDistanceMatrixDstTags(k) в матрице i.

Теги соответствуют VisitRequest.tags или Vehicle.start_tags . Данный VisitRequest или Vehicle должен соответствовать ровно одному тегу в этом поле. Обратите внимание, что теги источника, назначения и матрицы Vehicle могут совпадать; аналогично теги источника и назначения VisitRequest могут совпадать. Все теги должны быть разными и не могут быть пустыми строками. Если это поле не пусто, то durationDistanceMatrices не должно быть пустым.

transitionAttributes[]

object ( TransitionAttributes )

В модель добавлены атрибуты перехода.

shipmentTypeIncompatibilities[]

object ( ShipmentTypeIncompatibility )

Наборы несовместимых типов_доставки (см. ShipmentTypeIncompatibility »).

shipmentTypeRequirements[]

object ( ShipmentTypeRequirement )

Наборы требований shipmentType (см. ShipmentTypeRequirement ).

precedenceRules[]

object ( PrecedenceRule )

Набор правил приоритета, которые должны соблюдаться в модели.

maxActiveVehicles

integer

Ограничивает максимальное количество активных транспортных средств. Транспортное средство считается активным, если по его маршруту совершается хотя бы одна перевозка. Это можно использовать для ограничения количества маршрутов в случае, когда водителей меньше, чем транспортных средств, и парк транспортных средств неоднороден. Затем оптимизация выберет лучший подмножество транспортных средств для использования. Должен быть строго положительным.

Отгрузка

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

JSON-представление
{
  "displayName": string,
  "pickups": [
    {
      object (VisitRequest)
    }
  ],
  "deliveries": [
    {
      object (VisitRequest)
    }
  ],
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "allowedVehicleIndices": [
    integer
  ],
  "costsPerVehicle": [
    number
  ],
  "costsPerVehicleIndices": [
    integer
  ],
  "pickupToDeliveryAbsoluteDetourLimit": string,
  "pickupToDeliveryTimeLimit": string,
  "shipmentType": string,
  "label": string,
  "ignore": boolean,
  "penaltyCost": number,
  "pickupToDeliveryRelativeDetourLimit": number
}
Поля
displayName

string

Определяемое пользователем отображаемое имя отправления. Он может иметь длину до 63 символов и может использовать символы UTF-8.

pickups[]

object ( VisitRequest )

Набор вариантов получения, связанных с отправкой. Если не указано иное, транспортному средству необходимо посетить только место, соответствующее доставке.

deliveries[]

object ( VisitRequest )

Набор альтернатив доставки, связанных с отправкой. Если не указано иное, транспортному средству необходимо посетить только место, соответствующее пикапу.

loadDemands

map (key: string, value: object ( Load ))

Требования к загрузке груза (например, вес, объем, количество поддонов и т. д.). Ключами в карте должны быть идентификаторы, описывающие тип соответствующей нагрузки, в идеале также включающие единицы измерения. Например: «вес_кг», «объем_галлонов», «поддон_количество» и т. д. Если данный ключ не отображается на карте, соответствующая нагрузка считается нулевой.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

allowedVehicleIndices[]

integer

Набор транспортных средств, которые могут выполнить данную перевозку. Если пусто, все транспортные средства могут это сделать. Транспортные средства задаются по их индексу в списке vehicles ShipmentModel .

costsPerVehicle[]

number

Указывает затраты, возникающие при доставке груза каждым транспортным средством. Если указано, оно должно иметь ЛИБО:

  • то же количество элементов, что и costsPerVehicleIndices . costsPerVehicle[i] соответствует стоимости транспортного средства costsPerVehicleIndices[i] модели.
  • столько же элементов, сколько транспортных средств в модели. i-й элемент соответствует автомобилю №i модели.

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

costsPerVehicleIndices[]

integer

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

pickupToDeliveryAbsoluteDetourLimit

string ( Duration format)

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

Например, пусть t будет кратчайшим временем, необходимым для перехода от выбранного варианта самовывоза непосредственно к выбранному варианту доставки. Затем установка pickupToDeliveryAbsoluteDetourLimit приводит к следующему:

startTime(delivery) - startTime(pickup) <=
t + pickupToDeliveryAbsoluteDetourLimit

Если для одной и той же отправки указаны как относительные, так и абсолютные ограничения, для каждой возможной пары «вывоз/доставка» используется более строгий предел. С 2017/10 года объезды поддерживаются только в том случае, если продолжительность поездки не зависит от транспортных средств.

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

pickupToDeliveryTimeLimit

string ( Duration format)

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

shipmentType

string

Непустая строка, определяющая «тип» этой отправки. Эту функцию можно использовать для определения несовместимостей или требований между shipment_types (см. shipmentTypeIncompatibilities и shipmentTypeRequirements в ShipmentModel ).

Отличается от visitTypes , который указан для одного посещения: все вывозы/доставки, принадлежащие к одной и той же отправке, имеют один и тот же shipmentType .

label

string

Указывает этикетку для этой отправки. Эта метка указывается в ответе в shipmentLabel соответствующего ShipmentRoute.Visit .

ignore

boolean

Если это правда, пропустите эту отправку, но не применяйте penaltyCost .

Игнорирование отгрузки приводит к ошибке проверки, если в модели есть какие-либо shipmentTypeRequirements .

Игнорирование отправки, выполняемой в injectedFirstSolutionRoutes или injectedSolutionConstraint , разрешено; решатель удаляет связанные посещения получения/доставки из маршрута выполнения. precedenceRules , которые ссылаются на игнорируемые поставки, также будут игнорироваться.

penaltyCost

number

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

ВАЖНО : Если этот штраф не указан, он считается бесконечным, т.е. отгрузка должна быть завершена.

pickupToDeliveryRelativeDetourLimit

number

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

Например, пусть t будет кратчайшим временем, затраченным на переход от выбранного варианта самовывоза непосредственно к выбранному варианту доставки. Затем установка pickupToDeliveryRelativeDetourLimit приводит к следующему:

startTime(delivery) - startTime(pickup) <=
std::ceil(t * (1.0 + pickupToDeliveryRelativeDetourLimit))

Если для одной и той же отправки указаны как относительные, так и абсолютные ограничения, для каждой возможной пары «вывоз/доставка» используется более строгий предел. С 2017/10 года объезды поддерживаются только в том случае, если продолжительность поездки не зависит от транспортных средств.

ПосетитеЗапрос

Запрос на посещение, которое может быть совершено на транспортном средстве: у него есть географическое местоположение (или два, см. ниже), время открытия и закрытия, представленное временными окнами, и время продолжительности обслуживания (время, проведенное транспортным средством после прибытия забрать или сдать товар).

JSON-представление
{
  "arrivalLocation": {
    object (LatLng)
  },
  "arrivalWaypoint": {
    object (Waypoint)
  },
  "departureLocation": {
    object (LatLng)
  },
  "departureWaypoint": {
    object (Waypoint)
  },
  "tags": [
    string
  ],
  "timeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "duration": string,
  "cost": number,
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "visitTypes": [
    string
  ],
  "label": string
}
Поля
arrivalLocation

object ( LatLng )

Географическое местоположение, куда прибывает транспортное средство при выполнении этого VisitRequest . Если в модели отгрузки есть матрицы расстояний продолжительности, arrivalLocation указывать не следует.

arrivalWaypoint

object ( Waypoint )

Маршрутная точка, куда прибывает транспортное средство при выполнении этого VisitRequest . Если в модели доставки есть матрицы длительности и расстояния, arrivalWaypoint указывать не следует.

departureLocation

object ( LatLng )

Географическое местоположение, из которого отправляется транспортное средство после выполнения этого VisitRequest . Может быть опущено, если оно совпадает с arrivalLocation . Если в модели отгрузки есть матрицы расстояний продолжительности, departureLocation указывать не следует.

departureWaypoint

object ( Waypoint )

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

tags[]

string

Указывает теги, прикрепленные к запросу на посещение. Пустые или повторяющиеся строки не допускаются.

timeWindows[]

object ( TimeWindow )

Временные окна, ограничивающие время прибытия на визит. Обратите внимание, что транспортное средство может выехать за пределы временного окна прибытия, т. е. время прибытия + продолжительность не обязательно должны находиться внутри временного окна. Это может привести к увеличению времени ожидания, если транспортное средство прибудет раньше TimeWindow.start_time .

Отсутствие TimeWindow означает, что транспортное средство может совершить этот визит в любое время.

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

costPerHourAfterSoftEndTime и softEndTime можно установить только при наличии одного временного окна.

duration

string ( Duration format)

Продолжительность посещения, т.е. время, проведенное транспортным средством между прибытием и отъездом (должно быть добавлено к возможному времени ожидания; см. timeWindows ).

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

cost

number

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

loadDemands

map (key: string, value: object ( Load ))

Загрузить требования этого запроса на посещение. Это похоже на поле Shipment.load_demands , за исключением того, что оно применяется только к этому VisitRequest , а не ко всему Shipment . Перечисленные здесь требования добавляются к требованиям, перечисленным в Shipment.load_demands .

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

visitTypes[]

string

Указывает виды посещения. Это можно использовать для выделения дополнительного времени, необходимого транспортному средству для завершения этого визита (см. Vehicle.extra_visit_duration_for_visit_type ).

Тип может появиться только один раз.

label

string

Указывает метку для этого VisitRequest . Эта метка указывается в ответе как visitLabel в соответствующем ShipmentRoute.Visit .

ШиротаДлительность

Объект, представляющий пару широты и долготы. Это выражается в виде пары двойных чисел, обозначающих градусы широты и градусы долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны находиться в пределах нормализованных диапазонов.

JSON-представление
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

Широта в градусах. Оно должно находиться в диапазоне [-90,0, +90,0].

longitude

number

Долгота в градусах. Оно должно находиться в диапазоне [-180,0, +180,0].

Путевая точка

Инкапсулирует путевую точку. Путевые точки отмечают места прибытия и отправления VisitRequests, а также начальные и конечные местоположения транспортных средств.

JSON-представление
{
  "sideOfRoad": boolean,

  // Union field location_type can be only one of the following:
  "location": {
    object (Location)
  },
  "placeId": string
  // End of list of possible types for union field location_type.
}
Поля
sideOfRoad

boolean

Необязательный. Указывает, что местоположение этой путевой точки предназначено для того, чтобы транспортное средство остановилось на определенной стороне дороги. Если вы установите это значение, маршрут будет проходить через местоположение, так что транспортное средство сможет остановиться на той стороне дороги, к которой местоположение смещено от центра дороги. Эта опция не работает для режима передвижения «ХОДЬБА».

Поле объединения location_type . Различные способы представления местоположения. location_type может быть только одним из следующих:
location

object ( Location )

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

placeId

string

Идентификатор места POI, связанный с путевой точкой.

Расположение

Инкапсулирует местоположение (географическую точку и необязательный заголовок).

JSON-представление
{
  "latLng": {
    object (LatLng)
  },
  "heading": integer
}
Поля
latLng

object ( LatLng )

Географические координаты путевой точки.

heading

integer

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

ВремяОкно

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

Жесткие границы временного окна, startTime и endTime , определяют самое раннее и самое позднее время события, например startTime <= event_time <= endTime . Нижняя граница окна мягкого времени, softStartTime , выражает предпочтение тому, чтобы событие произошло в softStartTime или после него, за счет затрат, пропорциональных тому, как долго до softStartTime произойдет событие. Верхняя граница окна мягкого времени, softEndTime , выражает предпочтение тому, чтобы событие произошло в softEndTime или раньше, за счет затрат, пропорциональных тому, как долго после softEndTime происходит событие. startTime , endTime , softStartTime и softEndTime должны находиться в пределах глобальных ограничений по времени (см. ShipmentModel.global_start_time и ShipmentModel.global_end_time ) и должны учитывать:

  0 <= `startTime` <= `endTime` and
  0 <= `startTime` <= `softStartTime` and
  0 <= `softEndTime` <= `endTime`.
JSON-представление
{
  "startTime": string,
  "endTime": string,
  "softStartTime": string,
  "softEndTime": string,
  "costPerHourBeforeSoftStartTime": number,
  "costPerHourAfterSoftEndTime": number
}
Поля
startTime

string ( Timestamp format)

Время начала трудного временного окна. Если не указано, будет установлено значение ShipmentModel.global_start_time .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

Время окончания трудного временного окна. Если не указано, будет установлено значение ShipmentModel.global_end_time .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

softStartTime

string ( Timestamp format)

Время плавного запуска временного окна.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

softEndTime

string ( Timestamp format)

Время мягкого окончания временного окна.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

costPerHourBeforeSoftStartTime

number

Стоимость часа, добавленная к другим затратам в модели, если событие происходит до softStartTime, рассчитывается как:

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

Эта стоимость должна быть положительной, и это поле можно установить только в том случае, если установлено softStartTime.

costPerHourAfterSoftEndTime

number

Стоимость часа, добавленная к другим затратам в модели, если событие происходит после softEndTime , вычисляется как:

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

Эта стоимость должна быть положительной, и это поле можно установить только в том случае, если установлено softEndTime .

Транспортное средство

Моделирует автомобиль в задаче по доставке. Решение проблемы с отправкой позволит построить маршрут, начинающийся с startLocation и заканчивающийся endLocation для этого транспортного средства. Маршрут — это последовательность посещений (см. ShipmentRoute ).

JSON-представление
{
  "displayName": string,
  "travelMode": enum (TravelMode),
  "routeModifiers": {
    object (RouteModifiers)
  },
  "startLocation": {
    object (LatLng)
  },
  "startWaypoint": {
    object (Waypoint)
  },
  "endLocation": {
    object (LatLng)
  },
  "endWaypoint": {
    object (Waypoint)
  },
  "startTags": [
    string
  ],
  "endTags": [
    string
  ],
  "startTimeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "endTimeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "unloadingPolicy": enum (UnloadingPolicy),
  "loadLimits": {
    string: {
      object (LoadLimit)
    },
    ...
  },
  "costPerHour": number,
  "costPerTraveledHour": number,
  "costPerKilometer": number,
  "fixedCost": number,
  "usedIfRouteIsEmpty": boolean,
  "routeDurationLimit": {
    object (DurationLimit)
  },
  "travelDurationLimit": {
    object (DurationLimit)
  },
  "routeDistanceLimit": {
    object (DistanceLimit)
  },
  "extraVisitDurationForVisitType": {
    string: string,
    ...
  },
  "breakRule": {
    object (BreakRule)
  },
  "label": string,
  "ignore": boolean,
  "travelDurationMultiple": number
}
Поля
displayName

string

Определяемое пользователем отображаемое имя транспортного средства. Он может иметь длину до 63 символов и может использовать символы UTF-8.

travelMode

enum ( TravelMode )

Режим движения, влияющий на дороги, по которым движется транспортное средство, и его скорость. См. также travelDurationMultiple .

routeModifiers

object ( RouteModifiers )

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

startLocation

object ( LatLng )

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

startWaypoint

object ( Waypoint )

Путевая точка, представляющая географическое место, где транспортное средство начинает движение перед получением груза. Если не указаны ни startWaypoint , ни startLocation , транспортное средство трогается с места при первом получении. Если модель доставки имеет матрицы длительности и расстояния, startWaypoint указывать нельзя.

endLocation

object ( LatLng )

Географическое местоположение, в котором заканчивается транспортное средство после завершения последнего VisitRequest . Если не указано иное, ShipmentRoute транспортного средства завершается сразу после завершения последнего VisitRequest . Если модель доставки имеет матрицы длительности и расстояния, endLocation указывать не следует.

endWaypoint

object ( Waypoint )

Путевая точка, представляющая географическое местоположение, в котором заканчивается транспортное средство после завершения последнего VisitRequest . Если не указаны ни endWaypoint , ни endLocation , ShipmentRoute транспортного средства завершается сразу после завершения последнего VisitRequest . Если модель доставки имеет матрицы длительности и расстояния, endWaypoint указывать нельзя.

startTags[]

string

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

Пустые или повторяющиеся строки не допускаются.

endTags[]

string

Указывает теги, прикрепленные к концу маршрута транспортного средства.

Пустые или повторяющиеся строки не допускаются.

startTimeWindows[]

object ( TimeWindow )

Временные окна, в течение которых транспортное средство может покинуть исходное место. Они должны находиться в пределах глобальных ограничений по времени (см. поля ShipmentModel.global_* ). Если не указано, то нет никаких ограничений, кроме этих глобальных ограничений по времени.

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

costPerHourAfterSoftEndTime и softEndTime можно установить только при наличии одного временного окна.

endTimeWindows[]

object ( TimeWindow )

Временные окна, в течение которых транспортное средство может прибыть в конечное место. Они должны находиться в пределах глобальных ограничений по времени (см. поля ShipmentModel.global_* ). Если не указано, то нет никаких ограничений, кроме этих глобальных ограничений по времени.

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

costPerHourAfterSoftEndTime и softEndTime можно установить только при наличии одного временного окна.

unloadingPolicy

enum ( UnloadingPolicy )

Политика разгрузки применяется к транспортному средству.

loadLimits

map (key: string, value: object ( LoadLimit ))

Вместимость транспортного средства (например, вес, объем, количество поддонов). Ключами в карте являются идентификаторы типа груза, соответствующие ключам поля Shipment.load_demands . Если данный ключ отсутствует на этой карте, соответствующая емкость считается безграничной.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

costPerHour

number

Стоимость транспортного средства: все затраты суммируются и должны быть в той же единице измерения, что и Shipment.penalty_cost .

Стоимость часа проезда автомобиля. Эта стоимость применяется к общему времени, затраченному на маршрут, и включает время в пути, время ожидания и время посещения. Использование costPerHour вместо просто costPerTraveledHour может привести к дополнительной задержке.

costPerTraveledHour

number

Стоимость за час проезда транспортного средства по маршруту. Эта стоимость применяется только ко времени в пути, затраченному на маршрут (т. е. указанному в ShipmentRoute.transitions ), и не включает время ожидания и время посещения.

costPerKilometer

number

Стоимость за километр пути автомобиля. Эта стоимость применяется к расстоянию, указанному в ShipmentRoute.transitions , и не применяется к любому расстоянию, неявно пройденному от arrivalLocation до departureLocation одного VisitRequest .

fixedCost

number

Фиксированная стоимость применяется, если это транспортное средство используется для обработки груза.

usedIfRouteIsEmpty

boolean

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

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

В противном случае он не перемещается от своего начального к конечному местоположению, и для этого транспортного средства не запланировано никаких breakRule или задержки (из TransitionAttributes ). В этом случае ShipmentRoute транспортного средства не содержит никакой информации, кроме индекса и метки транспортного средства.

routeDurationLimit

object ( DurationLimit )

Ограничение применяется к общей продолжительности маршрута транспортного средства. В данном OptimizeToursResponse продолжительность маршрута транспортного средства — это разница между его vehicleEndTime и vehicleStartTime .

travelDurationLimit

object ( DurationLimit )

Ограничение применяется к продолжительности проезда по маршруту транспортного средства. В данном OptimizeToursResponse продолжительность путешествия по маршруту представляет собой сумму всех его transitions.travel_duration .

routeDistanceLimit

object ( DistanceLimit )

Ограничение применяется к общему расстоянию маршрута транспортного средства. В данном OptimizeToursResponse расстояние маршрута представляет собой сумму всех его transitions.travel_distance_meters .

extraVisitDurationForVisitType

map (key: string, value: string ( Duration format))

Определяет сопоставление строк visitTypes с длительностью. Продолжительность — это время в дополнение к VisitRequest.duration , которое должно учитываться при посещениях с указанными visitTypes . Эта дополнительная продолжительность посещения увеличивает стоимость, если указан costPerHour . Ключи (т.е. visitTypes ) не могут быть пустыми строками.

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

breakRule

object ( BreakRule )

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

label

string

Указывает метку для этого автомобиля. Эта метка указывается в ответе как vehicleLabel соответствующего ShipmentRoute .

ignore

boolean

Если значение true, usedIfRouteIsEmpty должно быть ложным, и это транспортное средство останется неиспользованным.

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

Если отгрузка выполняется игнорируемым транспортным средством в injectedSolutionConstraint и любая связанная с ним погрузка/доставка ограничена тем, что остается на транспортном средстве (т. е. не ослаблена до уровня RELAX_ALL_AFTER_THRESHOLD ), она пропускается в ответе. Если в отправлении имеется непустое поле allowedVehicleIndices и все разрешенные транспортные средства игнорируются, оно пропускается в ответе.

travelDurationMultiple

number

Указывает мультипликативный коэффициент, который можно использовать для увеличения или уменьшения времени в пути этого транспортного средства. Например, установка значения 2.0 означает, что этот автомобиль медленнее и его время в пути вдвое больше, чем у стандартных транспортных средств. Этот коэффициент не влияет на продолжительность посещения. Это влияет на стоимость, если указаны costPerHour или costPerTraveledHour . Оно должно находиться в диапазоне [0,001, 1000,0]. Если не установлено, транспортное средство является стандартным, и это кратное считается 1,0.

ВНИМАНИЕ: Время в пути будет округлено до ближайшей секунды после применения этого коэффициента, но до выполнения каких-либо числовых операций, поэтому небольшое значение кратного может привести к потере точности.

См. также extraVisitDurationForVisitType ниже.

Режим путешествия

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

Это должно быть подмножеством режимов передвижения API-интерфейса «Предпочитаемые маршруты маршрутов платформы Google Карт», см. https://developers.google.com/maps/documentation/routes_preferred/reference/rest/Shared.Types/RouteTravelMode .

Перечисления
TRAVEL_MODE_UNSPECIFIED Неопределенный режим движения, эквивалентный DRIVING .
DRIVING Режим движения, соответствующий направлениям движения (автомобиль, ...).
WALKING Режим движения, соответствующий пешеходным направлениям.

Модификаторы маршрута

Инкапсулирует набор дополнительных условий, которые необходимо выполнить при расчете маршрутов транспортных средств. Это похоже на RouteModifiers в предпочтительном API маршрутов платформы Google Maps; см.: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers .

JSON-представление
{
  "avoidTolls": boolean,
  "avoidHighways": boolean,
  "avoidFerries": boolean,
  "avoidIndoor": boolean
}
Поля
avoidTolls

boolean

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

avoidHighways

boolean

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

avoidFerries

boolean

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

avoidIndoor

boolean

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

Политика разгрузки

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

Другие перевозки могут осуществляться в любом месте маршрута независимо от unloadingPolicy .

Перечисления
UNLOADING_POLICY_UNSPECIFIED Неопределенная политика разгрузки; поставки должны происходить сразу после их соответствующего получения.
LAST_IN_FIRST_OUT Доставка должна осуществляться в порядке, обратном получению.
FIRST_IN_FIRST_OUT Доставка должна осуществляться в том же порядке, что и самовывоз.

Ограничение нагрузки

Определяет предельную нагрузку, применимую к транспортному средству, например: «Этот грузовик может перевозить не более 3500 кг». См. loadLimits .

JSON-представление
{
  "softMaxLoad": string,
  "costPerUnitAboveSoftMax": number,
  "startLoadInterval": {
    object (Interval)
  },
  "endLoadInterval": {
    object (Interval)
  },
  "maxLoad": string
}
Поля
softMaxLoad

string ( int64 format)

Мягкое ограничение нагрузки. См. costPerUnitAboveSoftMax .

costPerUnitAboveSoftMax

number

Если нагрузка когда-либо превышает softMaxLoad на маршруте этого транспортного средства, применяется следующий штраф (только один раз для каждого транспортного средства): (load - softMaxLoad ) * costPerUnitAboveSoftMax . Все затраты суммируются и должны быть в той же единице измерения, что и Shipment.penalty_cost .

startLoadInterval

object ( Interval )

Допустимый интервал загрузки автомобиля в начале маршрута.

endLoadInterval

object ( Interval )

Допустимый интервал загрузки автомобиля в конце маршрута.

maxLoad

string ( int64 format)

Максимально допустимый объем нагрузки.

Интервал

Интервал допустимых объемов нагрузки.

JSON-представление
{
  "min": string,
  "max": string
}
Поля
min

string ( int64 format)

Минимально допустимая нагрузка. Должно быть ≥ 0. Если указаны оба значения, min должно быть ≤ max .

max

string ( int64 format)

Максимально допустимая нагрузка. Должно быть ≥ 0. Если не указано, максимальная нагрузка не ограничивается этим сообщением. Если они оба указаны, min должно быть ≤ max .

Ограничение продолжительности

Лимит, определяющий максимальную продолжительность маршрута транспортного средства. Он может быть как твердым, так и мягким.

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

JSON-представление
{
  "maxDuration": string,
  "softMaxDuration": string,
  "quadraticSoftMaxDuration": string,
  "costPerHourAfterSoftMax": number,
  "costPerSquareHourAfterQuadraticSoftMax": number
}
Поля
maxDuration

string ( Duration format)

Жесткий предел, ограничивающий длительность не более maxDuration.

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

softMaxDuration

string ( Duration format)

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

Если определено, softMaxDuration не должно быть отрицательным. Если также определен maxDuration, softMaxDuration должен быть меньше maxDuration.

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

quadraticSoftMaxDuration

string ( Duration format)

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

Если определено, quadraticSoftMaxDuration должно быть неотрицательным. Если также определен maxDuration , quadraticSoftMaxDuration должен быть меньше maxDuration , а разница не должна превышать одного дня:

maxDuration - quadraticSoftMaxDuration <= 86400 seconds

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

costPerHourAfterSoftMax

number

Стоимость часа, понесенная в случае нарушения порога softMaxDuration . Дополнительная стоимость равна 0, если продолжительность ниже порогового значения, в противном случае стоимость зависит от продолжительности следующим образом:

  costPerHourAfterSoftMax * (duration - softMaxDuration)

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

costPerSquareHourAfterQuadraticSoftMax

number

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

Дополнительная стоимость равна 0, если продолжительность ниже порогового значения, в противном случае стоимость зависит от продолжительности следующим образом:

  costPerSquareHourAfterQuadraticSoftMax *
  (duration - quadraticSoftMaxDuration)^2

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

Предел расстояния

Предел, определяющий максимальное расстояние, которое можно преодолеть. Он может быть как твердым, так и мягким.

Если определен мягкий предел, как softMaxMeters , так и costPerKilometerAboveSoftMax должны быть определены и быть неотрицательными.

JSON-представление
{
  "maxMeters": string,
  "softMaxMeters": string,
  "costPerKilometerBelowSoftMax": number,
  "costPerKilometerAboveSoftMax": number
}
Поля
maxMeters

string ( int64 format)

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

softMaxMeters

string ( int64 format)

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

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

costPerKilometerBelowSoftMax

number

Стоимость понесенного километража увеличивается до softMaxMeters по формуле:

  min(distanceMeters, softMaxMeters) / 1000.0 *
  costPerKilometerBelowSoftMax.

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

costPerKilometerAboveSoftMax

number

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

  (distanceMeters - softMaxMeters) / 1000.0 *
  costPerKilometerAboveSoftMax.

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

BreakRule

Правила создания временных перерывов для транспортного средства (например, перерывы на обед). Перерыв — это непрерывный период времени, в течение которого транспортное средство простаивает на своем текущем месте и не может совершить ни одного визита. Обрыв может произойти:

  • во время путешествия между двумя посещениями (включая время непосредственно перед или сразу после посещения, но не в середине посещения), и в этом случае продлевается соответствующее транзитное время между посещениями,
  • или перед запуском автомобиля (автомобиль может не завестись в середине перерыва), в этом случае это не влияет на время запуска автомобиля.
  • или после окончания транспортного средства (то же самое, со временем окончания транспортного средства).
JSON-представление
{
  "breakRequests": [
    {
      object (BreakRequest)
    }
  ],
  "frequencyConstraints": [
    {
      object (FrequencyConstraint)
    }
  ]
}
Поля
breakRequests[]

object ( BreakRequest )

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

frequencyConstraints[]

object ( FrequencyConstraint )

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

Запрос на перерыв

Последовательность перерывов (т.е. их количество и порядок), применимых к каждому транспортному средству, должна быть известна заранее. Повторяющиеся BreakRequest определяют эту последовательность в том порядке, в котором они должны происходить. Их временные окна ( earliestStartTime / latestStartTime ) могут перекрываться, но они должны быть совместимы с порядком (это отмечено).

JSON-представление
{
  "earliestStartTime": string,
  "latestStartTime": string,
  "minDuration": string
}
Поля
earliestStartTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

latestStartTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

minDuration

string ( Duration format)

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

Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Частотное ограничение

Можно дополнительно ограничить частоту и продолжительность перерывов, указанных выше, установив минимальную частоту перерывов, например: «Перерыв должен быть не менее 1 часа каждые 12 часов». Если предположить, что это можно интерпретировать как «В пределах любого скользящего временного окна продолжительностью 12 часов должен быть хотя бы один перерыв продолжительностью не менее одного часа», этот пример будет преобразован в следующее FrequencyConstraint :

{
   minBreakDuration { seconds: 3600 }         # 1 hour.
   maxInterBreakDuration { 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
JSON-представление
{
  "minBreakDuration": string,
  "maxInterBreakDuration": string
}
Поля
minBreakDuration

string ( Duration format)

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

maxInterBreakDuration

string ( Duration format)

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

DurationDistanceMatrix

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

JSON-представление
{
  "rows": [
    {
      object (Row)
    }
  ],
  "vehicleStartTag": string
}
Поля
rows[]

object ( Row )

Указывает ряды матрицы продолжительности и расстояния. У него должно быть столько элементов, сколько и ShipmentModel.duration_distance_matrix_src_tags .

vehicleStartTag

string

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

Каждый старт автомобиля должен соответствовать ровской матрице, то есть, то есть одно из их поля startTags , должно соответствовать vehicleStartTag матрицы (и только этой матрицы).

Все матрицы должны иметь другой vehicleStartTag .

Ряд

Указывает ряд матрицы продолжительности и расстояния.

JSON-представление
{
  "durations": [
    string
  ],
  "meters": [
    number
  ]
}
Поля
durations[]

string ( Duration format)

Значения продолжительности для данной строки. У него должно быть столько элементов, сколько и ShipmentModel.duration_distance_matrix_dst_tags .

Продолжительность за секунды с девятью дробными цифрами, заканчивая « s ». Пример: "3.5s" .

meters[]

number

Значения расстояния для данной строки. Если никакие затраты или ограничения относятся к расстояниям в модели, это можно оставить пустым; В противном случае он должен иметь столько элементов, сколько и durations .

Transitionattributes

Определяет атрибуты переходов между двумя последовательными посещениями по маршруту. Несколько TransitionAttributes могут применяться к одному и тому же переходу: в этом случае все дополнительные затраты увеличиваются, и применяется строгое ограничение или ограничение (после естественной »и« семантики).

JSON-представление
{
  "srcTag": string,
  "excludedSrcTag": string,
  "dstTag": string,
  "excludedDstTag": string,
  "cost": number,
  "costPerKilometer": number,
  "distanceLimit": {
    object (DistanceLimit)
  },
  "delay": string
}
Поля
srcTag

string

Теги, определяющие набор (SRC-> DST) переходов, к этим атрибутам применяется.

Посещение источника или начало транспортного средства совпадает с тем, что его VisitRequest.tags или Vehicle.start_tags либо содержит srcTag , либо не содержит excludedSrcTag (в зависимости от того, какое из этих двух полей не является пустым).

excludedSrcTag

string

Смотрите srcTag . Точно один из srcTag и excludedSrcTag должны быть непустыми.

dstTag

string

Посещение пункта назначения или конец транспортного средства совпадает с тем, что его VisitRequest.tags или Vehicle.end_tags либо содержит dstTag , либо не содержит excludedDstTag (в зависимости от того, какое из этих двух полей не является пустым).

excludedDstTag

string

Смотрите dstTag . Точно один из dstTag и excludedDstTag должен быть непустым.

cost

number

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

costPerKilometer

number

Определяет стоимость за километр, применяемый на расстояние, пройденное при выполнении этого перехода. Это добавляется к любому Vehicle.cost_per_kilometer . Cost_per_kilometer, указанный на транспортных средствах.

distanceLimit

object ( DistanceLimit )

Определяет ограничение на расстояние, пройденное во время выполнения этого перехода.

По состоянию на 2021/06 поддерживаются только мягкие пределы.

delay

string ( Duration format)

Указывает задержку, понесенную при выполнении этого перехода.

Эта задержка всегда происходит после завершения посещения источника и перед началом посещения пункта назначения.

Продолжительность за секунды с девятью дробными цифрами, заканчивая « s ». Пример: "3.5s" .

Отгрузка

Указывает несовместимости между поставками в зависимости от их отгрузки. Появление несовместимых поставки на том же маршруте ограничено на основе режима несовместимости.

JSON-представление
{
  "types": [
    string
  ],
  "incompatibilityMode": enum (IncompatibilityMode)
}
Поля
types[]

string

Список несовместимых типов. Две отправки, имеющие разные shipment_types среди перечисленных, «несовместимы».

incompatibilityMode

enum ( IncompatibilityMode )

Режим применяется к несовместимости.

Несовместимость

Режимы, определяющие, как появление несовместимых поставки ограничено на одном и том же маршруте.

Перечисления
INCOMPATIBILITY_MODE_UNSPECIFIED Неуказанный режим несовместимости. Это значение никогда не должно использоваться.
NOT_PERFORMED_BY_SAME_VEHICLE В этом режиме две поставки с несовместимыми типами никогда не могут разделить один и тот же автомобиль.
NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY

Для двух поставок с несовместимыми типами с помощью режима несовместимости NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY несовместимость:

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

Отгрузка

Указывает требования между поставками на основе их отгрузки. Специфика требования определяется режимом требований.

JSON-представление
{
  "requiredShipmentTypeAlternatives": [
    string
  ],
  "dependentShipmentTypes": [
    string
  ],
  "requirementMode": enum (RequirementMode)
}
Поля
requiredShipmentTypeAlternatives[]

string

Список альтернативных типов отгрузки, необходимых для dependentShipmentTypes

dependentShipmentTypes[]

string

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

ПРИМЕЧАНИЕ. Цепочки требований, так что shipmentType зависит от себя, не допускаются.

requirementMode

enum ( RequirementMode )

Режим применяется к требованию.

Требование

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

Перечисления
REQUIREMENT_MODE_UNSPECIFIED Неуказанный режим требования. Это значение никогда не должно использоваться.
PERFORMED_BY_SAME_VEHICLE В этом режиме все «зависимые» поставки должны иметь то же автомобиль, что и по крайней мере одна из их «требуемых» поставки.
IN_SAME_VEHICLE_AT_PICKUP_TIME

В режиме IN_SAME_VEHICLE_AT_PICKUP_TIME все «зависимые» поставки должны иметь по крайней мере одну «требуемую» отгрузку на своем транспортном средстве во время их выбора.

Таким образом, «зависимый» выписка должен иметь либо:

  • Только доставка «требуется», доставленная по маршруту после, или
  • «Требуемая» отгрузка, поднятая на маршруте перед ним, и если «требуемая» отправка имеет доставку, эта доставка должна выполняться после получения «зависимой» отгрузки.
IN_SAME_VEHICLE_AT_DELIVERY_TIME То же, что и раньше, за исключением того, что «зависимые» поставки должны иметь «обязательную» отправку на их транспортное средство во время их доставки .

Предшествующий

Правило приоритета между двумя событиями (каждое событие - это пикап или доставка отгрузки): событие «Второе» должно начать, по крайней мере, offsetDuration после начала «первого».

Несколько предложений могут ссылаться на те же (или связанные) события, например, «пикап B происходит после доставки« и «пикап C происходит после пикапа B».

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

JSON-представление
{
  "firstIsDelivery": boolean,
  "secondIsDelivery": boolean,
  "offsetDuration": string,
  "firstIndex": integer,
  "secondIndex": integer
}
Поля
firstIsDelivery

boolean

Указывает, является ли «первое» событие доставкой.

secondIsDelivery

boolean

Указывает, является ли событие «второе» доставкой.

offsetDuration

string ( Duration format)

Смещение между «первым» и «вторым» событием. Это может быть отрицательным.

Продолжительность за секунды с девятью дробными цифрами, заканчивая « s ». Пример: "3.5s" .

firstIndex

integer

Индекс отправки "первого" события. Это поле должно быть указано.

secondIndex

integer

Индекс отправки "второго" события. Это поле должно быть указано.

,

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

  • Стоимость маршрутизации транспортных средств (сумма стоимости за общее время, стоимость за время в пути и фиксированная стоимость по всем транспортным средствам).
  • Неопроверженные штрафы отгрузки.
  • стоимость глобальной продолжительности поставок
JSON-представление
{
  "shipments": [
    {
      object (Shipment)
    }
  ],
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "globalStartTime": string,
  "globalEndTime": string,
  "globalDurationCostPerHour": number,
  "durationDistanceMatrices": [
    {
      object (DurationDistanceMatrix)
    }
  ],
  "durationDistanceMatrixSrcTags": [
    string
  ],
  "durationDistanceMatrixDstTags": [
    string
  ],
  "transitionAttributes": [
    {
      object (TransitionAttributes)
    }
  ],
  "shipmentTypeIncompatibilities": [
    {
      object (ShipmentTypeIncompatibility)
    }
  ],
  "shipmentTypeRequirements": [
    {
      object (ShipmentTypeRequirement)
    }
  ],
  "precedenceRules": [
    {
      object (PrecedenceRule)
    }
  ],
  "maxActiveVehicles": integer
}
Поля
shipments[]

object ( Shipment )

Набор поставок, которые должны быть выполнены в модели.

vehicles[]

object ( Vehicle )

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

globalStartTime

string ( Timestamp format)

Глобальное время начала и окончания модели: НЕТ ВРЕМЕННЫЕ ВРЕМЕНИ ВРЕМЯ этого диапазона нельзя считать действительным.

Пролет времени модели должен составлять менее года, то есть globalEndTime и globalStartTime должны быть в течение 31536000 секунд друг от друга.

При использовании полей cost_per_*hour , вы можете установить это окно на меньший интервал для повышения производительности (например, если вы моделируете один день, вам следует установить глобальные временные ограничения на тот день). Если unset, 00:00:00 UTC, 1 января 1970 года (то есть секунд: 0, нано: 0) используется в качестве дефолта.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

globalEndTime

string ( Timestamp format)

Если unset, 00:00:00 UTC, 1 января 1971 года (то есть секунд: 31536000, нано: 0) используется в качестве дефолта.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

globalDurationCostPerHour

number

«Глобальная продолжительность» общего плана - это разница между самым ранним эффективным временем начала и последним эффективным временем окончания всех транспортных средств. Пользователи могут назначать стоимость в час этому количеству, чтобы попытаться оптимизировать, например, для самого раннего завершения работы. Эта стоимость должна быть в той же единице, что и Shipment.penalty_cost . Penalty_cost.

durationDistanceMatrices[]

object ( DurationDistanceMatrix )

Определяет матрицы продолжительности и расстояния, используемых в модели. Если это поле пустое, вместо этого будут использоваться карты Google или геодезические расстояния, в зависимости от значения поля useGeodesicDistances . Если он не пуст, useGeodesicDistances не может быть истинной, и ни durationDistanceMatrixSrcTags , ни durationDistanceMatrixDstTags не могут быть пустыми.

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

  • Есть два места: Loca и LOCB.
  • 1 автомобиль, начинающий свой маршрут в Loca и заканчивая его в Loca.
  • 1 Запрос на посещение в LOCB.
model {
  vehicles { startTags: "locA"  endTags: "locA" }
  shipments { pickups { tags: "locB" } }
  durationDistanceMatrixSrcTags: "locA"
  durationDistanceMatrixSrcTags: "locB"
  durationDistanceMatrixDstTags: "locA"
  durationDistanceMatrixDstTags: "locB"
  durationDistanceMatrices {
    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
    }
  }
}
  • Есть три места: loca, locb и locc.
  • 1 автомобиль, начинающий свой маршрут в Loca и заканчивая его в LOCB, используя матрицу "Fast".
  • 1 автомобиль, начинающий свой маршрут в LOCB и заканчивая его в LOCB, используя матрицу «медленная».
  • 1 автомобиль, начинающий свой маршрут в LOCB и заканчивая его в LOCB, используя матрицу "Fast".
  • 1 Запрос на посещение в LOCC.
model {
  vehicles { startTags: "locA" endTags: "locB" startTags: "fast" }
  vehicles { startTags: "locB" endTags: "locB" startTags: "slow" }
  vehicles { startTags: "locB" endTags: "locB" startTags: "fast" }
  shipments { pickups { tags: "locC" } }
  durationDistanceMatrixSrcTags: "locA"
  durationDistanceMatrixSrcTags: "locB"
  durationDistanceMatrixSrcTags: "locC"
  durationDistanceMatrixDstTags: "locB"
  durationDistanceMatrixDstTags: "locC"
  durationDistanceMatrices {
    vehicleStartTag: "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
    }
  }
  durationDistanceMatrices {
    vehicleStartTag: "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
    }
  }
}
durationDistanceMatrixSrcTags[]

string

Теги, определяющие источники продолжительности и матриц расстояния; durationDistanceMatrices(i).rows(j) определяет продолжительность и расстояния от посещений с меткой durationDistanceMatrixSrcTags(j) в другие посещения в матрице i.

Теги соответствуют VisitRequest.tags или Vehicle.start_tags . Данный VisitRequest или Vehicle должно соответствовать точному тегу в этом поле. Обратите внимание, что источник, пункт назначения и матричные теги Vehicle могут быть такими же; Точно так же источник и теги VisitRequest может быть одинаковым. Все теги должны быть разными и не могут быть пустыми струнами. Если это поле не является пустым, то durationDistanceMatrices не должны быть пустыми.

durationDistanceMatrixDstTags[]

string

Теги, определяющие направления по прочтению и дистанционным матрицам; durationDistanceMatrices(i).rows(j).durations(k) (Respr. durationDistanceMatrices(i).rows(j).meters(k)) Определяет продолжительность (соответствующее расстояние) перемещения из посещений с меткой durationDistanceMatrixSrcTags(j) Посещения с тегом durationDistanceMatrixDstTags(k) в матрице i.

Теги соответствуют VisitRequest.tags или Vehicle.start_tags . Данный VisitRequest или Vehicle должно соответствовать точному тегу в этом поле. Обратите внимание, что источник, пункт назначения и матричные теги Vehicle могут быть такими же; Точно так же источник и теги VisitRequest может быть одинаковым. Все теги должны быть разными и не могут быть пустыми струнами. Если это поле не является пустым, то durationDistanceMatrices не должны быть пустыми.

transitionAttributes[]

object ( TransitionAttributes )

Переходные атрибуты добавлены в модель.

shipmentTypeIncompatibilities[]

object ( ShipmentTypeIncompatibility )

Наборы несовместимой отгрузки_types (см. ShipmentTypeIncompatibility

shipmentTypeRequirements[]

object ( ShipmentTypeRequirement )

Наборы требований shipmentType (см. ShipmentTypeRequirement

precedenceRules[]

object ( PrecedenceRule )

Набор правил приоритета, которые должны быть применены в модели.

maxActiveVehicles

integer

Ограничивает максимальное количество активных транспортных средств. Автомобиль активен, если его маршрут выполняет по крайней мере одну отправку. Это может быть использовано для ограничения количества маршрутов в случае, когда водителей меньше, чем транспортных средств, и что парк транспортных средств является неоднородным. Затем оптимизация выберет наилучшее подмножество транспортных средств для использования. Должен быть строго положительным.

Отгрузка

Отгрузка одного предмета, от одного из его пикапов до одного из его поставки. Чтобы поставка рассматривалась в качестве выполнения, уникальный автомобиль должен посетить одну из своих мест для пикапа (и соответственно снизить его запасные возможности), а затем посетить одно из своих мест доставки позже (и, следовательно, соответственно переоценить свои запасные возможности).

JSON-представление
{
  "displayName": string,
  "pickups": [
    {
      object (VisitRequest)
    }
  ],
  "deliveries": [
    {
      object (VisitRequest)
    }
  ],
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "allowedVehicleIndices": [
    integer
  ],
  "costsPerVehicle": [
    number
  ],
  "costsPerVehicleIndices": [
    integer
  ],
  "pickupToDeliveryAbsoluteDetourLimit": string,
  "pickupToDeliveryTimeLimit": string,
  "shipmentType": string,
  "label": string,
  "ignore": boolean,
  "penaltyCost": number,
  "pickupToDeliveryRelativeDetourLimit": number
}
Поля
displayName

string

Пользовательское отображение имени отгрузки. Это может быть до 63 символов в длину и может использовать символы UTF-8.

pickups[]

object ( VisitRequest )

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

deliveries[]

object ( VisitRequest )

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

loadDemands

map (key: string, value: object ( Load ))

Требования нагрузки отгрузки (например, вес, объем, количество поддонов и т. Д.). Ключи на карте должны быть идентификаторами, описывающими тип соответствующей нагрузки, в идеале, включая единицы. Например: «Whews_kg», «goom_gallons», «pallet_count» и т. Д. Если данная клавиша не отображается на карте, соответствующая нагрузка считается нулевой.

Объект, содержащий список "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

allowedVehicleIndices[]

integer

Набор транспортных средств, которые могут выполнить эту доставку. Если пустые, все транспортные средства могут выполнить это. Транспортные средства предоставляются их индексом в списке vehicles ShipmentModel .

costsPerVehicle[]

number

Определяет стоимость, которая понесена, когда эта доставка доставлена ​​каждому транспортному средству. Если указано, он должен иметь либо:

  • Такое же количество элементов, что и costsPerVehicleIndices . costsPerVehicle[i] соответствует costsPerVehicleIndices[i] на транспортное средство.
  • такое же количество элементов, что и в модели. Элемент I-TH соответствует транспортному средству #I модели.

Эти затраты должны быть в той же единице, что и penaltyCost и не должны быть отрицательными. Оставьте это поле пустым, если такими затратами нет.

costsPerVehicleIndices[]

integer

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

pickupToDeliveryAbsoluteDetourLimit

string ( Duration format)

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

Например, пусть t - самое короткое время, необходимое, чтобы перейти из выбранной альтернативы пикапа непосредственно к выбранной альтернативе доставки. Затем установите pickupToDeliveryAbsoluteDetourLimit Searciets:

startTime(delivery) - startTime(pickup) <=
t + pickupToDeliveryAbsoluteDetourLimit

Если как относительные, так и абсолютные пределы указаны на одной и той же отгрузке, более ограниченный предел используется для каждой возможной пары пикапа/доставки. По состоянию на 2017/10 объезд поддерживаются только тогда, когда продолжительность путешествий не зависят от транспортных средств.

Продолжительность за секунды с девятью дробными цифрами, заканчивая « s ». Пример: "3.5s" .

pickupToDeliveryTimeLimit

string ( Duration format)

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

Продолжительность за секунды с девятью дробными цифрами, заканчивая « s ». Пример: "3.5s" .

shipmentType

string

Непустые строки, указывающая «тип» для этой партии. Эта функция может быть использована для определения несовместимости или требований между shipment_types (см. shipmentTypeIncompatibilities и shipmentTypeRequirements в ShipmentModel ).

Отличается от visitTypes , который указан для одного посещения: все пикап/доставка, принадлежащие к одной и той же доставке, имеют одну и ту же shipmentType .

label

string

Определяет этикетку для этой партии. Эта ярлыка сообщается в ответе в shipmentLabel соответствующего ShipmentRoute.Visit .

ignore

boolean

Если это правда, пропустите эту доставку, но не применяйте penaltyCost .

Игнорирование отгрузки приводит к ошибке проверки, когда в модели есть какие -либо shipmentTypeRequirements .

Игнорирование отгрузки, которая выполняется в injectedFirstSolutionRoutes или injectedSolutionConstraint , разрешено; Решатель удаляет связанные с ними посещения пикапа/доставки с маршрута выполнения. precedenceRules , которые ссылаются на игнорируемые поставки, также будут игнорироваться.

penaltyCost

number

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

Важно : если этот штраф не указан, оно считается бесконечным, то есть отгрузка должна быть завершена.

pickupToDeliveryRelativeDetourLimit

number

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

Например, пусть t - самое короткое время, необходимое, чтобы перейти из выбранной альтернативы пикапа непосредственно к выбранной альтернативе доставки. Затем установите pickupToDeliveryRelativeDetourLimit Searciets:

startTime(delivery) - startTime(pickup) <=
std::ceil(t * (1.0 + pickupToDeliveryRelativeDetourLimit))

Если как относительные, так и абсолютные пределы указаны на одной и той же отгрузке, более ограниченный предел используется для каждой возможной пары пикапа/доставки. По состоянию на 2017/10 объезд поддерживаются только тогда, когда продолжительность путешествий не зависят от транспортных средств.

Визит

Запрос на посещение, которое может быть совершено транспортным средством: у него есть гео-расположение (или два, см. Ниже), время открытия и закрытия, представленное временными окнами, и время продолжительности обслуживания (время, проведенное транспортным средством, после его прибытия забрать или снять товары).

JSON-представление
{
  "arrivalLocation": {
    object (LatLng)
  },
  "arrivalWaypoint": {
    object (Waypoint)
  },
  "departureLocation": {
    object (LatLng)
  },
  "departureWaypoint": {
    object (Waypoint)
  },
  "tags": [
    string
  ],
  "timeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "duration": string,
  "cost": number,
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "visitTypes": [
    string
  ],
  "label": string
}
Поля
arrivalLocation

object ( LatLng )

Гео-локация, где автомобиль прибывает при выполнении этого VisitRequest . Если модель отгрузки имеет матрицы расстояния продолжительности, arrivalLocation не должна быть указана.

arrivalWaypoint

object ( Waypoint )

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

departureLocation

object ( LatLng )

Гео-локация, где автомобиль уходит после завершения этого VisitRequest . Может быть пропущено, если он такой же, как и arrivalLocation . Если модель отгрузки имеет матрицы расстояния продолжительности, departureLocation не должен быть указан.

departureWaypoint

object ( Waypoint )

Путь, где автомобиль уходит после завершения этого VisitRequest . Может быть опущено, если это то же самое, что и arrivalWaypoint . Если модель отгрузки имеет матрицы расстояния продолжительности, нельзя указать departureWaypoint .

tags[]

string

Определяет теги, прикрепленные к запросу посещения. Пустые или дублирующие строки не допускаются.

timeWindows[]

object ( TimeWindow )

Временные окна, которые ограничивают время прибытия при посещении. Обратите внимание, что транспортное средство может вылететь за пределами окна времени прибытия, то есть время прибытия + продолжительность не нужно находиться внутри временного окна. Это может привести к времени ожидания, если автомобиль прибывает до TimeWindow.start_time .

Отсутствие TimeWindow означает, что автомобиль может выполнить это посещение в любое время.

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

costPerHourAfterSoftEndTime и softEndTime могут быть установлены только в том случае, если есть одно временное окно.

duration

string ( Duration format)

Продолжительность визита, то есть время, проведенное транспортным средством между прибытием и отъездом (должно быть добавлено в возможное время ожидания; см. timeWindows ).

Продолжительность за секунды с девятью дробными цифрами, заканчивая « s ». Пример: "3.5s" .

cost

number

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

loadDemands

map (key: string, value: object ( Load ))

Требования нагрузки этого запроса на посещение. Это похоже на поле Shipment.load_demands , за исключением того, что оно относится только к этому VisitRequest а не к всей Shipment . Требования, перечисленные здесь, добавляются к требованиям, перечисленным в Shipment.load_demands .

Объект, содержащий список "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

visitTypes[]

string

Указывает типы визита. Это может использоваться для выделения дополнительного времени, необходимого для автомобиля, чтобы завершить это посещение (см. Vehicle.extra_visit_duration_for_visit_type ).

Тип может появиться только один раз.

label

string

Определяет этикетку для этого VisitRequest . Эта ярлыка сообщается в ответе в качестве visitLabel в соответствующей ShipmentRoute.Visit .

Латлнг

Объект, который представляет собой пару широты/долготы. Это выражается как пара удвоений, представляющих градус широты и градусов долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны быть в пределах нормализованных диапазонов.

JSON-представление
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

Широта в градусах. Это должно быть в диапазоне [-90.0, +90.0].

longitude

number

Долгота в градусах. Это должно быть в диапазоне [-180.0, +180.0].

Путевая точка

Инкапсулирует путевую точку. Путевые точки отмечают прибытие и отъезд в местах посещений, а также начальные и конечные места транспортных средств.

JSON-представление
{
  "sideOfRoad": boolean,

  // Union field location_type can be only one of the following:
  "location": {
    object (Location)
  },
  "placeId": string
  // End of list of possible types for union field location_type.
}
Поля
sideOfRoad

boolean

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

Объединение поля location_type . Различные способы представлять местоположение. location_type может быть только одним из следующих:
location

object ( Location )

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

placeId

string

ID POI Place, связанный с путевой точкой.

Расположение

Инкапсулирует местоположение (географическая точка и необязательный заголовок).

JSON-представление
{
  "latLng": {
    object (LatLng)
  },
  "heading": integer
}
Поля
latLng

object ( LatLng )

Географические координаты путевой точки.

heading

integer

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

TimeWindow

Временные окна ограничивают время события, например, время прибытия в посещение или время начала и окончания транспортного средства.

Тяжелые границы окна времени, startTime и endTime , обеспечивают самое раннее и последнее время события, такое, что startTime <= event_time <= endTime . Мягкое временное окно, нижняя граница, softStartTime , выражает предпочтение события, которое произойдет в softStartTime или после, затрачивая стоимость, пропорциональную тем, как долго до того, как произошло событие. Верхняя граница с мягким временным окном, softEndTime , выражает предпочтение события, которое произойдет в или до softEndTime , затрачивая стоимость, пропорциональную тем, как долго после softEndTime произойдет. startTime , endTime , softStartTime и softEndTime должны находиться в глобальных временных пределах (см. ShipmentModel.global_start_time и ShipmentModel.global_end_time ) и должен уважать:

  0 <= `startTime` <= `endTime` and
  0 <= `startTime` <= `softStartTime` and
  0 <= `softEndTime` <= `endTime`.
JSON-представление
{
  "startTime": string,
  "endTime": string,
  "softStartTime": string,
  "softEndTime": string,
  "costPerHourBeforeSoftStartTime": number,
  "costPerHourAfterSoftEndTime": number
}
Поля
startTime

string ( Timestamp format)

Трудное время начала окна. Если не указано, это будет установлено на ShipmentModel.global_start_time .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

Трудное время окончания окна. Если не указано, это будет установлено на ShipmentModel.global_end_time .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

softStartTime

string ( Timestamp format)

Мягкое время начала временного окна.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

softEndTime

string ( Timestamp format)

Мягкое время окончания временного окна.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

costPerHourBeforeSoftStartTime

number

Стоимость в час, добавленная к другим затратам в модели, если событие происходит перед SoftStarttime, вычисленным как:

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

Эта стоимость должна быть положительной, и поле может быть установлено только в том случае, если установлено SoftStarttime.

costPerHourAfterSoftEndTime

number

Стоимость в час, добавленная к другим затратам в модели, если событие происходит после softEndTime , вычисленной как:

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

Эта стоимость должна быть положительной, и поле может быть установлено только в случае установки softEndTime .

Транспортное средство

Моделируют транспортное средство в проблеме отгрузки. Решение проблемы отгрузки построит маршрут, начиная с startLocation , и заканчивается при endLocation этого автомобиля. Маршрут - это последовательность посещений (см. ShipmentRoute ).

JSON-представление
{
  "displayName": string,
  "travelMode": enum (TravelMode),
  "routeModifiers": {
    object (RouteModifiers)
  },
  "startLocation": {
    object (LatLng)
  },
  "startWaypoint": {
    object (Waypoint)
  },
  "endLocation": {
    object (LatLng)
  },
  "endWaypoint": {
    object (Waypoint)
  },
  "startTags": [
    string
  ],
  "endTags": [
    string
  ],
  "startTimeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "endTimeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "unloadingPolicy": enum (UnloadingPolicy),
  "loadLimits": {
    string: {
      object (LoadLimit)
    },
    ...
  },
  "costPerHour": number,
  "costPerTraveledHour": number,
  "costPerKilometer": number,
  "fixedCost": number,
  "usedIfRouteIsEmpty": boolean,
  "routeDurationLimit": {
    object (DurationLimit)
  },
  "travelDurationLimit": {
    object (DurationLimit)
  },
  "routeDistanceLimit": {
    object (DistanceLimit)
  },
  "extraVisitDurationForVisitType": {
    string: string,
    ...
  },
  "breakRule": {
    object (BreakRule)
  },
  "label": string,
  "ignore": boolean,
  "travelDurationMultiple": number
}
Поля
displayName

string

Пользовательское имя отображаемого автомобиля. Это может быть до 63 символов в длину и может использовать символы UTF-8.

travelMode

enum ( TravelMode )

Режим путешествий, который влияет на дороги, пригодные для автомобиля и его скорость. См. Также travelDurationMultiple .

routeModifiers

object ( RouteModifiers )

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

startLocation

object ( LatLng )

Географическое местоположение, где автомобиль начинается, прежде чем забрать любые поставки. Если не указано, автомобиль начинается с первого пикапа. Если модель отгрузки имеет матрицы продолжительности и расстояния, startLocation не должно быть указана.

startWaypoint

object ( Waypoint )

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

endLocation

object ( LatLng )

Географическое расположение, где транспортное средство заканчивается после того, как он завершил свой последний VisitRequest . Если не указано, что ShipmentRoute транспортного средства заканчивается немедленно, когда он завершает свой последний VisitRequest . Если модель отгрузки имеет матрицы продолжительности и расстояния, endLocation не должна быть указана.

endWaypoint

object ( Waypoint )

Путь, представляющая географическое местоположение, где транспортное средство заканчивается после того, как он завершил свой последний VisitRequest . Если не указано ни endWaypoint , ни endLocation , то ShipmentRoute транспортного средства заканчивается немедленно, когда он завершает свой последний VisitRequest . Если модель отгрузки имеет матрицы продолжительности и расстояния, endWaypoint не должна быть указана.

startTags[]

string

Определяет теги, прикрепленные к началу маршрута автомобиля.

Пустые или дублирующие строки не допускаются.

endTags[]

string

Определяет теги, прикрепленные к концу маршрута автомобиля.

Пустые или дублирующие строки не допускаются.

startTimeWindows[]

object ( TimeWindow )

Временные окна, в течение которых автомобиль может покинуть свое начало. Они должны находиться в пределах глобальных временных ограничений (см. Fields ShipmentModel.global_* . В случае неопределенности нет никаких ограничений, кроме этих глобальных временных ограничений.

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

costPerHourAfterSoftEndTime и softEndTime могут быть установлены только в том случае, если есть одно временное окно.

endTimeWindows[]

object ( TimeWindow )

Временные окна, в течение которых транспортное средство может прибыть в местоположение своего конца. Они должны находиться в пределах глобальных временных ограничений (см. Fields ShipmentModel.global_* . В случае неопределенности нет никаких ограничений, кроме этих глобальных временных ограничений.

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

costPerHourAfterSoftEndTime и softEndTime могут быть установлены только в том случае, если есть одно временное окно.

unloadingPolicy

enum ( UnloadingPolicy )

Политика разгрузки принудительно соблюдается на транспортном средстве.

loadLimits

map (key: string, value: object ( LoadLimit ))

Возможности транспортного средства (вес, объем, например, поддонов). Ключи на карте - это идентификаторы типа нагрузки, соответствующие ключам поля Shipment.load_demands . Если заданный ключ отсутствует на этой карте, соответствующая емкость считается безграничной.

Объект, содержащий список "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

costPerHour

number

Затраты на транспортное средство: все расходы составляют и должны быть в той же единице, что и Shipment.penalty_cost .

Стоимость в час транспортного средства. Эта стоимость применяется к общему времени, взятому маршрутом, и включает время в пути, время ожидания и время посещения. Использование costPerHour вместо просто costPerTraveledHour может привести к дополнительной задержке.

costPerTraveledHour

number

Стоимость за пройденное час маршрута автомобиля. Эта стоимость применяется только для пути в пути, взятым по маршруту (то есть, который сообщается в ShipmentRoute.transitions ), и исключает время ожидания и время посещения.

costPerKilometer

number

Стоимость за километр маршрута автомобиля. Эта стоимость применяется на расстоянии, о котором сообщается в ShipmentRoute.transitions , и не применяется к какому -либо расстоянию, неявно пройденному от arrivalLocation к departureLocation из одного VisitRequest .

fixedCost

number

Фиксированная стоимость применяется, если этот автомобиль используется для обработки отгрузки.

usedIfRouteIsEmpty

boolean

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

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

В противном случае он не перемещается от начала до своего конечного местоположения, и для этого автомобиля не запланировано никаких breakRule или задержки (от TransitionAttributes ). В этом случае транспортное ShipmentRoute не содержит никакой информации, за исключением индекса автомобиля и метки.

routeDurationLimit

object ( DurationLimit )

Ограничение применяется к общей продолжительности маршрута транспортного средства. В данном OptimizeToursResponse продолжительность маршрута транспортного средства заключается в разнице между его vehicleEndTime и vehicleStartTime .

travelDurationLimit

object ( DurationLimit )

Ограничение применяется к продолжительности движения маршрута транспортного средства. В заданном OptimizeToursResponse , продолжительность движения маршрута - это сумма всех его transitions.travel_duration . Travel_duration.

routeDistanceLimit

object ( DistanceLimit )

Ограничение применяется к общему расстоянию маршрута транспортного средства. В заданном OptimizeToursResponse расстояние маршрута - это сумма всех его transitions.travel_distance_meters .

extraVisitDurationForVisitType

map (key: string, value: string ( Duration format))

Определяет карту от струн VisitTypes до продолжительности. Продолжительность - visitTypes время в дополнение к VisitRequest.duration . Эта дополнительная продолжительность посещения добавляет стоимость, если указан costPerHour . Ключи (т.е. visitTypes ) не могут быть пустыми струнами.

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

Объект, содержащий список "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

breakRule

object ( BreakRule )

Описывает график перерыва, который должен применяться на этом транспортном средстве. Если это пустое, для этого автомобиля не будет запланировано перерывы.

label

string

Указывает этикетку для этого автомобиля. Эта ярлыка сообщается в ответе как vehicleLabel соответствующего ShipmentRoute .

ignore

boolean

Если это правда, usedIfRouteIsEmpty быть ложным, и этот автомобиль останется неиспользованным.

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

Если отгрузка выполняется игнорируемым транспортным средством в injectedSolutionConstraint и любой связанный сдача/доставка ограничена, чтобы оставаться на транспортном средстве (то есть, а не расслабится до уровня RELAX_ALL_AFTER_THRESHOLD ), она пропускается в ответе. Если отгрузка имеет невозмученное поле allowedVehicleIndices и все разрешенные транспортные средства игнорируются, она пропускается в ответе.

travelDurationMultiple

number

Указывает мультипликативный коэффициент, который можно использовать для увеличения или уменьшения времени прохождения этого транспортного средства. Например, установление этого до 2.0 означает, что этот автомобиль медленнее и имеет время прохождения, которое в два раза больше, чем для стандартных транспортных средств. Это множество не влияет на продолжительность посещения. Это влияет на стоимость, если указаны costPerHour или costPerTraveledHour . Это должно быть в диапазоне [0,001, 1000,0]. Если нет, транспортное средство является стандартным, и это множественное количество считается 1,0.

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

См. Также extraVisitDurationForVisitType ниже.

Travelmode

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

Это должно быть подмножеством платформ Google Maps Platform, предпочтительные режимы путешествий API, см .

Перечисления
TRAVEL_MODE_UNSPECIFIED Неуказанный режим путешествий, эквивалентный DRIVING .
DRIVING Режим путешествия, соответствующий направлению вождения (автомобиль, ...).
WALKING Режим путешествия, соответствующий направлению ходьбы.

Рукодификаторы

Инкапсулирует набор дополнительных условий для удовлетворения при расчете маршрутов транспортных средств. Это похоже на RouteModifiers в платформе Google Maps Platform Routes Preferred API; См.: https://developers.google.com/maps/documentation/routes/reference/rest/v2/routemodifiers .

JSON-представление
{
  "avoidTolls": boolean,
  "avoidHighways": boolean,
  "avoidFerries": boolean,
  "avoidIndoor": boolean
}
Поля
avoidTolls

boolean

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

avoidHighways

boolean

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

avoidFerries

boolean

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

avoidIndoor

boolean

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

UnloadingPolicy

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

Другие поставки могут свободно происходить на маршруте независимо от unloadingPolicy .

Перечисления
UNLOADING_POLICY_UNSPECIFIED Неопределенная политика разгрузки; Поставки должны происходить просто после их соответствующих пикапов.
LAST_IN_FIRST_OUT Поставки должны происходить в обратном порядке пикапов
FIRST_IN_FIRST_OUT Поставки должны происходить в том же порядке, что и пикапы

LoadLimit

Определяет ограничение нагрузки, применяемое к транспортному средству, например, «Этот грузовик может переносить только 3500 кг». See loadLimits .

JSON-представление
{
  "softMaxLoad": string,
  "costPerUnitAboveSoftMax": number,
  "startLoadInterval": {
    object (Interval)
  },
  "endLoadInterval": {
    object (Interval)
  },
  "maxLoad": string
}
Поля
softMaxLoad

string ( int64 format)

A soft limit of the load. See costPerUnitAboveSoftMax .

costPerUnitAboveSoftMax

number

If the load ever exceeds softMaxLoad along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - softMaxLoad ) * costPerUnitAboveSoftMax . All costs add up and must be in the same unit as Shipment.penalty_cost .

startLoadInterval

object ( Interval )

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

endLoadInterval

object ( Interval )

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

maxLoad

string ( int64 format)

The maximum acceptable amount of load.

Интервал

Interval of acceptable load amounts.

JSON-представление
{
  "min": string,
  "max": string
}
Поля
min

string ( int64 format)

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

max

string ( int64 format)

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 .

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.

JSON-представление
{
  "maxDuration": string,
  "softMaxDuration": string,
  "quadraticSoftMaxDuration": string,
  "costPerHourAfterSoftMax": number,
  "costPerSquareHourAfterQuadraticSoftMax": number
}
Поля
maxDuration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

softMaxDuration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

quadraticSoftMaxDuration

string ( Duration format)

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, quadraticSoftMaxDuration must be nonnegative. If maxDuration is also defined, quadraticSoftMaxDuration must be less than maxDuration , and the difference must be no larger than one day:

maxDuration - quadraticSoftMaxDuration <= 86400 seconds

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

costPerHourAfterSoftMax

number

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

  costPerHourAfterSoftMax * (duration - softMaxDuration)

The cost must be nonnegative.

costPerSquareHourAfterQuadraticSoftMax

number

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

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

  costPerSquareHourAfterQuadraticSoftMax *
  (duration - quadraticSoftMaxDuration)^2

The cost must be nonnegative.

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 softMaxMeters and costPerKilometerAboveSoftMax must be defined and be nonnegative.

JSON-представление
{
  "maxMeters": string,
  "softMaxMeters": string,
  "costPerKilometerBelowSoftMax": number,
  "costPerKilometerAboveSoftMax": number
}
Поля
maxMeters

string ( int64 format)

A hard limit constraining the distance to be at most maxMeters. The limit must be nonnegative.

softMaxMeters

string ( int64 format)

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 softMaxMeters must be less than maxMeters and must be nonnegative.

costPerKilometerBelowSoftMax

number

Cost per kilometer incurred, increasing up to softMaxMeters , with formula:

  min(distanceMeters, softMaxMeters) / 1000.0 *
  costPerKilometerBelowSoftMax.

This cost is not supported in routeDistanceLimit .

costPerKilometerAboveSoftMax

number

Cost per kilometer incurred if distance is above softMaxMeters limit. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following:

  (distanceMeters - softMaxMeters) / 1000.0 *
  costPerKilometerAboveSoftMax.

The cost must be nonnegative.

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).
JSON-представление
{
  "breakRequests": [
    {
      object (BreakRequest)
    }
  ],
  "frequencyConstraints": [
    {
      object (FrequencyConstraint)
    }
  ]
}
Поля
breakRequests[]

object ( BreakRequest )

Sequence of breaks. See the BreakRequest message.

frequencyConstraints[]

object ( FrequencyConstraint )

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequest s of this BreakRule . See FrequencyConstraint .

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 ( earliestStartTime / latestStartTime ) may overlap, but they must be compatible with the order (this is checked).

JSON-представление
{
  "earliestStartTime": string,
  "latestStartTime": string,
  "minDuration": string
}
Поля
earliestStartTime

string ( Timestamp format)

Необходимый. Lower bound (inclusive) on the start of the break.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

latestStartTime

string ( Timestamp format)

Необходимый. Upper bound (inclusive) on the start of the break.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

minDuration

string ( Duration format)

Необходимый. Minimum duration of the break. Must be positive.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

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 :

{
   minBreakDuration { seconds: 3600 }         # 1 hour.
   maxInterBreakDuration { 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
JSON-представление
{
  "minBreakDuration": string,
  "maxInterBreakDuration": string
}
Поля
minBreakDuration

string ( Duration format)

Необходимый. Minimum break duration for this constraint. Nonnegative. See description of FrequencyConstraint .

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

maxInterBreakDuration

string ( Duration format)

Необходимый. Maximum allowed span of any interval of time in the route that does not include at least partially a break of duration >= minBreakDuration . Must be positive.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

DurationDistanceMatrix

Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations.

JSON-представление
{
  "rows": [
    {
      object (Row)
    }
  ],
  "vehicleStartTag": string
}
Поля
rows[]

object ( Row )

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

vehicleStartTag

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

All matrices must have a different vehicleStartTag .

Ряд

Specifies a row of the duration and distance matrix.

JSON-представление
{
  "durations": [
    string
  ],
  "meters": [
    number
  ]
}
Поля
durations[]

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

meters[]

number

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 .

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

JSON-представление
{
  "srcTag": string,
  "excludedSrcTag": string,
  "dstTag": string,
  "excludedDstTag": string,
  "cost": number,
  "costPerKilometer": number,
  "distanceLimit": {
    object (DistanceLimit)
  },
  "delay": string
}
Поля
srcTag

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 srcTag or does not contain excludedSrcTag (depending on which of these two fields is non-empty).

excludedSrcTag

string

See srcTag . Exactly one of srcTag and excludedSrcTag must be non-empty.

dstTag

string

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

excludedDstTag

string

See dstTag . Exactly one of dstTag and excludedDstTag must be non-empty.

cost

number

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.

costPerKilometer

number

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

object ( DistanceLimit )

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

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

delay

string ( Duration format)

Specifies a delay incurred when performing this transition.

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

ShipmentTypeIncompatibility

Specifies incompatibilties between shipments depending on their shipmentType. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode.

JSON-представление
{
  "types": [
    string
  ],
  "incompatibilityMode": enum (IncompatibilityMode)
}
Поля
types[]

string

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

incompatibilityMode

enum ( IncompatibilityMode )

Mode applied to the incompatibility.

IncompatibilityMode

Modes defining how the appearance of incompatible shipments are restricted on the same route.

Перечисления
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 NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY incompatibility mode:

  • If both are pickups only (no deliveries) or deliveries only (no pickups), they cannot share the same vehicle at all.
  • If one of the shipments has a delivery and the other a pickup, the two shipments can share the same vehicle iff the former shipment is delivered before the latter is picked up.

ShipmentTypeRequirement

Specifies requirements between shipments based on their shipmentType. The specifics of the requirement are defined by the requirement mode.

JSON-представление
{
  "requiredShipmentTypeAlternatives": [
    string
  ],
  "dependentShipmentTypes": [
    string
  ],
  "requirementMode": enum (RequirementMode)
}
Поля
requiredShipmentTypeAlternatives[]

string

List of alternative shipment types required by the dependentShipmentTypes .

dependentShipmentTypes[]

string

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

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

requirementMode

enum ( RequirementMode )

Mode applied to the requirement.

RequirementMode

Modes defining the appearance of dependent shipments on a route.

Перечисления
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 IN_SAME_VEHICLE_AT_PICKUP_TIME mode, all "dependent" shipments need to have at least one "required" shipment on their vehicle at the time of their pickup.

A "dependent" shipment pickup must therefore have either:

  • A delivery-only "required" shipment delivered on the route after, or
  • A "required" shipment picked up on the route before it, and if the "required" shipment has a delivery, this delivery must be performed after the "dependent" shipment's pickup.
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 .

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

JSON-представление
{
  "firstIsDelivery": boolean,
  "secondIsDelivery": boolean,
  "offsetDuration": string,
  "firstIndex": integer,
  "secondIndex": integer
}
Поля
firstIsDelivery

boolean

Indicates if the "first" event is a delivery.

secondIsDelivery

boolean

Indicates if the "second" event is a delivery.

offsetDuration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

firstIndex

integer

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

secondIndex

integer

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

,

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
JSON-представление
{
  "shipments": [
    {
      object (Shipment)
    }
  ],
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "globalStartTime": string,
  "globalEndTime": string,
  "globalDurationCostPerHour": number,
  "durationDistanceMatrices": [
    {
      object (DurationDistanceMatrix)
    }
  ],
  "durationDistanceMatrixSrcTags": [
    string
  ],
  "durationDistanceMatrixDstTags": [
    string
  ],
  "transitionAttributes": [
    {
      object (TransitionAttributes)
    }
  ],
  "shipmentTypeIncompatibilities": [
    {
      object (ShipmentTypeIncompatibility)
    }
  ],
  "shipmentTypeRequirements": [
    {
      object (ShipmentTypeRequirement)
    }
  ],
  "precedenceRules": [
    {
      object (PrecedenceRule)
    }
  ],
  "maxActiveVehicles": integer
}
Поля
shipments[]

object ( Shipment )

Set of shipments which must be performed in the model.

vehicles[]

object ( Vehicle )

Set of vehicles which can be used to perform visits.

globalStartTime

string ( Timestamp format)

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 globalEndTime and the globalStartTime 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.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

globalEndTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

globalDurationCostPerHour

number

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 .

durationDistanceMatrices[]

object ( 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 useGeodesicDistances field. If it is not empty, useGeodesicDistances cannot be true and neither durationDistanceMatrixSrcTags nor durationDistanceMatrixDstTags can be empty.

Usage examples:

  • 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 { startTags: "locA"  endTags: "locA" }
  shipments { pickups { tags: "locB" } }
  durationDistanceMatrixSrcTags: "locA"
  durationDistanceMatrixSrcTags: "locB"
  durationDistanceMatrixDstTags: "locA"
  durationDistanceMatrixDstTags: "locB"
  durationDistanceMatrices {
    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 { startTags: "locA" endTags: "locB" startTags: "fast" }
  vehicles { startTags: "locB" endTags: "locB" startTags: "slow" }
  vehicles { startTags: "locB" endTags: "locB" startTags: "fast" }
  shipments { pickups { tags: "locC" } }
  durationDistanceMatrixSrcTags: "locA"
  durationDistanceMatrixSrcTags: "locB"
  durationDistanceMatrixSrcTags: "locC"
  durationDistanceMatrixDstTags: "locB"
  durationDistanceMatrixDstTags: "locC"
  durationDistanceMatrices {
    vehicleStartTag: "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
    }
  }
  durationDistanceMatrices {
    vehicleStartTag: "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
    }
  }
}
durationDistanceMatrixSrcTags[]

string

Tags defining the sources of the duration and distance matrices; durationDistanceMatrices(i).rows(j) defines durations and distances from visits with tag durationDistanceMatrixSrcTags(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 durationDistanceMatrices must not be empty.

durationDistanceMatrixDstTags[]

string

Tags defining the destinations of the duration and distance matrices; durationDistanceMatrices(i).rows(j).durations(k) (resp. durationDistanceMatrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag durationDistanceMatrixSrcTags(j) to visits with tag durationDistanceMatrixDstTags(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 durationDistanceMatrices must not be empty.

transitionAttributes[]

object ( TransitionAttributes )

Transition attributes added to the model.

shipmentTypeIncompatibilities[]

object ( ShipmentTypeIncompatibility )

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility ).

shipmentTypeRequirements[]

object ( ShipmentTypeRequirement )

Sets of shipmentType requirements (see ShipmentTypeRequirement ).

precedenceRules[]

object ( PrecedenceRule )

Set of precedence rules which must be enforced in the model.

maxActiveVehicles

integer

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.

Отгрузка

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

JSON-представление
{
  "displayName": string,
  "pickups": [
    {
      object (VisitRequest)
    }
  ],
  "deliveries": [
    {
      object (VisitRequest)
    }
  ],
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "allowedVehicleIndices": [
    integer
  ],
  "costsPerVehicle": [
    number
  ],
  "costsPerVehicleIndices": [
    integer
  ],
  "pickupToDeliveryAbsoluteDetourLimit": string,
  "pickupToDeliveryTimeLimit": string,
  "shipmentType": string,
  "label": string,
  "ignore": boolean,
  "penaltyCost": number,
  "pickupToDeliveryRelativeDetourLimit": number
}
Поля
displayName

string

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

pickups[]

object ( VisitRequest )

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

deliveries[]

object ( VisitRequest )

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

loadDemands

map (key: string, value: object ( 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

allowedVehicleIndices[]

integer

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.

costsPerVehicle[]

number

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 costsPerVehicleIndices . costsPerVehicle[i] corresponds to vehicle costsPerVehicleIndices[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 penaltyCost and must not be negative. Leave this field empty, if there are no such costs.

costsPerVehicleIndices[]

integer

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

pickupToDeliveryAbsoluteDetourLimit

string ( Duration format)

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

startTime(delivery) - startTime(pickup) <=
t + pickupToDeliveryAbsoluteDetourLimit

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.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

pickupToDeliveryTimeLimit

string ( Duration format)

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.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

shipmentType

string

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

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

label

string

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

ignore

boolean

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

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

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

penaltyCost

number

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.

pickupToDeliveryRelativeDetourLimit

number

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

startTime(delivery) - startTime(pickup) <=
std::ceil(t * (1.0 + pickupToDeliveryRelativeDetourLimit))

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.

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

JSON-представление
{
  "arrivalLocation": {
    object (LatLng)
  },
  "arrivalWaypoint": {
    object (Waypoint)
  },
  "departureLocation": {
    object (LatLng)
  },
  "departureWaypoint": {
    object (Waypoint)
  },
  "tags": [
    string
  ],
  "timeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "duration": string,
  "cost": number,
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "visitTypes": [
    string
  ],
  "label": string
}
Поля
arrivalLocation

object ( LatLng )

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

arrivalWaypoint

object ( Waypoint )

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

departureLocation

object ( LatLng )

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

departureWaypoint

object ( Waypoint )

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

tags[]

string

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

timeWindows[]

object ( 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.

costPerHourAfterSoftEndTime and softEndTime can only be set if there is a single time window.

duration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

cost

number

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.

loadDemands

map (key: string, value: object ( 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 .

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

visitTypes[]

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.

label

string

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

LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard . Values must be within normalized ranges.

JSON-представление
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

The latitude in degrees. It must be in the range [-90.0, +90.0].

longitude

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

Waypoint

Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.

JSON-представление
{
  "sideOfRoad": boolean,

  // Union field location_type can be only one of the following:
  "location": {
    object (Location)
  },
  "placeId": string
  // End of list of possible types for union field location_type.
}
Поля
sideOfRoad

boolean

Необязательный. 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

object ( Location )

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

placeId

string

The POI Place ID associated with the waypoint.

Расположение

Encapsulates a location (a geographic point, and an optional heading).

JSON-представление
{
  "latLng": {
    object (LatLng)
  },
  "heading": integer
}
Поля
latLng

object ( LatLng )

The waypoint's geographic coordinates.

heading

integer

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.

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, startTime and endTime , enforce the earliest and latest time of the event, such that startTime <= event_time <= endTime . The soft time window lower bound, softStartTime , expresses a preference for the event to happen at or after softStartTime by incurring a cost proportional to how long before softStartTime the event occurs. The soft time window upper bound, softEndTime , expresses a preference for the event to happen at or before softEndTime by incurring a cost proportional to how long after softEndTime the event occurs. startTime , endTime , softStartTime and softEndTime should be within the global time limits (see ShipmentModel.global_start_time and ShipmentModel.global_end_time ) and should respect:

  0 <= `startTime` <= `endTime` and
  0 <= `startTime` <= `softStartTime` and
  0 <= `softEndTime` <= `endTime`.
JSON-представление
{
  "startTime": string,
  "endTime": string,
  "softStartTime": string,
  "softEndTime": string,
  "costPerHourBeforeSoftStartTime": number,
  "costPerHourAfterSoftEndTime": number
}
Поля
startTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

softStartTime

string ( Timestamp format)

The soft start time of the time window.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

softEndTime

string ( Timestamp format)

The soft end time of the time window.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

costPerHourBeforeSoftStartTime

number

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

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

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

costPerHourAfterSoftEndTime

number

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

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

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

Транспортное средство

Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from startLocation and ending at endLocation for this vehicle. A route is a sequence of visits (see ShipmentRoute ).

JSON-представление
{
  "displayName": string,
  "travelMode": enum (TravelMode),
  "routeModifiers": {
    object (RouteModifiers)
  },
  "startLocation": {
    object (LatLng)
  },
  "startWaypoint": {
    object (Waypoint)
  },
  "endLocation": {
    object (LatLng)
  },
  "endWaypoint": {
    object (Waypoint)
  },
  "startTags": [
    string
  ],
  "endTags": [
    string
  ],
  "startTimeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "endTimeWindows": [
    {
      object (TimeWindow)
    }
  ],
  "unloadingPolicy": enum (UnloadingPolicy),
  "loadLimits": {
    string: {
      object (LoadLimit)
    },
    ...
  },
  "costPerHour": number,
  "costPerTraveledHour": number,
  "costPerKilometer": number,
  "fixedCost": number,
  "usedIfRouteIsEmpty": boolean,
  "routeDurationLimit": {
    object (DurationLimit)
  },
  "travelDurationLimit": {
    object (DurationLimit)
  },
  "routeDistanceLimit": {
    object (DistanceLimit)
  },
  "extraVisitDurationForVisitType": {
    string: string,
    ...
  },
  "breakRule": {
    object (BreakRule)
  },
  "label": string,
  "ignore": boolean,
  "travelDurationMultiple": number
}
Поля
displayName

string

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

travelMode

enum ( TravelMode )

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

routeModifiers

object ( RouteModifiers )

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

startLocation

object ( 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, startLocation must not be specified.

startWaypoint

object ( Waypoint )

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

endLocation

object ( 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, endLocation must not be specified.

endWaypoint

object ( Waypoint )

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

startTags[]

string

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

Empty or duplicate strings are not allowed.

endTags[]

string

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

Empty or duplicate strings are not allowed.

startTimeWindows[]

object ( 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.

costPerHourAfterSoftEndTime and softEndTime can only be set if there is a single time window.

endTimeWindows[]

object ( 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.

costPerHourAfterSoftEndTime and softEndTime can only be set if there is a single time window.

unloadingPolicy

enum ( UnloadingPolicy )

Unloading policy enforced on the vehicle.

loadLimits

map (key: string, value: object ( 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

costPerHour

number

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

costPerTraveledHour

number

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.

costPerKilometer

number

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 arrivalLocation to the departureLocation of a single VisitRequest .

fixedCost

number

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

usedIfRouteIsEmpty

boolean

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

routeDurationLimit

object ( 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 vehicleEndTime and vehicleStartTime .

travelDurationLimit

object ( 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 .

routeDistanceLimit

object ( 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 .

extraVisitDurationForVisitType

map (key: string, value: string ( Duration format))

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

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

breakRule

object ( BreakRule )

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

label

string

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

ignore

boolean

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

If a shipment is performed by an ignored vehicle in injectedFirstSolutionRoutes , 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 injectedSolutionConstraint 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 allowedVehicleIndices field and all of the allowed vehicles are ignored, it is skipped in the response.

travelDurationMultiple

number

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 costPerHour or costPerTraveledHour 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 extraVisitDurationForVisitType below.

TravelMode

Travel modes which can be used by vehicles.

These should be a subset of the Google Maps Platform Routes Preferred API travel modes, see: https://developers.google.com/maps/documentation/routes_preferred/reference/rest/Shared.Types/RouteTravelMode .

Перечисления
TRAVEL_MODE_UNSPECIFIED Unspecified travel mode, equivalent to DRIVING .
DRIVING Travel mode corresponding to driving directions (car, ...).
WALKING Travel mode corresponding to walking directions.

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 .

JSON-представление
{
  "avoidTolls": boolean,
  "avoidHighways": boolean,
  "avoidFerries": boolean,
  "avoidIndoor": boolean
}
Поля
avoidTolls

boolean

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

avoidHighways

boolean

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

avoidFerries

boolean

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

avoidIndoor

boolean

Необязательный. 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.

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

Перечисления
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

LoadLimit

Defines a load limit applying to a vehicle, eg "this truck may only carry up to 3500 kg". See loadLimits .

JSON-представление
{
  "softMaxLoad": string,
  "costPerUnitAboveSoftMax": number,
  "startLoadInterval": {
    object (Interval)
  },
  "endLoadInterval": {
    object (Interval)
  },
  "maxLoad": string
}
Поля
softMaxLoad

string ( int64 format)

A soft limit of the load. See costPerUnitAboveSoftMax .

costPerUnitAboveSoftMax

number

If the load ever exceeds softMaxLoad along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - softMaxLoad ) * costPerUnitAboveSoftMax . All costs add up and must be in the same unit as Shipment.penalty_cost .

startLoadInterval

object ( Interval )

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

endLoadInterval

object ( Interval )

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

maxLoad

string ( int64 format)

The maximum acceptable amount of load.

Интервал

Interval of acceptable load amounts.

JSON-представление
{
  "min": string,
  "max": string
}
Поля
min

string ( int64 format)

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

max

string ( int64 format)

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 .

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.

JSON-представление
{
  "maxDuration": string,
  "softMaxDuration": string,
  "quadraticSoftMaxDuration": string,
  "costPerHourAfterSoftMax": number,
  "costPerSquareHourAfterQuadraticSoftMax": number
}
Поля
maxDuration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

softMaxDuration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

quadraticSoftMaxDuration

string ( Duration format)

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, quadraticSoftMaxDuration must be nonnegative. If maxDuration is also defined, quadraticSoftMaxDuration must be less than maxDuration , and the difference must be no larger than one day:

maxDuration - quadraticSoftMaxDuration <= 86400 seconds

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

costPerHourAfterSoftMax

number

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

  costPerHourAfterSoftMax * (duration - softMaxDuration)

The cost must be nonnegative.

costPerSquareHourAfterQuadraticSoftMax

number

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

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

  costPerSquareHourAfterQuadraticSoftMax *
  (duration - quadraticSoftMaxDuration)^2

The cost must be nonnegative.

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 softMaxMeters and costPerKilometerAboveSoftMax must be defined and be nonnegative.

JSON-представление
{
  "maxMeters": string,
  "softMaxMeters": string,
  "costPerKilometerBelowSoftMax": number,
  "costPerKilometerAboveSoftMax": number
}
Поля
maxMeters

string ( int64 format)

A hard limit constraining the distance to be at most maxMeters. The limit must be nonnegative.

softMaxMeters

string ( int64 format)

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 softMaxMeters must be less than maxMeters and must be nonnegative.

costPerKilometerBelowSoftMax

number

Cost per kilometer incurred, increasing up to softMaxMeters , with formula:

  min(distanceMeters, softMaxMeters) / 1000.0 *
  costPerKilometerBelowSoftMax.

This cost is not supported in routeDistanceLimit .

costPerKilometerAboveSoftMax

number

Cost per kilometer incurred if distance is above softMaxMeters limit. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following:

  (distanceMeters - softMaxMeters) / 1000.0 *
  costPerKilometerAboveSoftMax.

The cost must be nonnegative.

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).
JSON-представление
{
  "breakRequests": [
    {
      object (BreakRequest)
    }
  ],
  "frequencyConstraints": [
    {
      object (FrequencyConstraint)
    }
  ]
}
Поля
breakRequests[]

object ( BreakRequest )

Sequence of breaks. See the BreakRequest message.

frequencyConstraints[]

object ( FrequencyConstraint )

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequest s of this BreakRule . See FrequencyConstraint .

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 ( earliestStartTime / latestStartTime ) may overlap, but they must be compatible with the order (this is checked).

JSON-представление
{
  "earliestStartTime": string,
  "latestStartTime": string,
  "minDuration": string
}
Поля
earliestStartTime

string ( Timestamp format)

Необходимый. Lower bound (inclusive) on the start of the break.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

latestStartTime

string ( Timestamp format)

Необходимый. Upper bound (inclusive) on the start of the break.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

minDuration

string ( Duration format)

Необходимый. Minimum duration of the break. Must be positive.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

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 :

{
   minBreakDuration { seconds: 3600 }         # 1 hour.
   maxInterBreakDuration { 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
JSON representation
{
  "minBreakDuration": string,
  "maxInterBreakDuration": string
}
Поля
minBreakDuration

string ( Duration format)

Необходимый. Minimum break duration for this constraint. Nonnegative. See description of FrequencyConstraint .

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

maxInterBreakDuration

string ( Duration format)

Необходимый. Maximum allowed span of any interval of time in the route that does not include at least partially a break of duration >= minBreakDuration . Must be positive.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

DurationDistanceMatrix

Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations.

JSON representation
{
  "rows": [
    {
      object (Row)
    }
  ],
  "vehicleStartTag": string
}
Поля
rows[]

object ( Row )

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

vehicleStartTag

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

All matrices must have a different vehicleStartTag .

Ряд

Specifies a row of the duration and distance matrix.

JSON representation
{
  "durations": [
    string
  ],
  "meters": [
    number
  ]
}
Поля
durations[]

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

meters[]

number

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 .

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

JSON representation
{
  "srcTag": string,
  "excludedSrcTag": string,
  "dstTag": string,
  "excludedDstTag": string,
  "cost": number,
  "costPerKilometer": number,
  "distanceLimit": {
    object (DistanceLimit)
  },
  "delay": string
}
Поля
srcTag

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 srcTag or does not contain excludedSrcTag (depending on which of these two fields is non-empty).

excludedSrcTag

string

See srcTag . Exactly one of srcTag and excludedSrcTag must be non-empty.

dstTag

string

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

excludedDstTag

string

See dstTag . Exactly one of dstTag and excludedDstTag must be non-empty.

cost

number

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.

costPerKilometer

number

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

object ( DistanceLimit )

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

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

delay

string ( Duration format)

Specifies a delay incurred when performing this transition.

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

ShipmentTypeIncompatibility

Specifies incompatibilties between shipments depending on their shipmentType. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode.

JSON representation
{
  "types": [
    string
  ],
  "incompatibilityMode": enum (IncompatibilityMode)
}
Поля
types[]

string

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

incompatibilityMode

enum ( IncompatibilityMode )

Mode applied to the incompatibility.

IncompatibilityMode

Modes defining how the appearance of incompatible shipments are restricted on the same route.

Перечисления
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 NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY incompatibility mode:

  • If both are pickups only (no deliveries) or deliveries only (no pickups), they cannot share the same vehicle at all.
  • If one of the shipments has a delivery and the other a pickup, the two shipments can share the same vehicle iff the former shipment is delivered before the latter is picked up.

ShipmentTypeRequirement

Specifies requirements between shipments based on their shipmentType. The specifics of the requirement are defined by the requirement mode.

JSON representation
{
  "requiredShipmentTypeAlternatives": [
    string
  ],
  "dependentShipmentTypes": [
    string
  ],
  "requirementMode": enum (RequirementMode)
}
Поля
requiredShipmentTypeAlternatives[]

string

List of alternative shipment types required by the dependentShipmentTypes .

dependentShipmentTypes[]

string

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

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

requirementMode

enum ( RequirementMode )

Mode applied to the requirement.

RequirementMode

Modes defining the appearance of dependent shipments on a route.

Перечисления
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 IN_SAME_VEHICLE_AT_PICKUP_TIME mode, all "dependent" shipments need to have at least one "required" shipment on their vehicle at the time of their pickup.

A "dependent" shipment pickup must therefore have either:

  • A delivery-only "required" shipment delivered on the route after, or
  • A "required" shipment picked up on the route before it, and if the "required" shipment has a delivery, this delivery must be performed after the "dependent" shipment's pickup.
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 .

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

JSON representation
{
  "firstIsDelivery": boolean,
  "secondIsDelivery": boolean,
  "offsetDuration": string,
  "firstIndex": integer,
  "secondIndex": integer
}
Поля
firstIsDelivery

boolean

Indicates if the "first" event is a delivery.

secondIsDelivery

boolean

Indicates if the "second" event is a delivery.

offsetDuration

string ( Duration format)

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

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

firstIndex

integer

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

secondIndex

integer

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