地理编码器类
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 optionalLatLngBounds 内进行搜索。可选。 | 
componentRestrictions optional | 
类型:   
GeocoderComponentRestrictions optional组成部分用于将结果限制在特定区域内。过滤条件包含以下一项或多项: route、locality、administrativeArea、postalCode、country。系统仅返回符合所有过滤条件的结果。在所支持的拼写更正和部分匹配方法方面,过滤值与其他地理编码请求相同。可选。 | 
 | 
类型:   
Array<ExtraGeocodeComputation> optional可用于完成请求的额外计算的列表。注意:这些额外的计算可能会在响应中返回额外的字段。  | 
fulfillOnZeroResults optional | 
类型:   
boolean optional兑现响应中 ZERO_RESULT 状态的 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
接口
由 Geocoder 返回的地理编码器响应,其中包含 GeocoderResult 的列表。
属性 | |
|---|---|
results | 
类型:   
Array<GeocoderResult>GeocoderResult 的列表。 | 
 | 
类型:   
AddressDescriptor optional位置的相关说明。包含一组排名靠前的附近地标和包含目标位置的区域。仅针对反向地理编码请求进行填充,且仅在启用  ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 时进行填充。 | 
plus_code optional | 
类型:   
PlacePlusCode optional与相应位置相关联的 Plus Code。  | 
GeocoderResult 接口
google.maps.GeocoderResult
接口
从地址解析服务器检索获得的单个地址解析器结果。一个地址解析请求可能会返回多个结果对象。请注意,虽然此结果类似于 JSON,但它并非严格意义上的 JSON,因为它间接包含 LatLng 对象。
属性 | |
|---|---|
address_components | 
GeocoderAddressComponent 的数组 | 
formatted_address | 
类型:   
string一个字符串,其中包含此位置直观易懂的地址。  | 
geometry | 
类型:   
GeocoderGeometry一个  GeocoderGeometry 对象 | 
place_id | 
类型:   
string与相应营业地点相关联的地点 ID。地点 ID 可唯一标识 Google Places 数据库中和 Google 地图上的地点。如需详细了解地点 ID,请参阅 Places API 开发者指南。  | 
types | 
类型:   
Array<string>一个字符串数组,这些字符串表示传回的地址解析元素的类型。如需查看可能的字符串列表,请参阅《开发者指南》的 地址组成部分类型部分。  | 
 | 
类型:   
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 | 
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 | 
传回的结果反映了精确的地址解析。 | 
Landmark 接口
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 查找”功能解析有关该区域的更多信息。  | 
包含常量
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 | 
地标具有空间几何图形,并且目标位于其边界内。 |