创建地点 ID 后,您可以 请求获取有关特定场所的更多详情,或 来启动一个感兴趣的地点 地点详情(新) 请求。地点详情(新) 请求会返回有关指定地点的更全面信息 例如其完整地址、电话号码、用户评分和评价。
您可以通过多种方式获取地点 ID。您可以使用:
利用 API Explorer,您可以发出实时请求,从而熟悉 API 和 API 选项:
试试看!“地点详情(新)”请求
“地点详情”请求是一个 HTTP GET 请求,格式如下:
https://places.googleapis.com/v1/places/PLACE_ID
将所有参数作为网址参数传递,或作为 GET 请求。例如:
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=API_KEY
或在 c网址 命令中运行以下命令:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
“地点详情(新)”响应
地点详情(新)会返回 JSON 对象作为响应。在响应中:
完整的 JSON 对象格式如下:
{ "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g", "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g", "displayName": { "text": "Trinidad" } ... }
必需参数
-
FieldMask
指定要在响应中返回的字段列表,方法是: 响应字段掩码。 使用网址参数将响应字段掩码传递给该方法
$fields
或fields
,或者使用 HTTP 标头X-Goog-FieldMask
。响应中没有返回字段的默认列表。 如果您省略字段掩码,则该方法会返回错误。字段遮盖是一种很好的设计做法,可确保您 不必要的数据,这有助于避免不必要的处理时间和 结算费用。
指定要返回的地点数据类型的列表(以英文逗号分隔)。例如: 检索地点的显示名称和地址。
X-Goog-FieldMask: displayName,formattedAddress
使用
*
检索所有字段。X-Goog-FieldMask: *
指定以下一个或多个字段:
以下字段会触发地点详情(仅 ID)SKU:
attributions
,id
,name
*、photos
*name
字段包含地点的资源名称 格式为:places/PLACE_ID
。使用displayName
访问地点的文本名称。以下字段会触发地点详情(仅限位置)SKU:
addressComponents
,adrFormatAddress
,formattedAddress
,location
,plusCode
,shortFormattedAddress
,types
,viewport
以下字段会触发地点详情(基本)SKU:
accessibilityOptions
,businessStatus
,displayName
,googleMapsUri
,iconBackgroundColor
,iconMaskBaseUri
,primaryType
,primaryTypeDisplayName
,subDestinations
,utcOffsetMinutes
以下字段会触发地点详情(高级)SKU:
currentOpeningHours
,currentSecondaryOpeningHours
,internationalPhoneNumber
,nationalPhoneNumber
,priceLevel
,rating
,regularOpeningHours
,regularSecondaryOpeningHours
,userRatingCount
,websiteUri
以下字段会触发地点详情(首选)SKU:
allowsDogs
,curbsidePickup
,delivery
,dineIn
,editorialSummary
,evChargeOptions
,fuelOptions
,goodForChildren
,goodForGroups
,goodForWatchingSports
,liveMusic
,menuForChildren
,parkingOptions
,paymentOptions
,outdoorSeating
,reservable
,restroom
,reviews
,servesBeer
,servesBreakfast
,servesBrunch
,servesCocktails
,servesCoffee
,servesDessert
,servesDinner
,servesLunch
,servesVegetarianFood
,servesWine
,takeout
-
placeId
唯一标识地点的文本标识符,从 文本搜索(新)或 附近搜索(新)。 如需了解有关地点 ID 的详细信息,请参阅 地点 ID 概览。
字符串
places/PLACE_ID
也称为地点 资源名称。在“地点详情(新)”的响应中: 附近搜索(新)和文本搜索(新) 请求,此字符串包含在响应的name
字段中。独立广告 地点 ID 包含在响应的id
字段中。
可选参数
languageCode
返回结果时所使用的语言。
- 请参阅 支持的语言列表。Google 会经常更新 支持的语言,因此该列表可能并不详尽。
-
如果未提供
languageCode
,则 API 默认为en
。如果 您指定了无效的语言代码,则 API 会返回INVALID_ARGUMENT
错误。 - API 会尽最大努力提供对于 用户和本地用户为实现该目标,它会返回街道 以当地语言显示地址,音译为可由 Google 搜索的 用户(如有必要),注意观察首选语言。所有其他 以首选语言返回地址。地址组成部分是 均以相同的语言返回,该语言从第一个 组件。
- 如果某个名称没有以首选语言提供,API 会使用 最接近的匹配项。
- 首选语言对要返回的结果集影响较小 API 选择返回的条目以及这些条目的返回顺序。通过 根据语言,地理编码器会以不同的方式解读缩写, 例如街道类型的缩写或 只对另一种语言有效。
regionCode
用于设置响应格式的地区代码,指定为 两个字符的 CLDR 代码值。没有默认值。
如果响应中
formattedAddress
字段的国家/地区名称与regionCode
,则formattedAddress
中省略了国家/地区代码。 此参数对adrFormatAddress
(始终包含国家/地区)没有影响 或shortFormattedAddress
(从不包含该属性值)。大多数 CLDR 代码与 ISO 3166-1 代码相同, 但有一些值得注意的例外情况。例如,英国的 ccTLD 为 "uk"(.co.uk),而其 ISO 3166-1 代码为“gb”(从技术层面来讲, “大不列颠及北爱尔兰联合王国”)。 根据适用法律,该参数可能会影响结果。
-
sessionToken
会话令牌是用户生成的字符串,用于跟踪自动补全情况 (新)调用作为“会话”。自动补全(新)会使用会话令牌 将用户自动补全搜索的查询和地点选择阶段分组到一个单独的会话中 用于结算目的会话令牌会传递到地点详情(新) 跟随“自动补全(新)”调用的调用。如需了解详情,请参阅 会话令牌。
地点详情示例
以下示例按照
placeId
:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
请注意,X-Goog-FieldMask
标头会指定
响应
包含以下数据字段:id,displayName
。
响应将采用以下格式:
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "displayName": { "text": "Googleplex", "languageCode": "en" } }
向字段掩码添加更多数据类型以返回其他信息。
例如,添加 formattedAddress,plusCode
以包含
地址和 Plus 代码(位于
响应:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName,formattedAddress,plusCode" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
响应现在采用以下格式:
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "formattedAddress": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA", "plusCode": { "globalCode": "849VCWC7+RW", "compoundCode": "CWC7+RW Mountain View, CA, USA" }, "displayName": { "text": "Googleplex", "languageCode": "en" } }
试试看!
借助 API Explorer,您可以发出示例请求, 您可以熟悉 API 和 API 选项。
如需发出请求,请执行以下操作:
- 选择 API 图标 , 。
- (可选)将
name
参数设置为:places/PLACE_ID
- (可选)展开显示标准参数,并设置
fields
参数 字段掩码。 - 选择执行按钮。在弹出式窗口中,选择您要更改 用于发出请求
在 API Explorer 面板中,选择“展开”图标, 用于展开 API Explorer 窗口。