将地点名称(或地址)列表解析为 Google 地图上的特定地理空间实体(例如地点)。
HTTP 请求
POST https://mapstools.googleapis.com/v1alpha:resolveNames
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 |
|---|
{ "queries": [ { object ( |
| 字段 | |
|---|---|
queries[] |
必需。要解析的位置查询列表。您最多可以指定 20 个查询。 |
locationBias |
可选。一个可选区域,用于使解析结果偏向该区域。如果指定,解析结果将偏向于更靠近此区域的实体。添加 如果同时指定了 |
regionCode |
可选。可选的地区代码,用于使解析结果偏向于特定地区。如果指定,解析结果将偏向于位于指定区域内或附近的实体。这应该是 CLDR 地区代码。例如,“US”或“CA”。添加 如果同时指定了 |
响应正文
v1alpha.resolveNames 的响应消息。
如果成功,响应正文将包含结构如下的数据:
| JSON 表示法 |
|---|
{ "results": [ { object ( |
| 字段 | |
|---|---|
results[] |
仅限输出。位置查询中解析出的实体列表。保证与请求 |
failedRequests |
仅限输出。传达部分失败信息的映射。键是 包含一系列 |
saveToMapsUrl |
仅限输出。一个用于在 Google 地图中保存所有已成功解析实体的链接。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/maps-platform.mapstools
LocationQuery
位置查询表示可通过 Google 地图解析的特定位置实体。目前,仅支持将地点名称和地址作为位置查询。
| JSON 表示法 |
|---|
{ "text": string } |
| 字段 | |
|---|---|
text |
必需。要解析为 Google 地图上特定地理空间实体(例如地点或地址)的文本查询。查询越具体,解析就越准确。例如,“旧金山”“Googleplex, Mountain View, CA”“1600 Amphitheatre Parkway, Mountain View, CA”或“Eiffel Tower, Paris”。查询必须是具体的地址或地点名称。不支持连锁店名称(例如“星巴克”)等大致位置或“餐馆”等搜索查询。 |
LocationBias
用于使解析结果偏向于特定区域的地区代码。
| JSON 表示法 |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"viewport": {
object ( |
| 字段 | |
|---|---|
| 位置偏向的类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
viewport |
由边界框定义的视口。 |
| 互斥字段结束。 | |
结果
从给定位置查询中解析出的单个实体,以及解析的置信度。
| JSON 表示法 |
|---|
{ "entity": { object ( |
| 字段 | |
|---|---|
entity |
仅限输出。从位置查询中解析出的实体。 |
confidence |
仅限输出。解析的置信度。 |
置信度
解析的置信度。
| 枚举 | |
|---|---|
CONFIDENCE_UNSPECIFIED |
默认值。此值未使用。 |
MEDIUM |
“中等置信度”表示解析结果可能正确,但可能还有其他候选结果。 |
HIGH |
高置信度表示解析结果正确,并且代表特定的地理空间实体(例如特定地点)。 |