ShipmentRoute

車両のルートは、次のように時間軸に沿って分解できます（訪問が n 回あると仮定します）。

  |            |            |          |       |  T[2], |        |      |
  | Transition |  Visit #0  |          |       |  V[2], |        |      |
  |     #0     |    aka     |   T[1]   |  V[1] |  ...   | V[n-1] | T[n] |
  |  aka T[0]  |    V[0]    |          |       | V[n-2],|        |      |
  |            |            |          |       | T[n-1] |        |      |
  ^            ^            ^          ^       ^        ^        ^      ^
vehicle    V[0].start   V[0].end     V[1].   V[1].    V[n].    V[n]. vehicle
 start     (arrival)   (departure)   start   end      start    end     end

次の 2 点は区別されます。

  • 車両の始点と終点、各訪問の始点と終点（到着と出発）などの「定刻イベント」。特定の瞬間に発生します。
  • 訪問そのものや、訪問間の移行などの「時間間隔」。時間間隔の期間がゼロになる（開始と終了を同じ秒にするなど）場合もありますが、多くの場合、継続時間は正になります。

不変条件:

  • 訪問が n 回ある場合、n+1 回の遷移があります。
  • 訪問は常に、その前の遷移（同じインデックス）とその後の遷移（インデックス + 1）に囲まれています。
  • 車両の始動には常にトランジション #0 が続きます。
  • 車両の終了には常に遷移 #n が先行します。

ズームインすると、Transition と Visit の間に以下のことが起こります。

---+-------------------------------------+-----------------------------+-->
   |           TRANSITION[i]             |           VISIT[i]          |
   |                                     |                             |
   |  * TRAVEL: the vehicle moves from   |      PERFORM the visit:     |
   |    VISIT[i-1].departure_location to |                             |
   |    VISIT[i].arrival_location, which |  * Spend some time:         |
   |    takes a given travel duration    |    the "visit duration".    |
   |    and distance                     |                             |
   |                                     |  * Load or unload           |
   |  * BREAKS: the driver may have      |    some quantities from the |
   |    breaks (e.g. lunch break).       |    vehicle: the "demand".   |
   |                                     |                             |
   |  * WAIT: the driver/vehicle does    |                             |
   |    nothing. This can happen for     |                             |
   |    many reasons, for example when   |                             |
   |    the vehicle reaches the next     |                             |
   |    event's destination before the   |                             |
   |    start of its time window         |                             |
   |                                     |                             |
   |  * DELAY: *right before* the next   |                             |
   |    arrival. E.g. the vehicle and/or |                             |
   |    driver spends time unloading.    |                             |
   |                                     |                             |
---+-------------------------------------+-----------------------------+-->
   ^                                     ^                             ^
V[i-1].end                           V[i].start                    V[i].end

最後に、トランジション中に TRAVEL、BREAKS、DELAY、WAIT をどのように調整できるかを説明します。

  • 重複することはありません。
  • DELAY は一意で、次回の訪問（または車両終了）直前の連続する期間でなければなりません。したがって、遅延の開始時刻と終了時刻を知るには、遅延時間を把握すれば十分です。
  • BREAKS は、連続した重複しない期間です。レスポンスでは、各休憩の開始時間と時間を指定します。
  • TRAVEL と WAIT は「プリエンプティブ」です。この移行中に複数回中断できます。クライアントは、移動が「できるだけ早く」行われ、残りの時間を「待機」で埋めると仮定できます。

（複雑な）例:

                               TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
  ||     |       |           |       |           |         |         ||
  ||  T  |   B   |     T     |       |     B     |         |    D    ||
  ||  r  |   r   |     r     |   W   |     r     |    W    |    e    ||
  ||  a  |   e   |     a     |   a   |     e     |    a    |    l    ||
  ||  v  |   a   |     v     |   i   |     a     |    i    |    a    ||
  ||  e  |   k   |     e     |   t   |     k     |    t    |    y    ||
  ||  l  |       |     l     |       |           |         |         ||
  ||     |       |           |       |           |         |         ||
--++-----------------------------------------------------------------++-->
JSON 表現 
{
  "vehicleIndex": integer,
  "vehicleLabel": string,
  "vehicleStartTime": string,
  "vehicleEndTime": string,
  "visits": [
    {
      object (Visit)
    }
  ],
  "transitions": [
    {
      object (Transition)
    }
  ],
  "hasTrafficInfeasibilities": boolean,
  "routePolyline": {
    object (EncodedPolyline)
  },
  "breaks": [
    {
      object (Break)
    }
  ],
  "metrics": {
    object (AggregatedMetrics)
  },
  "routeCosts": {
    string: number,
    ...
  },
  "routeTotalCost": number
}
フィールド
vehicleIndex

integer

ルートを運行している車両。ソース ShipmentModel のインデックスで識別されます。
vehicleLabel

string

このルートを運行する車両のラベル。指定された場合は ShipmentModel.vehicles(vehicleIndex).label と等しくなります。
vehicleStartTime

string (Timestamp format)

車両がルートを開始する時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
vehicleEndTime

string (Timestamp format)

車両がルートを終了した時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
visits[]

object (Visit)

ルートを表す一連の訪問順序です。visit[i] はルートの i 番目の訪問です。このフィールドが空の場合、車両は未使用とみなされます。
transitions[]

object (Transition)

ルートの移行の順序付きリスト。
hasTrafficInfeasibilities

boolean

OptimizeToursRequest.consider_road_traffic が true に設定されている場合、このフィールドは、交通状況に基づく推定所要時間を使用してルート時刻の不整合が予測されることを示します。訪問と車両の時間枠を満たしながら、訪問間、初回訪問前、または最終訪問後に、交通量を調整した移動、遅延、休憩を完了するのに十分な時間がない可能性があります。例:

  startTime(previous_visit) + duration(previous_visit) +
  travelDuration(previous_visit, next_visit) > startTime(next_visit)

交通状況により推定移動時間 travelDuration(previous_visit, next_visit) が増加するため、next_visit は現在の時間枠よりも後に到着する可能性があります。また、推定移動時間の増加や、訪問または休憩の時間枠の制限により、休憩が訪問と重なることがあります。
routePolyline

object (EncodedPolyline)

ルートのエンコード済みポリライン表現。このフィールドは、OptimizeToursRequest.populate_polylines が true に設定されている場合にのみ入力されます。
breaks[]

object (Break)

このルートを走行する車両のために予定されている休憩時間。breaks シーケンスは時間間隔を表します。それぞれ対応する startTime から開始し、duration 秒続きます。
metrics

object (AggregatedMetrics)

このルートの所要時間、距離、負荷の指標。AggregatedMetrics のフィールドは、コンテキストに応じてすべての ShipmentRoute.transitions または ShipmentRoute.visits で合計されます。
routeCosts

map (key: string, value: number)

ルートの費用。費用関連のリクエスト フィールド別に分類されます。キーは、入力 OptimizeToursRequest を基準とするプロトコルパス（例: model.shipments.pickups.cost）です。値は、対応するコスト フィールドによって生成された総コストで、ルート全体で集計されます。つまり、cost["model.shipments.pickups.cost"] はルートの全ピックアップ料金の合計です。モデルで定義されているすべての費用は、ここでは詳細に報告されます。ただし、TransitionAttributes に関連する費用は、2022 年 1 月時点で集計された方法でのみ報告されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
routeTotalCost

number

ルートの合計費用。費用マップ内のすべての費用の合計。

アクセス

経路の途中で行われた訪問。この訪問は、Shipment の集荷または宅配に対応しています。

JSON 表現 
{
  "shipmentIndex": integer,
  "isPickup": boolean,
  "visitRequestIndex": integer,
  "startTime": string,
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "detour": string,
  "shipmentLabel": string,
  "visitLabel": string
}
フィールド
shipmentIndex

integer

ソース ShipmentModel の shipments フィールドのインデックス。
isPickup

boolean

true の場合、その訪問は Shipment の受け取りに対応します。それ以外の場合は配信に対応します。
visitRequestIndex

integer

Shipment の pickup または delivery フィールドの VisitRequest のインデックス（isPickup を参照）。
startTime

string (Timestamp format)

訪問の開始時刻。車両はこれよりも早く訪問場所に到着する可能性があります。時刻は ShipmentModel と一致します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
loadDemands

map (key: string, value: object (Load))

訪問負荷の合計（配送と訪問リクエスト（loadDemands）の合計）。来店が配送の場合、値は負の値になります。需要は、Transition.loads と同じタイプでレポートされます（このフィールドを参照）。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
detour

string (Duration format)

訪問前にルートを訪れる荷物と、時間枠によって待ち時間が生じる可能性があるため、余計な迂回時間。配達の場合、迂回運転は対応する受け取り訪問から計算され、次と等しくなります。

startTime(delivery) - startTime(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).

それ以外の場合は、車両 startLocation から計算されます。これは以下と等しくなります。

startTime - vehicleStartTime - travel duration from
the vehicle's `startLocation` to the visit.

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

string

対応する Shipment.label のコピー（Shipment で指定されている場合）。
visitLabel

string

対応する VisitRequest.label のコピー（VisitRequest で指定されている場合）。

切り替え効果

ルート上の 2 つのイベント間の遷移。ShipmentRoute の説明をご覧ください。

車両に startLocation や endLocation がない場合、対応する移動指標は 0 です。

JSON 表現 
{
  "travelDuration": string,
  "travelDistanceMeters": number,
  "trafficInfoUnavailable": boolean,
  "delayDuration": string,
  "breakDuration": string,
  "waitDuration": string,
  "totalDuration": string,
  "startTime": string,
  "routePolyline": {
    object (EncodedPolyline)
  },
  "vehicleLoads": {
    string: {
      object (VehicleLoad)
    },
    ...
  }
}
フィールド
travelDuration

string (Duration format)

この移行期間中の移動時間。

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

number

移行中の移動距離。
trafficInfoUnavailable

boolean

OptimizeToursRequest.consider_road_traffic を介してトラフィックがリクエストされ、Transition の交通情報を取得できなかった場合、このブール値は true に設定されます。これは、一時的なもの（リアルタイムのトラフィック サーバーでまれに発生する問題）の場合もあれば、永続的な場合もあります（この場所のデータがない場合もあります）。
delayDuration

string (Duration format)

この遷移に適用される遅延時間の合計。設定されている場合、遅延は次のイベント（訪問または車両の終了）のちょうど delayDuration 秒前に開始されます。TransitionAttributes.delayをご確認ください。

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

string (Duration format)

この移行中に発生した休憩時間の合計（ある場合）。各休憩の開始時間と長さの詳細は、ShipmentRoute.breaks に保存されます。

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

string (Duration format)

この移行中に待機した時間。待機時間はアイドル時間に相当し、休憩時間は含まれません。また、この待機時間が、連続しない複数の間隔に分割されることがあります。

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

string (Duration format)

移行の合計時間です。便宜上提供されます。これは、

  • 次回のアクセス startTime（最後のトランジションの場合は vehicleEndTime）- このトランジションの startTime。
  • ShipmentRoute.has_traffic_infeasibilities が false の場合、さらに次の条件が満たされます。totalDuration = travelDuration + delayDuration
  • --breakDuration + waitDuration` 内です。

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

string (Timestamp format)

この移行の開始時間。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
routePolyline

object (EncodedPolyline)

遷移中にたどるルートをエンコードしたポリライン表現。このフィールドは、populateTransitionPolylines が true に設定されている場合にのみ入力されます。
vehicleLoads

map (key: string, value: object (VehicleLoad))

この移行中の車両の積載量。この車両の Vehicle.load_limits に現れるか、このルートで行われた一部の出荷で Shipment.load_demands が 0 以外のタイプごとに、積載量が計算されます。

最初の移行時の負荷は、車両ルートの開始負荷です。各訪問の後に、訪問の loadDemands を加算または減算し、訪問が集荷か宅配かに応じて、次の遷移の読み込みを取得します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

EncodedPolyline

ポリラインのエンコード表現。ポリラインのエンコードについて詳しくは、https://developers.google.com/maps/documentation/utilities/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding をご覧ください。

JSON 表現 
{
  "points": string
}
フィールド
points

string

ポリラインのエンコードされた地点を表す文字列。

休憩

ブレークの実行を表すデータ。

JSON 表現 
{
  "startTime": string,
  "duration": string
}
フィールド
startTime

string (Timestamp format)

休憩の開始時間。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
duration

string (Duration format)

休憩の長さ。

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