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

デフォルトでは、Routes API はデフォルト ルートを返します。これは通常、出発地から目的地までの最速ルートです。代替ルートをリクエストすると、API は最大 3 つのルートとデフォルト ルートを返します。ユーザーはその後、要件に最適なルートを選択できます。

代替ルートをリクエストする際の考慮事項

代替ルートをリクエストするには、次の点に注意してください。

  • 代替ルートをリクエストできるのは、中間地点がないルートのみです。中間の地点を指定したルートで代替ルートをリクエストしても、エラーは発生しません。ただし、代替ルートは返されません。

  • レスポンスには、最大 3 つの代替ルートが含まれます。ただし、代替ルートが利用できないため、レスポンスにはデフォルト ルートのみが含まれることがあります。

  • 代替ルートを計算するために追加の処理が必要になるため、代替ルートをリクエストすると API のレスポンス時間が長くなることがあります。

代替ルートのリクエストの例

代替ルートをリクエストするには、computeAlternativeRoutestrue に設定します。次の例は、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'

この例では、レスポンスに各ルートの durationdistanceMeters,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"
      ]
    }
   ]
}