Method: searchText

通过文本查询搜索地点。

HTTP 请求

POST https://mapstools.googleapis.com/v1alpha:searchText

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "pageSize": integer,
  "includeExtendedDetails": boolean,
  "locationBias": {
    object (LocationBias)
  }
}
字段
textQuery

string

必需。文本查询。

languageCode

string

可选。请求返回摘要时使用的语言。如果语言代码未指定或无法识别,系统会返回摘要,并优先使用英语。

例如,“en”表示英语。

当前支持的语言列表:https://developers.google.com/maps/faq#languagesupport。

regionCode

string

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

例如,"US" 表示美国。

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

请注意,目前不支持 3 位数的地区代码。

pageSize

integer

可选。要返回的地点数量上限,最多 10 个。服务返回的值可能小于此值。该默认值为 5。

请求超过 5 个地点会触发 Pro 层级,并产生更高的结算费用和延迟时间。

includeExtendedDetails

boolean

可选。在响应中包含扩展的地点详情。

当用户请求需要丰富的定性数据洞见、实时动态或专门的实体属性时,请将此字段设置为 true:- 定性评价、客户情绪和反馈。- 具体产品/服务,例如菜单项、菜品、特色美食、饮品或商家亮点。- 氛围、室内装饰、美学、环境或情调等定性描述。- 实时数据和专门设施规格、访客政策/提示、等待时间。

对于标准发现搜索(例如菜系、商店类型)、位置/地址查询、联系信息、营业时间和标准元数据/设施,请保留 false(默认)。

启用此字段会触发 Pro 层级,并产生更高的结算费用和更长的延迟时间。

locationBias

object (LocationBias)

一个可选区域,用于使搜索结果偏向于该区域。如果 textQuery 中有明确的位置,系统会使用该位置(而非此字段)来调整搜索结果。

响应正文

如果成功,则响应正文包含一个 SearchTextResponse 实例。

授权范围

需要以下 OAuth 作用域:

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