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

請注意，我們區分以下項目：

  • 「準時事件」，例如車輛的啟動和結束，以及每次拜訪的開始和結束 (即抵達和離開)。這些事件會在特定時間發生。
  • 「時間間隔」，例如造訪本身，以及造訪之間的轉換。雖然時間間隔有時可能為零 (即開始和結束時間相同)，但通常會持續一段時間。

不變量：

  • 如果有 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)
  },
  "vehicleFullness": {
    object (VehicleFullness)
  },
  "routeCosts": {
    string: number,
    ...
  },
  "routeTotalCost": number
}
欄位
vehicleIndex

integer

執行路線的車輛，由來源 ShipmentModel 中的索引識別。
vehicleLabel

string

執行這條路線的車輛標籤，如果指定，則等於 ShipmentModel.vehicles(vehicleIndex).label。
vehicleStartTime

string (Timestamp format)

車輛開始行駛路線的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
vehicleEndTime

string (Timestamp format)

車輛完成路線的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
visits[]

object (Visit)

代表路線的造訪順序。visits[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。
vehicleFullness

object (VehicleFullness)

VehicleFullness 欄位，計算受限指標與各自車輛限制的接近程度。這些欄位是設有上限的指標欄位 (例如 AggregatedMetrics.travel_distance_meters) 與相關車輛限制 (例如 Vehicle.route_distance_limit) 之間的比例。

實驗性：這個欄位的行為或存在狀態日後可能會變更。
routeCosts

map (key: string, value: number)

路線費用，依費用相關要求欄位細分。這些鍵是相對於輸入 OptimizeToursRequest 的原型路徑，例如「model.shipments.pickups.cost」，值則是對應費用欄位產生的總費用，並在整個路線中匯總。換句話說，costs["model.shipments.pickups.cost"] 是路線上所有取貨費用的總和。模型中定義的所有費用都會在此詳細列出，但與 TransitionAttributes 相關的費用除外，這類費用自 2022 年 1 月起只會以匯總方式列出。
routeTotalCost

number

路線總費用。費用地圖中所有費用的總和。

前往

在路線期間進行的拜訪。這項拜訪對應 Shipment 的取貨或送貨。

JSON 表示法 
{
  "shipmentIndex": integer,
  "isPickup": boolean,
  "visitRequestIndex": integer,
  "startTime": string,
  "loadDemands": {
    string: {
      object (Load)
    },
    ...
  },
  "detour": string,
  "shipmentLabel": string,
  "visitLabel": string,
  "visitType": enum (VisitType),
  "injectedSolutionLocationToken": integer
}
欄位
shipmentIndex

integer

來源 ShipmentModel 中 shipments 欄位的索引。
isPickup

boolean

如果為 true，表示該趟行程對應 Shipment 的取貨作業。否則，這項狀態代表已送達。
visitRequestIndex

integer

Shipment 的取貨或運送欄位中的索引 VisitRequest (請參閱 isPickup)。
startTime

string (Timestamp format)

訪視開始時間。請注意，車輛可能比這個時間更早抵達拜訪地點。時間與ShipmentModel一致。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
loadDemands

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

總訪視負載需求，即出貨和訪視要求的總和 loadDemands。如果拜訪是送貨，值為負數。系統會針對與 Transition.loads 相同的類型回報需求 (請參閱這個欄位)。
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.
shipmentLabel

string

如果 Shipment 中指定了對應的 Shipment.label，則必須提供副本。
visitLabel

string

如果 VisitRequest 中指定了對應的 VisitRequest.label，則必須提供副本。
visitType

enum (VisitType)

(選用步驟) 指定造訪類型。覆寫 Visit.is_pickup 欄位。
injectedSolutionLocationToken

integer

不透明權杖，代表造訪地點的相關資訊。

如果這個造訪的 VisitRequest.avoid_u_turns 設為 true，或要求 OptimizeToursRequest 中的 ShipmentModel.avoid_u_turns 設為 true，則這個欄位可能會在結果路徑的造訪中填入。

實驗功能：詳情請參閱 https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request。

VisitType

指出該次造訪是取貨、外送還是前往Stop。只有在啟用多模態最佳化時，系統才會使用停靠點的造訪次數。

列舉
VISIT_TYPE_UNSPECIFIED 未指定拜訪類型。
PICKUP_SHIPMENT 拜訪次數對應於取貨次數。
DELIVER_SHIPMENT 拜訪次數對應至出貨配送次數。

轉移

在路線上的兩個活動之間轉換。請參閱 ShipmentRoute 的說明。

如果車輛沒有 startLocation 和/或 endLocation，對應的行程指標為 0。

JSON 表示法 
{
  "travelDuration": string,
  "travelDistanceMeters": number,
  "trafficInfoUnavailable": boolean,
  "delayDuration": string,
  "breakDuration": string,
  "waitDuration": string,
  "totalDuration": string,
  "startTime": string,
  "routePolyline": {
    object (EncodedPolyline)
  },
  "routeToken": string,
  "vehicleLoads": {
    string: {
      object (VehicleLoad)
    },
    ...
  }
}
欄位
travelDuration

string (Duration format)

這段期間的旅行時間。
travelDistanceMeters

number

轉場期間的行進距離。
trafficInfoUnavailable

boolean

透過 OptimizeToursRequest.consider_road_traffic 要求流量時，如果無法擷取 Transition 的流量資訊，這個布林值就會設為 true。這可能是暫時性問題 (即時流量伺服器發生罕見的故障)，也可能是永久性問題 (這個位置沒有資料)。
delayDuration

string (Duration format)

套用至這項轉換作業的延遲時間總和。如有延遲，系統會在下一個事件 (到訪或車輛結束) 前 delayDuration 秒開始延遲。查看《TransitionAttributes.delay》。
breakDuration

string (Duration format)

如果這段期間發生中斷，則為中斷時間的總和。ShipmentRoute.breaks 會儲存每個休息時間的開始時間和時長詳細資料。
waitDuration

string (Duration format)

在這段期間的等待時間。等待時間對應閒置時間，不含休息時間。請注意，這段等待時間可能會分成幾個不連續的間隔。
totalDuration

string (Duration format)

為方便起見，我們提供轉移作業的總時長。這等於：

  • 下次造訪 startTime (或 vehicleEndTime，如果這是最後一次轉換) - 這次轉換的 startTime；
  • 如果 ShipmentRoute.has_traffic_infeasibilities 為 false，則下列項目也成立：`totalDuration = travelDuration + delayDuration
  • breakDuration + waitDuration`。
startTime

string (Timestamp format)

這項轉換的開始時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
routePolyline

object (EncodedPolyline)

轉換期間所遵循路線的編碼折線表示法。只有在 populateTransitionPolylines 設為 true 時，才會填入這個欄位。
routeToken

string

僅供輸出。不透明權杖，可傳遞至 Navigation SDK，在導航期間重建路線，並在重新規劃路線時，遵守建立路線時的原始意圖。請將這個權杖視為不透明的 Blob。請勿比較不同要求中的值，因為即使服務傳回完全相同的路線，這個值也可能會變更。只有在 populateTransitionPolylines 設為 true 時，才會填入這個欄位。
vehicleLoads

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

在此轉換期間，車輛的負載量 (針對出現在這輛車 Vehicle.load_limits 中的每種負載量，或在這條路線上進行的某趟貨運中，Shipment.load_demands 不為零的負載量)。

第一次轉移期間的裝載作業是車輛路線的起始裝載作業。然後，每次造訪後，系統會根據造訪是取貨或送貨，在下次轉換的載入次數中加入或扣除該次造訪的 loadDemands。

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)

休息時間的開始時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
duration

string (Duration format)

休息時間長度。

VehicleFullness

VehicleFullness 是計算車輛容量的指標。每個 VehicleFullness 欄位的值介於 0 到 1 之間，計算方式為有上限的指標欄位 (例如 AggregatedMetrics.travel_distance_meters) 與相關車輛限制 (例如 Vehicle.route_distance_limit) 之間的比例 (如有)。否則飽滿度比率會維持未設定狀態。如果上限為 0，則欄位會設為 1。注意：如果路線受到交通狀況限制，部分原始滿意度比率可能會超過 1.0，例如車輛可能超過距離限制。在這些情況下，飽和度值上限為 1.0。

JSON 表示法 
{
  "maxFullness": number,
  "distance": number,
  "travelDuration": number,
  "activeDuration": number,
  "maxLoad": number,
  "activeSpan": number
}
欄位
maxFullness

number

這則訊息中所有其他欄位的最大值。
distance

number

AggregatedMetrics.travel_distance_meters 與 Vehicle.route_distance_limit 的比例。如果未設定 Vehicle.route_distance_limit，這個欄位也會未設定。
travelDuration

number

[AggregatedMetrics.travel_duration_seconds][] 與 Vehicle.travel_duration_limit 之間的比例。如果未設定 Vehicle.travel_duration_limit，這個欄位也會未設定。
activeDuration

number

[AggregatedMetrics.total_duration_seconds][] 與 Vehicle.route_duration_limit 之間的比例。如果未設定 Vehicle.route_duration_limit，這個欄位也會未設定。
maxLoad

number

所有類型的 [AggregatedMetrics.max_load][] 與各自 Vehicle.load_limits 的最大比率。如果所有 Vehicle.load_limits 欄位都未設定，這個欄位也會未設定。
activeSpan

number

特定車輛的比率 (vehicleEndTime - vehicleStartTime) / (latestVehicleEndTime - earliestVehicleStartTime)。如果沒有分母，則改用 (ShipmentModel.global_end_time - ShipmentModel.global_start_time)。