Method: projects.locations.optimizeTours

ShipmentModel を含む OptimizeToursRequest を送信し、ShipmentRoute を含む OptimizeToursResponse を返します。ShipmentRoute は、車両が実行するルートのセットであり、総費用を最小限に抑えます。

ShipmentModel モデルは主に、実行が必要な Shipment と、Shipment の転送に使用できる Vehicle で構成されています。ShipmentRouteShipmentVehicle に割り当てます。具体的には、一連の Visit を各車両に割り当てます。VisitVisitRequestShipment の集荷または配達)に対応します。

目標は、ShipmentModel で定義されている多くのコンポーネントを含む費用の総費用を最小限に抑えるように、ShipmentRouteVehicle に割り当てることです。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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)

このタイムアウトが設定されている場合、サーバーは、タイムアウト期間か同期リクエストのサーバー期限のどちらか早いほうでレスポンスを返します。

非同期リクエストの場合、サーバーはタイムアウトが切れる前に(可能であれば)ソリューションを生成します。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

model

object (ShipmentModel)

解決する配送モデル。

solvingMode

enum (SolvingMode)

デフォルトでは、解法モードは DEFAULT_SOLVE(0)です。

searchMode

enum (SearchMode)

リクエストの解決に使用された検索モード。

injectedFirstSolutionRoutes[]

object (ShipmentRoute)

以前のソリューションに類似した最初のソリューションを見つけるように最適化アルゴリズムをガイドします。

最初のソリューションを構築する際には、モデルに制約が課されます。ルートで実行されない配送は、最初のソリューションで暗黙的にスキップされますが、後続のソリューションで実行される場合があります。

ソリューションは、次の基本的な有効性前提を満たす必要があります。

  • すべてのルートで、vehicleIndex は範囲内にあり、重複していない必要があります。
  • すべての訪問で、shipmentIndexvisitRequestIndex が範囲内にある必要があります。
  • 配送は 1 つのルートでのみ参照できます。
  • 受け取り、配達の集荷は配達前に行う必要があります。
  • 1 つの配送について、複数の受け取りまたは配送の代替を行うことはできない。
  • すべてのルートで所要時間が増加(vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime)。
  • 許可された車両でしか発送できない場合。Shipment.allowed_vehicle_indices が空であるか、その vehicleIndexShipment.allowed_vehicle_indices に含まれている場合、車両は許可されます。

挿入されたソリューションが実行可能でない場合、検証エラーが返されるとは限らず、実行不可を示すエラーが返される場合があります。

injectedSolutionConstraint

object (InjectedSolutionConstraint)

最適化アルゴリズムを制約して、以前の解に似た最終解を見つけます。たとえば、すでに完了しているルートや、完了する予定だが変更してはならないルートの一部をフリーズできます。

挿入された解が実行不可能な場合、必ずしも検証エラーが返されるとは限らず、代わりに実行可能性を示すエラーが返されることがあります。

refreshDetailsRoutes[]

object (ShipmentRoute)

空でない場合、指定されたルートは更新されますが、訪問の順序や所要時間は変更されません。他の詳細のみが更新されます。これではモデルが解決されません。

2020/11 の時点では、空でないルートのポリラインにのみデータが入力され、populatePolylines が true である必要があります。

渡されたルートの routePolyline フィールドがルート transitions と一致しない可能性があります。

このフィールドを injectedFirstSolutionRoutes または injectedSolutionConstraint と併用することはできません。

Shipment.ignoreVehicle.ignore は動作に影響しません。配送や車両が無視されるかどうかにかかわらず、空でないすべての経路のすべての訪問時にはポリラインが入力されます。

interpretInjectedSolutionsUsingLabels

boolean

true の場合:

この解釈は、injectedFirstSolutionRoutesinjectedSolutionConstraintrefreshDetailsRoutes フィールドに適用されます。ソリューションの作成後にリクエストの出荷数または車両のインデックスが変更された場合に使用できます。たとえば、出荷または車両がリクエストから削除または追加された場合などです。

true の場合、次のカテゴリのラベルは、カテゴリ内で 1 回だけ表示する必要があります。

挿入されたソリューションの vehicleLabel がリクエスト ベクターに対応していない場合、対応するルートは訪問とともにソリューションから削除されます。挿入されたソリューションの shipmentLabel がリクエスト配送に対応していない場合、対応する訪問はソリューションから削除されます。挿入されたソリューションの SkippedShipment.label がリクエストされた配送に一致しない場合、SkippedShipment はソリューションから削除されます。

挿入されたソリューションからルートの訪問またはルート全体を削除すると、暗黙的な制約に影響し、ソリューションの変更、検証エラー、実現不能につながる可能性があります。

注: 呼び出し元は、各 Vehicle.label(またはShipment.label)は、関連する 2 つのリクエスト(挿入されたソリューションで使用される OptimizeToursResponse を生成する過去のリクエストと、挿入されたソリューションが含まれる現在のリクエスト)で使用される車両(または配送)エンティティを一意に識別します。上記の一意性チェックは、この要件を保証するには不十分です。

considerRoadTraffic

boolean

ShipmentRoute フィールドの Transition.travel_durationVisit.start_timevehicleEndTime の計算、ShipmentRoute.has_traffic_infeasibilities フィールドの設定、OptimizeToursResponse.total_cost フィールドの計算では、トラフィックの見積もりを考慮します。

populatePolylines

boolean

true の場合、レスポンスの ShipmentRoute にポリラインが入力されます。

populateTransitionPolylines

boolean

true の場合、レスポンス ShipmentRoute.transitions にポリラインとルート トークンが入力されます。

allowLargeDeadlineDespiteInterruptionRisk

boolean

これが設定されている場合、リクエストに最大 60 分の期限(https://grpc.io/blog/deadlines を参照)を設定できます。それ以外の場合、最大期限は 30 分です。なお、長時間実行されるリクエストは、中断されるリスクが大幅に高くなります(それでも低いリスクです)。

useGeodesicDistances

boolean

true の場合、移動距離は Google マップの距離ではなく測地線距離を使用して計算され、移動時間は geodesicMetersPerSecond で定義された速度で測地線距離を使用して計算されます。

label

string

このリクエストを識別するために使用できるラベル。OptimizeToursResponse.request_label で報告されます。

geodesicMetersPerSecond

number

useGeodesicDistances が true の場合、このフィールドを設定する必要があります。このフィールドには、所要時間の計算に適用される速度を定義します。1.0 m/秒以上である必要があります。

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

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • routeoptimization.locations.use

詳細については、IAM のドキュメントをご覧ください。