Geocoder

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
要进行地理编码的地址。必须提供 addresslocationplaceId 中的一个,且只能提供一个。
bounds optional
类型:  LatLngBounds|LatLngBoundsLiteral optional
要在其中进行搜索的 LatLngBounds。可选。
componentRestrictions optional
类型:  GeocoderComponentRestrictions optional
组成部分用于将结果限制在特定区域内。过滤条件由以下一项或多项组成:routelocalityadministrativeAreapostalCodecountry。系统仅返回符合所有过滤条件的结果。在所支持的拼写更正和部分匹配方法方面,过滤值与其他地理编码请求相同。可选。
BetaextraComputations optional
类型:  Array<ExtraGeocodeComputation> optional
可能用于完成请求的额外计算列表。注意:这些额外的计算可能会在响应中返回额外的字段。
fulfillOnZeroResults optional
类型:  boolean optional
在响应中针对 ZERO_RESULT 状态执行 promise。这可能很有用,因为即使没有任何地理编码结果,系统可能仍会返回其他响应级字段。
language optional
类型:  string optional
应返回结果的语言的语言标识符(如果可能)。请参阅支持的语言列表
location optional
类型:  LatLng|LatLngLiteral optional
要搜索的 LatLng(或 LatLngLiteral)。地理编码器会执行反向地理编码。如需了解详情,请参阅 反向地理编码。必须提供 addresslocationplaceId 中的一个,且只能提供一个。
placeId optional
类型:  string optional
与营业地点相关联的地点 ID。地点 ID 可唯一标识 Google Places 数据库中和 Google 地图上的地点。如需详细了解地点 ID,请参阅 Places API 开发者指南。地理编码器会执行反向地理编码。如需了解详情,请参阅反向地理编码。必须提供 addresslocationplaceId 中的一个,且只能提供一个。
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
localitysublocality 类型匹配。可选。
postalCode optional
类型:  string optional
postal_codepostal_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 常量

Geocoder 在调用 geocode() 完成后返回的状态。您可以按值指定这些参数,也可以使用常量的名称指定这些参数。例如 '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 的列表。
Betaaddress_descriptor optional
类型:  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>
一个字符串数组,这些字符串表示传回的地址解析元素的类型。如需查看可能的字符串列表,请参阅《开发者指南》的 地址组成部分类型部分。
Betaaddress_descriptor optional
类型:  AddressDescriptor optional
与此地理编码关联的地点的关系说明。包含一组排名靠前的附近地标以及包含目标地理位置的区域。仅当启用 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 且请求是正向地理编码和地点 ID 查询时,系统才会为特定本地化地点填充此字段。
partial_match optional
类型:  boolean optional
地理编码器是否未能针对原始请求返回完全匹配的结果,但能够匹配所请求地址的一部分内容。如果完全匹配,则值为 undefined
plus_code optional
类型:  PlacePlusCode optional
与相应营业地点相关联的 Plus Code。
postcode_localities optional
类型:  Array<string> optional
一个字符串数组,用于表示邮政编码中包含的所有市行政区。只有当结果是一个包含多个地方的邮政编码时,才会有此数组。

AddressDescriptor 接口

google.maps.AddressDescriptor 接口

对某个地点的关系型说明。包含一组排名靠前的附近地标以及包含目标地理位置的区域。

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
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 查询功能解析该区域的更多信息。

容器常量

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 地标具有空间几何图形,并且目标位于其边界内。