迁移到附近搜索(新)

Places API 支持现有的附近地点搜索。如果您熟悉现有的“附近搜索”功能,新版“附近搜索”将做出以下变更:

  • 新版“附近搜索”使用 HTTP POST 请求。 在 HTTP POST 请求的请求正文或标头中传递参数。相比之下,对于现有的“附近搜索”,您使用 HTTP GET 请求传递网址参数。
  • 必须进行字段遮盖。您必须指定要在响应中返回的字段。没有返回字段的默认列表。如果您省略此列表,这些方法会返回错误。如需了解详情,请参阅 FieldMask
  • 新版“附近搜索”支持使用 API 密钥OAuth 令牌作为身份验证机制。
  • 新的“附近搜索”功能仅支持 JSON 作为响应格式。
  • 现在,所有包含文本查询的请求都应使用文本搜索(新),因为“附近搜索(新)”不支持文本输入。
  • Nearby Search(新)API 的 JSON 响应格式已与现有 API 的格式不同。如需了解详情,请参阅迁移 Google 地图 API 响应

下表列出了现有“附近搜索”中已针对新的“附近搜索”进行重命名或修改的参数,或不再受支持的参数。

当前参数 新增参数 备注
keyword 不受支持。请改用新版文本搜索
language languageCode
location locationRestriction 必填。
maxprice/minprice 不受支持。
maxResultCount 新增参数。
opennow 不受支持。
pagetoken 不受支持。
radius 立即使用 locationRestriction
rankby rankPreference
regionCode 新增参数。
type includedTypes
excludedTypes
includedPrimaryTypes
excludedPrimaryTypes
新参数也接受多个类型值。现有 API 仅接受单个值。

示例请求

以下示例 GET 请求会使用现有的“附近搜索”。在此示例中,您将请求包含 restaurant 类型地点相关信息的 JSON 响应,并将所有参数作为网址参数传递:

curl -L -X GET \
'https://maps.googleapis.com/maps/api/place/nearbysearch/json?location=37.7937%2C-122.3965&radius=500&type=restaurant&key=API_KEY'

使用“附近搜索”(新)时,您需要发出 POST 请求,并在 JSON 请求正文或标头中作为 POST 请求的一部分传递所有参数。此示例还使用了字段掩码,因此响应仅包含地点的显示名称和设置了格式的地址:

curl -X POST -d '{
  "includedTypes": ["restaurant"],
  "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" \
https://places.googleapis.com/v1/places:searchNearby