Package google.maps.geocode.v4alpha

索引

DestinationService

用于检索目的地的服务。

目的地提供有关地点的分层上下文,例如,您可以在较大的公寓建筑群中查找公寓楼,反之亦然。它还提供适合拼车或送货等使用情形的导航点。

SearchDestinations

rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse)

此方法会执行目的地查找并返回目的地列表。

授权范围

需要以下 OAuth 范围之一:

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

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

目的地

目的地。这包括主要地点、相关地点、入口和导航点。

字段
primary

PlaceView

请求中由 primary_query 标识的主要地点。

containing_places[]

PlaceView

包含主要地点的更不精确的地点。例如,包含此建筑物的公寓大楼。

sub_destinations[]

PlaceView

主要地点的更精确的子目的地。例如,建筑物中包含的单元。

注意:与 Places API 返回的 SubDestination 相比,此子目的地列表更详尽,并且每个子目的地都包含更多信息。

landmarks[]

Landmark

可用于传达目的地位置或帮助到达目的地的地标。

entrances[]

Entrance

此目的地的入口。

navigation_points[]

NavigationPoint

相应目的地的导航点。

parking_options

Destination.ParkingOptions

此目的地的停车选项。

arrival_summary

Destination.ArrivalSummary

AI 生成的目的地到达体验摘要。

ArrivalSummary

AI 生成的目的地到达体验摘要。

字段
text

LocalizedText

目的地到达体验的摘要。

flag_content_url

string

一个链接,用户可通过该链接举报摘要存在的问题。

disclosure_text

LocalizedText

仅限输出。包含到达摘要的披露声明文本。

ParkingOptions

有关目的地的停车选项的信息。

字段
availability

Destination.ParkingOptions.Availability

相应目的地的停车位提供情况。

onsite_parking

bool

目的地有停车场。

free_parking_lot

bool

提供免费停车场。

paid_parking_lot

bool

提供收费停车场。

free_street_parking

bool

提供免费路边停车。

paid_street_parking

bool

提供收费路边停车。

valet_parking

bool

提供代客泊车服务。

free_garage_parking

bool

提供免费停车库。

paid_garage_parking

bool

提供收费停车库。

可用性

到访此地点时找停车位的难易程度汇总衡量结果。

未来可能会添加新值。

枚举
AVAILABILITY_UNSPECIFIED 无法提供停车位信息。
PLENTY 酒店提供充足的停车位。
SOMEWHAT_DIFFICULT 找停车位有点难。
DIFFICULT 很难找到停车位。

入口

入口是一对经纬度坐标,用于定义地点的出入口位置。

字段
location

LatLng

入口的位置。

tags[]

Entrance.Tag

描述入口的一系列标记。

place

string

此入口实际所在的建筑物,采用 places/{place_id} 格式。

street_view_thumbnail

StreetViewThumbnail

显示入口的街景缩略图。您可以通过 Street View Static API 请求图片。请参阅 https://developers.google.com/maps/documentation/streetview/request-streetview。

street_view_annotation

ImageAnnotation

上面返回的 street_view_thumbnail 上的入口注释。

标记

描述入口的特征。

枚举
TAG_UNSPECIFIED 未使用。
PREFERRED

该入口可能提供对返回目的地中主要地点的物理访问。一个地点可以有多个首选入口。如果入口没有此标签,则表示该入口在物理上与主要地点位于同一建筑物,但不一定能通往该地点。

例如,如果主要地点是露天购物中心内的一家餐厅,那么“PREFERRED”入口可能是通往餐厅本身的入口,而返回的其他入口则是建筑物的其他入口,例如通往露天购物中心内其他餐厅的入口。

如果主要地点本身是一栋建筑,则 PREFERRED 入口将是通往建筑“主要”部分的入口。例如,在购物中心,PREFERRED 入口是通往主门厅区域的入口,但如果某个入口只能通往建筑物一侧的商店,则它不是PREFERRED入口。

注意:PREFERRED 入口可能无法通往主要地点,而非 PREFERRED 入口可能可以通往主要地点。

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

位置,采用“纬度,经度”字符串格式。例如,“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/{placeId}。可用于查找地点。

place_id

string

地点的唯一标识符。

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 其他。

ImageAnnotation

图片缩略图上的注释,例如勾勒出入口的多边形。

字段
coordinates[]

ImageAnnotation.Coordinate

在图片上形成多边形的坐标列表。坐标按逆时针顺序排列。

协调中心

图片上某个点的像素坐标。原点 (0,0) 是图片左上角像素的左上角,x 轴指向右侧,y 轴指向下方。

字段
x_px

float

X 坐标。

y_px

float

Y 坐标。

地标

地标用于说明目的地所在的位置,或帮助用户到达目的地。

字段
relational_description

LocalizedText

关于目的地与地标之间关系的人类可读说明。例如:“帝国大厦附近”或“白宫对面”。

tags[]

Landmark.Tag

描述地标在目的地背景下的使用方式的标签。

straight_line_distance_meters

double

仅限输出。从该地标到目的地的直线距离(以米为单位)。

travel_distance_meters

double

仅限输出。从该地标到目的地的步行距离(以米为单位)。

联合字段 landmark。地标。landmark 只能是下列其中一项:
place

PlaceView

代表此地标的地点。

标记

所有可能标记的列表,这些标记描述了如何在目的地背景下使用地标。

如果某个地址同时具有 ADDRESS 和 ARRIVAL 标记,则表示该地标既在当地知名,又靠近目的地。

枚举
TAG_UNSPECIFIED 未使用。
ADDRESS 可用于确定目的地大致位置的当地著名地点。通常在距离目的地几百米范围内。这些地标与 Geocoding API 的地址描述符功能返回的地标类似:https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors。
ARRIVAL 可用于帮助到达目的地的地点。当您接近目的地时,此功能有助于导航。例如,此地标可能是目的地对面的一处地点。带有此标记的地标通常比带有 ADDRESS 标记的地标更靠近目的地。

导航点是指道路旁可作为导航终点的位置。

字段
navigation_point_token

string

仅限输出。可用于标识此导航点的令牌。

display_name

LocalizedText

此导航点的显示名称。例如,“5th Ave”或“Gate B”。

location

LatLng

路段旁边应结束导航的点。该点有意与道路中心线略微偏移,以便清楚地标记地点所在的道路一侧。

travel_modes[]

NavigationPoint.TravelMode

适合此导航点的出行方式。

usages[]

NavigationPoint.Usage

列出此导航点支持的 usages。如果为空,并不一定意味着其使用受到任何限制。所有导航点都可用于常规导航。

street_view_thumbnail

StreetViewThumbnail

显示导航点的街景缩略图(如果有)。可以从 Street View Static API 请求该图片。请参阅 https://developers.google.com/maps/documentation/streetview/request-streetview。

entrance_annotation

ImageAnnotation

与上述返回的 street_view_thumbnail 上的此导航点关联的入口的注释(如果有)。

altitude_meters

float

导航点相对于 WGS-84 椭球体的高度(以米为单位)。

TravelMode

适合此导航点的出行方式。

枚举
TRAVEL_MODE_UNSPECIFIED 未使用。
DRIVE 适合驾驶。
WALK 适合步行。

用法

相应导航点支持的用途。未来可能会添加新值。

枚举
USAGE_UNSPECIFIED 未使用。
UNKNOWN 表示使用类型未知。
DROPOFF 适合乘客下车。例如,拼车下车地点。
PICKUP 适合接载乘客。例如,网约车上车地点。
PARKING 适合停车。例如,在停车场内。

PlaceView

表示 Places API 中 Place 的视图。它还提供特定于目的地的其他信息,例如结构类型和显示多边形。

在某些情况下,具有相同地点 ID 的 PlaceView 可能与 Places API 为 types 和 display_name 字段返回的内容不同。

字段
place

string

相应地点的资源名称,格式为 places/{placeId}。可用于查找地点。

place_id

string

地点的唯一标识符。

display_name

LocalizedText

人类可读的地点说明。例如“B 门”“麦当劳”

primary_type

string

相应地点的主要地点类型。如需查看可能的值的列表,请访问 https://developers.google.com/maps/documentation/places/web-service/place-types。

注意:此字段并不总是填充内容。请做好准备,在这种情况下使用 types 字段。

types[]

string

此地点的所有关联地点类型。如需查看可能的值列表,请参阅 https://developers.google.com/maps/documentation/places/web-service/place-types。

formatted_address

string

单行地址。

postal_address

PostalAddress

结构化地址。

structure_type

PlaceView.StructureType

与此地点对应的结构类型。

location

LatLng

此地点的地理位置。对于具有显示多边形的地点,这可以表示在地图上放置标记的理想位置。

display_polygon

Struct

采用 GeoJSON 格式的地点多边形轮廓,使用 RFC 7946 格式:https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6。

注意:RFC 7946 格式支持 MultiPolygon,因此一个 display_polygon 对象可以表示多个多边形。

address_components[]

PlaceView.AddressComponent

每个行政区划层级的重复组件。

AddressComponent

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

字段
long_text

string

地址组成部分的完整文本说明或名称。例如,澳大利亚这个国家的地址组成部分可能具有长名称“Australia”。

short_text

string

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

types[]

string

一个数组,表示地址组成部分的类型。

如需了解详情,请参阅 /maps/documentation/geocoding/requests-geocoding#Types。

language_code

string

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

StructureType

相应地点所代表的结构类型。

枚举
STRUCTURE_TYPE_UNSPECIFIED 未使用。
POINT 点位置。
SECTION 建筑物的子部分。
BUILDING 建筑物。
GROUNDS 通常包含多栋建筑的大型区域,例如大学校园、公寓楼群或购物中心。

PlusCode

Plus Code (http://plus.codes) 是一种位置引用,具有两种格式:全局代码(用于定义 14 米 x 14 米或更小的矩形)和混合代码(用于将前缀替换为参考位置)。

字段
global_code

string

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

compound_code

string

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

SearchDestinationsRequest

DestinationService.SearchDestinations 的请求消息。

字段
travel_modes[]

NavigationPoint.TravelMode

可选。用于过滤导航点的出行方式。这会影响响应中返回的 navigation_points 字段。如果为空,则返回所有出行模式的导航点。

language_code

string

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

region_code

string

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

联合字段 primary_query。查询主要目的地。可以是地点、完整指定的地址或 LatLng 位置。某些信息极少的地点和地址无法转换为目的地。

目标位置是围绕指定的主查询构建的。

注意:仅支持可作为导航目的地的地点和地址。例如,表示独栋房屋或公寓楼的地点可用作主查询,但表示市行政区或行政区的地点不能用作主查询。primary_query 只能是下列其中一项:

place

string

地点的资源名称,格式为 places/{place_id}。

address_query

SearchDestinationsRequest.AddressQuery

街道地址。

location_query

SearchDestinationsRequest.LocationQuery

精确位置。

AddressQuery

您要搜索的街道地址。按照相关国家全国邮政服务使用的格式指定地址

字段
联合字段 kind。地址查询。kind 只能是下列其中一项:
address

PostalAddress

采用邮政地址格式的街道地址。

address_query

string

格式为单行的街道地址。

LocationQuery

用于识别附近主要目的地的位置查询。

注意:如果位置查询位于包含子场所的建筑物内,则返回的主要地点可能是子场所。在这些情况下,containing_places 字段将包含建筑物。

字段
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

可选。要应用于目的地候选对象的过滤条件。

联合字段 kind。地点查询。kind 只能是下列其中一项:
location

LatLng

精确的 LatLng 位置。

PlaceFilter

要应用于候选目的地的过滤条件。

字段
structure_type

PlaceView.StructureType

可选。如果指定了此参数,则所有目的地都保证有一个具有此结构类型的主要地点。这可能会导致过滤掉某些目的地,或者粗化/细化返回的目的地。

例如,如果指定了 GROUNDS,则返回的所有目的地都将具有结构类型为 GROUNDS 的主要地点。这可能会导致过滤掉不属于场地一部分的某些目的地,或将返回的目的地粗化到场地级别。

此字段的另一个用途是更轻松地提取建筑物显示多边形。例如,如果指定了 BUILDING,则主要地点的显示多边形将是指定位置的建筑物。

addressability

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

可选。如果指定,则仅返回符合相应可寻址性条件的目标。

投放精准度

定义了可寻址性过滤的选项。未来可能会添加新值。

枚举
ADDRESSABILITY_UNSPECIFIED 如果未指定,服务将选择合理的默认值。
ANY 可寻址性不是过滤条件。无论目的地是否可寻址,都会返回。
PRIMARY 返回的所有目的地都将有一个具有街道级地址或名称的主要地点。
WEAK 返回的所有目的地都将具有主要地点或具有街道级地址或名称的子目的地。

SearchDestinationsResponse

针对 DestinationService.SearchDestinations 的响应消息。

字段
destinations[]

Destination

目的地列表。

如果可以从主查询中明确识别出主要目的地,该服务会返回一个结果。否则,该服务可能会返回多个结果以消除歧义,也可能返回零个结果。

StreetViewThumbnail

用于表示 Google 街景缩略图的参数。这些参数可用于向 Street View Static API 请求街景图像。请参阅 https://developers.google.com/maps/documentation/streetview/request-streetview。

字段
pano

string

特定全景图片 ID。

width_px

int32

输出缩略图的宽度(以像素为单位)。注意:在请求缩略图的同时请求注释时,必须在 Street View API 请求中使用这些高度和宽度值,以确保注释坐标与图片正确对齐。

height_px

int32

输出缩略图的高度(以像素为单位)。注意:在请求缩略图的同时请求注释时,必须在 Street View API 请求中使用这些高度和宽度值,以确保注释坐标与图片正确对齐。

heading_degree

float

摄像头的水平方向(以度为单位)。范围 [0, 360)。0 表示北,90 表示东。

pitch_degree

float

摄像头的垂直方向(以度为单位)。范围 [-90, 90]。0 表示水平方向,+90 表示垂直向上,-90 表示垂直向下。

fov_degree

float

水平视野范围(以度为单位)。范围 (0, 180]。控制缩放级别。FOV 越小,变焦倍数越大。