Method: resolveNames

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

HTTP 请求

POST https://mapstools.googleapis.com/v1alpha: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。

响应正文

针对 v1alpha.resolveNames 的响应消息。

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

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

object (Result)

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

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

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

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

授权范围

需要以下 OAuth 范围之一：

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

LocationQuery

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

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

string

必需。要在 Google 地图上解析为特定地理空间实体的文本查询，例如地点或地址。查询越具体，解决方案就越准确。例如，“旧金山”“Googleplex, Mountain View, CA”“1600 Amphitheatre Parkway, Mountain View, CA”或“巴黎埃菲尔铁塔”。查询必须是具体地址或地点名称。不支持连锁店名称（例如“星巴克”）或“餐厅”等搜索查询等一般性位置信息。

LocationBias

用于使解析结果偏向于特定地区的地区。

JSON 表示法 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
字段
联合字段 type。位置偏差的类型。type 只能是下列其中一项：
viewport

object (Viewport)

由边界框定义的视口。

视口

一个经纬度视口，表示为两个对角相对的 low 和 high 点。视口被视为一个封闭区域，即包含其边界。纬度范围必须介于 -90 度到 90 度之间（含），经度范围必须介于 -180 度到 180 度之间（含）。各种情况包括：

  • 如果 low = high，则视口由该单个点组成。

  • 如果 low.longitude > high.longitude，则经度范围会反转（视口跨越 180 度经度线）。

  • 如果 low.longitude = -180 度且 high.longitude = 180 度，则视口包含所有经度。

  • 如果 low.longitude = 180 度且 high.longitude = -180 度，则经度范围为空。

  • 如果 low.latitude > high.latitude，则纬度范围为空。

low 和 high 都必须填充，并且所表示的框不能为空（如上述定义中所指定）。空视口会导致错误。

例如，此视口完全包含纽约市：

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON 表示法 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
字段
low

object (LatLng)

必需。视口的低点。
high

object (LatLng)

必需。视口的高点。

LatLng

表示纬度/经度对的对象。该对象以一对双精度数表示，分别代表纬度度数和经度度数。除非另有说明，否则该对象必须符合 WGS84 标准。值必须介于标准化范围内。

JSON 表示法 
{
  "latitude": number,
  "longitude": number
}
字段
latitude

number

纬度（以度为单位）。它必须在 [-90.0, +90.0] 范围内。
longitude

number

经度（以度为单位）。它必须在 [-180.0, +180.0] 范围内。

结果

给定位置查询中的单个已解析实体，以及解析的置信度。

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

object (Entity)

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

enum (Confidence)

仅限输出。相应分辨率的置信度。

置信度

相应分辨率的置信度。

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