Place

Place

google.maps.places.Place

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

Place
Place(options)
参数
searchByText
searchByText(request)
参数
返回值Promise<{places:Array<Place>}>
基于文本查询的地点搜索。
searchNearby
searchNearby(request)
参数
返回值Promise<{places:Array<Place>}>
搜索附近的地点。
accessibilityOptions
类型AccessibilityOptions optional
此地点的无障碍选项。如果未从服务器调用无障碍选项数据,则为 undefined
addressComponents
类型Array<AddressComponent> optional
该地点营业地点的地址组成部分集合。如果没有已知的地址数据,则为空对象。如果未从服务器调用地址数据,则为 undefined
adrFormatAddress
类型string optional
adr 微格式表示的地方地址。
allowsDogs
类型boolean optional
attributions
类型Array<Attribution> optional
要针对此地点结果显示的提供方说明文本。
businessStatus
类型BusinessStatus optional
营业地点的营业状态。如果尚无已知状态,则返回 null。如果状态数据尚未从服务器加载,则为 undefined
displayName
类型string optional
营业地点的显示名称。如果没有名称,则为 null。如果姓名数据尚未从服务器加载,则为 undefined
editorialSummary
类型string optional
此地点的编辑摘要。如果没有编辑摘要,则返回 null。如果此字段尚未请求,则为 undefined
editorialSummaryLanguageCode
类型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”。
hasLiveMusic
类型boolean optional
hasMenuForChildren
类型boolean optional
hasOutdoorSeating
类型boolean optional
hasRestroom
类型boolean optional
hasTakeout
类型boolean optional
某个地点是否提供外卖服务。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果尚未请求此字段,则返回“undefined”。
hasWiFi
类型boolean optional
iconBackgroundColor
类型string optional
地点类别的默认十六进制颜色码。
id
类型string
唯一地点 ID。
internationalPhoneNumber
类型string optional
地点的电话号码(采用国际电话号码格式)。国际格式包含国家/地区代码,并且带有一个加号 (+) 前缀。
isGoodForChildren
类型boolean optional
isGoodForGroups
类型boolean optional
isGoodForWatchingSports
类型boolean optional
isReservable
类型boolean optional
地点是否可预订。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。如果尚未请求此字段,则返回“undefined”。
location
类型LatLng optional
地点的位置。
nationalPhoneNumber
类型string optional
该地点的电话号码,其格式遵循号码的地区惯例
parkingOptions
类型ParkingOptions optional
该地点提供的停车选项。如果尚未从服务器调用停车选项数据,则为 undefined
paymentOptions
类型PaymentOptions optional
地点提供的付款方式。undefined(如果未从服务器调用付款方式数据)。
photos
类型Array<Photo> optional
此地点的照片。该集合最多包含十个 Photo 对象。
plusCode
类型PlusCode optional
priceLevel
类型PriceLevel optional
地点的价格水平。此属性可以返回以下任意值:
  • Free
  • Inexpensive
  • Moderate
  • Expensive
  • Very Expensive
rating
类型number optional
一个评分(在 1.0 到 5.0 之间),这是根据用户对该地方的评价得出。
regularOpeningHours
类型OpeningHours optional
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”。
servesCocktails
类型boolean optional
servesCoffee
类型boolean optional
servesDessert
类型boolean optional
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
此地方的官方网站,例如商家的首页。
openingHours
类型OpeningHours optional
fetchFields
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”(专指“大不列颠及北爱尔兰联合王国”)。

AccessibilityOptions

google.maps.places.AccessibilityOptions

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

hasWheelchairAccessibleEntrance
类型boolean optional
地点是否有无障碍入口。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasWheelchairAccessibleParking
类型boolean optional
地点是否有无障碍停车位。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasWheelchairAccessibleRestroom
类型boolean optional
地点是否有无障碍卫生间。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasWheelchairAccessibleSeating
类型boolean optional
地点是否提供无障碍座席。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。

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>
要提取的字段的列表。

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]。系统会按照该地点的时区报告这一数据。

ParkingOptions

google.maps.places.ParkingOptions

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

hasFreeGarageParking
类型boolean optional
地点是否提供免费停车库。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasFreeParkingLot
类型boolean optional
某个地点是否提供免费停车场。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasFreeStreetParking
类型boolean optional
地点是否提供免费路边停车位。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasPaidGarageParking
类型boolean optional
某个地点是否提供付费停车库。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasPaidParkingLot
类型boolean optional
某个地点是否提供付费停车场。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasPaidStreetParking
类型boolean optional
某个地点是否提供付费路边停车位。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
hasValetParking
类型boolean optional
某个地点是否提供代客泊车服务。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。

PaymentOptions

google.maps.places.PaymentOptions

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

acceptsCashOnly
类型boolean optional
地点是否仅接受现金付款。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
acceptsCreditCards
类型boolean optional
地点是否接受信用卡付款。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
acceptsDebitCards
类型boolean optional
地点是否接受借记卡付款。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。
acceptsNFC
类型boolean optional
地点是否接受通过 NFC 付款。如果值已知,则返回“true”或“false”。如果值未知,则返回“null”。

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 Code,其 1/8000 度乘以 1/8000 度区域,其中的前四个字符(区号)会被丢弃,并替换为市行政区说明。例如:“9G8F+5W Zurich, Indonesia”。
globalCode
类型string optional
一个 Plus 代码,其面积为 1/8000 度,占面积的 1/8000。例如:“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 常量

Place 对象的价格级枚举。

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

EXPENSIVE
FREE
INEXPENSIVE
MODERATE
VERY_EXPENSIVE

SearchByTextRequest 接口

google.maps.places.SearchByTextRequest 接口

Place.searchByText 的请求接口。

fields
类型Array<string>
要包含在响应中的字段,将为其付费。如果传入 ['*'],系统将返回所有可用字段并计费(不建议用于生产部署)。如需查看字段列表,请参阅 PlaceResult。可以使用点路径来指定嵌套字段(例如 "geometry.location")。
includedType optional
类型string optional
请求的地点类型。支持的类型的完整列表:https://developers.google.com/maps/documentation/places/web-service/place-types。仅支持 1 种包含的类型。请参阅 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 和 5.0)。输入评分将四舍五入为最接近的 0.5(上限)。例如,如果评分为 0.6,则会排除评分低于 1.0 的所有结果。
priceLevels optional
类型Array<PriceLevel> optional
用于将搜索范围限制为标记为特定价位的地点。可以选择价位的任何组合。默认为所有价位。
query optional
类型string optional
BetarankBy optional
类型SearchByTextRankPreference optional
rankPreference optional
类型SearchByTextRankPreference optional
默认值SearchByTextRankPreference.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,则仅返回相同类型的结果。

SearchByTextRankPreference 常量

google.maps.places.SearchByTextRankPreference 常量

SearchByTextRequest 的 RankPreference 枚举。

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

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

SearchNearbyRequest 接口

google.maps.places.SearchNearbyRequest 接口

Place.searchNearby 的请求接口。如需详细了解该请求,请参阅 Places API 参考文档

fields
类型Array<string>
要包含在响应中的字段,将为其付费。如果传入 ['*'],系统将返回所有可用字段并计费(不建议用于生产部署)。如需查看字段列表,请参阅 PlaceResult。可以使用点路径来指定嵌套字段(例如 "geometry.location")。
locationRestriction
要搜索的区域,指定为带有中心和半径的圆形。系统不会返回指定位置以外的结果。
excludedPrimaryTypes optional
类型Array<string> optional
排除的主要地点类型。请参阅支持的类型的完整列表。一个地点只能有一个主要类型。最多可以指定 50 种类型。如果您在 includedexcluded 列表中指定相同的类型,则会返回 INVALID_ARGUMENT 错误。
includedPrimaryTypes optional
类型Array<string> optional
包含的主要地点类型。请参阅支持的类型的完整列表。一个地点只能有一个主要类型。最多可以指定 50 种类型。如果您在 includedexcluded 列表中指定相同的类型,则会返回 INVALID_ARGUMENT 错误。
includedTypes optional
类型Array<string> optional
包含的地点类型。请参阅支持的类型的完整列表。一个地点可以有许多不同的地点类型。最多可以指定 50 种类型。如果您在 includedexcluded 列表中指定相同的类型,则会返回 INVALID_ARGUMENT 错误。
language optional
类型string optional
系统会用首选语言(如果有)显示地点详情。将默认采用浏览器的语言偏好设置。当前支持的语言列表:https://developers.google.com/maps/faq#languagesupport
maxResultCount optional
类型number optional
要返回的结果数上限。该值必须介于 1 和 20 之间(包括 1 和 20)。
rankPreference optional
类型SearchNearbyRankPreference optional
默认值SearchNearbyRankPreference.DISTANCE
结果在响应中如何排序。
region optional
类型string optional
请求来源位置的 Unicode 国家/地区代码 (CLDR)。此参数用于显示地点详情,例如特定于区域的地点名称(如果有)。该参数可能会影响根据适用法律的结果。如需了解详情,请参阅 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html。请注意,目前不支持 3 位数的区域代码。

SearchNearbyRankPreference 常量

google.maps.places.SearchNearbyRankPreference 常量

SearchNearbyRequest 的 RankPreference 枚举。

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

DISTANCE 按距离对结果进行排名。
POPULARITY 按热门程度对结果排名。