Geocoder

Geocoder 类

google.maps.Geocoder class
library "geocoding"

一项用于在地址和 LatLng 之间进行转换的服务。

const {Geocoder} = await google.maps.importLibrary("geocoding");
Geocoder
Geocoder()
参数:无
创建向 Google 服务器发送地理编码请求的 Geocoder 的新实例。
geocode
geocode(request[, callback])
参数:
对请求内容进行地址解析。

GeocoderRequest 接口

google.maps.GeocoderRequest 接口

要发送到 Geocoder 的地理编码请求的规范。

address
可选
类型:string optional
要进行地理编码的地址。必须提供 address、location 和 placeId 中的一个,且只能提供一个。
bounds
可选
要在其中搜索的 LatLngBounds。可选。
componentRestrictions
可选
组件用于将结果限制在特定区域内。过滤器由以下一项或多项组成:route、locality、administrativeArea、postalCode、country。系统仅返回符合所有过滤条件的结果。在所支持的拼写更正和部分匹配方法方面,过滤值与其他地理编码请求相同。可选。
BetaextraComputations
可选
类型:Array<ExtraGeocodeComputation> optional
可能用于完成请求的额外计算列表。注意:这些额外计算可能会在响应中返回额外字段。
fulfillOnZeroResults
可选
类型:boolean optional
在响应中,如果状态为 ZERO_RESULT,则履行 promise。这可能是您想要的结果,因为即使地理编码结果为零,系统仍可能会返回其他响应级字段。
language
可选
类型:string optional
语言标识符,用于指定应尽可能以哪种语言返回结果。请参阅支持的语言列表。
location
可选
类型:LatLng|LatLngLiteral optional
要搜索的 LatLng(或 LatLngLiteral)。地理编码器执行反向地理编码。如需了解详情,请参阅 反向地理编码。必须提供 address、location 和 placeId 中的一个,且只能提供一个。
placeId
可选
类型:string optional
与营业地点相关联的地点 ID。地点 ID 可唯一标识 Google Places 数据库中和 Google 地图上的地点。如需详细了解地点 ID,请参阅 Places API 开发者指南。地理编码器执行反向地理编码。如需了解详情,请参阅反向地理编码。必须提供 address、location 和 placeId 中的一个,且只能提供一个。
region
可选
类型:string optional
用于偏向搜索的国家/地区代码,指定为双字符(非数字)Unicode 地区子标记/CLDR 标识符。可选。如需了解支持的地区,请参阅 Google Maps Platform 覆盖范围详细信息。

GeocoderComponentRestrictions 接口

google.maps.GeocoderComponentRestrictions 接口

GeocoderComponentRestrictions 表示一组解析为特定区域的过滤条件。如需详细了解其运作方式,请参阅 地理编码组成部分过滤。

administrativeArea
可选
类型:string optional
匹配所有 administrative_area levels。可选。
country
可选
类型:string optional
用于匹配国家/地区名称或两个字母的 ISO 3166-1 国家/地区代码。可选。
locality
可选
类型:string optional
同时匹配 locality 和 sublocality 类型。可选。
postalCode
可选
类型:string optional
匹配 postal_code 和 postal_code_prefix。可选。
route
可选
类型:string optional
匹配 route 的全称或简称。可选。

ExtraGeocodeComputation 常量

google.maps.ExtraGeocodeComputation 常量
库 "geocoding"

完成地理编码请求时要执行的额外计算。

这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 ExtraGeocodeComputationString 类型定义。

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");
ADDRESS_DESCRIPTORS 生成地址描述符。

GeocoderStatus 常量

google.maps.GeocoderStatus 常量
库 "geocoding"

Geocoder 在完成对 geocode() 的调用后返回的状态。按值或使用常量名称指定这些值。例如 '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 接口

Geocoder 返回的地理编码器响应,其中包含 GeocoderResult 列表。

results
GeocoderResult 的列表。
Betaaddress_descriptor
可选
类型:AddressDescriptor optional
对位置的关系描述。包含一组按排名顺序排列的附近地标以及包含目标位置的区域。仅针对反向地理编码请求填充,且仅在启用 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 时填充。
plus_code
可选
类型:PlacePlusCode optional
与营业地点相关联的 Plus Code。

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>
一个字符串数组,这些字符串表示传回的地址解析元素的类型。如需查看可能字符串的列表,请参阅开发者指南的 地址组成部分类型部分。
Betaaddress_descriptor
可选
类型:AddressDescriptor optional
与此地理编码关联的位置的关系描述。包含一组经过排名的附近地标以及包含目标位置的区域。此字段仅在以下情况下填充:正向地理编码和地点 ID 查找请求、ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 已启用,以及特定本地化地点。
partial_match
可选
类型:boolean optional
地理编码器是否无法返回与原始请求完全匹配的结果,尽管它能够匹配所请求地址的一部分内容。如果完全匹配,则值为 undefined。
plus_code
可选
类型:PlacePlusCode optional
与营业地点相关联的 Plus Code。
postcode_localities
可选
类型: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
可选
类型:LatLngBounds optional
此 GeocoderResult 的精确边界(如果适用)

GeocoderLocationType 常量

google.maps.GeocoderLocationType 常量
库 "geocoding"

描述从地理编码返回的位置类型。按值或使用常量名称指定这些值。例如,'ROOFTOP' 或 google.maps.GeocoderLocationType.ROOFTOP。

这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 GeocoderLocationTypeString 类型定义。

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");
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
可选
类型:number optional
目标位置与地标之间沿道路网络的行程距离。如果地标与目标位置最接近的路网部分断开连接,或者目标位置实际上不被视为位于路网上,则此字段可能为空。

Area 接口

google.maps.Area 接口

包含目标位置的小区域,例如街区、局部行政区或大型建筑群。

containment
类型:Containment
定义目标位置与区域之间的空间关系。
display_name
类型:string
区域的名称。
display_name_language_code
类型:string
区域名称的语言。
place_id
类型:string
底层区域的地点 ID。可用于通过“地点详情”或“地点 ID 查找”功能解析有关该区域的更多信息。

包含常量

google.maps.Containment 常量
库 "geocoding"

一个枚举,表示区域与目标位置之间的空间关系。

这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 ContainmentString 类型定义。

const {Containment} = await google.maps.importLibrary("geocoding");
NEAR 目标位置位于区域范围之外,但距离很近。
OUTSKIRTS 目标位置位于区域内,靠近边缘。
WITHIN 目标位置位于区域内,靠近中心。

SpatialRelationship 常量

google.maps.SpatialRelationship 常量
库 "geocoding"

一个枚举,表示地标与目标之间的空间关系。

这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 SpatialRelationshipString 类型定义。

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");
ACROSS_THE_ROAD 目标位于道路另一侧,与地标正对。
AROUND_THE_CORNER 与地标不在同一条路线上,但只需转弯一次即可到达。
BEHIND 靠近地标建筑,但距离其入口较远。
BESIDE 目标紧邻地标。
DOWN_THE_ROAD 与地标位于同一条路线上,但不在地标旁边或对面。
NEAR 如果以下更具体的关系都不适用,则默认使用此关系。
WITHIN 地标具有空间几何图形,且目标位于其边界内。