Package google.maps.geocode.v4beta

索引

GeocodeService

用于执行地理编码的服务。

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

此方法会执行地址地理编码,将地址映射到 LatLng。它还提供有关地址的结构化信息。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.address
GeocodeLocation

rpc GeocodeLocation(GeocodeLocationRequest) returns (GeocodeLocationResponse)

此方法执行位置地理编码,即将 LatLng 映射到地址。它还提供有关地址的结构化信息。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.location
GeocodePlace

rpc GeocodePlace(GeocodePlaceRequest) returns (GeocodeResult)

此方法使用地点 ID 执行地理编码查找。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.place

GeocodeAddressRequest

针对 GeocodeService.GeocodeAddress 的请求消息。

字段
location_bias

GeocodeAddressRequest.LocationBias

可选。要搜索的地区。此位置用作偏差,这意味着可能会返回给定位置附近的结果。

language_code

string

可选。应返回结果所用的语言。

region_code

string

可选。区域代码。地区代码,以 ccTLD(“顶级域名”)双字符值的形式指定。此参数会根据适用法律影响结果。此参数还会影响但不会完全限制服务中的结果。

联合字段 address_input。要进行地理编码的地址。address_input 只能是下列其中一项:
address_query

string

要进行地理编码的非结构化地址。

address

PostalAddress

要以邮政地址格式进行地理编码的结构化地址。

LocationBias

要搜索的地区。此位置用作偏差,这意味着可能会返回给定位置附近的结果。

字段
联合字段 type。位置偏向的类型。type 只能是下列其中一项:
rectangle

Viewport

由东北角和西南角定义的矩形框。rectangle.high() 必须是矩形视口的东北点。rectangle.low() 必须是矩形视口的西南点。rectangle.low().latitude() 不得大于 rectangle.high().latitude()。这会导致纬度范围为空。矩形视口的宽度不能超过 180 度。

GeocodeAddressResponse

GeocodeService.GeocodeAddress 的响应消息。

字段
results[]

GeocodeResult

地理编码结果。

GeocodeLocationRequest

针对 GeocodeService.GeocodeLocation 的请求消息。

字段
language_code

string

可选。应返回结果所用的语言。

region_code

string

可选。区域代码。地区代码,以 ccTLD(“顶级域名”)双字符值的形式指定。此参数会根据适用法律影响结果。

types[]

string

可选。一组用于限制结果的类型标记。系统会移除不属于任何指定类型的结果。

如需查看可能值的完整列表,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 和表 B。

granularity[]

GeocodeResult.Granularity

可选。一个或多个位置精细度枚举的过滤条件。

联合字段 location_input。要进行地理编码的位置。location_input 只能是下列其中一项:
location_query

string

位置,采用“lat,lng”字符串格式。例如,“64.7611872,-18.4705364”。

location

LatLng

结构化格式的位置。

GeocodeLocationResponse

GeocodeService.GeocodeLocation 的响应消息。

字段
results[]

GeocodeResult

地理编码结果。

plus_code

PlusCode

相应请求中位置的 Plus Code。

GeocodePlaceRequest

针对 GeocodeService.GeocodePlace 的请求消息。

字段
place

string

必需。要进行地理编码的地点标识符,格式为 places/{place}。

language_code

string

可选。应返回结果所用的语言。

region_code

string

可选。区域代码。地区代码,以 ccTLD(“顶级域名”)双字符值的形式指定。此参数会根据适用法律影响结果。

GeocodeResult

地理编码结果包含有关某个地点的地理信息。

字段
place

string

相应结果的完全限定地点标识符。格式为“//places.googleapis.com/places/{placeID}”。如需了解详情,请访问 https://developers.google.com/maps/documentation/places/web-service/place-id

place_id

string

相应结果的地点 ID。

location

LatLng

相应地址的纬度和经度。

granularity

GeocodeResult.Granularity

位置信息的粒度。

viewport

Viewport

适合显示地理编码结果的视口。

bounds

Viewport

地址的边界框。

formatted_address

string

单行格式的地址。

postal_address

PostalAddress

邮政地址格式的地址。

address_components[]

GeocodeResult.AddressComponent

每个地理位置级别的重复组件。

postal_code_localities[]

LocalizedText

邮政编码中包含的市行政区的完整列表。

仅当结果类型为“postal_code”时,系统才会填充此字段。

types[]

string

相应结果的一组类型标记。例如,“political”和“administrative_area”。

如需查看可能值的完整列表,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 和表 B。

plus_code

PlusCode

相应地理编码中位置的 Plus Code。

AddressComponent

构成格式化地址的结构化组件(如果此信息可用)。

字段
long_text

string

地址组成部分的完整文本说明或名称。例如,澳大利亚的地址组成部分可能包含长名称“Australia”。

short_text

string

地址组成部分的缩写文本名称(如果有)。例如,澳大利亚的地址组成部分可能具有“AU”的短名称。

types[]

string

一个数组,用于指示地址组成部分的类型。

如需了解详情,请参阅 https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types

language_code

string

用于设置相应组件格式的语言(采用 CLDR 表示法)。

粒度

位置信息的粒度。

枚举
GRANULARITY_UNSPECIFIED 请勿使用。
ROOFTOP 与匹配的地址对应的实际地块的非插值位置。
RANGE_INTERPOLATED 从一系列街道编号中插值得出。例如,如果我们知道 Amphitheatre Pkwy 的某个路段包含 1600 到 1699 号,那么 1650 号可能位于该路段的中间位置。
GEOMETRIC_CENTER 我们拥有多边形数据的地图项的几何中心。
APPROXIMATE 其他所有内容。

PlusCode

Plus Code (http://plus.codes) 是一种位置引用,包含两种格式:用于定义 14 米 x 14 米(1/8000 度)或更小矩形的全局代码,以及用参考位置替换前缀的混合代码。

字段
global_code

string

地点的全局(完整)代码,例如“9FWM33GV+HQ”,表示 1/8000 度 x 1/8000 度(约 14 米 x 14 米)的区域。

compound_code

string

地点的混合代码,例如“33GV+HQ, Ramberg, Norway”,包含全局代码的后缀,并将前缀替换为参考实体的格式化名称。