Route Optimization API は、対応するリクエスト内の車両のルートを返します。配送は車両に割り当てられますが、リクエストのプロパティによってはスキップされることもあります。
OptimizeToursResponse メッセージ（REST、gRPC）には、主に 2 つのトップレベル プロパティがあります。
routes[]は、割り当てられた配送がある各車両のルートです。各Routeには、その個々のルートのプロパティを反映した指標が含まれています。metricsは、すべての車両とルートプランにわたるレスポンス全体の集計指標です。トップレベルの指標には、ルートごとの指標と同じプロパティが含まれ、値はすべてのルートで集計されます。
一部のプロパティは、最適化結果によっては入力されないことがあります。
skippedShipments[]には、どの車両でも行われていない配送が表示されます。指定された制約内で実行できない場合や、配送の費用がペナルティ費用を超える場合は、配送をスキップできます。たとえば、荷物の集荷または配達のtimeWindowが非常に狭い場合、車両が必要な時間枠内に訪問することが不可能または費用対効果が低い場合があります。validationErrors[]には、リクエストのsolvingModeがVALIDATE_ONLYに設定されている場合に、リクエストを無効にするか解決できないエラーを指定します。通常のDEFAULT_SOLVEモードでは、検証エラーはレスポンス本文ではなくエラー メッセージに表示されます。VALIDATE_ONLY解決モードでは複数のエラーを一度に報告できます。これは、リクエストをすばやくデバッグする場合に便利です。
ルートのプロパティ
各 routes[] エントリは ShipmentRoute メッセージ（REST、gRPC）です。各 ShipmentRoute は、リクエストの特定の車両のルート割り当てを表します。対応する Vehicle に関連する重要な ShipmentRoute プロパティには、次のようなものがあります。
vehicleIndexは、対応するリクエスト メッセージのVehicleのゼロベースのインデックスです。REST レスポンスでは、値がゼロの場合、このプロパティは省略されます。vehicleStartTimeは、車両がルートを開始する時刻です。vehicleEndTimeは、車両がルートを完了する予定時刻です。
レスポンスでの routes は次のようになります。
{
"routes": [
{
"vehicleStartTime": "2024-02-13T00:00:00Z",
"vehicleEndTime": "2024-02-13T00:38:42Z",
"visits": [
...
],
"transitions": [
...
],
"metrics": {
...
},
...
}
],
...
}
各 ShipmentRoute には、車両が完了する visits の順序付きリストが含まれています。各 Visit（REST、gRPC）は、対応するリクエストの VisitRequest（REST、gRPC）を表します。重要な Visit プロパティは次のとおりです。
shipmentIndexは、対応するリクエストでこのアクセスが属する配送の 0 ベースのインデックスです。isPickupは、訪問が集荷の場合は true、訪問が配達の場合は false です。REST レスポンスでは、値が false の場合、このプロパティは省略されます。visitRequestIndexは、Visitが表す対応するリクエストのShipment.pickupsまたはShipment.deliveriesのVisitRequestのゼロベースのインデックスです。REST レスポンスでは、値がゼロの場合、このプロパティは省略されます。startTimeは、訪問が開始される予定の時刻です。loadDemandsは、Visitの完了に必要な負荷量に負荷タイプをマッピングします。配達訪問では積載量が負の値になり、車両から積荷が取り除かれていることを表します。
Visit の例を次に示します。
{
"routes": [
{
...
"visits": [
{
"isPickup": true,
"startTime": "2024-02-13T00:00:00Z",
"detour": "0s"
},
...
],
},
...
],
...
}
各 ShipmentRoute には、特定の車両の visits 間の移動を表す transitions の順序付きリストが含まれています。重要な Transition メッセージ（REST、gRPC）のプロパティには次のものがあります。
startTimeは、車両が遷移を開始する時刻です。travelDurationは、移行を完了するために車両が移動する必要がある時間です。travelDistanceMetersは、切り替えを完了するために車両が移動する必要がある距離（メートル単位）です。trafficInfoUnavailableは、遷移にトラフィック データが使用可能かどうかを示します。waitDurationは、次のVisitを開始するまで車両が待機しているアイドル時間を表します。これは、次のVisitのstart_timeが原因で発生する可能性があります。totalDurationは、移動、待ち時間、休憩、遅延時間を含む移行の合計時間です。vehicleLoadsは、この遷移中に車両が運ぶ荷物の種類と荷物の量をマッピングします。
Transition の例を次に示します。
{
"routes": [
{
...
"transitions": [
...
{
"travelDuration": "1171s",
"travelDistanceMeters": 9004,
"waitDuration": "0s",
"totalDuration": "1171s",
"startTime": "2024-02-13T00:00:00Z"
},
...
],
...
}
],
...
}
vists と transitions の関係について詳しくは、集荷と配達の停留所の注文の最適化と ShipmentRoute リファレンス ドキュメント（REST、gRPC）をご覧ください。Transition メッセージの routePolyline プロパティと routeToken プロパティの詳細については、遷移ポリラインとルートトークンをご覧ください。
指標プロパティ
Metrics メッセージ（REST、gRPC）には、ソリューション全体の概要が示されます。重要な Metrics プロパティには次のようなものがあります。
totalCostは、ルートを完了するために発生した合計費用です。費用の詳細については、費用モデル パラメータをご覧ください。usedVehicleCountは、ソリューションで使用される車両の合計数です。オプティマイザーがルートの使用が不要と判断した場合、車両に空のルートが設定されることがあります。skippedMandatoryShipmentCountは、「必須」のスキップされた配送の数です。必須配送では、配送がスキップされた場合に発生するpenaltyCostは指定されません。指定された制約で実行できない場合は、必須の配送をスキップできます。費用の詳細については、費用モデル パラメータをご覧ください。
その他の指標は、AggregatedMetrics メッセージ（REST、gRPC）として報告されます。AggregatedMetrics メッセージ タイプは Metrics.aggregatedRouteMetrics プロパティと ShipmentRoute.metrics プロパティに使用されます。Metrics.aggregatedRouteMetrics には、OptimizeToursResponse 内のすべての ShipmentRoute で集計された指標が含まれます。各 ShipmentRoute.metrics プロパティには、その特定の ShipmentRoute の指標が含まれています。
重要な AggregatedMetrics プロパティは次のとおりです。
performedShipmentCountは、車両がルート全体で行った配送の数です。travelDurationは、車両がルートを完了する際に移動に費やす合計時間です。waitDurationは、車両がルートを完了する際に待機する合計時間です。delayDurationは、車両の遅延時間の合計です。通常、リクエストでTransitionAttributesが使用されていない限り、ゼロです。breakDurationは、車両がルートを完了する際に休憩に費やす合計時間です。visitDurationは、車両がルートを完了する際に訪問に費やす合計時間です。これは、該当する車両に割り当てられたVisitに対応するVisitRequestのすべてのVisitRequest.duration値の合計です。totalDurationは、車両のルートを完了するために必要な合計時間です。travelDistanceMetersは、ルートを完了する際に車両が走行した合計距離です。maxLoadsは、ルートの任意の時点で車両が運ぶ最大積載量に荷物の種類をマッピングします。
Metrics メッセージの例を次に示します。
{
"routes": [
...
],
"metrics": {
"aggregatedRouteMetrics": {
"performedShipmentCount": 1,
"travelDuration": "2322s",
"waitDuration": "0s",
"delayDuration": "0s",
"breakDuration": "0s",
"visitDuration": "0s",
"totalDuration": "2322s",
"travelDistanceMeters": 18603
},
"usedVehicleCount": 1,
"earliestVehicleStartTime": "2024-02-13T00:00:00Z",
"latestVehicleEndTime": "2024-02-13T00:38:42Z",
"totalCost": 18.603,
"costs": {
"model.vehicles.cost_per_kilometer": 18.603
}
}
}
サンプルコードの全文
リクエストを作成するのリクエストの完全なレスポンスの例を次に示します。
{
"routes": [
{
"vehicleStartTime": "2024-02-13T00:00:00Z",
"vehicleEndTime": "2024-02-13T00:38:42Z",
"visits": [
{
"isPickup": true,
"startTime": "2024-02-13T00:00:00Z",
"detour": "0s"
},
{
"startTime": "2024-02-13T00:19:31Z",
"detour": "0s"
}
],
"transitions": [
{
"travelDuration": "0s",
"waitDuration": "0s",
"totalDuration": "0s",
"startTime": "2024-02-13T00:00:00Z"
},
{
"travelDuration": "1171s",
"travelDistanceMeters": 9004,
"waitDuration": "0s",
"totalDuration": "1171s",
"startTime": "2024-02-13T00:00:00Z"
},
{
"travelDuration": "1151s",
"travelDistanceMeters": 9599,
"waitDuration": "0s",
"totalDuration": "1151s",
"startTime": "2024-02-13T00:19:31Z"
}
],
"metrics": {
"performedShipmentCount": 1,
"travelDuration": "2322s",
"waitDuration": "0s",
"delayDuration": "0s",
"breakDuration": "0s",
"visitDuration": "0s",
"totalDuration": "2322s",
"travelDistanceMeters": 18603
},
"routeCosts": {
"model.vehicles.cost_per_kilometer": 18.603
},
"routeTotalCost": 18.603
}
],
"metrics": {
"aggregatedRouteMetrics": {
"performedShipmentCount": 1,
"travelDuration": "2322s",
"waitDuration": "0s",
"delayDuration": "0s",
"breakDuration": "0s",
"visitDuration": "0s",
"totalDuration": "2322s",
"travelDistanceMeters": 18603
},
"usedVehicleCount": 1,
"earliestVehicleStartTime": "2024-02-13T00:00:00Z",
"latestVehicleEndTime": "2024-02-13T00:38:42Z",
"totalCost": 18.603,
"costs": {
"model.vehicles.cost_per_kilometer": 18.603
}
}
}