此页面由 Cloud Translation API 翻译。

Method: projects.optimizeTours

HTTP 请求
路径参数
请求正文
- JSON 表示法
响应正文
授权范围

发送包含 ShipmentModel 的 OptimizeToursRequest，并返回包含 ShipmentRoute 的 OptimizeToursResponse，后者是车辆要执行的一组路线，旨在最大限度降低总费用。

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

目标是为 Vehicle 分配 ShipmentRoute，以最大限度降低在费用在 ShipmentModel 中定义许多组成部分的情况下的总费用。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数

参数
`parent`	`string` 必需。拨打电话的目标项目或位置。格式：* `projects/{project-id}` * `projects/{project-id}/locations/{location-id}` 如果未指定位置，系统会自动选择区域。

parent

string

必需。拨打电话的目标项目或位置。

格式：* projects/{project-id} * projects/{project-id}/locations/{location-id}

如果未指定位置，系统会自动选择区域。

请求正文

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

JSON 表示法

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,
  "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)` 如果设置了超时，服务器将在超时期限已过或同步请求所达到的服务器截止时间之前返回响应，以较早达到者为准。对于异步请求，服务器将在超时过去之前生成解决方案（如果可能）。此时长以秒为单位，最多包含九个小数位，以“`s`”结尾。示例：`"3.5s"`。
`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：使用 `ShipmentRoute.vehicle_label`（而非 `vehicleIndex`）将注入解决方案中的路线与请求中的车辆进行匹配；重复使用原始 `ShipmentRoute.vehicle_index` 到新 `ShipmentRoute.vehicle_index` 的映射以更新 `ConstraintRelaxation.vehicle_indices`（如果非空），但映射必须明确（即多个 `ShipmentRoute` 不得共用同一个原始 `vehicleIndex`）。使用 `ShipmentRoute.Visit.shipment_label`（而非 `shipmentIndex`）将注入的解决方案中的访问与请求中的运单进行匹配；使用 `SkippedShipment.label`（而非 `SkippedShipment.index`）将注入的解决方案中跳过的运单与请求发货匹配。此解释适用于 `injectedFirstSolutionRoutes`、`injectedSolutionConstraint` 和 `refreshDetailsRoutes` 字段。如果请求中的运单或车辆索引在解决方案创建后发生了变化（这可能是因为发货或车辆已从请求中移除或添加到请求中），则可以使用此索引。如果为 true，则以下类别的标签在其类别中最多只能出现一次： `Vehicle.label`； `Shipment.label`；注入的解决方案为 `ShipmentRoute.vehicle_label`；注入的解决方案中的 `SkippedShipment.label` 和 `ShipmentRoute.Visit.shipment_label`（取货/送货上门对除外，其 `shipmentLabel` 必须出现两次）。如果注入的解决方案中的 `vehicleLabel` 与请求的车辆不对应，则相应的路线及其访问将从解决方案中移除。如果注入的解决方案中的 `shipmentLabel` 与发货请求不对应，则系统会从解决方案中移除相应的访问。如果注入的解决方案中的 `SkippedShipment.label` 与发货请求不对应，则系统会从解决方案中移除 `SkippedShipment`。从注入的解决方案中移除路线造访记录或整个路线可能会影响隐含的约束条件，进而可能导致解决方案发生变化、验证错误或不可行。注意：调用方必须确保每个 `Vehicle.label` (resp. `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 错误载荷中，除非 resolveMode=VALIDATE_ONLY：请参阅 `OptimizeToursResponse.validation_errors` 字段。默认值为 100，上限为 10,000。

响应正文

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

授权范围

需要以下 OAuth 作用域：

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