Place 类
google.maps.places.Place
类
通过调用 const {Place} = await google.maps.importLibrary("places")
进行访问。请参阅 Maps JavaScript API 中的库。
构造函数 | |
---|---|
Place |
Place(options) 参数:
|
静态方法 | |
---|---|
searchByText |
searchByText(request) 参数:
基于文本查询的地点搜索。 |
searchNearby |
searchNearby(request) 参数:
搜索附近的地点。 |
属性 | |
---|---|
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 |
此地点的照片。该集合最多包含 10 个 Photo 对象。 |
plusCode |
类型:
PlusCode optional |
priceLevel |
类型:
PriceLevel optional 地点的价格水平。此属性可以返回以下任一值
|
rating |
类型:
number optional 评分,介于 1.0 到 5.0 之间,基于用户对此地点的评价。 |
regularOpeningHours |
类型:
OpeningHours optional |
requestedLanguage |
类型:
string optional 为此地点请求的语言。 |
requestedRegion |
类型:
string optional 为此地点请求的地区。 |
reviews |
此地点的评价列表。 |
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 |
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 optional |
方法 | |
---|---|
fetchFields |
fetchFields(options) 参数:
|
getNextOpeningTime |
getNextOpeningTime([date]) 参数:
计算表示下一个 OpeningHoursTime 的日期。如果数据不足以计算结果,或者此地点未投入运营,则返回“未定义”。 |
isOpen |
isOpen([date]) 参数:
返回值:
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 |
类型:
Array<OpeningHoursPeriod> 涵盖一周各天的营业时段,从星期日开始,按时间顺序排列。不包括地点未营业的日期。 |
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] 之间的数字,星期日为 0。例如,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 |
类型:
Array<AuthorAttribution> 要为此照片显示的提供方信息文本。 |
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, Switzerland”。 |
globalCode |
类型:
string optional 面积为 1/8,000 度 x 1/8,000 度的 Plus 代码。例如“8FVC9G8F+5W”。 |
评价类
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 之间(包括这两个数值)。 |
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
接口
Place.searchByText
的请求接口。
属性 | |
---|---|
fields |
类型:
Array<string> 要包含在响应中的字段(系统会按这些字段进行结算)。如果传入的是 ['*'] ,系统会返回所有可用字段并据此计费(不建议用于生产环境中的部署)。如需查看字段列表,请参阅 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 |
类型:
LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral|CircleLiteral|Circle optional 要搜索的区域。此位置用作偏差,这意味着系统可能会返回给定位置周围的结果。不能与 locationRestriction 一起设置。 |
locationRestriction optional |
类型:
LatLngBounds|LatLngBoundsLiteral optional 要搜索的区域。此位置用作限制条件,这意味着系统不会返回给定位置以外的结果。不能与 locationBias 一起设置。 |
maxResultCount optional |
类型:
number optional 返回的结果数上限。必须介于 1 到 20 之间(包括这两个数值)。 |
minRating optional |
类型:
number optional 滤除平均用户评分低于此限制的结果。有效值必须为介于 0 到 5(包括这两个数值)之间的浮点数,节奏为 0.5,即 [0, 0.5, 1.0, ... , 5.0](包括这两个数值)。输入评分将向上舍入到最接近的 0.5(上限)。例如,如果评分为 0.6,则系统会排除评分低于 1.0 的所有结果。 |
priceLevels optional |
类型:
Array<PriceLevel> optional 用于将搜索范围限制为标记为特定价格水平的地点。您可以选择任意价格级别组合。默认为所有价格级别。 |
|
类型:
string 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 |
类型:
Circle|CircleLiteral 要搜索的区域,指定为具有中心和半径的圆形。系统不会返回给定地理位置之外的结果。 |
excludedPrimaryTypes optional |
类型:
Array<string> optional 排除的主要地点类型。请参阅支持的类型的完整列表。一个地点只能有一个主要类型。最多可以指定 50 种类型。如果您在 included 和 excluded 列表中都指定了相同的类型,系统会返回 INVALID_ARGUMENT 错误。 |
includedPrimaryTypes optional |
类型:
Array<string> optional 包含的主要地点类型。请参阅支持的类型的完整列表。一个地点只能有一个主要类型。最多可以指定 50 种类型。如果您在 included 和 excluded 列表中都指定了相同的类型,系统会返回 INVALID_ARGUMENT 错误。 |
includedTypes optional |
类型:
Array<string> optional 包含的地点类型。请参阅支持的类型的完整列表。一个地点可以有许多不同的地点类型。最多可以指定 50 种类型。如果您在 included 和 excluded 列表中都指定了相同的类型,系统会返回 INVALID_ARGUMENT 错误。 |
language optional |
类型:
string optional 地点详情将以首选语言(如果有)显示。将默认采用浏览器的语言偏好设置。受支持语言的最新列表:https://developers.google.com/maps/faq#languagesupport。 |
maxResultCount optional |
类型:
number optional 返回的结果数上限。必须介于 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 |
按热门程度对结果进行排名。 |