Method: resolveNames

将地点名称(或地址)列表解析为 Google 地图上的特定地理空间实体(例如地点)。

HTTP 请求

POST https://mapstools.googleapis.com/v1:resolveNames

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
字段
queries[]

object (LocationQuery)

必需。要解析的位置查询列表。您最多可以指定 20 个查询。

locationBias

object (LocationBias)

可选。一个可选区域,用于使解析结果偏向该区域。如果指定,解析结果将偏向于更靠近此区域的实体。添加 locationBias 或 regionCode 通常可以缩小搜索范围,从而提供更好的结果。

如果同时指定了 locationBias 和 regionCode,则 locationBias 优先于 regionCode。

regionCode

string

可选。可选的地区代码,用于使解析结果偏向于特定地区。如果指定,解析结果将偏向于位于指定区域内或附近的实体。这应该是 CLDR 地区代码。例如,“US”或“CA”。添加 locationBias 或 regionCode 通常可以缩小搜索范围,从而提供更好的结果。

如果同时指定了 locationBias 和 regionCode,则 locationBias 优先于 regionCode。

响应正文

v1.resolveNames 的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
字段
results[]

object (Result)

仅限输出。位置查询中解析出的实体列表。保证与请求 queries 索引一一对应。索引 i 处的空字符串表示该查询的解析失败。如果解析失败,请查看 failedRequests 字段,了解错误状态。

failedRequests

map (key: integer, value: object (Status))

仅限输出。传达部分失败信息的映射。键是 queries 字段中失败请求的索引。该值是详细说明解析失败原因的错误状态。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

saveToMapsUrl

string

仅限输出。一个用于在 Google 地图中保存所有已成功解析实体的链接。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/maps-platform.mapstools

LocationQuery

位置查询表示可通过 Google 地图解析的特定位置实体。目前,仅支持将地点名称和地址作为位置查询。

JSON 表示法
{
  "text": string
}
字段
text

string

必需。要解析为 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)
  }
  // End of mutually exclusive fields.
}
字段
位置偏向的类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
viewport

object (Viewport)

由边界框定义的视口。

互斥字段结束。

结果

从给定位置查询中解析出的单个实体,以及解析的置信度。

JSON 表示法
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
字段
entity

object (Entity)

仅限输出。从位置查询中解析出的实体。

confidence

enum (Confidence)

仅限输出。解析的置信度。

置信度

解析的置信度。

枚举
CONFIDENCE_UNSPECIFIED 默认值。此值未使用。
MEDIUM “中等置信度”表示解析结果可能正确,但可能还有其他候选结果。
HIGH 高置信度表示解析结果正确,并且代表特定的地理空间实体(例如特定地点)。