デフォルトでは、Routes API はデフォルトのルートを返します。これは通常、出発地から目的地への最速ルートです。代替ルートをリクエストすると、API はデフォルト ルートとともに最大 3 つのルートを返します。その後、ユーザーは要件に最も適したルートを選択できます。
代替ルートをリクエストする際の考慮事項
代替ルートをリクエストする場合は、次の点を考慮してください。
代替ルートは、中間地点がないルートに対してのみリクエストできます。ルートで中間地点が指定されている場合に代替ルートをリクエストしても、エラーは発生しません。ただし、代替ルートは返されません。
レスポンスには、最大 3 つの代替ルートが含まれます。ただし、代替ルートが利用できないため、レスポンスにはデフォルト ルートのみが含まれます。
代替ルートの計算に追加の処理が必要になるため、代替ルートをリクエストすると API のレスポンス時間が長くなる可能性があります。
代替ルート リクエストの例
代替ルートをリクエストするには、computeAlternativeRoutes を true に設定します。次の例は、computeRoutes メソッド（REST）リクエストで代替ルートをリクエストする方法を示しています。
curl -X POST -d '{
"origin":{
"location":{
"latLng":{
"latitude":42.340173523716736,
"longitude":-71.05997968330408
}
}
},
"destination":{
"location":{
"latLng":{
"latitude":42.075698891472804,
"longitude": -72.59806562080408
}
}
},
"travelMode": "DRIVE",
"routingPreference":"TRAFFIC_AWARE",
"computeAlternativeRoutes": true
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.routeLabels' \
'https://routes.googleapis.com/directions/v2:computeRoutes'
この例では、レスポンスに各ルートの duration、distanceMeters,、routeLabels プロパティのみが含まれるようにフィールド マスクを指定します。顧客はこの情報を使用して、使用するルートを選択できます。詳しくは、返す情報の選択をご覧ください。
代替ルートのレスポンス例
レスポンスでは、routeLabels 配列プロパティを使用してリーチルートを識別します。
デフォルト ルートの場合、
routeLabelsプロパティにはDEFAULT_ROUTEが含まれます。代替ルートの場合、
routeLabelsプロパティにはDEFAULT_ROUTE_ALTERNATEが含まれます。
この例のレスポンスには、デフォルト ルートと 2 つの代替ルートが含まれています。duration プロパティと distanceMeters プロパティの値はルートごとに異なることに注意してください。
{
"routes": [
{
"distanceMeters": 150322,
"duration": "5309s",
"routeLabels": [
"DEFAULT_ROUTE"
]
},
{
"distanceMeters": 157614,
"duration": "6879s",
"routeLabels": [
"DEFAULT_ROUTE_ALTERNATE"
]
},
{
"distanceMeters": 189311,
"duration": "7376s",
"routeLabels": [
"DEFAULT_ROUTE_ALTERNATE"
]
}
]
}
レスポンスにポリラインを含める
ユーザーがルートを簡単に選択できるように、レスポンスに各ルートのポリラインを追加します。各ポリラインを地図上に表示できます。
ポリラインを追加するには、フィールド マスクに routes.polyline を含めます。
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.routeLabels,routes.polyline'
レスポンスには各ルートのポリラインが含まれます。
{
"routes": [
{
"distanceMeters": 150322,
"duration": "5309s",
"polyline": {
"encodedPolyline": "mrlaGtavpLPLBTm…PgA^qC"
},
"routeLabels": [
"DEFAULT_ROUTE"
]
},
{
"distanceMeters": 157614,
"duration": "6879s",
"polyline": {
"encodedPolyline": "DmEd`@e@pCo@pCs@z…PgA^qC"
},
"routeLabels": [
"DEFAULT_ROUTE_ALTERNATE"
]
},
{
"distanceMeters": 189311,
"duration": "7376s",
"polyline": {
"encodedPolyline": "FVLL|Af@HPAV…PgA^qC"
},
"routeLabels": [
"DEFAULT_ROUTE_ALTERNATE"
]
}
]
}