取得大眾運輸路線

大眾運輸路線會使用該地區提供的大眾運輸選項提供導航指示。大眾運輸選項包括公車、地鐵和火車等。大眾運輸路線通常也會提供前往、離開和在兩個大眾運輸站之間步行的操作說明。由於大眾運輸路線通常需要使用多種交通工具,因此要求路線的方式和回應的部分內容會有所不同。

大眾運輸路線與其他路線的差異

您透過設定 travelMode 為 TRANSIT 來要求的大眾運輸路線,與使用其他 travelMode 選項的路線不同。您無法要求所有相同的物件和選項,而且回應會傳回其他路徑的不同欄位。

在 Routes API 中,步驟一律是所有類型行程的單一導覽指示。因此,每個導覽指示都是一個步驟。大眾運輸路線回應與其他交通方式的路線非常相似,但有幾個主要差異:

要求差異 回應差異
您無法指定中繼路線點。 包含大眾運輸詳細資料。
無法取得環保路徑 在 `stepsOverview` 中,納入每種交通模式的中繼資料,其中包含該交通模式的步驟摘要 (如要要求這項中繼資料,請使用 `routes.legs.stepsOverview` 欄位遮罩)。
無法指定是否要納入流量資料,也無法指定納入方式
無法指定要避免的路線地圖項目
只能為 routingPreference 指定 transitPreferences。詳情請參閱 TransitPreferences

如要進一步瞭解 Routes API 傳回的回應,請參閱「查看大眾運輸路線回應」。

取得大眾運輸路線

  1. 設定出發地和目的地。

  2. 將交通方式設為大眾運輸:

    travelMode: "TRANSIT"

  3. 新增欄位遮罩,取得所需的回應欄位。請參閱「要求所需的大眾運輸路線欄位」。

  4. 視需要設定選用參數。請參閱「設定大眾運輸路線的參數」。

要求所需的大眾運輸路線欄位

使用欄位遮罩要求所需的大眾運輸路線欄位。下表列出幾個大眾運輸路線的建議回應,以及用於要求這些回應的欄位遮罩。

如何要求提供這項資訊 使用這個欄位遮罩
所有路線詳細資料 routes.*
所有大眾運輸詳細資料 routes.legs.steps.transitDetails
每個路段的起點 routes.legs.steps.startLocation
每個航段的終點 routes.legs.steps.endLocation
每個步驟的路線折線 routes.legs.steps.polyline
每個步驟使用的大眾運輸類型 routes.legs.steps.travelMode
每個步驟和路線的預估車資,以及當地預估車資 routes.travel_advisory.transitFare localized routes.localizedValues.transitFare

注意:只有在 API 能夠判斷所有步驟的大眾運輸車資資訊時,才會提供 transitFare

時間和距離的本地化文字 routes.localizedValues

如要進一步瞭解如何設定欄位遮罩,請參閱「選擇要傳回的欄位」一文。

設定大眾運輸路線的參數

以下是大眾運輸路線的相關參數:

如要執行這項操作 使用這項參數 附註
選取大眾運輸模式 travelMode: "TRANSIT" 必要元素。瞭解詳情
設定抵達或出發時間 "arrivalTime": "yyyy-mm-ddThh:mm:ssZ"

"departureTime": "yyyy-mm-ddThh:mm:ssZ"
選用設定。您可以指定 arrival_time 或 departure_time。如果未指定任何時間,departure_time 的預設值為目前的執行時間 (now)。您只能在下列時間範圍內設定到達和離開時間,並以目前的執行時間 (now) 做為參考:
  • now 前 7 天 (含當天)
  • now 後的 100 天內
時間以 RFC3339 UTC Zulu 格式表示的時間戳記。瞭解詳情
加入替代路線 "computeAlternativeRoutes": true 選用設定。設為 true 可讓 Routes API 計算最多 3 條額外路線 (如有)。瞭解詳情
指定大眾運輸類型的偏好設定 "transitPreferences": { allowedTravelModes: ["BUS","SUBWAY","TRAIN","LIGHT_RAIL","RAIL"]}

注意:如果您指定偏好的交通工具,系統可能會根據偏好路線的效率和可用性,返回仍會使用其他交通工具,甚至只會使用其他交通工具的路線。

選用設定。指定偏好的大眾運輸交通方式。瞭解詳情
指定大眾運輸路線的偏好設定 "transitPreferences": {routingPreference: "LESS_WALKING|FEWER_TRANSFERS"} 選用設定。指定大眾運輸路線偏好設定。瞭解詳情

範例:取得大眾運輸路線

以下範例會使用下列參數取得大眾運輸路線:

  • 指定偏好搭乘火車,且步行距離較短。

  • 要求替代路線。

  • 提供可傳回大眾運輸詳細資料的欄位遮罩:

curl -X POST -H 'content-type: application/json' -d '{
  "origin": {
    "address": "Humberto Delgado Airport, Portugal"
  },
  "destination": {
    "address": "Basílica of Estrela, Praça da Estrela, 1200-667 Lisboa, Portugal"
  },
  "travelMode": "TRANSIT",
  "computeAlternativeRoutes": true,
  "transitPreferences": {
     routingPreference: "LESS_WALKING",
     allowedTravelModes: ["TRAIN"]
  },
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.legs.steps.transitDetails' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

回應會顯示兩個路徑的 route.legs.steps.transitDetails 欄位:

{
  "routes": [
    {
    "legs": [
        {
        "steps": [
          {},
          {},
          {},
          {
          "transitDetails": {
            "stopDetails": {
            "arrivalStop": {
              "name": "Saldanha",
              "location": {
                "latLng": {
                  "latitude": 38.73532,
                  "longitude": -9.14543
                }
              }
            },
            "arrivalTime": "2023-08-26T10:49:42Z",
            "departureStop": {
              "name": "Aeroporto",
              "location": {
                "latLng": {
                  "latitude": 38.769047799999996,
                  "longitude": -9.1284593
                }
              }
            },
            "departureTime": "2023-08-26T10:32:10Z"
              },
              "localizedValues": {
              "arrivalTime": {
                  "time": {
                    "text": "11:49"
                  },
                  "timeZone": "Europe/Lisbon"
              },
              "departureTime": {
                "time": {
                  "text": "11:32"
                },
                "timeZone": "Europe/Lisbon"
              }
            },
              "headsign": "São Sebastião",
              "transitLine": {
                "agencies": [
                  {
                    "name": "Metropolitano de Lisboa, E.P.E.",
                    "phoneNumber": "+351 21 350 0115",
                    "uri": "https://www.metrolisboa.pt/"
                  }
                ],
                "name": "Vermelha",
                "color": "#f23061",
                "nameShort": "Vm",
                "textColor": "#000000",
                "vehicle": {
                  "name": {
                    "text": "Metrô"
                  },
                "type": "SUBWAY",
                "iconUri": "//maps.gstatic.com/mapfiles/transit/iw2/6/subway2.png"
                }
              },
              "stopCount": 11
            }
          },
        {},
        {
          "transitDetails": {
            "stopDetails": {
              "arrivalStop": {
                "name": "Rato",
                "location": {
                  "latLng": {
                    "latitude": 38.7201022,
                    "longitude": -9.1540562
                  }
              }
            },
            "arrivalTime": "2023-08-26T11:01:37Z",
            "departureStop": {
              "name": "Saldanha",
                "location": {
                  "latLng": {
                    "latitude": 38.73527,
                    "longitude": -9.1455200000000012
                  }
                }
              },
              "departureTime": "2023-08-26T10:57:57Z"
            },
            "localizedValues": {
              "arrivalTime": {
                "time": {
                  "text": "12:01"
                },
                "timeZone": "Europe/Lisbon"
              },
              "departureTime": {
                "time": {
                  "text": "11:57"
                },
                "timeZone": "Europe/Lisbon"
              }
            },
            "headsign": "Rato",
            "transitLine": {
              "agencies": [
                {
                "name": "Metropolitano de Lisboa, E.P.E.",
                "phoneNumber": "+351 21 350 0115",
                "uri": "https://www.metrolisboa.pt/"
                }
              ],
              "name": "Amarela",
              "color": "#f2c200",
              "nameShort": "Am",
              "textColor": "#000000",
              "vehicle": {
                "name": {
                  "text": "Metrô"
                },
                "type": "SUBWAY",
                "iconUri": "//maps.gstatic.com/mapfiles/transit/iw2/6/subway2.png"
              }
            },
            "stopCount": 4
          }
        },
        {},
        {},
        {},
        {},
        {},
        {}
        ]
      }
    ]
  }
]
}