Method: projects.optimizeTours

发送包含 ShipmentModel 的 OptimizeToursRequest,并返回包含 ShipmentRoute 的 OptimizeToursResponse,这是一组由车辆执行的路线,可最大限度地降低总费用。

ShipmentModel 模型主要由需要执行的Shipment和可用于运输Shipment的Vehicle组成。ShipmentRoute 会将 Shipment 分配给 Vehicle。更具体地说,它们会为每辆车分配一系列 Visit,其中 Visit 对应于 VisitRequest,即 Shipment 的取件或送货。

目标是提供 ShipmentRoute 到 Vehicle 的分配,以最大限度地降低总费用,其中费用包含 ShipmentModel 中定义的许多组成部分。

HTTP 请求

POST https://routeoptimization.googleapis.com/v1/{parent=projects/*}:optimizeTours

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。定位项目或位置以进行调用。

格式:

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

不支持区域 {location-id} 值。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "timeout": string,
  "model": {
    object (ShipmentModel)
  },
  "solvingMode": enum (SolvingMode),
  "searchMode": enum (SearchMode),
  "injectedFirstSolutionRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "injectedSolutionConstraint": {
    object (InjectedSolutionConstraint)
  },
  "refreshDetailsRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "interpretInjectedSolutionsUsingLabels": boolean,
  "considerRoadTraffic": boolean,
  "populatePolylines": boolean,
  "populateTransitionPolylines": boolean,
  "allowLargeDeadlineDespiteInterruptionRisk": boolean,
  "useGeodesicDistances": boolean,
  "label": string,
  "geodesicMetersPerSecond": number,
  "maxValidationErrors": integer
}
字段
timeout

string (Duration format)

如果设置了此超时,服务器会在超时期限过去之前或达到同步请求的服务器截止时间之前(以较早者为准)返回响应。

对于异步请求,服务器会在超时之前生成解决方案(如果可能)。

model

object (ShipmentModel)

要求解的配送模型。

solvingMode

enum (SolvingMode)

默认情况下,求解模式为 DEFAULT_SOLVE (0)。

searchMode

enum (SearchMode)

用于解决请求的搜索模式。

injectedFirstSolutionRoutes[]

object (ShipmentRoute)

引导优化算法找到与先前解决方案类似的第一个解决方案。

在构建第一个解决方案时,模型会受到约束。在第一个解决方案中,未在路线上执行的所有配送都会被隐式跳过,但可能会在后续解决方案中执行。

该解决方案必须满足一些基本有效性假设:

  • 对于所有路线,vehicleIndex 必须在范围内且不得重复。
  • 对于所有访问,shipmentIndex 和 visitRequestIndex 必须在范围内。
  • 一个运单只能在一条路线中引用。
  • 必须先执行取货-送货配送的取货,然后才能执行送货。
  • 最多只能执行一次取货替代方案或送货替代方案。
  • 对于所有路线,时间都在增加(即vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime)。
  • 只能在允许的车辆上执行配送。如果 Shipment.allowed_vehicle_indices 为空或其 vehicleIndex 包含在 Shipment.allowed_vehicle_indices 中,则允许车辆。

如果注入的解决方案不可行,则不一定会返回验证错误,而是可能会返回指示不可行的错误。

injectedSolutionConstraint

object (InjectedSolutionConstraint)

限制优化算法,以找到与先前解决方案类似的最终解决方案。例如,这可用于冻结已完成或待完成但不得修改的路线部分。

如果注入的解决方案不可行,则不一定会返回验证错误,而是可能会返回指示不可行的错误。

refreshDetailsRoutes[]

object (ShipmentRoute)

如果此字段不为空,则系统会刷新给定路线,而不会修改其底层经停点顺序或行程时间,仅更新其他详细信息。这并不能求解模型。

自 2020 年 11 月起,此字段仅填充非空路线的多段线,并且要求 populatePolylines 为 true。

传入路线的 routePolyline 字段可能与路线 transitions 不一致。

此字段不得与 injectedFirstSolutionRoutes 或 injectedSolutionConstraint 一起使用。

Shipment.ignore 和 Vehicle.ignore 对行为没有影响。无论相关运单或车辆是否被忽略,系统仍会在所有非空路线中的所有经停点之间填充多段线。

interpretInjectedSolutionsUsingLabels

boolean

如果为 true:

此解释适用于 injectedFirstSolutionRoutes、injectedSolutionConstraint 和 refreshDetailsRoutes 字段。如果请求中的配送或车辆索引自解决方案创建以来发生了变化(可能是因为从请求中移除或添加了配送或车辆),则可以使用此字段。

如果为 true,则以下类别中的标签在其类别中最多只能出现一次:

如果注入的解决方案中的 vehicleLabel 与请求车辆不对应,则系统会从解决方案中移除相应路线及其经停点。如果注入的解决方案中的 shipmentLabel 与请求配送不对应,则系统会从解决方案中移除相应的访问。如果注入的解决方案中的 SkippedShipment.label 与请求配送不对应,则会从解决方案中移除 SkippedShipment。

从注入的解决方案中移除路线访问或整条路线可能会影响隐式约束条件,从而可能导致解决方案发生变化、出现验证错误或不可行。

注意:调用方必须确保每个 Vehicle.label(或 Shipment.label)唯一标识在两个相关请求中使用的车辆(或配送)实体:产生注入解决方案中使用的 OptimizeToursResponse 的过去请求,以及包含注入解决方案的当前请求。上述唯一性检查不足以保证满足此要求。

considerRoadTraffic

boolean

在计算 ShipmentRoute 字段 Transition.travel_duration、Visit.start_time 和 vehicleEndTime、设置 ShipmentRoute.has_traffic_infeasibilities 字段以及计算 OptimizeToursResponse.total_cost 字段时,请考虑流量估算。

populatePolylines

boolean

如果为 true,则多段线将填充到响应 ShipmentRoute 中。

populateTransitionPolylines

boolean

如果为 true,则系统会在响应 ShipmentRoute.transitions 中填充多段线和路线令牌。

allowLargeDeadlineDespiteInterruptionRisk

boolean

如果设置了此字段,则请求的截止时间(请参阅 https://grpc.io/blog/deadlines)最长可达 60 分钟。否则,最长时限仅为 30 分钟。请注意,长时间运行的请求发生中断的风险要大得多(但仍然很小)。

useGeodesicDistances

boolean

如果为 true,系统将使用测地距离(而非 Google 地图距离)计算行程距离,并使用测地距离和 geodesicMetersPerSecond 定义的速度计算行程时间。

label

string

可用于标识此请求的标签,在 OptimizeToursResponse.request_label 中报告。

geodesicMetersPerSecond

number

当 useGeodesicDistances 为 true 时,必须设置此字段,该字段定义了用于计算行程时间的速度。其值必须至少为 1.0 米/秒。

maxValidationErrors

integer

截断返回的验证错误数。这些错误通常作为 BadRequest 错误详细信息 (https://cloud.google.com/apis/design/errors#error_details)) 附加到 INVALID_ARGUMENT 错误载荷,除非 solvingMode=VALIDATE_ONLY:请参阅 OptimizeToursResponse.validation_errors 字段。此值默认为 100,上限为 10,000。

响应正文

如果成功,则响应正文包含一个 OptimizeToursResponse 实例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

IAM 权限

需要拥有 parent 资源的以下 IAM 权限:

  • routeoptimization.locations.use

如需了解详情,请参阅 IAM 文档。