文本搜索(新) 根据一个字符串返回一组地点的相关信息,例如 “北京烤鸭”或“南京附近的鞋店”或“长安街 123 号”。通过 服务会返回与文本字符串和任何位置相匹配的地点列表 设置偏差。
该服务特别适合用于 模糊地址查询 字符串中的非地址部分可以匹配 提供商家信息和地址模糊地址查询的示例包括 格式错误的地址或包含非地址组成部分(例如, 用作商家名称。与下表中的前两个示例相关的请求 可能返回任何结果,除非是地理位置(如区域、位置) 限制或位置偏向。
“英国,高街 10 号”或“123 Main Street, US” | 英国的多个“高街”;美国的多条“主街” 除非位置限制是 。 |
“纽约连锁餐馆” | 多个“连锁餐厅”位于纽约的分店;无街道地址或 甚至街道名称。 |
“10 High Street, Escher UK”或“123 Main Street, Pleasanton US” | 仅一条“高街”英国埃舍尔市;只有一个“Main Street” 位于美国加利福尼亚州普莱森顿 |
“UniqueRestaurantName New York” | 在纽约只有一个具有此名称的场所;无街道地址 进行区分 |
“北京烤鸭店” | 此查询包含其位置限制以及“北京烤鸭店”为 明确定义的地点类型该方法会返回多个结果。 |
“+1 514-670-8700” | 此查询包含电话号码。它会针对以下查询返回多个结果: 显示与该电话号码相关的地点 |
利用 API Explorer,您可以发出实时请求,从而熟悉 API 和 API 选项:
“文本搜索”请求
文本搜索请求是采用以下形式的 HTTP POST 请求:
https://places.googleapis.com/v1/places:searchText
将 JSON 请求正文或标头中的所有参数作为 POST 请求。例如:
curl -X POST -d '{ "textQuery" : "Spicy Vegetarian Food in Sydney, Australia" }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.priceLevel' \ 'https://places.googleapis.com/v1/places:searchText'
文本搜索(新)响应
文本搜索(新)会返回 JSON 对象作为响应。在响应中:
完整的 JSON 对象格式如下:
{ "places": [ { object (Place) } ] }
必需参数
-
FieldMask
指定要在响应中返回的字段列表,方法是: 响应字段掩码。 使用网址参数将响应字段掩码传递给该方法
$fields
或fields
,或者使用 HTTP 标头X-Goog-FieldMask
。响应中没有返回字段的默认列表。 如果您省略字段掩码,则该方法会返回错误。字段遮盖是一种很好的设计做法,可确保您 不必要的数据,这有助于避免不必要的处理时间和 结算费用。
指定要返回的地点数据类型的列表(以英文逗号分隔)。例如: 检索地点的显示名称和地址。
X-Goog-FieldMask: places.displayName,places.formattedAddress
使用
*
检索所有字段。X-Goog-FieldMask: *
指定以下一个或多个字段:
以下字段会触发文本搜索(仅 ID)SKU:
places.attributions
,places.id
,places.name
*、nextPageToken
*places.name
字段包含地点的资源名称 格式为:places/PLACE_ID
。使用places.displayName
来访问地点的文本名称。以下字段会触发文本搜索(基本)SKU:
places.accessibilityOptions
,places.addressComponents
,places.adrFormatAddress
,places.businessStatus
,places.displayName
,places.formattedAddress
,places.googleMapsUri
,places.iconBackgroundColor
,places.iconMaskBaseUri
,places.location
,places.photos
,places.plusCode
,places.primaryType
,places.primaryTypeDisplayName
,places.shortFormattedAddress
,places.subDestinations
,places.types
,places.utcOffsetMinutes
,places.viewport
以下字段会触发文本搜索(高级)SKU:
places.currentOpeningHours
,places.currentSecondaryOpeningHours
,places.internationalPhoneNumber
,places.nationalPhoneNumber
,places.priceLevel
,places.rating
,places.regularOpeningHours
,places.regularSecondaryOpeningHours
,places.userRatingCount
,places.websiteUri
以下字段会触发文本搜索(首选)SKU:
places.allowsDogs
,places.curbsidePickup
,places.delivery
,places.dineIn
,places.editorialSummary
,places.evChargeOptions
,places.fuelOptions
,places.goodForChildren
,places.goodForGroups
,places.goodForWatchingSports
,places.liveMusic
,places.menuForChildren
,places.parkingOptions
,places.paymentOptions
,places.outdoorSeating
,places.reservable
,places.restroom
,places.reviews
,places.servesBeer
,places.servesBreakfast
,places.servesBrunch
,places.servesCocktails
,places.servesCoffee
,places.servesDessert
,places.servesDinner
,places.servesLunch
,places.servesVegetarianFood
,places.servesWine
,places.takeout
-
textQuery
要搜索的文本字符串,例如“餐馆” “主街 123 号”或“旧金山最佳游览地点”。API 根据结果返回 并根据其判断的相关性对结果进行排序。
可选参数
includedType
将结果限制为与 定义的指定类型相匹配的地点。 表 A. 只能指定一个类型。例如:
"includedType":"bar"
"includedType":"pharmacy"
languageCode
返回结果时所使用的语言。
- 请参阅 支持的语言列表。 Google 会经常更新支持的语言,因此,此列表可能未 详尽无遗。
-
如果未提供
languageCode
,则 API 默认为en
。如果您指定的语言代码无效,则 API 会返回INVALID_ARGUMENT
错误。 - API 会尽最大努力提供对于 用户和本地用户为实现该目标,它会返回街道 以当地语言显示地址,音译为可由 Google 搜索的 用户(如有必要),注意观察首选语言。所有其他 以首选语言返回地址。地址组成部分是 均以相同的语言返回,该语言从第一个 组件。
- 如果某个名称没有以首选语言提供,API 会使用 最接近的匹配项。
- 首选语言对要返回的结果集影响较小 API 选择返回的条目以及这些条目的返回顺序。通过 根据语言,地理编码器会以不同的方式解读缩写, 例如街道类型的缩写或 只对另一种语言有效。
locationBias
指定要搜索的区域。这个位置就是一种偏差,这意味着 可返回指定位置周围的结果,包括结果 在指定区域之外。
您可以指定
locationRestriction
或locationBias
, 但不能同时设置这两者。可以将locationRestriction
视为指定 结果所在的区域,以及locationBias
指定结果必须靠近但可以不在的区域 数据。将区域指定为矩形视口或圆形。
圆形由中心点和半径(以米为单位)定义。半径 必须介于 0.0 和 50000.0 之间(含 0.0 和 50000.0)。默认半径为 0.0。 例如:
"locationBias": { "circle": { "center": { "latitude": 37.7937, "longitude": -122.3965 }, "radius": 500.0 } }
矩形是一种经纬度视口,表示为 低点和高点对角线。低点表示西南方 矩形的一角,高点表示东北 矩形的一角。
视口被视为 表示它包含其边界。纬度边界 必须介于 -90 度(含)到 90 度(含)之间,且经度范围必须为 必须介于 -180 度到 180 度之间(包括 -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
、 纬度范围为空。
必须同时填充低值和高值,且不能同时填充表示的方框 为空。视口为空会导致错误。
例如,以下视口将纽约市完全包围:
"locationBias": { "rectangle": { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } }
- 如果
locationRestriction
指定要搜索的区域。指定区域以外的搜索结果不予显示 返回。将区域指定为矩形视口。请参阅说明 共
locationBias
个 了解有关定义视口的信息。您可以指定
locationRestriction
或locationBias
, 但不能同时设置这两者。可以将locationRestriction
视为指定 结果所在的区域,以及locationBias
指定结果必须靠近但可以不在的区域 数据。-
maxResultCount(已废弃)
指定每页显示的结果数(介于 1 到 20 之间)。 例如,如果将
maxResultCount
值设置为 5,则最多会返回 5 搜索结果第一页。如果可以返回更多结果 响应会包含nextPageToken
可以传递到后续请求以访问下一页。 evOptions
指定用于识别可用电动汽车 (EV) 的参数 充电连接器和充电速率。
connectorTypes
按某个地点可用的电动汽车充电连接器类型过滤的过滤条件。答 不支持任何连接器类型的位置将会被过滤掉 。 支持的电动汽车充电连接器类型包括组合型(交流和直流) 充电器、特斯拉充电器、符合 GB/T 标准的充电器(适用于英国的电动汽车快速充电站) 中国)和墙壁插座充电器。有关详情,请参阅参考文档 文档。
minimumChargingRateKw
按电动汽车最低充电率(以千瓦 (kW) 为单位)过滤地点。不限 充电费率低于最低充电率的地方 已滤除。例如,要查找充电速度 至少为 10 kW,则可以将此参数设置为“10”。
minRating
将结果的范围限制为平均用户评分高于 或等于此上限。中的值必须介于 0.0 和 5.0(含)之间 以 0.5 为增量。例如:0、0.5、1.0、...、5.0(含边界值)。值为 向上舍入到最接近的 0.5。例如,值 0.6 会排除 评分低于 1.0 的结果。
openNow
如果为
true
,则仅返回正常营业的地点 。如果为false
,则返回所有商家 而无论打开状态如何 未在 Google Places 数据库中指定营业时间的地点为 返回false
。pageSize
指定每页显示的结果数(介于 1 到 20 之间)。 例如,如果将
pageSize
值设置为 5,则最多会返回 5 搜索结果第一页。如果可以返回更多结果 响应会包含nextPageToken
可以传递到后续请求以访问下一页。pageToken
指定
nextPageToken
上一页。-
priceLevels
将搜索范围限制为标记在特定价位的地点。 默认设置是选择所有价位。
指定由以下项定义的一个或多个值的数组:
PriceLevel
。例如:
"priceLevels":["PRICE_LEVEL_INEXPENSIVE", "PRICE_LEVEL_MODERATE"]
rankPreference
指定如何根据 查询:
- 对于像“Restaurants in New York City”这样的分类查询,
默认值为
RELEVANCE
(按搜索相关性对结果排名)。 您可以将rankPreference
设置为RELEVANCE
或DISTANCE
(按距离对结果排名)。 - 对于非分类查询(例如“Mountain View, CA”),我们建议
让
rankPreference
保持未设置状态。
- 对于像“Restaurants in New York City”这样的分类查询,
默认值为
regionCode
用于设置响应格式的地区代码,指定为 两个字符的 CLDR 代码值。此参数也可能具有偏差效应 。没有默认值。
如果
formattedAddress
字段的国家/地区名称 响应与regionCode
匹配,则省略了国家/地区代码formattedAddress
起。此参数不会影响adrFormatAddress
:始终包含国家/地区 或shortFormattedAddress
上,该字符串绝不会 包含该标记。大多数 CLDR 代码与 ISO 3166-1 代码相同, 但有一些值得注意的例外情况。例如,英国的 ccTLD 为 "uk"(.co.uk),而其 ISO 3166-1 代码为“gb”(从技术层面来讲, “大不列颠及北爱尔兰联合王国”)。 根据适用法律,该参数可能会影响结果。
strictTypeFiltering
与
includedType
参数搭配使用。设置为true
,则仅搜索与由 返回includeType
。 如果为 false(默认值),响应可以包含不匹配的地点 指定的类型。
文本搜索示例
按查询字符串查找地点
以下示例显示了针对 “澳大利亚悉尼的辛辣素食”:
curl -X POST -d '{ "textQuery" : "Spicy Vegetarian Food in Sydney, Australia" }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H 'X-Goog-FieldMask: places.displayName,places.formattedAddress' \ 'https://places.googleapis.com/v1/places:searchText'
请注意,X-Goog-FieldMask
标头会指定
响应
包含以下数据字段:places.displayName,places.formattedAddress
。
响应将采用以下格式:
{ "places": [ { "formattedAddress": "367 Pitt St, Sydney NSW 2000, Australia", "displayName": { "text": "Mother Chu's Vegetarian Kitchen", "languageCode": "en" } }, { "formattedAddress": "175 First Ave, Five Dock NSW 2046, Australia", "displayName": { "text": "Veggo Sizzle - Vegan & Vegetarian Restaurant, Five Dock, Sydney", "languageCode": "en" } }, { "formattedAddress": "29 King St, Sydney NSW 2000, Australia", "displayName": { "text": "Peace Harmony", "languageCode": "en" } }, ... ] }
向字段掩码添加更多数据类型以返回其他信息。
例如,添加 places.types,places.websiteUri
以包含
餐馆类型和网址
response:
curl -X POST -d '{ "textQuery" : "Spicy Vegetarian Food in Sydney, Australia" }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.types,places.websiteUri' \ 'https://places.googleapis.com/v1/places:searchText'
响应现在采用以下格式:
{ "places": [ { "types": [ "vegetarian_restaurant", "vegan_restaurant", "chinese_restaurant", "restaurant", "food", "point_of_interest", "establishment" ], "formattedAddress": "367 Pitt St, Sydney NSW 2000, Australia", "websiteUri": "http://www.motherchusvegetarian.com.au/", "displayName": { "text": "Mother Chu's Vegetarian Kitchen", "languageCode": "en" } }, { "types": [ "vegan_restaurant", "thai_restaurant", "vegetarian_restaurant", "indian_restaurant", "italian_restaurant", "american_restaurant", "restaurant", "food", "point_of_interest", "establishment" ], "formattedAddress": "175 First Ave, Five Dock NSW 2046, Australia", "websiteUri": "http://www.veggosizzle.com.au/", "displayName": { "text": "Veggo Sizzle - Vegan & Vegetarian Restaurant, Five Dock, Sydney", "languageCode": "en" } }, ... ] }
按价位过滤地点
使用 priceLevel
选项过滤结果,以显示餐馆
便宜或适中:
curl -X POST -d '{ "textQuery" : "Spicy Vegetarian Food in Sydney, Australia", "priceLevels":["PRICE_LEVEL_INEXPENSIVE", "PRICE_LEVEL_MODERATE"] }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.priceLevel' \ 'https://places.googleapis.com/v1/places:searchText'
此示例还使用 X-Goog-FieldMask
标头将
places.priceLevel
数据字段复制到
响应
因此其格式为:
{ "places": [ { "formattedAddress": "367 Pitt St, Sydney NSW 2000, Australia", "priceLevel": "PRICE_LEVEL_MODERATE", "displayName": { "text": "Mother Chu's Vegetarian Kitchen", "languageCode": "en" } }, { "formattedAddress": "115 King St, Newtown NSW 2042, Australia", "priceLevel": "PRICE_LEVEL_MODERATE", "displayName": { "text": "Green Mushroom", "languageCode": "en" } }, ... ] }
添加其他选项以缩小搜索范围,例如 includedType
minRating
、rankPreference
、openNow
、
以及
可选参数。
搜索某个区域内的地点
请使用 locationRestriction
或 locationBias
。
(但不能同时设置这两者),以便将搜索限制在某个区域内。想想locationRestriction
指定结果必须位于哪个区域,以及 locationBias
以指定结果必须靠近但可以位于 之外的区域
数据。
以下示例显示了针对 “辛辣的素食”偏向位置偏离某个点 500 米以内 旧金山市中心此请求仅返回以下查询的前 10 个结果: 营业的地点。
curl -X POST -d '{ "textQuery" : "Spicy Vegetarian Food", "openNow": true, "pageSize": 10, "locationBias": { "circle": { "center": {"latitude": 37.7937, "longitude": -122.3965}, "radius": 500.0 } }, }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H 'X-Goog-FieldMask: places.displayName,places.formattedAddress' \ 'https://places.googleapis.com/v1/places:searchText'
搜索设有最低充电速度的电动汽车充电器
使用 minimumChargingRateKw
和 connectorTypes
执行以下操作:
搜索与您的电动汽车兼容的充电桩地点。
以下示例展示了对特斯拉和 J1772 Type 1 EV 充电的请求 (加利福尼亚州山景城的最低充电率为 10 kW)的连接器。只有四个 结果。
curl -X POST -d '{ "textQuery": "EV Charging Station Mountain View", "pageSize": 4, "evOptions": { "minimumChargingRateKw": 10, "connectorTypes": ["EV_CONNECTOR_TYPE_J1772","EV_CONNECTOR_TYPE_TESLA"] } }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H "X-Goog-FieldMask: places.displayName,places.evChargeOptions" \ 'https://places.googleapis.com/v1/places:searchText'
该请求会返回以下响应:
{ "places": [ { "displayName": { "text": "EVgo Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 16, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_CHADEMO", "maxChargeRateKw": 100, "count": 8, "availableCount": 5, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 100, "count": 2, "availableCount": 2, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 350, "count": 6, "availableCount": 3, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" } ] } }, { "displayName": { "text": "EVgo Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 6, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 100, "count": 4, "availableCount": 3, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 350, "count": 2, "availableCount": 0, "outOfServiceCount": 2, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" } ] } }, { "displayName": { "text": "EVgo Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 5, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_J1772", "maxChargeRateKw": 3.5999999046325684, "count": 1, "availableCount": 0, "outOfServiceCount": 1, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CHADEMO", "maxChargeRateKw": 50, "count": 2, "availableCount": 0, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 50, "count": 2, "availableCount": 0, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" } ] } }, { "displayName": { "text": "Electric Vehicle Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 10, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_OTHER", "maxChargeRateKw": 210, "count": 10 } ] } } ] }
指定每页返回的结果数
使用 pageSize
参数指定
每页返回率响应正文中的 nextPageToken
参数
用于提供令牌,可以在后续调用中使用,以访问
结果。
以下示例展示了对“北京烤鸭”的请求最多 5 个 每页结果数:
curl -X POST -d '{ "textQuery": "pizza in New York", "pageSize": 5 }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H "X-Goog-FieldMask: places.id,nextPageToken" \ 'https://places.googleapis.com/v1/places:searchText'
{ "places": [ { "id": "ChIJifIePKtZwokRVZ-UdRGkZzs" }, { "id": "ChIJPxPd_P1YwokRfzLhSiACEoU" }, { "id": "ChIJrXXKn5NZwokR78g0ipCnY60" }, { "id": "ChIJ6ySICVZYwokR9rIK8HjXhzE" }, { "id": "ChIJ6xvs94VZwokRnT1D2lX2OTw" } ], "nextPageToken": "AeCrKXsZWzNVbPzO-MRWPu52jWO_Xx8aKwOQ69_Je3DxRpfdjClq8Ekwh3UcF2h2Jn75kL6PtWLGV4ecQri-GEUKN_OFpJkdVc-JL4Q" }
如需访问下一页结果,请使用 pageToken
传入
nextPageToken
:
curl -X POST -d '{ "textQuery": "pizza in New York", "pageSize": 5, "pageToken": "AeCrKXsZWzNVbPzO-MRWPu52jWO_Xx8aKwOQ69_Je3DxRpfdjClq8Ekwh3UcF2h2Jn75kL6PtWLGV4ecQri-GEUKN_OFpJkdVc-JL4Q" }' \ -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \ -H "X-Goog-FieldMask: places.id,nextPageToken" \ 'https://places.googleapis.com/v1/places:searchText'
{ "places": [ { "id": "ChIJL-LN1N1ZwokR8K2jACu6Ydw" }, { "id": "ChIJjaD94kFZwokR-20CXqlpy_4" }, { "id": "ChIJ6ffdpJNZwokRmcafdROM5q0" }, { "id": "ChIJ8Q2WSpJZwokRQz-bYYgEskM" }, { "id": "ChIJ8164qwFZwokRhplkmhvq1uE" } ], "nextPageToken": "AeCrKXvPd6uUy-oj96W2OaqEe2pUD8QTxOM8-sKfUcFsC9t2Wey5qivrKGoGSxcZnyc7RPmaFfAktslrKbUh31ZDTkL0upRmaxA7c_c" }
试试看!
借助 API Explorer,您可以发出示例请求, 您可以熟悉 API 和 API 选项。
选择 API 图标 , 。
(可选)展开 Show standard parameters(显示标准参数)并设置
fields
参数添加到字段 遮盖。(可选)修改请求正文。
选择执行按钮。在弹出的对话框中,选择需要 用于发出请求
在 API Explorer 面板中,选择“展开”图标, 用于展开 API Explorer 窗口。