Geocoder 类
google.maps.Geocoder 类
用于在地址和 LatLng 之间转换的服务。
通过调用 const {Geocoder} = await google.maps.importLibrary("geocoding") 进行访问。请参阅 Maps JavaScript API 中的库。
构造函数 | |
|---|---|
Geocoder |
Geocoder()参数：无
创建 Geocoder 的新实例，可向 Google 服务器发送地理编码请求。 |
方法 | |
|---|---|
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。系统仅返回符合所有过滤条件的结果。在所支持的拼写更正和部分匹配方法方面，过滤值与其他地理编码请求相同。可选。 |
|
类型：
Array<ExtraGeocodeComputation> optional可用于完成请求的额外计算列表。注意：这些额外计算可能会在响应中返回额外字段。 |
fulfillOnZeroResults optional |
类型：
boolean optional对响应中的 ZERO_RESULTS 状态执行 promise。这可能是需要的，因为即使没有地理编码结果，仍可能返回其他响应级别字段。 |
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 的全称或简称。可选。 |
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 接口
由包含 GeocoderResult 列表的 Geocoder 返回的地理编码器响应。
属性 | |
|---|---|
results |
类型：
Array<GeocoderResult>GeocoderResult 的列表。 |
|
类型：
AddressDescriptor optional营业地点的相关描述。包含一组经过排名的附近地标和包含目标位置的区域。只有针对反向地理编码请求才填充此字段，并且仅当启用 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 时才会填充。 |
plus_code optional |
类型：
PlacePlusCode optional与营业地点相关联的 Plus 代码。 |
GeocoderResult 接口
google.maps.GeocoderResult 接口
从地址解析服务器检索获得的单个地址解析器结果。一个地址解析请求可能会返回多个结果对象。请注意，尽管此结果为“类 JSON”，但它并非严格意义上的 JSON，因为它间接包含一个 LatLng 对象。
属性 | |
|---|---|
address_components |
GeocoderAddressComponent 的数组 |
formatted_address |
类型：
string一个字符串，其中包含此位置直观易懂的地址。 |
geometry |
一个 GeocoderGeometry 对象 |
place_id |
类型：
string与营业地点相关联的地点 ID。地点 ID 可唯一标识 Google Places 数据库中和 Google 地图上的地点。如需详细了解地点 ID，请参阅 Places API 开发者指南。 |
types |
类型：
Array<string>一个字符串数组，这些字符串表示传回的地址解析元素的类型。有关可能的字符串的列表，请参阅开发者指南的 地址组成部分类型部分。 |
|
类型：
AddressDescriptor optional与此地理编码相关联的位置的关系说明。包含一组经过排名的附近地标和包含目标位置的区域。仅当启用了 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 时，才会为前向地理编码和地点 ID 查找请求填充此字段，并且只有某些本地化地点才会填充此字段。 |
partial_match optional |
类型：
boolean optional地理编码器是否返回与原始请求完全匹配的结果，尽管它能够匹配所请求的地址的一部分。如果完全匹配，则值为 undefined。 |
plus_code optional |
类型：
PlacePlusCode optional与营业地点相关联的 Plus 代码。 |
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 |
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 |
返回的结果反映了在两个精确点（例如交叉路口）之间用插值计算得到的近似值（通常为道路上的地址）。当某个街道地址的 rooftop 地理编码不可用时，通常会返回内插值结果。 |
ROOFTOP |
传回的结果反映了精确的地址解析。 |
地标界面
google.maps.Landmark 接口
表示地址参照点的地点。
属性 | |
|---|---|
display_name |
类型：
string地标的名称。 |
display_name_language_code |
类型：
string地标的名称语言。 |
place_id |
类型：
string用作地标的底层场所的地点 ID。可用于通过“地点详情”或“地点 ID 查询”解析关于地标的更多信息。 |
spatial_relationship |
定义目标位置与地标之间的空间关系。 |
straight_line_distance_meters |
类型：
number目标位置与地标之间的直线距离。 |
types |
类型：
Array<string>一个或多个值，用于表示返回结果的类型。如需了解详情，请参阅类型 。 |
travel_distance_meters optional |
类型：
number optional沿着道路网到达目标位置与地标之间的行程距离。如果地标与目标最近的道路网部分断开了连接，或者目标位置实际上并未包含在道路网中，则此值不会填充。 |
Area 接口
google.maps.Area 接口
是指包含目标位置的较小区域，例如社区、副市级或大型综合体的地点。
属性 | |
|---|---|
containment |
类型：
Containment定义目标位置与区域之间的空间关系。 |
display_name |
类型：
string区域的名称。 |
display_name_language_code |
类型：
string区域名称的语言。 |
place_id |
类型：
string底层区域的地点 ID。可用于通过“地点详情”或“地点 ID 查询”解析有关相应区域的更多信息。 |
Containment 常量
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 |
与地标不在同一条路线上，但只有一个转弯。 |
BEHIND |
靠近地标建筑，但远离其接入点。 |
BESIDE |
目标紧邻地标。 |
DOWN_THE_ROAD |
与地标在同一路线上，但不跨越或过路。 |
NEAR |
这是默认关系（当下文没有更具体的限制适用时）。 |
WITHIN |
地标具有空间几何图形，且目标在边界内。 |