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)

模型的全局开始时间和结束时间：此范围以外的时间都不能视为有效时间。

模型的时间跨度必须少于 1 年，即 globalEndTime 和 globalStartTime 之间的间隔必须在 31536000 秒以内。

使用 cost_per_*hour 字段时，不妨将此时间范围设置为较小的时间间隔以提高性能（例如，如果您针对一天进行建模，则应将全局时间限制设置为当天）。如果未设置，系统将使用 1970 年 1 月 1 日 00:00:00 世界协调时间 (UTC)（即秒数：0，纳米：0）作为默认值。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
globalEndTime

string (Timestamp format)

如果未设置，系统将使用世界协调时间 (UTC) 1971 年 1 月 1 日 00:00:00（即秒数：31536000，纳米：0）作为默认值。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
globalDurationCostPerHour

number

“全局持续时间”是指所有车辆的最早有效开始时间与最晚有效结束时间之间的差值。例如，用户可以为此数量指定每小时费用，以尝试进行优化，以便尽早完成作业。此费用必须与Shipment.penalty_cost使用同一个单位。
durationDistanceMatrices[]

object (DurationDistanceMatrix)

指定模型中使用的时长和距离矩阵。如果此字段为空，则会根据 useGeodesicDistances 字段的值，改用 Google 地图距离或测地距离。如果不为空，则 useGeodesicDistances 不为 true，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) 标记的访问到矩阵 i 中带有 durationDistanceMatrixDstTags(k) 标记的访问的行程时长（代表距离）。

标记对应于 VisitRequest.tags 或 Vehicle.start_tags。指定的 VisitRequest 或 Vehicle 必须与此字段中的一个标记完全匹配。请注意，Vehicle 的源标记、目标标记和矩阵标记可能相同；同样，VisitRequest 的源标记和目标标记可能相同。所有标签不得相同，且不能为空字符串。如果此字段不为空，则 durationDistanceMatrices 不得为空。
transitionAttributes[]

object (TransitionAttributes)

添加到模型的过渡属性。
shipmentTypeIncompatibilities[]

object (ShipmentTypeIncompatibility)

不兼容的 shipping_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))

加载货物需求信息（例如重量、体积、托盘数量等）。映射中的键应该是描述相应加载类型的标识符，最好也包括单位。例如：“weight_kg”“volume_gallons”“pallet_count”等。如果给定键未出现在映射中，则相应的加载会被视为 null。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
allowedVehicleIndices[]

integer

可以履行此运单的一组车辆。如果留空，所有车辆都可以执行此操作。车辆由其在 ShipmentModel 的 vehicles 列表中的索引指定。
costsPerVehicle[]

number

指定每辆车交付此运单时产生的费用。如果指定，它必须具有以下 EITHER：

  • 元素数量与 costsPerVehicleIndices 相同。costsPerVehicle[i] 对应于模型的车辆 costsPerVehicleIndices[i]。
  • 元素数量与模型中车辆数量相同。第 i-th 元素对应于模型的第 #i 辆车。

这些费用的单位必须与“penaltyCost”相同，且不得为负数。如果没有此类费用，请将此字段留空。
costsPerVehicleIndices[]

integer

costsPerVehicle 所适用的车辆的索引。如果非空，则其元素数量必须与 costsPerVehicle 相同。一个车辆索引只能指定一次。如果某个车辆已从 costsPerVehicleIndices 中排除，则其费用为零。
pickupToDeliveryAbsoluteDetourLimit

string (Duration format)

指定与从自提到送餐的最短路径相比的最长绝对绕行时间。如果指定，则必须为非负数，并且运单中必须至少包含自提和送货信息。

例如，可以是从所选的自提备选方案直接到所选的备选配送方式所需的最短时间。然后，设置 pickupToDeliveryAbsoluteDetourLimit 会强制执行：

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

如果为同一批商品同时指定了相对限制和绝对限制，系统会对每个可能的自提/送货对使用更具限制性的限制。从 2017 年 10 月 10 日开始，仅当行程时长不取决于车辆时才支持绕行。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
pickupToDeliveryTimeLimit

string (Duration format)

指定从开始自提到开始配送的最长时长。如果指定，则必须为非负数，并且运单中必须至少包含自提和送货信息。这既不取决于为自提和配送选择的替代选项，也不取决于车辆速度。这可以与最大绕行约束条件一起指定：解决方案将同时遵循这两种规范。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
shipmentType

string

指定“类型”的非空字符串。此功能可用于定义 shipment_types 之间的不兼容性或要求（请参阅 ShipmentModel 中的 shipmentTypeIncompatibilities 和 shipmentTypeRequirements）。

与为单次访问指定的 visitTypes 不同：属于同一运单的所有自取/配送都共用同一个 shipmentType。
label

string

指定此运单的标签。此标签会在相应 ShipmentRoute.Visit 的 shipmentLabel 的响应中报告。
ignore

boolean

如果为 true，则跳过此运单，但不应用 penaltyCost。

如果模型中存在任何 shipmentTypeRequirements，忽略运单会导致验证错误。

允许忽略在 injectedFirstSolutionRoutes 或 injectedSolutionConstraint 中执行的配送；求解器会从执行路线中移除相关的自提/送货访问信息。引用已忽略的运单的precedenceRules也会被忽略。
penaltyCost

number

如果未能完成运输，则此处罚将添加到路线的总费用中。如果使用了某个自提和配送备选方式，则视为配送已完成。费用可以用用于模型中所有其他费用相关字段的相同单位表示，并且必须为正值。

重要提示：如果未指定此处罚，则会被视为无限期，即必须完成发货。
pickupToDeliveryRelativeDetourLimit

number

指定与从自提到送餐的最短路径相比的最长相对绕行时间。如果指定，则必须为非负数，并且运单中必须至少包含自提和送货信息。

例如，可以是从所选的自提备选方案直接到所选的备选配送方式所需的最短时间。然后，设置 pickupToDeliveryRelativeDetourLimit 会强制执行：

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

如果为同一批商品同时指定了相对限制和绝对限制，系统会对每个可能的自提/送货对使用更具限制性的限制。从 2017 年 10 月 10 日开始，仅当行程时长不取决于车辆时才支持绕行。

VisitRequest

可通过车辆完成的上门服务请求：请求具有地理位置（或两个，见下文）、开始和结束时间（以时间窗口表示）和服务持续时间（车辆在抵达取货或还车时所花的时间）。

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 指定标签。在响应中，此标签会在相应 ShipmentRoute.Visit 中报告为 visitLabel。

LatLng

表示纬度/经度对的对象。该对象以一对双精度数表示，分别代表纬度度数和经度度数。除非另有说明，否则该对象必须符合 WGS84 标准。值必须介于标准化范围内。

JSON 表示法 
{
  "latitude": number,
  "longitude": number
}
字段
latitude

number

纬度（以度为单位）。它必须在 [-90.0, +90.0] 范围内。
longitude

number

经度（以度为单位）。它必须在 [-180.0, +180.0] 范围内。

关键点

封装航点。航点用于标记 VisitRequest 的到达和出发位置，以及车辆的起点和终点。

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。

位置

封装位置（地理点和可选标题）。

JSON 表示法 
{
  "latLng": {
    object (LatLng)
  },
  "heading": integer
}
字段
latLng

object (LatLng)

航点的地理坐标。
heading

integer

与交通流动方向相关联的罗盘航向。此值用于指定上车点和下车点的公路一侧。方位值的范围为 0 到 360，其中 0 指定正北方位，90 指定正北方方向，依此类推。

TimeWindow

时间窗口用于限制事件的时间，例如到达时间或车辆的开始时间和结束时间。

硬性时间范围边界（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` <= `softStartTime` <= `endTime` and
  0 <= `startTime` <= `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),
  "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。
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 中报告的距离，而不适用于从单个 VisitRequest 的 arrivalLocation 到 departureLocation 隐式传输的任何距离。
fixedCost

number

如果此车辆用于处理运单，则会收取固定费用。
usedIfRouteIsEmpty

boolean

此字段仅适用于相应车辆路线不提供任何运单的车辆。用于指明在这种情况下是否应将车辆视为二手。

如果为 true，则即使车辆不提供任何装运，也会从起点到终点位置，以及从起点开始产生的时间和距离成本 -->包括结束旅行

否则，它不会从出发位置前往目的地，并且没有为此车辆安排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 之外的时间。如果指定了 costPerHour，这种额外的访问持续时间会增加费用。键（即 visitTypes）不能为空字符串。

如果访问请求有多种类型，系统会为地图中的每种类型分别添加一个时长。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
breakRule

object (BreakRule)

说明要在这辆车上强制执行的休息时间表。如果留空，系统不会为此车辆安排任何休息时间。
label

string

指定此车辆的标签。此标签会在响应中报告为相应 ShipmentRoute 的 vehicleLabel。
ignore

boolean

如果设为 true，usedIfRouteIsEmpty 必须为 false，这辆车将保持未使用状态。

如果配送由 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 出行方式的一部分，详见：https://developers.google.com/maps/documentation/routes_preferred/reference/rest/Shared.Types/RouteTravelMode。

枚举
TRAVEL_MODE_UNSPECIFIED 未指定的出行方式，相当于DRIVING。
DRIVING 与行车路线相对应的出行方式（汽车...）。
WALKING 与步行路线对应的出行方式。

UnloadingPolicy

关于如何卸载车辆的政策。仅适用于同时提供取货和送货服务的货品。

其他运输服务可以在运输途中的任何地方免费送货，不受unloadingPolicy的影响。

枚举
UNLOADING_POLICY_UNSPECIFIED 未指定的卸载政策；送货必须刚好在其相应自取之后。
LAST_IN_FIRST_OUT 送货顺序必须与取货顺序相反
FIRST_IN_FIRST_OUT 送货顺序必须与取货顺序相同

LoadLimit

定义适用于车辆的负载限制，例如“这辆卡车最多只能载重 3500 千克”。请参阅 loadLimits。

JSON 表示法 
{
  "softMaxLoad": string,
  "costPerUnitAboveSoftMax": number,
  "startLoadInterval": {
    object (Interval)
  },
  "endLoadInterval": {
    object (Interval)
  },
  "maxLoad": string
}
字段
softMaxLoad

string (int64 format)

负载的软性限制。请参阅 costPerUnitAboveSoftMax。
costPerUnitAboveSoftMax

number

如果车辆沿这辆车路线的负载超过 softMaxLoad，则适用以下费用罚款（每辆车只能收费一次）：(负载 - 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。

DurationLimit

定义车辆路线的最大时长的限制。它可以是硬性质的，也可以是软的。

定义软性限制字段后，必须同时定义软最大阈值及其相关费用。

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

费用必须是非负数。

DistanceLimit

定义可行驶的最大距离的限制。它可以是硬性质的，也可以是软的。

如果定义了软性限制，则必须将 softMaxMeters 和 costPerKilometerAboveSoftMax 都定义为非负数。

JSON 表示法 
{
  "maxMeters": string,
  "softMaxMeters": string,
  "costPerKilometerAboveSoftMax": number
}
字段
maxMeters

string (int64 format)

将距离限制为不超过 maxMeters 的硬性限制。上限必须是非负数。
softMaxMeters

string (int64 format)

不强制执行最大距离限制的软性限制，但如果违反，则产生的费用将与模型中定义的其他费用相加，且单位相同。

如果定义的 softMaxMeters 必须小于 maxMeters，则必须为非负数。
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。它们必须都满足此 BreakRule 的 BreakRequest。请参阅 FrequencyConstraint。

BreakRequest

您必须事先知道适用于每辆车的插播时间点顺序（即其数量和顺序）。重复的 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"。

FrequencyConstraint

可以通过强制设定最小广告插播频率（例如“每 12 小时至少有 1 小时的广告插播时间”），进一步限制上述广告插播的频率和时长。假设这可解释为“在 12 小时的任何滑动时间段内，必须至少有一次休息时间至少一小时”，该示例可转换为以下 FrequencyConstraint：

{
   minBreakDuration { seconds: 3600 }         # 1 hour.
   maxInterBreakDuration { seconds: 39600 }  # 11 hours (12 - 1 = 11).
}

除了 BreakRequest 中已指定的时间范围和最短时长之外，解决方案中插播时间点的时间和时长将遵循所有此类约束条件。

在实践中，FrequencyConstraint 可能适用于不连续的插播时间点。例如，以下时间表将遵循“每 12 小时 1 小时”这一设置示例：

  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 可能会应用于同一转换：在这种情况下，所有额外费用都会累加，并应用最严格的限制条件或限制（遵循自然的“AND”语义）。

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

object (DistanceLimit)

指定执行此转场时移动的距离限制。

自 2021 年 6 月起，仅支持软性限额。
delay

string (Duration format)

指定执行此过渡时产生的延迟。

这种延迟总是发生在完成来源访问之后和开始目标访问之前。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。

ShipmentTypeIncompatibility

根据 shippingType 指定运单之间的不兼容情况。由于不兼容模式，同一航线上出现不兼容的运单会受到限制。

JSON 表示法 
{
  "types": [
    string
  ],
  "incompatibilityMode": enum (IncompatibilityMode)
}
字段
types[]

string

不兼容的类型列表。列出的 shipment_types 不同的两件运单是“不兼容”的。
incompatibilityMode

enum (IncompatibilityMode)

应用于不兼容的模式。

IncompatibilityMode

定义如何在同一条航线上限制出现不相容运单的情况。

枚举
INCOMPATIBILITY_MODE_UNSPECIFIED 未指定的不兼容模式。不应使用此值。
NOT_PERFORMED_BY_SAME_VEHICLE 在此模式下，类型不兼容的两件货品绝不能共用同一辆车。
NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY

对于类型不兼容且NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY不兼容的两件货品：

  • 如果两者均为仅自提（不送货）或仅送货（不自提），则两人不能共用同一辆车。
  • 如果其中一批货物已送达，而另一批货物为取货商品，且前一批货物在其取件前送达，则这两批货物可以共用同一辆车。

ShipmentTypeRequirement

根据 shippingType 指定运单之间的要求。具体要求由要求模式定义。

JSON 表示法 
{
  "requiredShipmentTypeAlternatives": [
    string
  ],
  "dependentShipmentTypes": [
    string
  ],
  "requirementMode": enum (RequirementMode)
}
字段
requiredShipmentTypeAlternatives[]

string

dependentShipmentTypes要求的备选运单类型的列表。
dependentShipmentTypes[]

string

对于所有属于“dependentShipmentTypes”字段的运单，同一条航线上必须有至少 1 个类型为 requiredShipmentTypeAlternatives 的运单。

注意：不允许使用导致 shipmentType 依赖于自身的要求链。
requirementMode

enum (RequirementMode)

应用于要求的模式。

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 与之前相同，但“从属项”除外需要有一个“必需”在交付时为其发货。

PrecedenceRule

两个事件（每个事件都是自提或送货上门）之间的优先规则：第二个事件活动必须在“first”（第一个）之后至少 offsetDuration开始已开始。

多个优先级可以指代相同（或相关）的事件，例如，“在商品 A 送达后提货 B”和“C 的提货发生在 B 的提货之后”。

此外，优先级仅在两批配送均执行时适用，否则会被忽略。

JSON 表示法 
{
  "firstIsDelivery": boolean,
  "secondIsDelivery": boolean,
  "offsetDuration": string,
  "firstIndex": integer,
  "secondIndex": integer
}
字段
firstIsDelivery

boolean

指明其是否为“第一个”事件是交付事件。
secondIsDelivery

boolean

指示“第二个”事件是交付事件。
offsetDuration

string (Duration format)

“第一个”和“second”事件。它可以为负值。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
firstIndex

integer

“第一个”的发货索引事件。必须指定此字段。
secondIndex

integer

“秒”的装运索引事件。必须指定此字段。