Places Autocomplete Service

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

AutocompleteService

google.maps.places.AutocompleteService

包含与检索自动补全联想查询相关的方法。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

AutocompleteService
AutocompleteService()
参数:无
创建 AutocompleteService 的新实例。
getPlacePredictions
getPlacePredictions(request[, callback])
参数
根据提供的自动补全请求检索地点自动补全预测结果。
getQueryPredictions
getQueryPredictions(request, callback)
参数
返回值:无
根据提供的查询自动补全请求检索查询自动补全预测结果。

Auto completionRequest 接口

google.maps.places.AutocompletionRequest接口

将向 AutocompleteService.getPlacePredictions 发送一个自动填充请求。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

input
类型string
用户输入的字符串。
bounds optional
预测自定义调整的边界。预测将偏向于(但不限于)给定的 bounds。如果设置了 boundslocationradius 都会被忽略。
componentRestrictions optional
类型ComponentRestrictions optional
组件限制。组件限制用于将预测结果限制为仅父组件内的联想查询。例如,国家/地区。
language optional
类型string optional
返回结果时所用语言的语言标识符(如果可以的话)。所选语言的搜索结果排名可能会更高,但建议并不仅限于该语言。请参阅支持的语言列表
location optional
类型LatLng optional
预测自定义调整的位置。预测将偏向于指定的 locationradius。或者,您也可以使用 bounds
offset optional
类型number optional
输入字词中的字符位置,服务会在此位置上使用文本进行预测(光标在输入字段中的位置)。
origin optional
类型LatLng|LatLngLiteral optional
radius optional
类型number optional
用于预测偏差的区域的半径。radius 以米为单位,必须始终附带 location 属性。或者,您也可以使用 bounds
region optional
类型string optional
用于结果格式和结果过滤的区域代码。并不意味着只能向此国家/地区提供建议。地区代码接受 ccTLD(“顶级域名”)双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同,但也有一些需要注意的例外情况。例如,英国的 ccTLD 为“uk”(.co.uk),而其 ISO 3166-1 代码为“gb”(特指“大不列颠及北爱尔兰联合王国”)。
sessionToken optional
类型AutocompleteSessionToken optional
用于将各个请求捆绑到会话中的唯一引用。
types optional
类型Array<string> optional
要返回的预测类型。如需了解支持的类型,请参阅开发者指南。如果未指定任何类型,则会返回所有类型。

AutocompleteResponse 接口

google.maps.places.AutocompleteResponse接口

调用 AutocompleteService.getPlacePredictions(包含 AutocompletePrediction 列表)返回的自动补全响应。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

predictions

QueryAuto completionRequest 接口

google.maps.places.QueryAutocompletionRequest接口

要发送到 QueryAutocompleteService 的查询自动补全请求。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

input
类型string
用户输入的字符串。
bounds optional
预测自定义调整的边界。预测将偏向于(但不限于)给定的 bounds。如果设置了 boundslocationradius 都会被忽略。
location optional
类型LatLng optional
预测自定义调整的位置。预测将偏向于指定的 locationradius。或者,您也可以使用 bounds
offset optional
类型number optional
输入字词中的字符位置,服务会在此位置上使用文本进行预测(光标在输入字段中的位置)。
radius optional
类型number optional
用于预测偏差的区域的半径。radius 以米为单位,必须始终附带 location 属性。或者,您也可以使用 bounds

AutocompleteSessionToken

google.maps.places.AutocompleteSessionToken

表示用于跟踪自动补全会话的会话令牌,该令牌可以是一系列 AutocompleteService.getPlacePredictions 调用,后跟单个 PlacesService.getDetails 调用。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

AutocompleteSessionToken
AutocompleteSessionToken()
参数:无
创建 AutocompleteSessionToken 的新实例。

ComponentRestrictions 接口

google.maps.places.ComponentRestrictions接口

定义可与自动补全服务搭配使用的组件限制。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

country optional
类型string|Array<string> optional
将预测范围限制为指定的国家/地区(ISO 3166-1 Alpha-2 国家/地区代码,不区分大小写)。例如 'us''br''au'。您可以提供单个国家/地区代码,也可以提供最多包含五个国家/地区代码字符串的数组。

AutocompletePrediction 接口

google.maps.places.AutocompletePrediction接口

表示单个自动补全联想查询。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

description
类型string
这是 Places 服务建议的非格式查询版本。
matched_substrings
地点说明中与用户输入中的元素匹配的一组子字符串,适合突出显示这些子字符串。每个子字符串都由偏移量和长度标识(以 Unicode 字符表示)。
place_id
类型string
地点 ID,可用于使用地点详情服务检索此地点的详细信息(请参阅 PlacesService.getDetails)。
structured_formatting
有关地点说明的结构化信息,分为主要文本和辅助文本,包括自动补全输入中的一组匹配子字符串,由偏移量和长度标识(以 Unicode 字符表示)。
terms
上述说明中各个字词的相关信息,从最具体到最宽泛。例如,“Taco Bell”、“Willitis”和“CA”。
types
类型Array<string>
预测结果所属的类型数组,例如 'establishment''geocode'
distance_meters optional
类型number optional
地点与AutocompletionRequest.origin之间的距离(以米为单位)。

QueryAutocompletePrediction 接口

google.maps.places.QueryAutocompletePrediction接口

表示单个查询自动补全联想查询。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

description
类型string
这是 Places 服务建议的非格式查询版本。
matched_substrings
地点说明中与用户输入中的元素匹配的一组子字符串,适合突出显示这些子字符串。每个子字符串都由偏移量和长度标识(以 Unicode 字符表示)。
terms
上述说明中各个术语的相关信息。先使用类别字词(例如“餐馆”)。系统会按从大到小的顺序显示地址术语。例如,“San Francisco”和“CA”。
place_id optional
类型string optional
仅在预测地点可用时提供。地点 ID,可用于使用地点详情服务检索此地点的详细信息(请参阅 PlacesService.getDetails)。

PredictionTerm 接口

google.maps.places.PredictionTerm接口

表示预测字词。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

offset
类型number
地点说明中此字词开头部分的偏移量(以 Unicode 字符表示)。
value
类型string
此字词的值,例如“塔可钟”。

PredictionSubstring 接口

google.maps.places.PredictionSubstring接口

表示预测子字符串。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

length
类型number
子字符串的长度。
offset
类型number
说明字符串中子字符串开始的偏移量。

StructuredFormat 接口

google.maps.places.StructuredFormatting接口

包含地点说明的结构化信息,分为主要文本和辅助文本,包括自动补全输入中的一组匹配子字符串,由偏移量和长度标识(以 Unicode 字符表示)。

需要提供 &libraries=places 网址参数。请参阅 Maps JavaScript API 中的库

main_text
类型string
这是地点服务所建议的地点的无格式说明的主要文字部分。通常为地点的名称。
main_text_matched_substrings
主文本中与用户输入中的元素匹配的一组子字符串,适合突出显示这些子字符串。每个子字符串都由偏移量和长度标识(以 Unicode 字符表示)。
secondary_text
类型string
这是地点服务所建议地点的无格式说明中的辅助文本部分。通常是地点的位置。