Method: places.searchText

基于文本查询的地点搜索。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
字段
textQuery

string

必需。用于文本搜索的文本查询。

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 位数的区域代码。

rankPreference

enum (RankPreference)

结果在响应中如何排序。

includedType

string

请求的地点类型。支持的类型的完整列表:https://developers.google.com/maps/documentation/places/web-service/place-types。仅支持一种包含的类型。

openNow

boolean

用于将搜索范围限定为当前营业的地点。默认值为 false。

minRating

number

过滤掉平均用户评分严格低于此上限的结果。有效值必须是介于 0 和 5(含)之间的浮点数,频率为 0.5,即 [0, 0.5, 1.0, ... , 5.0](含 0 和 5.0)。输入评分将四舍五入为最接近的 0.5(上限)。例如,如果评分为 0.6,则会排除评分低于 1.0 的所有结果。

maxResultCount

integer

要返回的结果数上限。该值必须介于 1 和 20 之间(包括 1 和 20)。默认值为 20。如果未设置数值,则会回退到上限。如果将数值设置为负数或超过上限,则系统会返回 INVALID_ARGUMENT 错误。

priceLevels[]

enum (PriceLevel)

用于将搜索范围限制为标记为特定价位的地点。用户可以选择价位的任意组合。默认选择所有价位。

strictTypeFiltering

boolean

用于为 includeType 设置严格的类型过滤。如果设置为 true,则仅返回相同类型的结果。默认值为 false。

locationBias

object (LocationBias)

要搜索的地区。此位置充当偏差,表示可能会返回指定位置附近的结果。不能与 locationRestriction 一起设置。

locationRestriction

object (LocationRestriction)

要搜索的地区。此位置具有限制条件,这意味着系统不会返回指定位置以外的结果。不能与 locationBias 一起设置。

evOptions

object (EVOptions)

可选。设置地点搜索请求的可搜索电动汽车选项。

响应正文

Places.searchText 的响应 proto。

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

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

object (Place)

符合用户文本搜索条件的地点列表。

RankPreference

结果在响应中如何排序。

枚举
RANK_PREFERENCE_UNSPECIFIED 未设置 RankPreference 值。默认为 DISTANCE。
DISTANCE 按距离对结果进行排名。
RELEVANCE 按相关性对结果排名。排序顺序由正常排名堆栈确定。

LocationBias

要搜索的地区。此位置充当偏差,表示可能会返回指定位置附近的结果。

JSON 表示法
{

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

联合字段 type

type 只能是下列其中一项:

rectangle

object (Viewport)

由东北角和西南角定义的矩形框。rectangle.high() 必须是矩形视口的东北点。rectangle.low() 必须是矩形视口的西南点。“rectangle.low().latitude()”的值不能大于 rectangle.high().latitude()。这将会导致一个空的纬度范围。矩形视口的宽度不得超过 180 度。

circle

object (Circle)

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

LocationRestriction

要搜索的地区。此位置具有限制条件,这意味着系统不会返回指定位置以外的结果。

JSON 表示法
{

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

联合字段 type

type 只能是下列其中一项:

rectangle

object (Viewport)

由东北角和西南角定义的矩形框。rectangle.high() 必须是矩形视口的东北点。rectangle.low() 必须是矩形视口的西南点。“rectangle.low().latitude()”的值不能大于 rectangle.high().latitude()。这将会导致一个空的纬度范围。矩形视口的宽度不得超过 180 度。

EVOptions

地点搜索请求的可搜索电动汽车选项。

JSON 表示法
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
字段
minimumChargingRateKw

number

可选。按最低收费频率过滤地点。任何地点的收费费率低于最低收费费率都会被滤除。

connectorTypes[]

enum (EVConnectorType)

可选。首选的电动汽车连接器类型列表。不支持任何所列连接器类型的地点将被滤除。