Geocoder 类
google.maps.Geocoder
类
用于在地址和 LatLng
之间进行转换的服务。
使用 v=beta
时,可通过调用 const {Geocoder} = await google.map.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 中的一个(且其中一个)。 |
bounds optional |
类型:
LatLngBounds|LatLngBoundsLiteral optional 要在其中进行搜索的 LatLngBounds 。可选。 |
componentRestrictions optional |
类型:
GeocoderComponentRestrictions optional 组件用于将结果限制在特定区域内。过滤条件包含以下一项或多项: route 、locality 、administrativeArea 、postalCode 、country 。系统仅返回符合所有过滤条件的结果。在所支持的拼写更正和部分匹配方法方面,过滤值与其他地理编码请求相同。可选。 |
language optional |
类型:
string optional 返回结果所用语言的语言标识符(如果可能)。请参阅支持的语言列表。 |
location optional |
类型:
LatLng|LatLngLiteral optional 要搜索的 LatLng (或 LatLngLiteral )。地理编码器执行反向地理编码。如需了解详情,请参阅反向地理编码。必须提供 address 、location 和 placeId 中的一个(且其中一个)。 |
placeId optional |
类型:
string optional |
region optional |
类型:
string optional 用于偏向搜索的国家/地区代码,指定为两个字符(非数字)Unicode 区域子标记/CLDR 标识符。(可选)如需了解受支持的地区,请参阅 Google Maps Platform 覆盖范围详细信息。 |
GeocoderComponentRestrictions 接口
google.maps.GeocoderComponentRestrictions
接口
GeocoderComponentRestrictions
表示一组解析到特定区域的过滤条件。如需详细了解其工作原理,请参阅地理编码组成部分过滤。
属性 | |
---|---|
administrativeArea optional |
类型:
string optional 匹配所有 administrative_area levels 。可选。 |
country optional |
类型:
string optional 用于匹配国家/地区名称或两个字母的 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
常量
Geocoder
在完成对 geocode()
的调用后返回的状态。可以按值或使用常量名称指定这些值。例如 'OK'
或 google.maps.GeocoderStatus.OK
。
使用 v=beta
时,可通过调用 const {GeocoderStatus} = await google.map.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”,但它并非严格意义上的 JSON,因为该结果间接包含 LatLng
对象。
属性 | |
---|---|
address_components |
GeocoderAddressComponent 的数组 |
formatted_address |
类型:
string 包含此位置直观易懂的地址的字符串。 |
geometry |
GeocoderGeometry 对象 |
place_id |
类型:
string |
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 |
location 中返回的位置类型 |
viewport |
类型:
LatLngBounds 用于显示此 GeocoderResult 的推荐视口的边界 |
bounds optional |
类型:
LatLngBounds optional 此 GeocoderResult 的精确边界(如果适用) |
GeocoderLocationType 常量
google.maps.GeocoderLocationType
常量
用于描述从地理编码返回的位置类型。可以按值或使用常量名称指定这些值。例如,'ROOFTOP'
或 google.maps.GeocoderLocationType.ROOFTOP
。
使用 v=beta
时,可通过调用 const {GeocoderLocationType} = await google.map.importLibrary("geocoding")
进行访问。请参阅 Maps JavaScript API 中的库。
常量 | |
---|---|
APPROXIMATE |
传回的结果是近似值。 |
GEOMETRIC_CENTER |
传回的结果是线(例如街道)或多边形(区域)等结果的几何中心。 |
RANGE_INTERPOLATED |
返回的结果反映了用两个精确点(例如十字路口)之间用内插法计算得到的近似值(通常在道路上)。当某个街道地址的 rooftop 地理编码不可用时,通常会返回内插值结果。 |
ROOFTOP |
传回的结果反映了精确的地址解析。 |