Routes API を使用して、computeRouteMatrix メソッド(REST)またはストリーミング ComputeRouteMatrix メソッド(gRPC)を呼び出して、複数の出発地と目的地のルートの距離と所要時間を計算します。
このメソッドは、出発地と目的地のリストが与えられると、各出発地から各目的地を経由するルートの距離と所要時間を計算します。
交通機関のルート マトリックスを取得する
また、交通機関のルート マトリックスを計算することもできます。例については、交通機関のルート マトリックスの取得をご覧ください。
リクエストに関する上限
Compute Route Matrix メソッドでは、住所または placeID を使用する地点と、要素に対して、次のリクエスト上限が適用されます。要素はルート マトリックス内の各出発地と目的地を結ぶルートであるため、要素数は出発地の数に目的地の数を掛けた値になります。たとえば、10 個の出発地と 10 個の目的地を指定した場合、要素は 100 個あります。
TRANSIT
ルート以外のルートの要素数は 625 以下にしてください。TRANSIT
ルートを指定する場合、要素数は 100 を超えることはできません。TRAFFIC_AWARE_OPTIMAL
を指定する場合、要素数は 100 以下にしてください。TRAFFIC_AWARE_OPTIMAL
の詳細については、トラフィック データを含める方法と指定する場合をご覧ください。住所またはプレイス ID を使用して出発地や目的地を指定する場合は、合計で最大 50 件まで指定できます。
レスポンス エラー
Compute Route Matrix メソッドの 1 つの特長として、レスポンス全体または個々のレスポンス要素に対してエラーを返すことができます。たとえば、リクエストの形式が正しくない場合(送信元がゼロなど)、レスポンス全体にエラーが含まれます。
ただし、エラーがレスポンスの要素のサブセットに適用される場合(たとえば、出発地と目的地の 1 つの組み合わせに対してルートを計算できない場合)、エラーの影響を受ける要素のみがエラーコードを返します。
gRPC ストリームの結果
ComputeRouteMatrix gRPC メソッドは、出発地と目的地のリストを受け取り、出発地と目的地の各組み合わせのルート情報を含むストリームを返します。結果はストリームとして返されるため、すべての可能なルートの組み合わせが計算されるまで待たずに、結果の処理を開始できます。
ストリームによって返される要素は、任意の順序で返される保証はありません。したがって、各レスポンス要素には origin_index
と destination_index
が含まれます。リクエストで指定された出発地と目的地について、ルートの出発地は特定の要素の origins[origin_index]
と同等で、ルートの目的地は destinations[destination_index]
と同等です。これらの配列にはゼロ インデックスが付けられます。出発地と目的地のリストの順序を保存することが重要です。
ルート マトリックスの計算の例
ルート マトリックスを計算するには、HTTP リクエストで computeRouteMatrix メソッドを使用します。
HTTP の例
次の例は、computeRouteMatrix
HTTP リクエストを示しています。この例では、次のことを行います。
出発地と目的地の地点の配列を指定します。このメソッドは、各出発地から各目的地へのルートを計算するため、レスポンスには 4 つのルートが含まれます。
配列内では、1 つ目の要素はインデックス 0、2 つ目の要素はインデックス 1 というように続きます。
レスポンス フィールド マスクを追加して、レスポンス(REST)または ComputeRoutesResponse(gRPC)のフィールドを指定します。この例では、ルートごとに
originIndex
、destinationIndex
、duration
、distanceMeters
、status
、condition
を返すようにリクエストを構成します。詳細については、返すフィールドの選択をご覧ください。
curl -X POST -d '{ "origins": [ { "waypoint": { "location": { "latLng": { "latitude": 37.420761, "longitude": -122.081356 } } }, "routeModifiers": { "avoid_ferries": true} }, { "waypoint": { "location": { "latLng": { "latitude": 37.403184, "longitude": -122.097371 } } }, "routeModifiers": { "avoid_ferries": true} } ], "destinations": [ { "waypoint": { "location": { "latLng": { "latitude": 37.420999, "longitude": -122.086894 } } } }, { "waypoint": { "location": { "latLng": { "latitude": 37.383047, "longitude": -122.044651 } } } } ], "travelMode": "DRIVE", "routingPreference": "TRAFFIC_AWARE" }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: YOUR_API_KEY' \ -H 'X-Goog-FieldMask: originIndex,destinationIndex,duration,distanceMeters,status,condition' \ 'https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix'
レスポンスには、出発地と目的地のすべてのウェイポイントの組み合わせで、考えられる 4 つのルートが含まれます。
originIndex
と destinationIndex
のレスポンス フィールドを使用して、レスポンスの各ルートを特定します。たとえば、レスポンスの originIndex
が 1 の場合、リクエスト内の origins
配列のインデックス 1 の地点から計算されたルートに対応します。
[ { "originIndex": 0, "destinationIndex": 0, "status": {}, "distanceMeters": 822, "duration": "160s", "condition": "ROUTE_EXISTS" }, { "originIndex": 1, "destinationIndex": 0, "status": {}, "distanceMeters": 2919, "duration": "361s", "condition": "ROUTE_EXISTS" }, { "originIndex": 1, "destinationIndex": 1, "status": {}, "distanceMeters": 5598, "duration": "402s", "condition": "ROUTE_EXISTS" }, { "originIndex": 0, "destinationIndex": 1, "status": {}, "distanceMeters": 7259, "duration": "712s", "condition": "ROUTE_EXISTS" } ]
gRPC の例
gRPC リクエストの例については、gRPC リクエストの例をご覧ください。そのページの Java の例では、Compute Routes と Compute Route Matrix の両方を呼び出します。