简介
“附近搜索(新) ”请求会采用一个或多个地点类型,并返回 指定区域内匹配的地点列表。您需要指定一个或多个数据类型的字段掩码。“附近搜索(新)”仅支持 POST 请求。
借助 APIs Explorer,您可以发出实时请求,以便熟悉 API 和 API 选项:
试用互动 演示,查看地图上显示的“附近搜索(新)”结果。
“附近搜索(新)”请求
“附近搜索(新)”请求是向以下格式的网址发出的 HTTP POST 请求:
https://places.googleapis.com/v1/places:searchNearby
在 JSON 请求正文或标头中传递所有参数,作为 POST 请求的一部分。例如:
curl -X POST -d '{
"includedTypes": ["restaurant"],
"maxResultCount": 10,
"locationRestriction": {
"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" \
https://places.googleapis.com/v1/places:searchNearby
“附近搜索(新)”响应
“附近搜索(新)”会返回一个 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: *
指定以下一个或多个字段:
以下字段会触发附近搜索专业版 SKU:
places.accessibilityOptions
places.addressComponents
places.addressDescriptor*
places.adrFormatAddress
places.attributions
places.businessStatus
places.containingPlaces
places.displayName
places.formattedAddress
places.googleMapsLinks
places.googleMapsUri
places.iconBackgroundColor
places.iconMaskBaseUri
places.id
places.location
places.name**
places.movedPlace
places.movedPlaceId
places.openingDate
places.photos
places.plusCode
places.postalAddress
places.primaryType
places.primaryTypeDisplayName
places.pureServiceAreaBusiness
places.shortFormattedAddress
places.subDestinations
places.timeZone
places.types
places.utcOffsetMinutes
places.viewport
* 地址描述符通常面向印度客户提供,在其他地区处于实验阶段。
**places.name字段包含地点 资源名称 ,格式为:places/PLACE_ID。使用places.displayName访问地点的文本名称。以下字段会触发附近搜索企业版 SKU:
places.currentOpeningHours
places.currentSecondaryOpeningHours
places.internationalPhoneNumber
places.nationalPhoneNumber
places.priceLevel
places.priceRange
places.rating
places.regularOpeningHours
places.regularSecondaryOpeningHours
places.transitStation
places.userRatingCount
places.websiteUri以下字段会触发附近搜索企业版 + 氛围 SKU:
places.allowsDogs
places.curbsidePickup
places.delivery
places.dineIn
places.editorialSummary
places.evChargeAmenitySummary
places.evChargeOptions
places.fuelOptions
places.generativeSummary
places.goodForChildren
places.goodForGroups
places.goodForWatchingSports
places.liveMusic
places.menuForChildren
places.neighborhoodSummary
places.parkingOptions
places.paymentOptions
places.outdoorSeating
places.reservable
places.restroom
places.reviews
places.reviewSummary
routingSummaries*
places.servesBeer
places.servesBreakfast
places.servesBrunch
places.servesCocktails
places.servesCoffee
places.servesDessert
places.servesDinner
places.servesLunch
places.servesVegetarianFood
places.servesWine
places.takeout
* 仅限文本搜索和附近搜索
-
locationRestriction
要搜索的区域,指定为圆形,由中心点和半径(以米为单位)定义。 半径必须介于 0.0 到 50000.0 之间(含边界值)。默认半径为 0.0。您必须 在请求中将其设置为大于 0.0 的值。
例如:
"locationRestriction": { "circle": { "center": { "latitude": 37.7937, "longitude": -122.3965 }, "radius": 500.0 } }
可选参数
-
includeFutureOpeningBusinesses
如果为
true,则返回预计在未来开业的商家。默认值为false。
如需检索商家状态,请在请求字段掩码中添加places.businessStatus。如需检索商家的预计开业日期,请在请求字段掩码中添加places.openingDate。 -
includedTypes/excludedTypes、includedPrimaryTypes/excludedPrimaryTypes
让您可以指定一个类型列表(来自类型 表 A),用于过滤 搜索结果。在每个类型限制类别中,最多可以指定 50 种类型。
中的值仅在响应中返回。您不能将 表 B 中的值用作过滤条件。一个地点只能关联类型表 A 中的一个主要类型 。例如,主要类型可能是
"mexican_restaurant"或"steak_house"。使用includedPrimaryTypes和excludedPrimaryTypes根据 地点的主要类型过滤结果。一个地点还可以关联类型表 A 中的多个类型值 。例如,一家餐厅可能具有以下类型:
"seafood_restaurant","restaurant","food","point_of_interest","establishment"。使用includedTypes和excludedTypes根据与地点关联的 地点列表过滤结果。当您指定一般主要类型(例如
"restaurant"或"hotel")时,响应可以包含主要类型比指定类型更具体的地点。例如,您指定包含"restaurant"主要类型。然后,响应可以包含主要类型为"restaurant"的地点,但响应也可以包含主要类型更具体的地点,例如"chinese_restaurant"或"seafood_restaurant"。如果搜索指定了多个类型限制,则仅返回满足所有限制的地点 。例如,如果您指定
{"includedTypes": ["restaurant"], "excludedPrimaryTypes": ["steak_house"]},则 返回的地点提供"restaurant"相关服务,但主要不作为"steak_house"运营。includedTypes
要搜索的地点类型(来自 表 A)的英文逗号分隔列表。 如果省略此参数,则返回所有类型的地点。
excludedTypes
要从表 A中排除的地点类型(英文逗号分隔列表),用于 搜索。
如果您在请求中同时指定了
includedTypes(例如"school")和excludedTypes(例如"primary_school"),则响应会包含归类为"school"但不归类为"primary_school"的地点。响应包含与 中的至少一个 类型匹配且与excludedTypes中的任何 类型都不匹配的地点。includedTypes如果存在任何冲突的类型(例如,某个类型同时出现在
includedTypes和excludedTypes中),则会返回INVALID_REQUEST错误。includedPrimaryTypes
要包含在搜索中的主要地点类型(来自表 A)的英文逗号分隔列表 。
excludedPrimaryTypes
要从搜索中排除的主要地点类型(来自表 A)的英文逗号分隔列表 。
如果存在任何冲突的主要类型(例如,某个类型同时出现在
includedPrimaryTypes和excludedPrimaryTypes中),则会返回INVALID_ARGUMENT错误。 -
languageCode
返回结果所用的语言。
- 请参阅支持的语言列表。Google 会经常 更新支持的语言,因此该列表可能并非详尽无遗。
- 如果未提供
languageCode,API 会默认使用en。如果您指定了无效的语言代码,API 会返回INVALID_ARGUMENT错误。 - API 会尽力提供用户和 当地人都能看懂的街道地址。为实现这一目标,它会以当地语言返回街道地址, 并在必要时根据首选语言将街道地址音译为用户可读的文字。所有其他地址均以首选语言返回。地址组成部分全部以同一种语言返回,该语言是从第一个组成部分中选择的。
- 如果名称在首选语言中没有对应项,API 会使用最接近的匹配项。
- 首选语言对 API 选择返回的结果集以及返回结果的顺序影响不大。地理编码器会根据语言以不同的方式解读缩写 ,例如街道类型的缩写,或者在一种语言中有效但在另一种语言中无效的同义词 。
-
maxResultCount
指定要返回的地点结果数上限。必须介于 1 到 20(默认值)之间(含边界值)。
-
rankPreference
要使用的排名类型。如果省略此参数,结果将按受欢迎程度排名。 可以是以下值之一:
POPULARITY(默认值)根据结果的受欢迎程度对结果进行排序。DISTANCE根据结果与 指定位置的距离按升序对结果进行排序。
-
regionCode
用于设置响应格式的区域代码,指定为 双字符 CLDR 代码值。没有默认值。
如果响应中
formattedAddress字段的国家/地区名称与regionCode匹配,则系统会从formattedAddress中省略国家/地区代码。 此参数对adrFormatAddress(始终包含国家/地区名称)或shortFormattedAddress(从不包含国家/地区名称)没有影响。多数 CLDR 代码都与 ISO 3166-1 代码 相同,但也有一些需要注意的例外情况。例如,英国的 ccTLD 为 “uk”(.co.uk),而其 ISO 3166-1 代码为“gb”(从技术上讲,适用于 “大不列颠及北爱尔兰联合王国”实体)。 此参数可能会根据适用法律影响结果。
“附近搜索(新)”示例
查找一种类型的地点
以下示例展示了“附近搜索(新)”请求,用于查找由 circle 定义的 500 米半径范围内的所有餐厅的显示名称:
curl -X POST -d '{
"includedTypes": ["restaurant"],
"maxResultCount": 10,
"locationRestriction": {
"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" \
https://places.googleapis.com/v1/places:searchNearby
请注意,X-Goog-FieldMask 标头指定响应包含以下数据字段:places.displayName。
然后,响应
采用以下格式:
{ "places": [ { "displayName": { "text": "La Mar Cocina Peruana", "languageCode": "en" } }, { "displayName": { "text": "Kokkari Estiatorio", "languageCode": "en" } }, { "displayName": { "text": "Harborview Restaurant & Bar", "languageCode": "en" } }, ... }
向字段掩码添加更多数据类型,以返回其他信息。例如,添加 places.formattedAddress,places.types,places.websiteUri,以便在响应中包含餐厅地址、类型和网址:
curl -X POST -d '{
"includedTypes": ["restaurant"],
"maxResultCount": 10,
"locationRestriction": {
"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,places.types,places.websiteUri" \
https://places.googleapis.com/v1/places:searchNearby
{ "places": [ { "types": [ "seafood_restaurant", "restaurant", "food", "point_of_interest", "establishment" ], "formattedAddress": "PIER 1 1/2 The Embarcadero N, San Francisco, CA 94105, USA", "websiteUri": "http://lamarsf.com/", "displayName": { "text": "La Mar Cocina Peruana", "languageCode": "en" } }, { "types": [ "greek_restaurant", "meal_takeaway", "restaurant", "food", "point_of_interest", "establishment" ], "formattedAddress": "200 Jackson St, San Francisco, CA 94111, USA", "websiteUri": "https://kokkari.com/", "displayName": { "text": "Kokkari Estiatorio", "languageCode": "en" } }, ... }
查找多种类型的地点
以下示例展示了“附近搜索(新)”请求,用于查找指定 circle 的 1000 米半径范围内的所有便利店和酒类商店的显示名称:
curl -X POST -d '{
"includedTypes": ["liquor_store", "convenience_store"],
"maxResultCount": 10,
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 1000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName,places.primaryType,places.types" \
https://places.googleapis.com/v1/places:searchNearby
places.primaryType 和 places.types,以便响应包含每个地点(Places)的类型信息,从而更轻松地从结果中选择合适的地点(Places)。从搜索中排除一种地点类型
以下示例展示了“附近搜索(新)”请求,用于查找所有 "school" 类型的地点,排除所有 "primary_school" 类型的地点,并按距离对结果进行排名:
curl -X POST -d '{
"includedTypes": ["school"],
"excludedTypes": ["primary_school"],
"maxResultCount": 10,
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 1000.0
}
},
"rankPreference": "DISTANCE"
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName" \
https://places.googleapis.com/v1/places:searchNearby
搜索某个区域附近的所有地点,并按距离排名
以下示例展示了“附近搜索(新)”请求,用于查找旧金山市中心某个点附近的地点。在此示例中,您添加了 rankPreference 参数,以便按距离对结果进行排名:
curl -X POST -d '{
"maxResultCount": 10,
"rankPreference": "DISTANCE",
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 1000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName" \
https://places.googleapis.com/v1/places:searchNearby
获取地址描述符
地址描述符提供有关地点位置的关系信息,包括附近的 标志性建筑和包含的区域。
以下示例展示了“附近搜索(新)”请求,用于查找圣何塞一家购物中心附近的地点
。在此示例中,您在字段掩码中添加了 addressDescriptors
:
curl -X POST -d '{
"maxResultCount": 5,
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.321328,
"longitude": -121.946275
},"radius": 1000
}
},
"includedTypes": ["restaurant", "cafe"],
"excludedTypes": [],
"rankPreference":"POPULARITY"
}' \
-H 'Content-Type: application/json' \
-H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName,places.addressDescriptor" \
https://places.googleapis.com/v1/places:searchNearby
响应包含请求中指定的地点、附近标志性建筑的列表及其 与地点的距离,以及区域列表及其与地点的包含关系:
{ "places": [ { "displayName": { "text": "Westfield Valley Fair", "languageCode": "en" }, "addressDescriptor": { "landmarks": [ { "name": "places/ChIJ62_oCR7Lj4AR_MGWkSPotD4", "placeId": "ChIJ62_oCR7Lj4AR_MGWkSPotD4", "displayName": { "text": "Nordstrom", "languageCode": "en" }, "types": [ "clothing_store", "department_store", "establishment", "point_of_interest", "shoe_store", "store" ], "straightLineDistanceMeters": 114.76984, "travelDistanceMeters": 114.261856 }, { "name": "places/ChIJgexMlR_Lj4ARiKCKuhNnjn0", "placeId": "ChIJgexMlR_Lj4ARiKCKuhNnjn0", "displayName": { "text": "Valley Fair Mall Eyexam of CA", "languageCode": "en" }, "types": [ "establishment", "health", "point_of_interest" ], "straightLineDistanceMeters": 131.62566, "travelDistanceMeters": 237.33253 }, { "name": "places/ChIJWWIlNx7Lj4ARpe1E0ob-_GI", "placeId": "ChIJWWIlNx7Lj4ARpe1E0ob-_GI", "displayName": { "text": "Din Tai Fung", "languageCode": "en" }, "types": [ "establishment", "food", "point_of_interest", "restaurant" ], "straightLineDistanceMeters": 110.0775, "travelDistanceMeters": 171.41951 }, { "name": "places/ChIJwyfPQx7Lj4AR7bYI2A2Yc54", "placeId": "ChIJwyfPQx7Lj4AR7bYI2A2Yc54", "displayName": { "text": "Abercrombie & Fitch", "languageCode": "en" }, "types": [ "clothing_store", "establishment", "point_of_interest", "shoe_store", "store" ], "spatialRelationship": "DOWN_THE_ROAD", "straightLineDistanceMeters": 53.620117, "travelDistanceMeters": 2.4578214 }, { "name": "places/ChIJpycNQx7Lj4ARjhXw3PrM_kU", "placeId": "ChIJpycNQx7Lj4ARjhXw3PrM_kU", "displayName": { "text": "Hollister Co.", "languageCode": "en" }, "types": [ "clothing_store", "establishment", "point_of_interest", "shoe_store", "store" ], "spatialRelationship": "DOWN_THE_ROAD", "straightLineDistanceMeters": 56.53726, "travelDistanceMeters": 15.418246 } ], "areas": [ { "name": "places/ChIJb3F-EB7Lj4ARnHApQ_Hu1gI", "placeId": "ChIJb3F-EB7Lj4ARnHApQ_Hu1gI", "displayName": { "text": "Westfield Valley Fair", "languageCode": "en" }, "containment": "WITHIN" }, { "name": "places/ChIJXYuykB_Lj4AR1Ot8nU5q26Q", "placeId": "ChIJXYuykB_Lj4AR1Ot8nU5q26Q", "displayName": { "text": "Valley Fair", "languageCode": "en" }, "containment": "WITHIN" }, { "name": "places/ChIJtYoUX2DLj4ARKoKOb1G0CpM", "placeId": "ChIJtYoUX2DLj4ARKoKOb1G0CpM", "displayName": { "text": "Central San Jose", "languageCode": "en" }, "containment": "OUTSKIRTS" } ] } }, /.../ }
查找未来开业的商家
以下示例展示了“附近搜索(新)”请求,用于查找爱达荷州新梅多斯未来开业的商家:
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.id,places.displayName,places.businessStatus,places.openingDate" \
-d '{
"includeFutureOpeningBusinesses": true,
"maxResultCount": 20,
"locationRestriction": {
"circle": {
"center": {"latitude": 44.9755100, "longitude": -116.2842180},
"radius": 20
}
},
"rankPreference": "DISTANCE"
}' \
"https://places.googleapis.com/v1/places:searchNearby"
响应包含未来开业的商家,以及其商家状态 和预计开业日期:
{ "places": [ { "id": "ChIJp1-VoKWJplQRMz8g-7Wa3Do", "businessStatus": "FUTURE_OPENING", "displayName": { "text": "Roberts Greenhouse and Tree Farm", "languageCode": "en" }, "openingDate": { "year": 2026, "month": 4, "day": 15 } } ] }
获取公交车站信息
您可以使用“附近搜索(新)”获取给定位置特定半径范围内的公交车站信息。响应正文包含有关车站的信息,包括车站名称、附属公交机构以及为车站提供服务的公交线路。此外,响应还包含车辆图标和颜色,您可以使用这些图标和颜色来显示公交车站信息。
以下示例展示了对曼哈顿中城 50 米范围内的公交车站的请求:
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.id,places.displayName,places.transitStation" \
-d '{
"includedTypes": ["transit_station"],
"locationRestriction": {
"circle": {
"center": {"latitude": 40.754851, "longitude": -73.984164},
"radius": 50.0
}
}
}' \
"https://places.googleapis.com/v1/places:searchNearby"
响应正文包含半径范围内的每个车站的信息、车站服务的 线路、公交机构在该站点发布的提醒以及出发信息:
{ "places": [ { "id": "ChIJH2EstKpZwokRCwZtYyMd5Fg", "displayName": { "text": "6 Av/W 41 St", "languageCode": "en" }, "transitStation": { "displayName": { "text": "6 Av/W 41 St", "languageCode": "en" }, "agencies": [ { "displayName": { "text": "ShortLine Hudson", "languageCode": "en" }, "url": "https://www.coachusa.com/", "lines": [ { "id": "ChIJSQlbzvPwwokRolrIA-Kuh6o", "vehicleType": "BUS", "displayName": { "text": "200 - Northern District – Nanuet", "languageCode": "en" }, "shortDisplayName": { "text": "ShortLine Hudson", "languageCode": "en" }, "textColor": "#000000", "backgroundColor": "#ED60A3", "vehicleIcon": { "url": "https://maps.gstatic.com/mapfiles/transit/iw2/svg/bus2.svg" } } ] }, { "displayName": { "text": "MTA New York City Transit", "languageCode": "en" }, "url": "http://www.mta.info/", "lines": [ { "id": "ChIJjUrj7PBewokR3O3S2JVpBrI", "vehicleType": "SUBWAY", "displayName": { "text": "E Train (8 Av Local)", "languageCode": "en" }, "shortDisplayName": { "text": "E Line", "languageCode": "en" }, "textColor": "#FFFFFF", "backgroundColor": "#0039A6", "url": "https://www.mta.info/schedules/subway/e-train", "icon": { "url": "https://maps.gstatic.com/mapfiles/transit/iw2/svg/us-ny-mta/E.svg", "nameIncluded": true }, "vehicleIcon": { "url": "https://maps.gstatic.com/mapfiles/transit/iw2/svg/subway2.svg" } }, ... ] }, "stops": [ { "id": "ChIJvRnquapZwokRdUOyVwNGbe8", "displayName": { "text": "6 Av/W 41 St", "languageCode": "en" }, "location": { "latitude": 40.754509, "longitude": -73.984216500000016 }, "wheelchairAccessibleEntrance": true } ], "departureBoards": [ { "displayType": "DIRECTION_CENTRIC", "rows": [ { "departures": [ { "timedDeparture": { "scheduledTime": "2026-05-15T22:29:51Z", "timingType": "SCHEDULED" }, "originallyScheduledStopId": "ChIJvRnquapZwokRdUOyVwNGbe8", "lineId": "ChIJA1aFyaZfwokRkO5869M6UXk" } ] }, { "departures": [ { "timedDeparture": { "scheduledTime": "2026-05-15T22:33:55Z", "timingType": "SCHEDULED" }, "originallyScheduledStopId": "ChIJvRnquapZwokRdUOyVwNGbe8", "lineId": "ChIJj3iCEwJfwokRZE2Qtnm4pPI" } ] }, ... ] } ] } }, ... { { "id": "ChIJPyq6TZBZwokRdGoiJ5Iq_hE", "vehicleType": "BUS", "displayName": { "text": "W 44 St - South Ferry", "languageCode": "en" }, "shortDisplayName": { "text": "M55", "languageCode": "en" }, "textColor": "#FFFFFF", "backgroundColor": "#1D59B3", "vehicleIcon": { "url": "https://maps.gstatic.com/mapfiles/transit/iw2/svg/bus2.svg" }, "alerts": [ { "effect": "OTHER", "texts": [ { "headline": { "text": "Information", "languageCode": "en" }, "summary": { "text": "Northbound M20 and M55 stop on State St at Bridge St is closed; use the temporary stop on State St before the intersection instead", "languageCode": "en" }, "fullDescription": { "text": "See a map of the new stop location. What's happening? Construction", "languageCode": "en" } } ], "detailsUrls": [ { "url": "https://www.mta.info/" } ], "cause": "OTHER_CAUSE", "startTime": "2025-04-02T04:00:00Z", "endTime": "2026-06-15T00:00:00Z", "attribution": { "link": { "text": "www.mta.info", "url": "https://www.mta.info/" } }, "createTime": "2026-05-15T22:32:00Z", "severityLevel": "INFO" } ] }, ... } ... }
试试看!
借助 APIs Explorer,您可以发出示例请求,以便熟悉 API 和 API 选项。
选择页面右侧的 API 图标 api 。
(可选)修改请求参数。
选择执行 按钮。在对话框中,选择您要用于发出请求的账号 。
在 APIs Explorer 面板中,选择全屏图标 fullscreen 以展开 APIs Explorer 窗口。