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 デベロッパー ガイドのプレイス ID をご覧ください。ジオコーダはリバース ジオコーディングを実行します。詳細については、リバース ジオコーディングをご覧ください。 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
インターフェース
Geocoder
から返される、GeocoderResult
のリストを含むジオコーダ レスポンス。
プロパティ | |
---|---|
results |
タイプ:
Array<GeocoderResult> GeocoderResult のリスト。 |
GeocoderResult インターフェース
google.maps.GeocoderResult
インターフェース
ジオコード サーバーから取得された 1 つのジオコーダの結果。ジオコード リクエストでは、複数の結果オブジェクトが返されることがあります。この結果は「JSON に類似した形式」ですが、LatLng
オブジェクトが間接的に含まれているため、厳密には JSON ではありません。
プロパティ | |
---|---|
address_components |
GeocoderAddressComponent の配列。 |
formatted_address |
タイプ:
string 人が読める形式のこの場所の住所を含む文字列。 |
geometry |
タイプ:
GeocoderGeometry GeocoderGeometry オブジェクト |
place_id |
タイプ:
string ビジネスに関連付けられているプレイス ID。プレイス ID は、Google プレイスのデータベースおよび Google マップで、特定の場所を一意に識別する ID です。詳しくは、Places API デベロッパー ガイドのプレイス ID をご覧ください。 |
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 |
正確なジオコードの結果が返されました。 |