Route Matrix (beta)

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: ['*'] の使用は推奨されません。理由は次のとおりです。
  • 必要なフィールドのみを選択すると、サーバーの計算サイクルを節約できるため、レイテンシを短縮して結果を返すことができます。
  • 本番環境ジョブで必要なフィールドのみを選択すると、レイテンシ パフォーマンスが安定します。今後、レスポンス フィールドが追加される可能性があり、その場合、新しいフィールドでは追加の計算時間が必要になることがあります。すべてのフィールドを選択した場合、または最上位レベルですべてのフィールドを選択した場合、新しいフィールドがレスポンスに自動的に含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク経由での読み込みが速くなります。
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
ルートに関する追加情報。

ComputeRouteMatrixRequest インターフェース

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

ルート マトリックスのリクエスト。
destinations
宛先の配列。レスポンス マトリックスの列を決定します。文字列として渡される値は、住所、プラスコード、または Place リソース名にできます。高度の値は考慮されません。
fields
タイプ:  Iterable<string>
取得するフィールドのコレクション。すべてのフィールドに ["*"] を指定します。
origins
レスポンス マトリックスの行を決定するオリジンの配列。文字列として渡される値は、住所、プラスコード、または 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
オリジンのロケーション。文字列として渡される値は、住所またはプラスコードです。高度の値は考慮されません。
routeModifiers optional
タイプ:  RouteModifiers optional
これを起点とするすべてのルートの修飾子。