Route Matrix

RouteMatrix クラス

google.maps.routes.RouteMatrix クラス

RouteMatrix.computeRouteMatrix によって出発地と目的地のペアのセットに対して計算されたルートのマトリックス

const {RouteMatrix} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
computeRouteMatrix
computeRouteMatrix(request)
パラメータ: 
戻り値:  Promise<{matrix:RouteMatrix}>
出発地と目的地のリストを受け取り、出発地と目的地の各組み合わせについてルート情報を含むマトリックスを返します。

注: このメソッドでは、ComputeRouteMatrixRequest.fields プロパティを設定して、リクエストでレスポンス フィールド マスクを指定する必要があります。値はフィールドパスのリストです。

例:
  • 使用可能なすべてのフィールドのフィールド マスク: fields: ['*']
  • ルートレベルの所要時間と距離のフィールド マスク: fields: ['durationMillis', 'distanceMeters']

ワイルドカード レスポンス フィールド マスク fields: ['*'] の使用は、次の理由により推奨されません。
  • 必要なフィールドのみを選択すると、サーバーの計算サイクルが節約され、レイテンシを抑えて結果を返すことができます。
  • 本番環境ジョブで必要なフィールドのみを選択すると、レイテンシ パフォーマンスが安定します。今後、レスポンス フィールドが追加される可能性があります。新しいフィールドでは、追加の計算時間が必要になる場合があります。すべてのフィールドを選択した場合、または最上位レベルですべてのフィールドを選択した場合、Google が追加した新しいフィールドが自動的にレスポンスに含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク経由の読み込みが高速になります。
rows
タイプ:  Array<RouteMatrixRow>
行列の行。各行は出発地に対応し、RouteMatrixItem の配列が含まれます。各 RouteMatrixItem は目的地へのルートを表します。
toJSON
toJSON()
パラメータ: なし
戻り値:  Object
オブジェクトに変換します。

RouteMatrixRow クラス

google.maps.routes.RouteMatrixRow クラス

RouteMatrix.computeRouteMatrix に渡されるオリジンに対応します。RouteMatrixItem のリストが含まれます。各アイテムは目的地へのルートを表します。

const {RouteMatrixRow} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
items
タイプ:  Array<RouteMatrixItem>
各宛先のルート情報。
toJSON
toJSON()
パラメータ: なし
戻り値:  Object
オブジェクトに変換します。

RouteMatrixItem クラス

google.maps.routes.RouteMatrixItem クラス

RouteMatrix.computeRouteMatrix に渡された出発地と目的地のペアに対して計算されたルート情報が含まれます。

const {RouteMatrixItem} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
condition
タイプ:  RouteMatrixItemCondition optional
ルートが見つかったかどうかを示します。
distanceMeters
タイプ:  number optional
ルートの移動距離（メートル単位）。
durationMillis
タイプ:  number optional
ルートのナビゲーションに必要な時間（ミリ秒単位）。ComputeRouteMatrixRequest.routingPreference を TRAFFIC_UNAWARE に設定すると、この値は RouteMatrixItem.staticDurationMillis と同じになります。ComputeRouteMatrixRequest.routingPreference を TRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL に設定すると、この値は交通状況を考慮して計算されます。

注: 期間が 2^53 ミリ秒を超える場合、この値は Number.POSITIVE_INFINITY です。
error
タイプ:  RouteMatrixItemError optional
ルートの計算中に発生したエラー。
fallbackInfo
タイプ:  FallbackInfo optional
サーバーが、特定の出発地と目的地のペアに対して指定された設定でルートを計算できない場合、別の計算モードにフォールバックすることがあります。フォールバックが使用される場合、このフィールドにはフォールバック レスポンスに関する詳細情報が含まれます。それ以外の場合、このフィールドは設定されません。
localizedValues
タイプ:  RouteMatrixItemLocalizedValues optional
RouteMatrixItem のプロパティのテキスト表現。
staticDurationMillis
タイプ:  number optional
交通状況を考慮せずにルートを移動する所要時間。

注: 期間が 2^53 ミリ秒を超える場合、この値は Number.POSITIVE_INFINITY です。
travelAdvisory
タイプ:  RouteTravelAdvisory optional
ルートに関する追加情報。
toJSON
toJSON()
パラメータ: なし
戻り値:  Object
オブジェクトに変換します。

ComputeRouteMatrixRequest インターフェース

google.maps.routes.ComputeRouteMatrixRequest インターフェース

ルート マトリックスのリクエスト。
destinations
目的地の配列。レスポンス マトリックスの列を決定します。文字列として渡される値は、住所、Plus Codes、または Place リソース名です。高度の値は考慮されません。
fields
タイプ:  Iterable<string>
取得するフィールドのコレクション。すべてのフィールドに ["*"] を指定します。
origins
出発地の配列。レスポンス マトリックスの行を決定します。文字列として渡される値は、住所、Plus Codes、または Place リソース名です。高度の値は考慮されません。

出発地と目的地のカーディナリティには、いくつかのサイズ制限が適用されます。
  • string または Place として指定する出発地と目的地の合計数は 50 以下にする必要があります。
  • 出発地の数と目的地の数を掛け合わせた値は 625 以下にする必要があります。
  • ComputeRouteMatrixRequest.routingPreference が TRAFFIC_AWARE_OPTIMAL に設定されている場合、出発地と目的地の数の積は 100 以下にする必要があります。
  • ComputeRouteMatrixRequest.travelMode が TRANSIT に設定されている場合、出発地と目的地の数の積は 100 以下にする必要があります。
arrivalTime optional
タイプ:  Date optional
到着時刻。

注: ComputeRouteMatrixRequest.travelMode が TRANSIT に設定されている場合にのみ設定できます。ComputeRouteMatrixRequest.departureTime または ComputeRouteMatrixRequest.arrivalTime のどちらかを指定できますが、両方を指定することはできません。乗換案内は、過去 7 日間または今後 100 日間まで利用できます。
departureTime optional
タイプ:  Date optional
出発時刻。この値を設定しない場合、デフォルトでリクエストを行った時刻になります。

注: ComputeRouteMatrixRequest.travelMode が TRANSIT に設定されている場合にのみ、過去の時間を指定できます。乗換案内は、過去 7 日間または今後 100 日間まで利用できます。
extraComputations optional
リクエストを完了するために使用される追加の計算のリスト。

注: これらの追加の計算により、レスポンスに追加のフィールドが返されることがあります。これらの追加フィールドは、レスポンスで返される ComputeRouteMatrixRequest.fields にも指定する必要があります。
language optional
タイプ:  string optional
「en-US」や「sr-Latn」などの BCP-47 言語コード。詳しくは、Unicode ロケール識別子をご覧ください。サポートされている言語の一覧については、言語サポートをご覧ください。この値を指定しない場合、言語は Google Maps JavaScript API のローカライズ設定から推測されます。それ以外の場合は、最初の出発地の場所から言語が推測されます。
region optional
タイプ:  string optional
地域コード。ccTLD（「トップレベル ドメイン」）の 2 文字の値として指定します。詳しくは、国別コード トップレベル ドメインをご覧ください。この値を指定しない場合、リージョンは Google Maps JavaScript API のローカライズ設定から推測されます。それ以外の場合、リージョンは最初の送信元のロケーションから推測されます。
routingPreference optional
タイプ:  RoutingPreference optional
ルート マトリックスの計算方法を指定します。サーバーは、選択されたルーティング設定を使用してルート マトリックスを計算しようとします。ルーティング設定でエラーが発生した場合や、レイテンシが非常に長くなった場合は、エラーが返されます。このオプションは、ComputeRouteMatrixRequest.travelMode が DRIVING または TWO_WHEELER の場合にのみ指定できます。それ以外の場合、リクエストは失敗します。
trafficModel optional
タイプ:  TrafficModel optional
所要時間を計算する上での仮定条件を指定します。この設定に応じて、RouteMatrixItem.durationMillis で返される値が変わります。この値は、過去の平均データに基づく予測所要時間となります。ComputeRouteMatrixRequest.trafficModel は、ComputeRouteMatrixRequest.routingPreference が TRAFFIC_AWARE_OPTIMAL に設定され、ComputeRouteMatrixRequest.travelMode が DRIVING に設定されているリクエストでのみ使用できます。デフォルトは BEST_GUESS です。
transitPreference optional
タイプ:  TransitPreference optional
TRANSIT ルートで返されるルートに影響する設定を指定します。

注: ComputeRouteMatrixRequest.travelMode が TRANSIT に設定されている場合にのみ指定できます。
travelMode optional
タイプ:  TravelMode optional
移動手段を指定します。
units optional
タイプ:  UnitSystem optional
表示フィールドの測定単位を指定します。この値を指定しない場合、表示単位は最初の出発地の場所から推測されます。

ComputeRouteMatrixExtraComputation 定数

google.maps.routes.ComputeRouteMatrixExtraComputation 定数

RouteMatrix.computeRouteMatrix リクエストに対して実行する追加の計算。

const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
TOLLS マトリックス アイテムの通行料金情報。

RouteMatrixItemCondition 定数

google.maps.routes.RouteMatrixItemCondition 定数

特定の出発地と目的地のペアのルートの状態。

const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
ROUTE_EXISTS ルートが見つかりました。
ROUTE_NOT_FOUND 経路が見つかりませんでした。

RouteMatrixItemError クラス

google.maps.routes.RouteMatrixItemError クラス

特定の出発地と目的地のペアの RouteMatrix.computeRouteMatrix 中に発生したエラー。

このクラスは Error を拡張します。

const {RouteMatrixItemError} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
toJSON
toJSON()
パラメータ: なし
戻り値:  Object
オブジェクトに変換します。

RouteMatrixItemLocalizedValues クラス

google.maps.routes.RouteMatrixItemLocalizedValues クラス

RouteMatrixItem のテキスト表現。

const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
distance
タイプ:  string optional
ルート マトリックス アイテムの移動距離（テキスト形式）。
distanceLanguage
タイプ:  string optional
距離テキストの BCP-47 言語コード（「en-US」や「sr-Latn」など）。

詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。
duration
タイプ:  string optional
テキスト形式で表され、クエリのリージョンにローカライズされた期間。交通状況を考慮します。

注: 交通情報をリクエストしなかった場合、この値は RouteMatrixItemLocalizedValues.staticDuration と同じ値になります。
durationLanguage
タイプ:  string optional
所要時間テキストの BCP-47 言語コード（「en-US」や「sr-Latn」など）。

詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。
staticDuration
タイプ:  string optional
交通状況を考慮しない所要時間（テキスト形式）。
staticDurationLanguage
タイプ:  string optional
静的期間テキストの BCP-47 言語コード（「en-US」や「sr-Latn」など）。
transitFare
タイプ:  string optional
テキスト形式で表される交通機関の運賃。
transitFareLanguage
タイプ:  string optional
乗車料金テキストの BCP-47 言語コード（「en-US」や「sr-Latn」など）。

詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。
toJSON
toJSON()
パラメータ: なし
戻り値:  Object
オブジェクトに変換します。

RouteMatrixOrigin インターフェース

google.maps.routes.RouteMatrixOrigin インターフェース

ComputeRouteMatrixRequest の単一のオリジン。
waypoint
オリジンのロケーション。文字列として渡される値は、住所または Plus Code です。高度の値は考慮されません。
routeModifiers optional
タイプ:  RouteModifiers optional
この場所を出発地とするすべてのルートの修飾子。