Geocoder クラス
google.maps.Geocoder
クラス
住所と LatLng
の間の変換を行うサービス。
アクセスするには、const {Geocoder} = await google.maps.importLibrary("geocoding")
を呼び出します。詳しくは、Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
Geocoder |
Geocoder() パラメータ: なし
Google サーバーにジオコード リクエストを送信する Geocoder の新しいインスタンスを作成します。 |
Methods | |
---|---|
geocode |
geocode(request[, callback]) パラメータ:
戻り値:
Promise<GeocoderResponse> リクエストをジオコード化します。 |
GeocoderRequest インターフェース
google.maps.GeocoderRequest
インターフェース
Geocoder
に送信されるジオコーディング リクエストの仕様。
プロパティ | |
---|---|
address optional |
タイプ:
string optional ジオコーディングする住所。 address 、location 、placeId のいずれか 1 つのみを指定する必要があります。 |
bounds optional |
タイプ:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds を検索する範囲です。省略可。 |
componentRestrictions optional |
タイプ:
GeocoderComponentRestrictions optional コンポーネントは、結果を特定のエリアに制限するために使用します。フィルタは route 、locality 、administrativeArea 、postalCode 、country のうち 1 つ以上で構成されます。すべてのフィルタに一致する結果のみが返されます。 フィルタ値では、他のジオコーディング リクエストと同じように、綴りの修正や部分一致がサポートされます。省略可。 |
language optional |
タイプ:
string optional 結果を結果で返す言語の言語識別子(可能な場合)。サポートされている言語の一覧をご覧ください。 |
location optional |
タイプ:
LatLng|LatLngLiteral optional 検索する LatLng (またはLatLngLiteral )。ジオコーダはリバース ジオコーディングを実行します。詳しくは、 リバース ジオコーディングをご覧ください。address 、location 、placeId のいずれか 1 つのみを指定する必要があります。 |
placeId optional |
タイプ:
string optional ビジネスに関連付けられたプレイス ID。場所 ID は、Google プレイスのデータベースと Google マップで、プレイスを一意に識別します。場所 ID について詳しくは、Places API のデベロッパー ガイドをご覧ください。ジオコーダはリバース ジオコーディングを実行します。詳しくは、リバース ジオコーディングをご覧ください。 address 、location 、placeId のいずれか 1 つのみを指定する必要があります。 |
region optional |
タイプ:
string optional 検索のバイアスに使用する国コード。2 文字の Unicode 地域サブタグ / CLDR 識別子で指定します。(省略可)サポートされている地域は、Google Maps Platform のサポート状況でご確認いただけます。 |
GeocoderComponentRestrictions インターフェース
google.maps.GeocoderComponentRestrictions
インターフェース
GeocoderComponentRestrictions
は、特定の領域に解決される一連のフィルタを表します。この仕組みの詳細については、 ジオコーディング コンポーネントのフィルタリングをご覧ください。
プロパティ | |
---|---|
administrativeArea optional |
タイプ:
string optional すべての administrative_area levels に一致します。省略可。 |
country optional |
タイプ:
string optional 国名または 2 文字の ISO 3166-1 国コードに一致します。省略可。 |
locality optional |
タイプ:
string optional locality 型と sublocality 型の両方に一致します。省略可。 |
postalCode optional |
タイプ:
string optional postal_code および postal_code_prefix と一致します。省略可。 |
route optional |
タイプ:
string optional route の正式名または略称と一致します。省略可。 |
GeocoderStatus 定数
google.maps.GeocoderStatus
定数
geocode()
の呼び出しの完了時に Geocoder
から返されるステータス。値または定数名を使用して指定します。たとえば、'OK'
や google.maps.GeocoderStatus.OK
です。
アクセスするには、const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
を呼び出します。詳しくは、Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
ERROR |
Google サーバーへの接続で問題が発生しました。 |
INVALID_REQUEST |
この GeocoderRequest は無効です。 |
OK |
レスポンスには有効な GeocoderResponse が含まれます。 |
OVER_QUERY_LIMIT |
ウェブページは、短期間にリクエストの制限回数を超えました。 |
REQUEST_DENIED |
ウェブページではジオコーダを使用できません。 |
UNKNOWN_ERROR |
サーバーエラーのため、ジオコーディング リクエストを処理できませんでした。再度リクエストすると、成功する可能性があります。 |
ZERO_RESULTS |
この GeocoderRequest に一致する結果は見つかりませんでした。 |
GeocoderResponse インターフェース
google.maps.GeocoderResponse
インターフェース
GeocoderResult
のリストを含む Geocoder
から返されるジオコーダ レスポンス。
プロパティ | |
---|---|
results |
タイプ:
Array<GeocoderResult> GeocoderResult のリスト。 |
GeocoderResult インターフェース
google.maps.GeocoderResult
インターフェース
ジオコーダ サーバーから取得された単一のジオコーダの結果。ジオコード リクエストでは、複数の結果オブジェクトが返されることがあります。この結果は「JSON に類似した形式」ですが、LatLng
オブジェクトが間接的に含まれているため、厳密には JSON ではありません。
プロパティ | |
---|---|
address_components |
GeocoderAddressComponent の配列。 |
formatted_address |
タイプ:
string 人が読める形式のこの場所の住所を含む文字列。 |
geometry |
タイプ:
GeocoderGeometry GeocoderGeometry オブジェクト |
place_id |
タイプ:
string ビジネスに関連付けられたプレイス ID。場所 ID は、Google プレイスのデータベースと Google マップで、プレイスを一意に識別します。場所 ID について詳しくは、Places API デベロッパー ガイドをご覧ください。 |
types |
タイプ:
Array<string> 返されるジオコードされた要素のタイプを示す文字列の配列。使用可能な文字列のリストについては、デベロッパー ガイドの 住所コンポーネントのタイプをご覧ください。 |
partial_match optional |
タイプ:
boolean optional ジオコーダによって、元のリクエストに完全一致する住所は見つからなかったものの、部分一致する住所は見つかったかどうかを示します。完全一致の場合、値は undefined になります。 |
plus_code optional |
タイプ:
PlacePlusCode optional 場所に関連付けられている plus code。 |
postcode_localities optional |
タイプ:
Array<string> optional 郵便番号に含まれるすべての地域を示す文字列の配列。このフィールドは、結果の郵便番号に複数の地域が含まれる場合のみ存在します。 |
GeocoderAddressComponent インターフェース
google.maps.GeocoderAddressComponent
インターフェース
GeocoderResult
内の単一の住所コンポーネント。完全な住所は、複数の住所コンポーネントで構成できます。
プロパティ | |
---|---|
long_name |
タイプ:
string 住所コンポーネントのフル テキスト。 |
short_name |
タイプ:
string 指定された住所コンポーネントの、省略された短い形式のテキスト。 |
types |
タイプ:
Array<string> この住所コンポーネントのタイプを示す文字列の配列です。有効なタイプのリストについては、こちらをご覧ください。 |
GeocoderGeometry インターフェース
google.maps.GeocoderGeometry
インターフェース
この GeocoderResult
のジオメトリ情報
プロパティ | |
---|---|
location |
タイプ:
LatLng この結果の緯度/経度の座標。 |
location_type |
タイプ:
GeocoderLocationType location で返される場所のタイプ |
viewport |
タイプ:
LatLngBounds この GeocoderResult を表示するための推奨ビューポートの境界。 |
bounds optional |
タイプ:
LatLngBounds optional この GeocoderResult の正確な境界(該当する場合) |
GeocoderLocationType 定数
google.maps.GeocoderLocationType
定数
ジオコードから返される場所のタイプを記述します。値または定数名を使用して指定します。('ROOFTOP'
や google.maps.GeocoderLocationType.ROOFTOP
など)が使用されます。
アクセスするには、const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
を呼び出します。詳しくは、Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
APPROXIMATE |
返された結果はおおよその値です。 |
GEOMETRIC_CENTER |
返された結果はライン(例: ストリート)やポリゴン(領域)などの結果の幾何学的中心です。 |
RANGE_INTERPOLATED |
返された結果は、2 つの正確なポイント(交差点など)の間で補間された近似値(通常は道路上)を反映しています。補間された結果が返されるのは、番地に対してルーフトップ ジオコーディングが使用できない場合が一般的です。 |
ROOFTOP |
正確なジオコードの結果が返されました。 |