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)
}
字段
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 上包含的地点类型（例如“餐馆”或“加油站”）。

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

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

如果为某个地点类型指定了多种类型限制，则系统仅返回满足所有限制的地点。例如，如果我们有 {includedTypes = ["餐馆"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点将提供“餐馆”但并非以“餐厅”为主要目的。
excludedTypes[]

string

已从 https://developers.google.com/maps/documentation/places/web-service/place-types 中排除地点类型（例如“餐馆”或“加油站”）。

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

如果客户端同时提供 includeType（如餐馆）和 excludedTypes（如咖啡馆），则响应应包含餐馆而非咖啡馆的地点。响应包含的地点至少与一个 includeType 匹配，但不与任何 excludedType 匹配。

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

如果为某个地点类型指定了多种类型限制，则系统仅返回满足所有限制的地点。例如，如果我们有 {includedTypes = ["餐馆"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点将提供“餐馆”但并非以“餐厅”为主要目的。
includedPrimaryTypes[]

string

添加了 https://developers.google.com/maps/documentation/places/web-service/place-types 上的主要地点类型（例如“餐馆”或“加油站”）。一个地点只能有一个关联的受支持类型表中的一种主要类型。

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

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

如果为某个地点类型指定了多种类型限制，则系统仅返回满足所有限制的地点。例如，如果我们有 {includedTypes = ["餐馆"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点将提供“餐馆”但并非以“餐厅”为主要目的。
excludedPrimaryTypes[]

string

已从 https://developers.google.com/maps/documentation/places/web-service/place-types 中排除主要地点类型（例如“餐馆”或“加油站”）。

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

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

如果为某个地点类型指定了多种类型限制，则系统仅返回满足所有限制的地点。例如，如果我们有 {includedTypes = ["餐馆"], excludedPrimaryTypes = ["restaurant"]}，则返回的地点将提供“餐馆”但并非以“餐厅”为主要目的。
maxResultCount

integer

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

object (LocationRestriction)

必需。要搜索的地区。
rankPreference

enum (RankPreference)

结果在响应中如何排名。

响应正文

搜索附近地点的响应 proto。

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

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

object (Place)

满足用户要求（例如地点类型、地点数量和特定位置限制）的地点列表。

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 按热门程度对结果进行排名。