Place (beta)

Place

google.maps.places.Place

通过调用 const {Place} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

Place
Place(options)
参数
BetafindPlaceFromPhoneNumber
findPlaceFromPhoneNumber(request)
参数
返回值Promise<{places:Array<Place>}>
根据指定的电话号码搜索地点。在极少数情况下,可能有多个地点共用一个电话号码,因此返回数组。
BetafindPlaceFromQuery
findPlaceFromQuery(request)
参数
返回值Promise<{places:Array<Place>}>
根据指定文本查询搜索地点。如果查询不太明确,并且会返回多个地点,则会返回一个数组。此方法不适用于需要多条结果的搜索。
BetasearchByText
searchByText(request)
参数
返回值Promise<{places:Array<Place>}>
基于文本查询的地点搜索。
addressComponents
类型Array<AddressComponent> optional
此地点位置的地址组成部分的集合。如果没有已知的地址数据,则为空对象。如果没有从服务器调用地址数据,则为 undefined
adrFormatAddress
类型string optional
adr 微格式表示的地点地址。
attributions
类型Array<Attribution> optional
要针对此地点结果显示的提供方说明文本。
businessStatus
类型BusinessStatus optional
营业地点的营业状态。如果没有已知状态,则为 null。如果状态数据尚未从服务器加载,则为 undefined
displayName
类型string optional
营业地点的显示名称。如果没有名称,则为 null。如果名称数据尚未从服务器加载,则为 undefined
formattedAddress
类型string optional
营业地点的完整地址。
googleMapsURI
类型string optional
此地点的官方 Google 页面的网址。这是由 Google 拥有的页面,其中包含有关该地点的实用信息。
hasCurbsidePickup
类型boolean optional
地点是否提供路边自提。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
hasDelivery
类型boolean optional
地点是否提供送餐服务。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
hasDineIn
类型boolean optional
地点是否堂食。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
hasTakeout
类型boolean optional
地点是否提供外卖。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
BetahasWheelchairAccessibleEntrance
类型boolean optional
地点是否有无障碍入口。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
iconBackgroundColor
类型string optional
地点类别的默认十六进制颜色码。
id
类型string
唯一地点 ID。
internationalPhoneNumber
类型string optional
地点的电话号码(采用国际电话号码格式)。国际格式包含国家/地区代码,并且带有一个加号 (+) 前缀。
isReservable
类型boolean optional
地点是否可预订。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
location
类型LatLng optional
地点的位置。
nationalPhoneNumber
类型string optional
该地方的电话号码,其格式遵循号码的地区惯例
openingHours
类型OpeningHours optional
photos
类型Array<Photo> optional
此地点的照片。该集合最多包含十个 Photo 对象。
plusCode
类型PlusCode optional
priceLevel
类型PriceLevel optional
地点的价格水平。此属性可以返回以下任意值:
  • Free
  • Inexpensive
  • Moderate
  • Expensive
  • Very Expensive
rating
类型number optional
评分(基于用户对此地点的评价),介于 1.0 到 5.0 之间。
requestedLanguage
类型string optional
此地点请求的语言。
requestedRegion
类型string optional
为此地点请求的区域。
reviews
类型Array<Review> optional
针对此地点的评价列表。
servesBeer
类型boolean optional
地点是否供应啤酒。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
servesBreakfast
类型boolean optional
地点是否供应早餐。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
servesBrunch
类型boolean optional
地点是否供应早午餐。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
servesDinner
类型boolean optional
地点是否供应晚餐。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
servesLunch
类型boolean optional
地点是否供应午餐。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
servesVegetarianFood
类型boolean optional
地点是否供应素食。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
servesWine
类型boolean optional
地点是否供应葡萄酒。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果此字段尚未请求,则返回“undefined”。
svgIconMaskURI
类型string optional
指向可用于表示地点类别的 svg 图片遮罩资源的 URI。
types
类型Array<string> optional
此地点的类型数组(例如 ["political", "locality"]["restaurant", "establishment"])。
userRatingCount
类型number optional
促使此地点的 Place.rating 做出的用户评分数量。
utcOffsetMinutes
类型number optional
地点当前时区的世界协调时间 (UTC) 偏移量(以分钟为单位)。例如,在夏令时期间,奥地利东部标准时间 (GMT+10) 比世界协调时间 (UTC) 早 11 小时,因此 utc_offset_minutes 将为 660。对于晚于世界协调时间 (UTC) 的时区,偏移量为负。例如,对于佛得角,utc_offset_minutes-60
viewport
类型LatLngBounds optional
在地图上显示此地点时的首选视口。
websiteURI
类型string optional
此地点的官方网站,例如商家首页。
BetafetchFields
fetchFields(options)
参数
返回值Promise<{place:Place}>
BetagetNextOpeningTime
getNextOpeningTime([date])
参数
  • dateDate optional
返回值Promise<Date optional>
计算表示下一个 OpeningHoursTime 的日期。如果数据不足以计算结果,或者此地点不再运营,则返回 undefined。
BetaisOpen
isOpen([date])
参数
  • dateDate optional 默认为现在。
返回值Promise<boolean optional>
检查该地点是否在指定日期时间营业。如果营业地点的已知数据不足以计算此值(例如,营业时间未登记),则解析为 undefined
toJSON
toJSON()
参数:无
返回值Object 是一个 JSON 对象,包含所请求的全部地点属性。

PlaceOptions 接口

google.maps.places.PlaceOptions 接口

用于构建地点的选项。

id
类型string
唯一地点 ID。
requestedLanguage optional
类型string optional
应返回详细信息时所使用的语言的语言标识符。请参阅支持的语言列表
requestedRegion optional
类型string optional
用户所在地区的地区代码。这可能会影响系统可能会返回哪些照片,还可能会影响其他因素。地区代码接受 ccTLD(“顶级域名”)双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同,但也有一些需要注意的例外情况。例如,英国的 ccTLD 为“uk”(.co.uk),而其 ISO 3166-1 代码为“gb”(特指“大不列颠及北爱尔兰联合王国”)。

AddressComponent

google.maps.places.AddressComponent

通过调用 const {AddressComponent} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

longText
类型string optional
地址组成部分的完整文本。
shortText
类型string optional
给定地址组成部分的简写文本。
types
类型Array<string>
一个字符串数组,用于表示该地址组成部分的类型。如需查看有效类型的列表,请点击此处

Attribution

google.maps.places.Attribution

通过调用 const {Attribution} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

provider
类型string optional
要针对此地点结果显示的提供方说明文本。
providerURI
类型string optional

FetchFieldsRequest 接口

google.maps.places.FetchFieldsRequest 接口

用于获取地点字段的选项。

fields
类型Array<string>
要提取的字段的列表。
sessionToken optional
类型AutocompleteSessionToken optional
用于将详情请求与自动补全会话捆绑在一起的唯一引用。

OpeningHours

google.maps.places.OpeningHours

通过调用 const {OpeningHours} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

periods
开放时段涵盖一周中的每一天,从星期日开始,按时间顺序排列。不包括地点未营业的日期。
weekdayDescriptions
类型Array<string>
由七个字符串组成的数组,以特定格式表示一周内每天的营业时间。地点服务会根据当前语言对营业时间进行适当的格式设置和本地化。此数组中元素的顺序取决于语言。有些语言以星期一作为一周的开始,有些语言则以星期日作为开始。

OpeningHoursPeriod

google.maps.places.OpeningHoursPeriod

通过调用 const {OpeningHoursPeriod} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

close
类型OpeningHoursPoint optional
地点的结束营业时间。
open
地点的营业时间。

OpeningHoursPoint

google.maps.places.OpeningHoursPoint

通过调用 const {OpeningHoursPoint} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

day
类型number
星期几,以 [0, 6] 范围内的数字表示,从星期日开始。例如,2 表示星期二。
hour
类型number
OpeningHoursPoint.time 的小时,以数字表示,范围为 [0, 23]。系统将按照地点的时区报告这种情况。
minute
类型number
OpeningHoursPoint.time 的分钟,以数字表示,范围为 [0, 59]。系统将按照地点的时区报告这种情况。

Photo

google.maps.places.Photo

通过调用 const {Photo} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

authorAttributions
要为此照片显示的提供方说明文本。
heightPx
类型number
照片的高度,以像素为单位。
widthPx
类型number
照片的宽度(以像素为单位)。
getURI
getURI([options])
参数
返回值string
返回与指定选项对应的图片网址。

AuthorAttribution

google.maps.places.AuthorAttribution

通过调用 const {AuthorAttribution} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

displayName
类型string
此结果的作者姓名。
photoURI
类型string optional
此结果的作者照片 URI。系统不一定会显示相关信息。
uri
类型string optional
此结果的作者个人资料 URI。

PlusCode

google.maps.places.PlusCode

通过调用 const {PlusCode} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

compoundCode
类型string optional
一个 Plus 代码,范围是 1/8000 度、1/8000 度的区域,其中前四个字符(区号)会被删除,并替换为市行政区说明。例如:“9G8F+5W Zurich, zoo”。
globalCode
类型string optional
表示面积的 1/8000 度和 1/8000 度的 Plus 代码。例如:“8FVC9G8F+5W”。

Review

google.maps.places.Review

通过调用 const {Review} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

authorAttribution
类型AuthorAttribution optional
评价者。
publishTime
类型Date optional
rating
类型number optional
此评价的评分,介于 1.0 到 5.0 之间(含 1.0 和 5.0)。
relativePublishTimeDescription
类型string optional
一串近期时间,以适合相应语言和国家/地区的形式表示相对于当前时间的评价时间。例如,“一个月前”。
text
类型string optional
评价的文字。
textLanguageCode
类型string optional
表示撰写此评价所用语言的 IETF 语言代码。请注意,此代码仅包含主要语言标记,不包含任何用于指示国家或地区的辅助标记。例如,所有英文评价都标记为 'en',而不是“en-AU”或“en-UK”。

PriceLevel 常量

google.maps.places.PriceLevel 常量

地点对象的价格水平枚举。

通过调用 const {PriceLevel} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

EXPENSIVE
FREE
INEXPENSIVE
MODERATE
VERY_EXPENSIVE

SearchByTextRequest 接口

google.maps.places.SearchByTextRequest 接口

BetaPlace.searchByText 的请求接口。

fields
类型Array<string>
要包含在响应中的字段,将产生费用。如果传入 ['ALL'],系统将返回所有可用字段并计费(不建议用于生产部署)。如需查看字段列表,请参阅 PlaceResult。可以使用点路径指定嵌套字段(例如 "geometry.location")。
includedType optional
类型string optional
请求的地点类型。受支持类型的完整列表:https://developers.google.com/maps/documentation/places/web-service/place-types。仅支持一种包含的类型。查看SearchByTextRequest.useStrictTypeFiltering
isOpenNow optional
类型boolean optional
默认值false
用于将搜索范围限制为当前营业的地点。
language optional
类型string optional
系统会以首选语言(如果有)显示地点详情。将默认采用浏览器的语言偏好设置。当前支持的语言列表:https://developers.google.com/maps/faq#languagesupport
locationBias optional
要搜索的地区。此位置充当偏差,这意味着可能会返回给定位置周围的结果。不能与 locationRestriction 一起设置。
locationRestriction optional
要搜索的地区。此位置起到限制作用,这意味着系统不会返回指定位置以外的结果。不能与 locationBias 一起设置。
maxResultCount optional
类型number optional
要返回的结果数上限。该值必须介于 1 和 20 之间(含 1 和 20)。
minRating optional
类型number optional
过滤掉平均用户评分严格低于此上限的结果。有效值必须是介于 0 到 5(含)之间的浮点数,频率为 0.5,即 [0, 0.5, 1.0, ... , 5.0](含 [0, 0.5, 1.0, ... , 5.0])。输入评分将向上舍入为最接近的 0.5(上限)。例如,评分 0.6 会排除评分低于 1.0 的所有结果。
priceLevels optional
类型Array<PriceLevel> optional
用于将搜索范围限定为标记为特定价位的地点。可以选择任意价位组合。默认为所有价位。
query optional
类型string optional
rankBy optional
类型SearchByTextRankBy optional
默认值SearchByTextRankBy.DISTANCE
结果在响应中的排名方式。
region optional
类型string optional
发出请求的地点的 Unicode 国家/地区代码 (CLDR)。此参数用于显示地点详情,例如特定于地区的地点名称(如果有)。该参数可能会影响根据适用法律显示的结果。如需了解详情,请参阅 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html。请注意,目前不支持 3 位数的区域代码。
textQuery optional
类型string optional
必需。针对文本搜索的文本查询。
useStrictTypeFiltering optional
类型boolean optional
默认值false
用于为 SearchByTextRequest.includedType 设置严格类型过滤。如果设置为 true,系统将仅返回同一类型的结果。

SearchByTextRankBy 常量

google.maps.places.SearchByTextRankBy 常量

SearchByTextRequest 的 RankBy 枚举。

通过调用 const {SearchByTextRankBy} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库

DISTANCE 按距离对结果排名。
RELEVANCE 按相关性对结果排名。