Places Service

PlacesService 类

google.maps.places.PlacesService 类

包含与搜索地点和检索地点详情相关的方法。

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

构造函数
PlacesService	PlacesService(attrContainer) 参数：  attrContainer：HTMLDivElement|Map 创建 PlacesService 的新实例，以在指定容器中呈现提供方说明。

方法
findPlaceFromPhoneNumber	findPlaceFromPhoneNumber(request, callback) 参数：  request：FindPlaceFromPhoneNumberRequest callback：function(Array<PlaceResult> optional, PlacesServiceStatus): void 返回值：None 根据电话号码检索地点列表。在大多数情况下，结果列表中应该只有一个项，但如果请求不明确，则可能会返回多个结果。传递给回调的 PlaceResult 是完整 PlaceResult 的子集。您的应用可以通过调用 PlacesService.getDetails 并传递所需地点的 PlaceResult.place_id 来获取每个地点的更详细的 PlaceResult。
findPlaceFromQuery	findPlaceFromQuery(request, callback) 参数： request：FindPlaceFromQueryRequest callback：function(Array<PlaceResult> optional, PlacesServiceStatus): void 返回值：None 根据查询字符串检索地点列表。在大多数情况下，结果列表中应该只有一个项，但如果请求不明确，则可能会返回多个结果。传递给回调的 PlaceResult 是完整 PlaceResult 的子集。您的应用可以通过调用 PlacesService.getDetails 并传递所需地点的 PlaceResult.place_id 来获取每个地点的更详细的 PlaceResult。
getDetails	getDetails(request, callback) 参数：  request：PlaceDetailsRequest callback：function(PlaceResult optional, PlacesServiceStatus): void 返回值：None 检索由给定 placeId 标识的地点的详细信息。
nearbySearch	nearbySearch(request, callback) 参数： request：PlaceSearchRequest callback：function(Array<PlaceResult> optional, PlacesServiceStatus, PlaceSearchPagination optional): void 返回值：None 根据关键字或类型检索特定地点附近的地点列表。必须始终指定位置，可以通过传递 LatLngBounds 或 location 和 radius 参数来指定。传递给回调的 PlaceResult 是完整 PlaceResult 的子集。通过发送地点详情请求并传递所需地点的 PlaceResult.place_id，您的应用可以获取每个地点的更详细的 PlaceResult。PlaceSearchPagination 对象可用于提取更多结果页面（如果这是结果的最后一页或只有一页结果，则为 null）。
textSearch	textSearch(request, callback) 参数：  request：TextSearchRequest callback：function(Array<PlaceResult> optional, PlacesServiceStatus, PlaceSearchPagination optional): void 返回值：None 根据查询字符串（例如，“北京烤鸭”或“南京附近的鞋店”）检索地点列表。位置参数是可选的；指定位置后，结果仅会偏向于附近的结果，而不会仅限于相应区域内的地点。当您想使用任意字符串搜索地点，以及不想将搜索结果限制为特定位置时，请使用 textSearch。PlaceSearchPagination 对象可用于提取更多结果页面（如果这是结果的最后一页或只有一页结果，则为 null）。

PlaceDetailsRequest 接口

google.maps.places.PlaceDetailsRequest 接口

要发送到 PlacesService 的地点详情查询。

属性
placeId	类型：string 请求详情的地方的地点 ID。
fields optional	类型：Array<string> optional 要包含在详细信息响应中的字段（将计入费用）。如果未指定任何字段或传入的是 ['ALL']，系统会返回所有可用字段并据此计费（不建议用于生产环境中的部署）。如需查看字段列表，请参阅 PlaceResult。可以通过点路径指定嵌套字段（例如 "geometry.location"）。
language optional	类型：string optional 应返回详细信息时使用的语言的语言标识符。请参阅支持的语言列表。
region optional	类型：string optional 用户所在地区的地区代码。这可能会影响系统返回哪些照片，还可能会影响其他内容。地区代码接受 ccTLD（“顶级域名”）双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同，但也有一些需要注意的例外情况。例如，英国的国家代码顶级域名为“uk”(.co.uk)，而其 ISO 3166-1 代码却是“gb”（专指“大不列颠及北爱尔兰联合王国”这一实体）。
sessionToken optional	类型：AutocompleteSessionToken optional 用于将详情请求与自动补全会话捆绑在一起的唯一引用。

FindPlaceFromPhoneNumberRequest 接口

google.maps.places.FindPlaceFromPhoneNumberRequest 接口

要发送给 PlacesService.findPlaceFromPhoneNumber 的“通过文本搜索查找地点”请求。

属性
fields	类型：Array<string> 要包含在响应中（将产生费用）的字段。如果传入 ['ALL']，则系统将返回所有可用字段并收取费用（不建议用于生产部署）。如需查看字段列表，请参阅 PlaceResult。嵌套字段可以使用点路径指定（例如 "geometry.location"）。
phoneNumber	类型：string 要查询的地点的电话号码。格式必须为 E.164。
language optional	类型：string optional 返回姓名和地址时所用的语言的语言标识符（如果可能的话）。请参阅支持的语言列表。
locationBias optional	类型：LocationBias optional 搜索地点时使用的偏向。结果将偏向于（但不限于）给定 LocationBias。

FindPlaceFromQueryRequest 接口

google.maps.places.FindPlaceFromQueryRequest 接口

从文本搜索请求发送到 PlacesService.findPlaceFromQuery 的查找地点。

属性
fields	类型：Array<string> 要包含在响应中（将产生费用）的字段。如果传入的是 ['ALL']，系统会返回所有可用字段并据此计费（不建议用于生产环境中的部署）。如需查看字段列表，请参阅 PlaceResult。嵌套字段可以使用点路径指定（例如 "geometry.location"）。
query	类型：string 请求的查询。例如，地点的名称或地址。
language optional	类型：string optional 语言标识符，表示应以哪种语言返回姓名和地址（如有可能）。请参阅支持的语言列表。
locationBias optional	类型：LocationBias optional 搜索地点时使用的偏向。结果将偏向于（但不限于）给定 LocationBias。

PlaceSearchRequest 接口

google.maps.places.PlaceSearchRequest 接口

要发送到 PlacesService 的地点搜索查询。

属性
bounds optional	类型：LatLngBounds|LatLngBoundsLiteral optional 要在其中搜索地点的边界。如果设置了 bounds，则 location 和 radius 都会被忽略。
keyword optional	类型：string optional 要与所有可用字段进行匹配的字词，包括但不限于名称、类型和地址，以及客户评价和其他第三方内容。
language optional	类型：string optional 语言标识符，表示应以哪种语言返回姓名和地址（如有可能）。请参阅支持的语言列表。
location optional	类型：LatLng|LatLngLiteral optional 要在其中搜索“地方”的位置。
maxPriceLevel optional	类型：number optional 将结果限定为仅包含指定价位或更低价位的地点。有效值范围介于 0（最实惠）和 4（最昂贵）之间，包括 0 和 4。必须大于或等于 minPrice （如果指定）。
minPriceLevel optional	类型：number optional 将结果限定为仅包含指定价位或更高价位的地点。有效值范围介于 0（最实惠）和 4（最昂贵）之间，包括 0 和 4。必须小于或等于 maxPrice（如果指定）。
name optional	已废弃：请改用 keyword。 类型：string optional 等同于 keyword。此字段中的值会与 keyword 字段中的值合并，作为同一搜索字符串的一部分进行传递。
openNow optional	类型：boolean optional 将结果限制为仅包含当前营业的地点。
radius optional	类型：number optional 从给定地点搜索地点的范围（以米为单位）。允许的最大值为 50,000。
rankBy optional	类型：RankBy optional 默认值：RankBy.PROMINENCE 指定返回结果时要使用的排名方法。请注意，将 rankBy 设置为 DISTANCE 时，您必须指定 location，但不能指定 radius 或 bounds。
type optional	类型：string optional 搜索指定类型的地点。此类型会翻译为请求目标位置的本地语言，并用作查询字符串。如果还提供了查询，系统会将其附加到本地化类型字符串。系统会从响应中舍弃其他类型的结果。使用此字段可执行不受语言和地区限制的分类搜索。有效类型详见此处。

TextSearchRequest 接口

google.maps.places.TextSearchRequest 接口

要发送给 PlacesService 的文本搜索请求。

属性
bounds optional	类型：LatLngBounds|LatLngBoundsLiteral optional 用于在搜索地点时偏向结果的边界（可选）。如果设置了 bounds，系统会忽略 location 和 radius。结果不会仅限于这些边界内，但这些边界内的结果排名会更高。
language optional	类型：string optional 语言标识符，表示应以哪种语言返回姓名和地址（如有可能）。请参阅支持的语言列表。
location optional	类型：LatLng|LatLngLiteral optional 区域的中心，用于在搜索地点时自定义调整搜索结果的范围。
query optional	类型：string optional 请求的查询字词。例如，地点名称（“埃菲尔铁塔”）、类别后跟地点名称（“纽约的披萨店”），或地点名称后跟地点歧义消除符（“悉尼的星巴克”）。
radius optional	类型：number optional 用于在搜索地点时自定义调整结果的区域的半径，以米为单位。
region optional	类型：string optional 用于偏向于某个区域的区域代码。地区代码接受 ccTLD（“顶级域名”）双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同，但也有一些需要注意的例外情况。例如，英国的国家代码顶级域名为“uk”(.co.uk)，而其 ISO 3166-1 代码却是“gb”（专指“大不列颠及北爱尔兰联合王国”这一实体）。
type optional	类型：string optional 搜索指定类型的地点。此类型会翻译为请求目标位置的本地语言，并用作查询字符串。如果还提供了查询，系统会将其连接到本地化的类型字符串。系统会从响应中移除其他类型的结果。使用此字段可执行不受语言和地区限制的分类搜索。有效类型详见此处。

RankBy 常量

google.maps.places.RankBy 常量

PlaceSearchRequest 的排名选项。

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

常量
DISTANCE	根据与地点的距离对地点结果进行排名。
PROMINENCE	按地点知名度对地点结果进行排名。

LocationBias 类型定义

google.maps.places.LocationBias typedef

LocationBias 表示搜索地点时使用的软边界或提示。结果可能来自指定区域之外。要将当前用户的 IP 地址用作自定义调整，可以指定字符串 "IP_BIAS"。注意：如果使用 Circle，则必须定义中心和半径。

LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral|Circle|CircleLiteral|string

LocationRestriction 类型定义

google.maps.places.LocationRestriction typedef

LocationRestriction 表示搜索地点时要使用的严格边界。

LatLngBounds|LatLngBoundsLiteral

PlacesServiceStatus 常量

google.maps.places.PlacesServiceStatus 常量

PlacesService 在其搜索完成时返回的状态。请通过值或使用常量名称指定这些参数。例如 'OK' 或 google.maps.places.PlacesServiceStatus.OK。

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

常量
INVALID_REQUEST	请求无效。
NOT_FOUND	找不到引用的地点。
OK	该响应包含有效的结果。
OVER_QUERY_LIMIT	应用已超出其请求配额。
REQUEST_DENIED	应用无权使用 PlacesService。
UNKNOWN_ERROR	由于服务器出错，因此无法处理 PlacesService 请求。如果您再试一次，该请求可能会成功。
ZERO_RESULTS	该请求查询不到任何结果。

PlaceSearchPagination 接口

google.maps.places.PlaceSearchPagination 接口

用于提取更多地点结果页面的对象。

属性
hasNextPage	类型：boolean 指示是否还有其他结果。如果存在额外的结果页面，属性值为 true。

方法
nextPage	nextPage() 参数：无 返回值：void 提取下一页结果。使用提供给第一个搜索请求的同一回调函数。

PlaceResult 接口

google.maps.places.PlaceResult 接口

定义地点的相关信息。

属性
address_components optional	类型：Array<GeocoderAddressComponent> optional 该地点位置的地址组成部分的集合。仅适用于 PlacesService.getDetails。
adr_address optional	类型：string optional 以 adr 微格式表示的地方地址。仅适用于PlacesService.getDetails。
aspects optional	类型：Array<PlaceAspectRating> optional 此地点的各个方面获得的评分，基于 Google 和 Zagat 用户评价。评分范围为 0 到 30。
business_status optional	类型：BusinessStatus optional 一个标志，表示地点的营业状态（如果该地点为商家，则表示地点是正常营业、暂停营业还是永久停业）。如果没有可用的数据，则搜索或详情响应中不会出现该标志。
formatted_address optional	类型：string optional “地方”的完整地址。
formatted_phone_number optional	类型：string optional 地点的电话号码，其格式遵循 号码的地区惯例。仅适用于 PlacesService.getDetails。
geometry optional	类型：PlaceGeometry optional 该“地方”的几何图形相关信息。
html_attributions optional	类型：Array<string> optional 要显示的此地点结果的提供方说明文本。无论请求了什么 fields，可用的 html_attributions 始终都会返回，并且必须显示。
icon optional	类型：string optional 指向可用于代表此地点类别的图片资源的网址。
icon_background_color optional	类型：string optional 与地点图标搭配使用的背景颜色。另请参阅 PlaceResult.icon_mask_base_uri。
icon_mask_base_uri optional	类型：string optional 图标掩码的截断网址。通过在末尾附加文件扩展名（即 .svg 或 .png）来访问不同的图标类型。
international_phone_number optional	类型：string optional “地方”的电话号码（采用国际电话号码格式）。国际格式包含国家/地区代码，并以加号符号 (+) 作为前缀。仅适用于 PlacesService.getDetails。
name optional	类型：string optional 地点的名称。注意：对于用户输入的地点，此字段是用户输入的原始文本。使用此类数据时请务必小心，因为恶意用户可能会尝试将其用作代码注入攻击的载体（请参阅 http://en.wikipedia.org/wiki/Code_injection）。
opening_hours optional	类型：PlaceOpeningHours optional 定义地点的开业或打烊时间。
permanently_closed optional	已废弃：permanently_closed 自 2020 年 5 月起已废弃，并将于 2021 年 5 月停用。请改用 PlaceResult.business_status，因为 permanently_closed 不会区分暂停营业和永久停业。 类型：boolean optional 一个标记，用于指明相应地方是永久停业还是暂时停业。如果该地点可运营，或者没有可用的数据，则响应中不会有此标记。
photos optional	类型：Array<PlacePhoto> optional 此地点的照片。该集合最多包含 10 个 PlacePhoto 对象。
place_id optional	类型：string optional 地点的唯一标识符。
plus_code optional	类型：PlacePlusCode optional 为地点定义开放式地理编码或“Plus Code”。
price_level optional	类型：number optional 地点的价位，从 0 到 4 级。价位解释如下： 0：免费 1：价格低廉 2：中等 3：昂贵 4：非常昂贵
rating optional	类型：number optional 1.0 到 5.0 之间的评分，以用户对此地方的评价为基础。
reviews optional	类型：Array<PlaceReview> optional 此地点的评价列表。仅适用于 PlacesService.getDetails。
types optional	类型：Array<string> optional 此地点的类型（例如 ["political", "locality"] 或 ["restaurant", "establishment"]）的数组。
url optional	类型：string optional 此地点的官方 Google 页面的网址。这是由 Google 拥有的页面，其中包含有关该“地方”的最佳可用信息。仅适用于 PlacesService.getDetails。
user_ratings_total optional	类型：number optional 促成该地方的PlaceResult.rating的用户评分数量。
utc_offset optional	已弃用：自 2019 年 11 月起，utc_offset 已被弃用。请改用 PlaceResult.utc_offset_minutes。请参阅 https://goo.gle/js-open-now 类型：number optional 地点当前时区与世界协调时间 (UTC) 之间的偏移量（以分钟为单位）。例如，澳大利亚悉尼在夏令时期间比世界协调时间 (UTC) 早 11 小时，因此 utc_offset 将为 660。对于比世界协调时间 (UTC) 晚的时区，偏移量为负值。例如，对于佛得角，utc_offset 为 -60。仅适用于PlacesService.getDetails。
utc_offset_minutes optional	类型：number optional 地点当前时区相对于世界协调时间 (UTC) 的偏移量（以分钟为单位）。例如，澳大利亚悉尼在夏令时期间比世界协调时间 (UTC) 早 11 小时，因此 utc_offset_minutes 将为 660。对于晚于世界协调时间 (UTC) 的时区，时差为负数。例如，对于佛得角，utc_offset_minutes 为 -60。仅适用于PlacesService.getDetails。
vicinity optional	类型：string optional 地方的简化地址，包括街道名称、门牌号和市行政区，但不包括省/州、邮政编码或国家/地区。例如，Google 澳大利亚悉尼办事处的“vicinity”值为 "48 Pirrama Road, Pyrmont"。仅适用于 PlacesService.getDetails。
website optional	类型：string optional 此地点的官方网站，例如商家主页。仅适用于 PlacesService.getDetails。

PlaceAspectRating 接口

google.maps.places.PlaceAspectRating 接口

已废弃：此接口已不再使用。

定义用户已评价的地点的某个方面的信息。

属性
rating	类型：number 此方面获得的评分。对于单个评价，此值是一个介于 0 到 3 之间的整数。对于地点的综合评分，此值为介于 0 到 30 之间的整数。
type	类型：string 相应方面类型。例如 "food"、"decor"、"service" 或 "overall"。

BusinessStatus 常量

google.maps.places.BusinessStatus 常量

在 PlaceResult 中返回的地点的营业状态（如果是商家，用于指明该地点是正常营业还是暂时停业还是永久停业）。您可以按值或常量名称（例如 'OPERATIONAL' 或 google.maps.places.BusinessStatus.OPERATIONAL）指定这些值。

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

常量
CLOSED_PERMANENTLY	该商家已永久停业。
CLOSED_TEMPORARILY	商家已暂停营业。
OPERATIONAL	商家正在正常运营。

PlaceGeometry 界面

google.maps.places.PlaceGeometry 接口

定义地点几何图形的相关信息。

属性
location optional	类型：LatLng optional 地点的位置。
viewport optional	类型：LatLngBounds optional 在地图上显示此“地方”时使用的首选视口。如果地点的首选视口未知，此属性将为 null。仅适用于 PlacesService.getDetails。

PlaceOpeningHours 接口

google.maps.places.PlaceOpeningHours 接口

定义地点的营业时间相关信息。

属性
open_now optional	已弃用：自 2019 年 11 月起，open_now 已被弃用。请改用 PlacesService.getDetails 结果中的 PlaceOpeningHours.isOpen 方法。请访问 https://goo.gle/js-open-now 类型：boolean optional 地点当前是否营业。
periods optional	类型：Array<PlaceOpeningHoursPeriod> optional 一周中每一天的开始时段，从星期日开始，按时间顺序排列。该地方未营业的天数不包含在内。仅适用于 PlacesService.getDetails。
weekday_text optional	类型：Array<string> optional 包含七个字符串的数组，用于以特定格式表示一周内每天的营业时间。地点服务会根据当前语言设置营业时间格式，并进行本地化。此数组中的元素排序取决于语言。有些语言的一周从星期一开始，有些语言则从星期日开始。仅适用于 PlacesService.getDetails。其他调用可能会返回空数组。

方法
isOpen	isOpen([date]) 参数：  date：Date optional 返回值：boolean|undefined 检查相应地点目前（未过任何日期）或指定日期是否营业。如果此地点没有 PlaceResult.utc_offset_minutes 或 PlaceOpeningHours.periods，则返回 undefined（PlaceOpeningHours.periods 只能通过 PlacesService.getDetails 提供）。此方法不会考虑特殊营业时间，例如节假日营业时间。

PlaceOpeningHoursPeriod 接口

google.maps.places.PlaceOpeningHoursPeriod 接口

定义有关地点营业时间的结构化信息。注意：如果某个地点全天营业，响应中将缺少 close 部分。客户可以通过以下方式表示全天营业：将 open 中的 day 设置为 0，将 time 设置为 "0000"，并且不包含 close。

属性
open	类型：PlaceOpeningHoursTime 地点的营业时间。
close optional	类型：PlaceOpeningHoursTime optional 地点的打烊时间。

PlaceOpeningHoursTime 接口

google.maps.places.PlaceOpeningHoursTime 接口

定义地点的开业或打烊时间。

属性
day	类型：number 星期几，表示为介于 [0, 6] 之间的数字，从星期日开始。例如，2 表示星期二。
hours	类型：number 以数字表示的PlaceOpeningHoursTime.time的小时数，范围为 [0, 23]。系统将按地方的时区报告此数据。
minutes	类型：number PlaceOpeningHoursTime.time 的分钟数，是一个介于 [0, 59] 范围内的数字。系统将按地点的时区报告此值。
time	类型：string 一天中的某个时间，采用 24 小时制“hhmm”格式。值的范围为 ["0000", "2359"]。系统将按地点的时区报告时间。
nextDate optional	类型：number optional 表示此 PlaceOpeningHoursTime 的下一次出现的时间戳（以自纪元以来的毫秒数表示，适用于 new Date()）。它是根据一周中的 PlaceOpeningHoursTime.day、PlaceOpeningHoursTime.time 和 PlaceResult.utc_offset_minutes 计算得出的。如果 PlaceResult.utc_offset_minutes 为 undefined，则 nextDate 将为 undefined。

PlacePlusCode 接口

google.maps.places.PlacePlusCode 接口

为地点定义开放式地理编码或“Plus Code”。Plus Code 可用于在没有街道地址的地点（例如建筑物未编号，或者街道未命名）取代街道地址。

属性
global_code	类型：string 一个 Plus 代码，其面积为 1/8,000 度 x 1/8,000 度。例如 "8FVC9G8F+5W"。
compound_code optional	类型：string optional 一个 plus 代码，表示 1/8000 度乘 1/8000 度的区域，其中前四位字符（区域代码）会被舍弃，并替换为地理位置描述。例如 "9G8F+5W Zurich, Switzerland"。如果没有找到合适的市行政区来缩短代码，则忽略此字段。

PlacePhoto 接口

google.maps.places.PlacePhoto 接口

表示地点的照片元素。

属性
height	类型：number 照片的高度（以像素为单位）。
html_attributions	类型：Array<string> 要显示的此照片的提供方说明文本。
width	类型：number 照片的宽度（以像素为单位）。

方法
getUrl	getUrl([opts]) 参数：  opts：PhotoOptions optional 返回值：string 返回与指定选项对应的图片网址。

PhotoOptions 接口

google.maps.places.PhotoOptions 接口

定义照片请求选项。

属性
maxHeight optional	类型：number optional 所返回图片的最大高度（以像素为单位）。
maxWidth optional	类型：number optional 返回的图片的最大宽度（以像素为单位）。

PlaceReview 接口

google.maps.places.PlaceReview 接口

表示对地点的单条评价。

属性
author_name	类型：string 评价者的姓名。
language	类型：string 表示此评论撰写语言的 IETF 语言代码。请注意，此代码仅包含主要语言标记，不包含任何表示国家或地区的辅助标记。例如，所有英语评价都标记为 'en'，而不是“en-AU”或“en-UK”。
profile_photo_url	类型：string 指向评价者个人资料图片的网址。
relative_time_description	类型：string 格式化后的近期时间字符串，以适合相应语言和国家/地区的形式表示相对于当前时间的评价时间。例如 "a month ago"。
text	类型：string 评价文本。
time	类型：number 评价的时间戳，以秒为单位，自公元纪年开始算起。
aspects optional	已弃用：此字段不再可用。 类型：Array<PlaceAspectRating> optional 评价所评分的各个方面。评分范围为 0 到 3。
author_url optional	类型：string optional 指向评价者个人资料的网址。如果评价者的个人资料不可用，此值将为 undefined。
rating optional	类型：number optional 此评价的评分，介于 1.0 和 5.0（含）之间的数字。