Geocoder

Geocoder クラス

google.maps.Geocoder クラス
ライブラリ "geocoding"

住所と LatLng の相互変換を行うサービス。

const {Geocoder} = await google.maps.importLibrary("geocoding");

コンストラクタ
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 省略可	タイプ: string optional ジオコーディングする住所。address、location、placeId のいずれか 1 つのみを指定する必要があります。
bounds 省略可	タイプ: LatLngBounds|LatLngBoundsLiteral optional 検索対象の LatLngBounds。省略可。
componentRestrictions 省略可	タイプ: GeocoderComponentRestrictions optional コンポーネントは、結果を特定のエリアに制限するために使用されます。フィルタは、route、locality、administrativeArea、postalCode、country の 1 つ以上で構成されます。すべてのフィルタに一致する結果のみが返されます。 フィルタ値では、他のジオコーディング リクエストと同じように、綴りの修正や部分一致がサポートされます。省略可。
extraComputations 省略可	注: v=Beta チャンネルでのみ利用できます。 タイプ: Array<ExtraGeocodeComputation> optional リクエストを完了するために使用される追加の計算のリスト。注: これらの追加の計算により、レスポンスに追加のフィールドが返されることがあります。
fulfillOnZeroResults 省略可	タイプ: boolean optional レスポンスが ZERO_RESULT ステータスの場合、Promise に入力します。ジオコーディング結果がゼロであっても、追加のレスポンス単位のフィールドが返される可能性があるため、推奨されています。
language 省略可	タイプ: string optional 可能な場合に結果を返す言語の言語識別子。サポートされている言語の一覧をご覧ください。
location 省略可	タイプ: LatLng|LatLngLiteral optional 検索対象の LatLng（または LatLngLiteral）。ジオコーダは、リバース ジオコーディングを実行します。詳細については、 リバース ジオコーディングをご覧ください。address、location、placeId のいずれか 1 つのみを指定する必要があります。
placeId 省略可	タイプ: string optional ビジネスに関連付けられたプレイス ID。プレイス ID は、Google プレイスのデータベースおよび Google マップで、特定の場所を一意に識別する ID です。プレイス ID について詳しくは、Places API デベロッパー ガイドをご覧ください。ジオコーダは、リバース ジオコーディングを実行します。詳細については、リバース ジオコーディングをご覧ください。address、location、placeId のいずれか 1 つのみを指定する必要があります。
region 省略可	タイプ: string optional 検索をバイアスするために使用される国コード。2 文字（数値ではない）の Unicode 地域サブタグ / CLDR 識別子として指定します。省略可。サポートされている地域は、Google Maps Platform のサポート状況でご確認いただけます。

GeocoderComponentRestrictions インターフェース

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

GeocoderComponentRestrictions は、特定のエリアに解決されるフィルタのセットを表します。この仕組みの詳細については、 ジオコーディング コンポーネントのフィルタリングをご覧ください。

プロパティ
administrativeArea 省略可	タイプ: string optional すべての administrative_area levels と一致します。省略可。
country 省略可	タイプ: string optional 国名、または 2 文字の ISO 3166-1 国コードを照合します。省略可。
locality 省略可	タイプ: string optional locality と sublocality の両方のタイプで照合します。省略可。
postalCode 省略可	タイプ: string optional postal_code と postal_code_prefix に一致します。省略可。
route 省略可	タイプ: string optional route の正式名または略称を照合します。省略可。

ExtraGeocodeComputation 定数

google.maps.ExtraGeocodeComputation constants
library "geocoding"

注: v=Beta チャンネルでのみ利用できます。

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

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは ExtraGeocodeComputationString 型で定義されます。

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");

定数
ADDRESS_DESCRIPTORS	アドレス記述子を生成します。

GeocoderStatus 定数

google.maps.GeocoderStatus constants
library "geocoding"

geocode() の呼び出しの完了時に Geocoder によって返されるステータス。これらは値で指定するか、定数の名前を使用して指定します。たとえば、'OK' や google.maps.GeocoderStatus.OK です。

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは GeocoderStatusString 型で定義されます。

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");

定数
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 のリスト。
address_descriptor 省略可	注: v=Beta チャンネルでのみ利用できます。 タイプ: AddressDescriptor optional 場所の関係的な説明。近くのランドマークと、対象地域を含むエリアのランク付けされたセットが含まれます。これは、リバース ジオコーディング リクエストに対してのみ、ExtraGeocodeComputation.ADDRESS_DESCRIPTORS が有効になっている場合にのみ入力されます。
plus_code 省略可	タイプ: 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 です。プレイス ID の詳細については、Places API デベロッパー ガイドをご覧ください。
types	タイプ: Array<string> 返されたジオコーディングされた要素のタイプを示す文字列の配列。指定可能な文字列の一覧については、デベロッパー ガイドの 住所コンポーネントのタイプをご覧ください。
address_descriptor 省略可	注: v=Beta チャンネルでのみ利用できます。 タイプ: AddressDescriptor optional このジオコードに関連付けられた場所の関係の説明。近くのランドマークと、対象地域を含むエリアのランク付けされたセットが含まれます。このフィールドは、ExtraGeocodeComputation.ADDRESS_DESCRIPTORS が有効になっている場合に、特定のローカライズされた場所に対する、前方ジオコーディングとプレイス ID の検索リクエストでのみ入力されます。
partial_match 省略可	タイプ: boolean optional ジオコーダによって、元のリクエストに完全一致する住所は見つからなかったものの、部分一致する住所は見つかったかどうか。完全一致の場合、値は undefined になります。
plus_code 省略可	タイプ: PlacePlusCode optional 場所に関連付けられた Plus Code。
postcode_localities 省略可	タイプ: 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 省略可	タイプ: LatLngBounds optional この GeocoderResult の正確な境界（該当する場合）

GeocoderLocationType 定数

google.maps.GeocoderLocationType constants
library "geocoding"

ジオコードから返される場所のタイプを表します。これらは値で指定するか、定数の名前を使用して指定します。たとえば、'ROOFTOP' や、google.maps.GeocoderLocationType.ROOFTOP です。

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは GeocoderLocationTypeString 型で定義されます。

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");

定数
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 省略可	タイプ: number optional 対象地域とランドマーク間の道路網に沿った移動距離。ランドマークが、ターゲットに最も近い道路ネットワークの一部から切り離されている場合、またはターゲットの場所が実際には道路ネットワーク上にあると見なされなかった場合、このフィールドは空になることがあります。

Area インターフェース

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

注: v=Beta チャンネルでのみ利用できます。

対象地域を含む、近隣地域、地域の下位区分、大規模な複合施設などの小さな地域。

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

Containment 定数

google.maps.Containment constants
library "geocoding"

注: v=Beta チャンネルでのみ利用できます。

エリアと対象地域の空間関係を表す列挙型。

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは ContainmentString 型で定義されます。

const {Containment} = await google.maps.importLibrary("geocoding");

定数
NEAR	対象地域はエリアリージョンの外側にあるが、近くにある。
OUTSKIRTS	対象地域はエリア リージョン内にあり、端に近い。
WITHIN	対象地域はエリア リージョン内にあり、中心に近い。

SpatialRelationship 定数

google.maps.SpatialRelationship constants
library "geocoding"

注: v=Beta チャンネルでのみ利用できます。

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

これらの定数は文字列としても使用できます。TypeScript では、文字列リテラルは SpatialRelationshipString 型で定義されます。

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");

定数
ACROSS_THE_ROAD	目的地は、道路を挟んだランドマークの真向かいにあります。
AROUND_THE_CORNER	ランドマークと同じ経路上にはないが、1 回曲がったところにある。
BEHIND	ランドマークの構造物の近くにありますが、アクセス ポイントからは離れています。
BESIDE	ターゲットがランドマークに直接隣接している。
DOWN_THE_ROAD	ランドマークと同じ経路上にあるが、隣でも向かいでもない。
NEAR	これは、以下のより具体的な関係が適用されない場合のデフォルトの関係です。
WITHIN	ランドマークに空間ジオメトリがあり、ターゲットがその境界内にある。