DistanceMatrixService クラス
google.maps.DistanceMatrixService
クラス
複数の出発地と目的地の間の距離を計算するサービス。
const {DistanceMatrixService} = await google.maps.importLibrary("routes")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
DistanceMatrixService |
DistanceMatrixService() パラメータ: なし
距離行列クエリを Google サーバーに送信する DistanceMatrixService の新しいインスタンスを作成します。 |
メソッド | |
---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback]) パラメータ:
距離行列リクエストを発行します。 |
DistanceMatrixRequest インターフェース
google.maps.DistanceMatrixRequest
インターフェース
DistanceMatrixService
から送信される距離行列クエリ。出発地と目的地の場所の配列と、指標の計算に関するさまざまなオプションが含まれています。
プロパティ | |
---|---|
destinations |
タイプ:
Array<string|LatLng|LatLngLiteral|Place> 目的地の住所文字列、 LatLng 、または Place オブジェクトを含む配列。距離と時間の計算に使用されます。必須。 |
origins |
タイプ:
Array<string|LatLng|LatLngLiteral|Place> 出発地の住所文字列、 LatLng 、または Place オブジェクトを含む配列。距離と時間を計算するために使用されます。必須。 |
travelMode |
タイプ:
TravelMode リクエストされたルーティングのタイプ。必須。 |
avoidFerries optional |
タイプ:
boolean optional true の場合、可能であればフェリーを回避するように距離行列サービスに指示します。省略可。 |
avoidHighways optional |
タイプ:
boolean optional true の場合、可能であれば高速道路を避けるよう距離行列サービスに指示します。省略可。 |
avoidTolls optional |
タイプ:
boolean optional true の場合、可能であれば有料区間を回避するよう距離行列サービスに指示します。省略可。 |
drivingOptions optional |
タイプ:
DrivingOptions optional travelMode が DRIVING であるリクエストにのみ適用される設定。このオブジェクトは、他の移動手段には影響しません。 |
language optional |
タイプ:
string optional 結果を返す言語の言語識別子(可能な場合)。サポートされている言語の一覧をご覧ください。 |
region optional |
タイプ:
string optional ジオコーディング リクエストのバイアスとして使用される地域コード。地域コードには、ccTLD(「トップレベル ドメイン」)の 2 文字の値を指定します。ほとんどの ccTLD コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」( .co.uk )ですが、ISO 3166-1 コードは「gb」(技術的には「グレート ブリテンおよび北アイルランド連合王国」のエンティティ)です。 |
transitOptions optional |
タイプ:
TransitOptions optional travelMode が TRANSIT であるリクエストにのみ適用される設定。このオブジェクトは、他の移動手段には影響しません。 |
unitSystem optional |
タイプ:
UnitSystem optional 距離の表示に使用する単位系を示します。省略可能で、デフォルトはメートル法です。 |
DistanceMatrixResponse インターフェース
google.maps.DistanceMatrixResponse
インターフェース
DistanceMatrixService
リクエストへのレスポンス。書式設定された送信元と宛先の住所と、対応する送信元住所ごとに 1 つずつ、一連の DistanceMatrixResponseRow
で構成されます。
プロパティ | |
---|---|
destinationAddresses |
タイプ:
Array<string> 書式設定した目的地の住所。 |
originAddresses |
タイプ:
Array<string> 書式設定した出発地の住所。 |
rows |
出発地の住所に対応する行列の行。 |
DistanceMatrixResponseRow インターフェース
google.maps.DistanceMatrixResponseRow
インターフェース
DistanceMatrixService
リクエストに対するレスポンスの行。対応する宛先アドレスごとに 1 つずつ、一連の DistanceMatrixResponseElement
で構成されます。
プロパティ | |
---|---|
elements |
目的地の住所に対応する行の要素。 |
DistanceMatrixResponseElement インターフェース
google.maps.DistanceMatrixResponseElement
インターフェース
DistanceMatrixService
リクエストに対するレスポンスの単一要素。1 つの出発地から 1 つの目的地までの所要時間と距離が含まれます。
プロパティ | |
---|---|
distance |
タイプ:
Distance この出発地と目的地のペアの距離。このプロパティは距離が不明な場合は未定義にできます。 |
duration |
タイプ:
Duration この出発地と目的地のペアの所要時間。このプロパティは所要時間が不明な場合は未定義にできます。 |
duration_in_traffic |
タイプ:
Duration trafficModel プロパティで示される交通状況を考慮した、この出発地と目的地のペアリングの時間。所要時間が不明な場合、このプロパティは undefined になることがあります。リクエスト時に drivingOptions が定義されている場合、プレミアム プランのお客様のみが利用できます。 |
fare |
タイプ:
TransitFare この出発地と目的地の組み合わせの運賃の合計額。乗換案内リクエストにのみ適用されます。 |
status |
この特定の出発地と目的地のペアのステータス。 |
DistanceMatrixStatus 定数
google.maps.DistanceMatrixStatus
定数
距離行列リクエストの完了時に DistanceMatrixService
から返される、リクエストに関する最上位のステータス。これらは値で指定するか、定数の名前を使用して指定します。たとえば、'OK'
や google.maps.DistanceMatrixStatus.OK
などです。
const {DistanceMatrixStatus} = await google.maps.importLibrary("routes")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
INVALID_REQUEST |
指定されたリクエストが無効です。 |
MAX_DIMENSIONS_EXCEEDED |
リクエストに 25 を超える出発地または 25 を超える目的地が含まれています。 |
MAX_ELEMENTS_EXCEEDED |
出発地と目的地のサービスが、クエリごとの制限を超えました。 |
OK |
レスポンスには有効な結果が含まれています。 |
OVER_QUERY_LIMIT |
許可された期間内にリクエストされた要素が多すぎます。しばらくしてから再度リクエストすると、成功するはずです。 |
REQUEST_DENIED |
距離行列サービスの使用がウェブページによって拒否されたことを示します。 |
UNKNOWN_ERROR |
サーバーエラーが原因で距離行列リクエストを処理できませんでした。もう一度試すと正常に処理される可能性があります。 |
DistanceMatrixElementStatus 定数
google.maps.DistanceMatrixElementStatus
定数
距離行列リクエストの完了時に DistanceMatrixService
から返される、特定の出発地と目的地のペアに関する要素レベルのステータス。これらの値は、'OK'
などの文字列として指定します。
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
NOT_FOUND |
このペアの出発地または目的地、あるいはその両方がジオコード化できませんでした。 |
OK |
レスポンスには有効な結果が含まれています。 |
ZERO_RESULTS |
出発地点と到着地点間でルートを見つけられませんでした。 |