Method: computeRouteMatrix

會接收起點和目的地清單，並傳回包含起點和目的地組合路線資訊的串流。

注意：這個方法需要您在輸入內容中指定回應欄位遮罩。您可以使用網址參數 $fields 或 fields，或是使用 HTTP/gRPC 標頭 X-Goog-FieldMask 提供回應欄位遮罩 (請參閱可用的網址參數和標頭)。值是以逗號分隔的欄位路徑清單。請參閱這份詳細說明文件，瞭解如何建構欄位路徑。

例如，在這個方法中：

  • 所有可用欄位的欄位遮罩 (供手動檢查)：X-Goog-FieldMask: *
  • 路線時間長度、距離、元素狀態、條件和元素索引的欄位遮罩 (正式版設定範例)：X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

請務必在欄位遮罩中加入 status，否則所有訊息都會顯示為 OK。Google 不建議使用萬用字元 (*) 回應欄位遮罩，因為：

  • 只選取所需欄位有助於伺服器節省運算週期，讓我們能以更低的延遲時間傳回結果。
  • 只在實際工作中選取所需欄位，即可確保延遲時間穩定。我們日後可能會新增更多回應欄位，而這些新欄位可能需要額外的運算時間。如果您選取所有欄位，或是選取頂層的所有欄位，系統會自動將新增的任何欄位納入回應，因此可能會導致效能降低。
  • 只選取所需欄位，可縮小回應大小，進而提高網路傳輸量。

HTTP 要求

POST https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "origins": [
    {
      object (RouteMatrixOrigin)
    }
  ],
  "destinations": [
    {
      object (RouteMatrixDestination)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "departureTime": string,
  "arrivalTime": string,
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
欄位
origins[]

object (RouteMatrixOrigin)

必要欄位。來源陣列，用於決定回應矩陣的資料列。來源和目的地的基數有幾項大小限制：

  • 以 placeId 或 address 指定的來源數量 + 目的地數量總和不得超過 50。
  • 來源數量 × 目的地數量乘積不得超過 625。
  • 如果 routingPreference 設為 TRAFFIC_AWARE_OPTIMAL，起點數量 × 目的地數量不得超過 100。
  • 如果 travelMode 設為 TRANSIT，起點數量 × 目的地數量不得超過 100。
destinations[]

object (RouteMatrixDestination)

必要欄位。目的地陣列，用於決定回應矩陣的資料欄。
travelMode

enum (RouteTravelMode)

選用設定。指定交通方式。
routingPreference

enum (RoutingPreference)

選用設定。指定計算路線的方式。伺服器會嘗試使用所選的路由偏好設定來計算路徑。如果路由偏好設定導致錯誤或延遲時間過長，系統會傳回錯誤。只有在 travelMode 為 DRIVE 或 TWO_WHEELER 時，才能指定這個選項，否則要求會失敗。
departureTime

string (Timestamp format)

選用設定。出發時間。如果您未設定這個值，則預設值為您提出要求的時間。注意：只有在 RouteTravelMode 設為 TRANSIT 時，才能指定過去的 departureTime。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
arrivalTime

string (Timestamp format)

選用設定。抵達時間。注意：只有在 RouteTravelMode 設為 TRANSIT 時才能設定。您可以選擇指定 departureTime 或 arrivalTime，但不能兩者同時指定。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
languageCode

string

選用設定。BCP-47 語言代碼，例如「en-US」或「sr-Latn」。詳情請參閱「Unicode 語言代碼」。如需支援語言清單，請參閱「程式語言支援」一文。如果未提供這個值，系統會根據第一個來源的位置推測顯示語言。
regionCode

string

選用設定。區碼，採 ccTLD (「頂層網域」) 的兩位字元值 詳情請參閱「國家/地區代碼頂層網域」。
units

enum (Units)

選用設定。指定顯示欄位的測量單位。
extraComputations[]

enum (ExtraComputation)

選用設定。可用來完成要求的額外運算清單。注意：這些額外運算可能會在回應中傳回額外欄位。您必須在回應中傳回的欄位遮罩中指定這些額外欄位。
trafficModel

enum (TrafficModel)

選用設定。指定計算交通時間時要採用的假設。這項設定會影響 RouteMatrixElement 中 duration 欄位傳回的值，其中包含根據歷來平均值預估的交通時間。RoutingPreference 至 TRAFFIC_AWARE_OPTIMAL，RouteTravelMode 至 DRIVE。如果要求傳送流量，且未指定 TrafficModel，則預設為 BEST_GUESS。
transitPreferences

object (TransitPreferences)

選用設定。指定會影響 TRANSIT 路線傳回路線的偏好設定。注意：只有在 RouteTravelMode 設為 TRANSIT 時，才能指定 transitPreferences。

回應主體

包含在 v2.computeRouteMatrix API 中，針對起點/目的地組合計算的路線資訊。這個 proto 可以串流傳送至用戶端。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "status": {
    object (Status)
  },
  "condition": enum (RouteMatrixElementCondition),
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "localizedValues": {
    object (LocalizedValues)
  },
  "originIndex": integer,
  "destinationIndex": integer
}
欄位
status

object (Status)

這個元素的錯誤狀態代碼。
condition

enum (RouteMatrixElementCondition)

指出是否找到路線。不受狀態影響。
distanceMeters

integer

路線的移動距離 (以公尺為單位)。
duration

string (Duration format)

導航路線所需的時間長度。如果您將 routingPreference 設為 TRAFFIC_UNAWARE，則這個值與 staticDuration 相同。如果您將 routingPreference 設為 TRAFFIC_AWARE 或 TRAFFIC_AWARE_OPTIMAL，系統會在計算這個值時考量交通狀況。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
staticDuration

string (Duration format)

不考量交通狀況的路線行駛時間。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
travelAdvisory

object (RouteTravelAdvisory)

路線的其他資訊。例如：限制資訊和收費資訊
fallbackInfo

object (FallbackInfo)

在某些情況下，如果伺服器無法根據特定起點/目的地組合的指定偏好設定來計算路線，可能會改用其他計算模式。使用備用模式時，這個欄位會包含備用回應的詳細資訊。否則，這個欄位未設定。
localizedValues

object (LocalizedValues)

RouteMatrixElement 屬性的文字表示法。
originIndex

integer

要求中來源的索引，從零開始。
destinationIndex

integer

要求中目的地的索引，從零開始。

RouteMatrixOrigin

ComputeRouteMatrixRequest 的單一來源

JSON 表示法 
{
  "waypoint": {
    object (Waypoint)
  },
  "routeModifiers": {
    object (RouteModifiers)
  }
}
欄位
waypoint

object (Waypoint)

必要欄位。起點路線控點
routeModifiers

object (RouteModifiers)

選用設定。針對以此為起點的每條路線的修飾符

RouteMatrixDestination

ComputeRouteMatrixRequest 的單一目的地

JSON 表示法 
{
  "waypoint": {
    object (Waypoint)
  }
}
欄位
waypoint

object (Waypoint)

必要欄位。目的地路線點

ExtraComputation

在完成要求時要執行的額外運算。

列舉
EXTRA_COMPUTATION_UNSPECIFIED 未使用。含有這個值的要求會失敗。
TOLLS 矩陣元素的通行費資訊。

RouteMatrixElementCondition

傳回路徑的條件。

列舉
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED 僅在元素的 status 不正確時使用。
ROUTE_EXISTS 找到路線，並為元素填入相應資訊。
ROUTE_NOT_FOUND 找不到路線。元素中不會填入含有路線資訊的欄位，例如 distanceMeters 或 duration。

LocalizedValues

特定資源的文字表示法。

JSON 表示法 
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
欄位
distance

object (LocalizedText)

以文字形式表示的移動距離。
duration

object (LocalizedText)

以文字形式表示的時間長度，考量路況。注意：如果未要求流量資訊，這個值會與 staticDuration 相同。
staticDuration

object (LocalizedText)

不考量交通狀況，以文字形式表示的時間長度。
transitFare

object (LocalizedText)

以文字形式表示的大眾運輸票價。