文本搜索(新)可以根据一个字符串(例如,“北京烤鸭”“南京附近的鞋店”或“长安街 8 号”)返回一组地点的相关信息。该服务会返回一个与文本字符串和任何位置偏向设置相匹配的地点列表。
该服务特别适合在自动化系统中进行地址模糊查询,字符串的非地址组成部分可能与商家以及地址匹配。模糊地址查询的示例包括格式错误的地址或包含商家名称等非地址组成部分的请求。除非设置了位置(例如区域、位置限制或位置偏向),否则与下表中的前两个示例相关的请求可能返回零个结果。
“10 High Street, UK”或“123 Main Street, US” | 英国有多个“高街”;美国有多条“主街”。 除非设置了位置限制,否则查询不会返回所需的结果。 |
“纽约连锁餐馆” | 纽约的多个“ChainRestaurant”营业地点;没有街道地址,甚至没有街道名称。 |
“10 High Street, Escher UK”或“123 Main Street, Pleasanton US” | 英国埃舍尔市只有一条“高街”;在美国加利福尼亚州普莱森顿市只有一条“主街”。 |
“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 对象作为响应。在响应中:
places
数组包含所有匹配的地点。- 数组中的每个地点均由一个
Place
对象表示。Place
对象包含单个地点的详细信息。 - 请求中传递的 FieldMask 指定了
Place
对象中返回的字段列表。
完整的 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.delivery
、places.reviews
、places.servesBeer
、places.servesBeer
、{19places.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 会尽力提供用户和当地人都能看懂的街道地址。为实现这一目标,它会使用当地语言返回街道地址,必要时将其音译为用户可以看懂的脚本,并观察首选语言。所有其他地址均以首选语言返回。所有地址组成部分均以从第一个组成部分中选择的同一种语言返回。
- 如果首选语言没有某个名称,则 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 度(含)之间:
- 如果
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
,则返回所有商家,无论其是否处于营业状态。如果您将此参数设置为false
,则系统会返回未在 Google 地点数据库中指定营业时间的地点。pageSize
指定每页显示的结果数(介于 1 到 20 之间)。例如,如果将
pageSize
值设置为 5,系统最多会在第一页返回 5 个结果。如果查询可以返回更多结果,响应中会包含一个nextPageToken
,您可以将其传递到后续请求中以访问下一页。pageToken
指定上一页的响应正文中的
nextPageToken
。-
priceLevels
将搜索范围限制为标记在特定价位的地点。默认设置是选择所有价位。
指定由
PriceLevel
定义的一个或多个值的数组。例如:
"priceLevels":["PRICE_LEVEL_INEXPENSIVE", "PRICE_LEVEL_MODERATE"]
rankPreference
指定如何基于查询类型在响应中对结果进行排名:
- 对于“纽约市的餐馆”等分类查询,
RELEVANCE
(按搜索相关性对结果排名)是默认值。您可以将rankPreference
设置为RELEVANCE
或DISTANCE
(按距离对结果排序)。 - 对于非分类查询(例如“Mountain View, CA”),我们建议您不设置
rankPreference
。
- 对于“纽约市的餐馆”等分类查询,
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
以将餐馆类型和网址包含在响应中:
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 类型 1 电动汽车充电连接器的请求,最低充电率为 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 窗口。