DistanceMatrixService クラス
google.maps.DistanceMatrixService
クラス
ライブラリ "routes"
const {DistanceMatrixService} = await google.maps.importLibrary("routes");
コンストラクタ | |
|---|---|
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
省略可 |
タイプ:
boolean optionaltrue の場合、可能な限りフェリーを避けるよう距離行列サービスに指示します。省略可。 |
avoidHighways
省略可 |
タイプ:
boolean optionaltrue の場合、可能であれば高速道路を避けるよう距離行列サービスに指示します。省略可。 |
avoidTolls
省略可 |
タイプ:
boolean optionaltrue の場合、可能であれば有料道路を避けるよう距離行列サービスに指示します。省略可。 |
drivingOptions
省略可 |
タイプ:
DrivingOptions optionaltravelMode が DRIVING であるリクエストにのみ適用される設定。このオブジェクトは、他の移動手段には影響しません。 |
language
省略可 |
タイプ:
string optional可能な場合に結果を返す言語の言語識別子。サポートされている言語の一覧をご覧ください。 |
region
省略可 |
タイプ:
string optionalジオコーディング リクエストのバイアスとして使用されるリージョン コード。地域コードには、ccTLD(「トップレベル ドメイン」)の 2 文字の値を指定できます。ほとんどの ccTLD コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」( .co.uk)ですが、ISO 3166-1 コードは「gb」です(厳密には「グレート ブリテンおよび北アイルランド連合王国」のエンティティ)。 |
transitOptions
省略可 |
タイプ:
TransitOptions optionaltravelMode が TRANSIT であるリクエストにのみ適用される設定。このオブジェクトは、他の移動手段には影響しません。 |
unitSystem
省略可 |
タイプ:
UnitSystem optional距離を表示するときに使用する優先単位系。省略可能で、デフォルトはメートル法です。 |
DistanceMatrixResponse インターフェース
google.maps.DistanceMatrixResponse インターフェース
DistanceMatrixService リクエストに対するレスポンス。書式設定された出発地と目的地の住所、および DistanceMatrixResponseRow のシーケンス(対応する出発地住所ごとに 1 つ)で構成されます。
プロパティ | |
|---|---|
destinationAddresses |
タイプ:
Array<string>書式設定した目的地の住所。 |
originAddresses |
タイプ:
Array<string>書式設定した出発地の住所。 |
rows |
出発地の住所に対応する行列の行。 |
DistanceMatrixResponseRow インターフェース
google.maps.DistanceMatrixResponseRow インターフェース
DistanceMatrixService リクエストに対するレスポンスの行。DistanceMatrixResponseElement のシーケンスで構成され、各 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
constants
library "routes"
距離行列リクエストの完了時に DistanceMatrixService から返される、リクエスト全般に関する最上位のステータス。これらは値で指定するか、定数の名前を使用して指定します。たとえば、'OK' や google.maps.DistanceMatrixStatus.OK です。
これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは DistanceMatrixStatusString 型で定義されます。
const {DistanceMatrixStatus} = await google.maps.importLibrary("routes");
定数 | |
|---|---|
INVALID_REQUEST |
指定されたリクエストが無効です。 |
MAX_DIMENSIONS_EXCEEDED |
リクエストに 25 を超える出発地または 25 を超える目的地が含まれています。 |
MAX_ELEMENTS_EXCEEDED |
出発地と目的地のサービスが、クエリごとの制限を超えました。 |
OK |
レスポンスには有効な結果が含まれています。 |
OVER_QUERY_LIMIT |
許可された期間内にリクエストされた要素が多すぎます。しばらくしてからもう一度リクエストすると、成功する可能性があります。 |
REQUEST_DENIED |
距離行列サービスの使用がウェブページによって拒否されたことを示します。 |
UNKNOWN_ERROR |
サーバーエラーが原因で、距離行列リクエストを処理できませんでした。もう一度試すと正常に処理される可能性があります。 |
DistanceMatrixElementStatus 定数
google.maps.DistanceMatrixElementStatus
constants
library "routes"
距離行列リクエストの完了時に DistanceMatrixService から返される、特定の出発地と目的地のペアに関する要素レベルのステータス。これらの値は文字列として指定します(例: 'OK')。
これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは DistanceMatrixElementStatusString 型で定義されます。
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes");
定数 | |
|---|---|
NOT_FOUND |
このペアの出発地または目的地、あるいはその両方がジオコード化できませんでした。 |
OK |
レスポンスには有効な結果が含まれています。 |
ZERO_RESULTS |
出発地点と到着地点間でルートを見つけられませんでした。 |