Method: places.searchNearby

搜索地点附近的地点。

HTTP 请求

POST https://places.googleapis.com/v1/places:searchNearby

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
字段
languageCode

string

地点详情将以首选语言（如果有）显示。如果未指定语言代码或系统无法识别语言代码，系统可能会返回任何语言的地点详细信息，并优先返回英语详细信息（如果有）。

受支持语言的最新列表：https://developers.google.com/maps/faq#languagesupport。
regionCode

string

请求来源位置的 Unicode 国家/地区代码 (CLDR)。此参数用于显示地点详细信息，例如特定于地区的地点名称（如果有）。根据适用法律，该参数可能会影响结果。

如需了解详情，请参阅 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html。

请注意，目前不支持 3 位数的地区代码。
includedTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 中包含的地点类型（例如“restaurant”或“gas_station”）。

您最多可以指定 表格 A 中的 50 种类型。

如果存在任何冲突的类型（即某个类型同时出现在 includeTypes 和 excludedTypes 中），则会返回 INVALID_ARGUMENT 错误。

如果指定的地点类型具有多个类型限制，则系统只会返回满足所有限制的地点。例如，如果我们有 {includedTypes = ["餐馆"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点提供与“餐馆”相关的服务，但经营内容并非以“餐馆”为主。
excludedTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 中排除的地点类型（例如“restaurant”或“gas_station”）。

您最多可以指定 表格 A 中的 50 种类型。

如果客户端同时提供 includedTypes（例如餐厅）和 excludedTypes（例如咖啡厅），则响应应包含餐厅但不包含咖啡厅。响应包含与至少一个 includedTypes 匹配且与任何 excludedTypes 都不匹配的地点。

如果存在任何冲突的类型（即某个类型同时出现在 includedTypes 和 excludedTypes 中），系统会返回 INVALID_ARGUMENT 错误。

如果指定的地点类型具有多个类型限制，则系统只会返回满足所有限制的地点。例如，如果我们使用 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点提供与“餐厅”相关的服务，但主要经营的业务并非“餐厅”。
includedPrimaryTypes[]

string

包含 https://developers.google.com/maps/documentation/places/web-service/place-types 中列出的主要地点类型（例如“restaurant”或“gas_station”）。地点只能有一个主要类型，该类型必须来自与其关联的“支持的类型”表。

您最多可以指定 表格 A 中的 50 种类型。

如果存在任何冲突的主要类型（即某个类型同时出现在 includedPrimaryTypes 和 excludedPrimaryTypes 中），系统会返回 INVALID_ARGUMENT 错误。

如果指定的地点类型具有多个类型限制，则系统只会返回满足所有限制的地点。例如，如果我们使用 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点提供与“餐厅”相关的服务，但主要经营的业务并非“餐厅”。
excludedPrimaryTypes[]

string

从 https://developers.google.com/maps/documentation/places/web-service/place-types 中排除的主要地点类型（例如“restaurant”或“gas_station”）。

最多可以指定表 A 中的 50 种类型。

如果存在任何冲突的主要类型（即某个类型同时出现在 includedPrimaryTypes 和 excludedPrimaryTypes 中），系统会返回 INVALID_ARGUMENT 错误。

如果指定的地点类型具有多个类型限制，则系统只会返回满足所有限制的地点。例如，如果我们有 {includedTypes = ["餐馆"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点提供与“餐馆”相关的服务，但经营内容并非以“餐馆”为主。
maxResultCount

integer

返回的结果数上限。此值必须介于 1 到 20（默认值）之间（包括这两个数值）。如果未设置此数字，则会回退到上限。如果将数字设置为负数或超出上限，系统会返回 INVALID_ARGUMENT 错误。
locationRestriction

object (LocationRestriction)

必需。要搜索的区域。
rankPreference

enum (RankPreference)

结果在响应中的排名方式。
routingParameters

object (RoutingParameters)

可选。影响搜索结果路由的参数。

响应正文

适用于“附近搜索”的响应原型。

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

JSON 表示法 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
字段
places[]

object (Place)

符合用户要求（例如地点类型、地点数量和特定位置限制）的地点列表。
routingSummaries[]

object (RoutingSummary)

路由摘要列表，其中每个条目都与 places 字段中相同索引内的相应位置相关联。如果其中某个地点没有路线摘要，其中将包含一个空条目。如果请求，此列表中的条目数量应与地点列表中的条目数量相同。

LocationRestriction

要搜索的地区。

JSON 表示法 
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
字段

联合字段 type。

type 只能是下列其中一项：
circle

object (Circle)

由中心点和半径定义的圆形。

RankPreference

结果在响应中如何排名。

枚举
RANK_PREFERENCE_UNSPECIFIED 未设置 RankPreference 值。默认使用“热门程度”排名。
DISTANCE 根据距离对结果进行排名。
POPULARITY 按热门程度对结果进行排名。