Geocoder

Geocoder クラス

google.maps.Geocoder クラス

アドレスと LatLng の間で変換を行うサービス。

const {Geocoder} = await google.maps.importLibrary("geocoding") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。

コンストラクタ
Geocoder	Geocoder() パラメータ: なし Google サーバーにジオコード リクエストを送信する Geocoder の新しいインスタンスを作成します。

メソッド
geocode	geocode(request[, callback]) パラメータ:  request:  GeocoderRequest callback:  function(Array<GeocoderResult> optional, GeocoderStatus): void optional 戻り値:  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	注意: v=beta チャンネルでのみ使用できます。 タイプ:  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 です。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 の正式名または略称を照合します。省略可。

ExtraGeocodeComputation 定数

google.maps.ExtraGeocodeComputation 定数

注意: v=beta チャンネルでのみ使用できます。

ジオコーディング リクエストの完了時に実行する追加の計算。

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 インターフェース

GeocoderResult のリストを含む Geocoder によって返される Geocoder レスポンス。

プロパティ
results	タイプ:  Array<GeocoderResult> GeocoderResult のリスト。
address_descriptor optional	注意: v=beta チャンネルでのみ使用できます。 タイプ:  AddressDescriptor optional 場所の相対的な説明。付近のランドマークと、ターゲットの場所を含むエリアのランク付けされたセットが含まれます。これは、逆ジオコーディング リクエストに対してのみ、また ExtraGeocodeComputation.ADDRESS_DESCRIPTORS が有効になっている場合にのみ入力されます。
plus_code optional	タイプ:  PlacePlusCode optional ビジネスに関連付けられている Plus Code。

GeocoderResult インターフェース

google.maps.GeocoderResult インターフェース

ジオコード サーバーから取得された 1 つのジオコーダ結果。なお、1 件のジオコード リクエストで、結果として複数のオブジェクトが返される場合もあります。この結果は「JSON のような」ものですが、LatLng オブジェクトを間接的に含んでいるため、厳密には JSON ではありません。

プロパティ
address_components	タイプ:  Array<GeocoderAddressComponent> GeocoderAddressComponent の配列。
formatted_address	タイプ:  string 人が読める形式のこの場所の住所を含む文字列。
geometry	タイプ:  GeocoderGeometry GeocoderGeometry オブジェクト
place_id	タイプ:  string ビジネスに関連付けられているプレイス ID。プレイス ID は、Google プレイスのデータベースおよび Google マップで、特定の場所を一意に識別する ID です。Places API デベロッパー ガイドのプレイス ID をご覧ください。
types	タイプ:  Array<string> 返されたジオコード要素のタイプを示す文字列の配列。使用可能な文字列の一覧については、デベロッパー ガイドの アドレス コンポーネント タイプのセクションをご覧ください。
address_descriptor optional	注意: v=beta チャンネルでのみ使用できます。 タイプ:  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 インターフェース

注意: v=beta チャンネルでのみ使用できます。

場所の相対的な説明。付近のランドマークと、ターゲットの場所を含むエリアのランク付けされたセットが含まれます。

プロパティ
areas	タイプ:  Array<Area> 包含または隣接するエリアのランキング リスト。最も有用な（認識可能で正確な）エリアが最初にランク付けされます。
landmarks	タイプ:  Array<Landmark> 近くのランドマークのランキング リスト。最も有用な（認識しやすく、近くにある）ランドマークが最初にランク付けされます。

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	正確なジオコードの結果が返されました。

Landmark インターフェース

google.maps.Landmark インターフェース

注意: v=beta チャンネルでのみ使用できます。

住所の基準点となる場所。

プロパティ
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 インターフェース

注意: v=beta チャンネルでのみ使用できます。

近隣地域、地域の下位区分、ターゲットの場所を含む大規模な複合施設などの小さな地域。

プロパティ
containment	タイプ:  Containment ターゲットの場所とエリアの空間的関係を定義します。
display_name	タイプ:  string エリアの名前。
display_name_language_code	タイプ:  string 地域の名前の言語。
place_id	タイプ:  string 基盤となるエリアの Place ID。Place Details または Place ID Lookup を使用して、エリアに関する詳細情報を解決するために使用できます。

Containment 定数

google.maps.Containment 定数

注意: v=beta チャンネルでのみ使用できます。

エリアとターゲットの場所の空間的関係を表す列挙型。

const {Containment} = await google.maps.importLibrary("geocoding") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。

定数
NEAR	ターゲットの場所はエリア リージョン外ですが、近くにあります。
OUTSKIRTS	ターゲット ロケーションがエリア リージョン内にあり、端に近い。
WITHIN	ターゲットの場所は、エリア リージョンの中央付近にあります。

SpatialRelationship 定数

google.maps.SpatialRelationship 定数

注意: v=beta チャンネルでのみ使用できます。

ランドマークとターゲットの空間的な関係を表す列挙型。

const {SpatialRelationship} = await google.maps.importLibrary("geocoding") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。

定数
ACROSS_THE_ROAD	ターゲットが道路を挟んだランドマークの真向かいにある。
AROUND_THE_CORNER	ランドマークと同じルート上にはないが、1 回曲がれば到達できる。
BEHIND	ランドマークの構造には近いが、出入口からは遠い。
BESIDE	ターゲットがランドマークに直接隣接している。
DOWN_THE_ROAD	ランドマークと同じ経路上にあるが、隣または向かい側ではない。
NEAR	これは、以下のより具体的な関係のいずれにも該当しない場合のデフォルトの関係です。
WITHIN	ランドマークに空間ジオメトリがあり、ターゲットがその境界内にある。