別の経路をリクエストする

デフォルトでは、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"
      ]
    }
   ]
}