Geocoder クラス
google.maps.Geocoder
クラス
住所と LatLng
を相互に変換するサービス。
const {Geocoder} = await google.maps.importLibrary("geocoding")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
Geocoder |
Geocoder() パラメータ: なし
ジオコード リクエストを Google サーバーに送信する Geocoder の新しいインスタンスを作成します。 |
メソッド | |
---|---|
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 つ以上で構成されます。すべてのフィルタに一致する結果のみが返されます。 フィルタ値では、他のジオコーディング リクエストと同じように、綴りの修正や部分一致がサポートされます。省略可。 |
extraComputations optional |
タイプ:
Array<ExtraGeocodeComputation> optional リクエストの完了に使用できる追加の計算のリスト。注: これらの追加計算により、レスポンスに追加のフィールドが返される場合があります。 |
fulfillOnZeroResults optional |
タイプ:
boolean optional レスポンスが ZERO_RESULT ステータスの場合、Promise に入力します。ジオコーディング結果がゼロであっても、追加のレスポンス単位のフィールドが返される可能性があるため、推奨されています。 |
language optional |
タイプ:
string optional 結果を返す言語の言語識別子(可能な場合)。サポートされている言語の一覧をご覧ください。 |
location optional |
タイプ:
LatLng|LatLngLiteral optional 検索する LatLng (または LatLngLiteral )。ジオコーダはリバース ジオコーディングを実行します。詳細については、 リバース ジオコーディングをご覧ください。address 、location 、placeId のいずれか 1 つを指定する必要があります。 |
placeId optional |
タイプ:
string optional 場所に関連付けられているプレイス ID。プレイス ID は、Google プレイスのデータベースおよび Google マップで、特定の場所を一意に識別する ID です。プレイス ID の詳細については、Places API デベロッパー ガイドをご覧ください。ジオコーダはリバース ジオコーディングを実行します。詳細については、リバース ジオコーディングをご覧ください。 address 、location 、placeId のいずれか 1 つを指定する必要があります。 |
region optional |
タイプ:
string optional 検索のバイアス付けに使用される国コード。2 文字(数値ではない)の Unicode 地域サブタグ / CLDR ID で指定します。省略可。サポートされている地域は、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 の正式名または略称を照合します。省略可。 |
ExtraGeocodeComputation 定数
google.maps.ExtraGeocodeComputation
定数
ジオコーディング リクエストの完了時に実行する追加の計算。
const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
ADDRESS_DESCRIPTORS |
アドレス記述子を生成します。 |
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 のリスト。 |
address_descriptor optional |
タイプ:
AddressDescriptor optional 場所の関連する説明。近くのランドマークと、対象の場所を含むエリアのランキング セットが含まれます。リバース ジオコーディング リクエストで、 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS が有効になっている場合にのみ入力されます。 |
plus_code optional |
タイプ:
PlacePlusCode optional 場所に関連付けられている Plus Code。 |
GeocoderResult インターフェース
google.maps.GeocoderResult
インターフェース
ジオコード サーバーから取得された 1 つのジオコーダ結果。1 件のジオコード リクエストで、結果として複数のオブジェクトが返される場合もあります。この結果は「JSON に似ている」ものの、LatLng
オブジェクトが間接的に含まれているため、厳密には JSON ではありません。
プロパティ | |
---|---|
address_components |
GeocoderAddressComponent の配列。 |
formatted_address |
タイプ:
string この場所の住所が人間が読める形式で格納された文字列。 |
geometry |
タイプ:
GeocoderGeometry GeocoderGeometry オブジェクト |
place_id |
タイプ:
string 場所に関連付けられているプレイス ID。プレイス ID は、Google プレイスのデータベースおよび Google マップで、特定の場所を一意に識別する ID です。Place ID の詳細については、Places API デベロッパー ガイドをご覧ください。 |
types |
タイプ:
Array<string> 返されたジオコーディングされた要素のタイプを示す文字列の配列。使用可能な文字列の一覧については、デベロッパー ガイドの 住所のコンポーネント タイプをご覧ください。 |
address_descriptor optional |
タイプ:
AddressDescriptor optional このジオコードに関連付けられている場所の説明。近くのランドマークと、対象の場所を含むエリアのランキング セットが含まれます。これは、フォワード ジオコーディング リクエストとプレイス ID ルックアップ リクエストで、 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS が有効になっている場合にのみ、特定のローカライズされた場所でのみ入力されます。 |
partial_match optional |
タイプ:
boolean optional ジオコーダによって、元のリクエストに完全一致する住所は見つからなかったものの、部分一致する住所は見つかったかどうか。完全一致の場合、値は undefined になります。 |
plus_code optional |
タイプ:
PlacePlusCode optional 場所に関連付けられている Plus Code。 |
postcode_localities optional |
タイプ:
Array<string> optional 郵便番号に含まれるすべての地域区分を示す文字列の配列。このフィールドは、結果の郵便番号に複数の地域が含まれる場合のみ存在します。 |
AddressDescriptor インターフェース
google.maps.AddressDescriptor
インターフェース
場所の関連する説明。近くのランドマークと、対象の場所を含むエリアのランキング セットが含まれます。
プロパティ | |
---|---|
areas |
含まれるエリアまたは隣接するエリアのランキング リスト。最も有用な(認識可能で正確な)エリアが優先されます。 |
landmarks |
近くのランドマークのランキング リスト。最も有用な(認識しやすく、近くにある)ランドマークが最初に表示されます。 |
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 |
正確なジオコードの結果が返されました。 |
ランドマーク インターフェース
google.maps.Landmark
インターフェース
住所の参照ポイントを表す場所。
プロパティ | |
---|---|
display_name |
タイプ:
string ランドマークの名前。 |
display_name_language_code |
タイプ:
string ランドマークの名前の言語。 |
place_id |
タイプ:
string ランドマークとして機能する基盤となる施設のプレイス ID。Place Details または Place Id Lookup を使用して、ランドマークの詳細情報を解決するために使用できます。 |
spatial_relationship |
タイプ:
SpatialRelationship ターゲット ロケーションとランドマーク間の空間関係を定義します。 |
straight_line_distance_meters |
タイプ:
number 目的地とランドマーク間の直線距離。 |
types |
タイプ:
Array<string> 返される結果のタイプを示す 1 つ以上の値。詳しくは、タイプ をご覧ください。 |
travel_distance_meters optional |
タイプ:
number optional 対象の場所とランドマーク間の道路網に沿った移動距離。ランドマークがターゲットが最も近い道路網の一部から切断されている場合や、ターゲット ロケーションが実際に道路網上にあると見なされていない場合は、このフィールドに値が入力されないことがあります。 |
Area インターフェース
google.maps.Area
インターフェース
対象の場所を含む小さな地域(近隣地域、地域の下位区分、大規模な複合施設など)。
プロパティ | |
---|---|
containment |
タイプ:
Containment 対象の場所とエリア間の空間関係を定義します。 |
display_name |
タイプ:
string エリアの名前。 |
display_name_language_code |
タイプ:
string 地域の名前の言語。 |
place_id |
タイプ:
string 基盤となるエリアの Place ID。Place Details または Place ID Lookup を使用して、その地域の詳細情報を解決できます。 |
コンテナ化定数
google.maps.Containment
定数
エリアとターゲット ロケーション間の空間関係を表す列挙型。
const {Containment} = await google.maps.importLibrary("geocoding")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
NEAR |
対象の場所はエリアの外部にあるが、近くにある。 |
OUTSKIRTS |
ターゲット ロケーションがエリア領域内にあり、端に近い。 |
WITHIN |
ターゲット ロケーションがエリア内の中心付近にある。 |
SpatialRelationship 定数
google.maps.SpatialRelationship
定数
ランドマークとターゲット間の空間的な関係を表す列挙型。
const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
定数 | |
---|---|
ACROSS_THE_ROAD |
ターゲットが道路の反対側にあるランドマークの真向かいにある場合。 |
AROUND_THE_CORNER |
ランドマークと同じルート上ではないが、1 回曲がれば到達できる場所。 |
BEHIND |
ランドマークの構造物に近いが、出入口からは遠い。 |
BESIDE |
ターゲットがランドマークに直接隣接している。 |
DOWN_THE_ROAD |
ランドマークと同じ経路上にあるが、隣接していない、または向かい側にない。 |
NEAR |
以下に具体的な関係がない場合、これがデフォルトの関係になります。 |
WITHIN |
ランドマークに空間ジオメトリがあり、ターゲットがその境界内にある。 |