AutocompleteService 类
class
google.maps.places.AutocompleteService
library "places"
包含与检索自动补全联想查询相关的方法。
const {AutocompleteService} = await google.maps.importLibrary("places");
构造函数 | |
|---|---|
AutocompleteService |
AutocompleteService()参数：无
创建 AutocompleteService 的新实例。 |
方法 | |
|---|---|
getPlacePredictions |
getPlacePredictions(request[, callback])参数：
根据提供的自动补全请求检索地点自动补全联想查询。 |
getQueryPredictions |
getQueryPredictions(request, callback)参数：
返回值：无
根据提供的查询自动补全请求检索查询自动补全联想查询。 |
AutocompletionRequest 接口
接口
google.maps.places.AutocompletionRequest
要发送到 AutocompleteService.getPlacePredictions 的自动补全请求。
属性 | |
|---|---|
input |
类型：
string用户输入的字符串。 |
可选 |
类型：
LatLngBounds|LatLngBoundsLiteral optional预测偏差的边界。预测结果会偏向于（但不限于）给定的 bounds。如果设置了 bounds，系统会忽略 location 和 radius。 |
componentRestrictions
可选 |
类型：
ComponentRestrictions optional组件限制。组件限制用于将预测结果限制在父组件内。例如，国家/地区。 |
language
可选 |
类型：
string optional语言标识符，用于指定返回结果时应使用的语言（如果可能）。所选语言的结果可能会获得更高的排名，但建议并不局限于此语言。请参阅支持的语言列表。 |
可选 |
类型：
LatLng optional用于预测偏差的位置。预测结果将偏向于给定的 location 和 radius。或者，也可以使用 bounds。 |
locationBias
可选 |
类型：
LocationBias optional在搜索地点时使用的软边界或提示。 |
locationRestriction
可选 |
类型：
LocationRestriction optional用于限制搜索结果的边界。 |
offset
可选 |
类型：
number optional输入字词中服务使用文本进行预测的字符位置（输入字段中光标的位置）。 |
origin
可选 |
类型：
LatLng|LatLngLiteral optional |
可选 |
类型：
number optional用于预测偏差的区域半径。 radius 以米为单位指定，并且必须始终附带 location 属性。或者，也可以使用 bounds。 |
region
可选 |
类型：
string optional用于结果格式设置和结果过滤的地区代码。它不会将建议限制为此国家/地区。地区代码接受 ccTLD（“顶级域名”）双字符值。多数 ccTLD 代码都与 ISO 3166-1 代码相同，但也有一些需要注意的例外情况。例如，英国的 ccTLD 为“uk”( .co.uk)，而其 ISO 3166-1 代码为“gb”（代表“大不列颠及北爱尔兰联合王国”）。 |
sessionToken
可选 |
类型：
AutocompleteSessionToken optional用于将各个请求捆绑到会话中的唯一标识。 |
types
可选 |
类型：
Array<string> optional要返回的联想查询类型。如需了解支持的类型，请参阅 开发者指南。如果未指定任何类型，系统将返回所有类型。 |
AutocompleteResponse 接口
接口
google.maps.places.AutocompleteResponse
调用 AutocompleteService.getPlacePredictions 返回的自动补全响应，其中包含 AutocompletePrediction 列表。
属性 | |
|---|---|
predictions |
|
QueryAutocompletionRequest 接口
接口
google.maps.places.QueryAutocompletionRequest
要发送到 QueryAutocompleteService 的 QueryAutocompletion 请求。
属性 | |
|---|---|
input |
类型：
string用户输入的字符串。 |
bounds
可选 |
类型：
LatLngBounds|LatLngBoundsLiteral optional预测偏差的边界。预测结果会偏向于（但不限于）给定的 bounds。如果设置了 bounds，系统会忽略 location 和 radius。 |
location
可选 |
类型：
LatLng optional用于预测偏差的位置。预测结果将偏向于给定的 location 和 radius。或者，也可以使用 bounds。 |
offset
可选 |
类型：
number optional输入字词中服务使用文本进行预测的字符位置（输入字段中光标的位置）。 |
radius
可选 |
类型：
number optional用于预测偏差的区域半径。 radius 以米为单位指定，并且必须始终附带 location 属性。或者，也可以使用 bounds。 |
ComponentRestrictions 接口
接口
google.maps.places.ComponentRestrictions
定义可与自动补全服务搭配使用的组件限制。
属性 | |
|---|---|
country
可选 |
类型：
string|Array<string> optional将联想查询限制在指定国家/地区（ISO 3166-1 Alpha-2 国家/地区代码，不区分大小写）。例如 'us'、'br' 或 'au'。您可以提供一个国家/地区代码字符串，也可以提供最多包含五个国家/地区代码字符串的数组。 |
AutocompletePrediction 接口
接口
google.maps.places.AutocompletePrediction
表示单个自动补全联想查询。
属性 | |
|---|---|
description |
类型：
string这是地点服务建议的查询的未格式化版本。 |
matched_substrings |
地点说明中与用户输入中的元素相匹配的一组子字符串，适合用于突出显示这些子字符串。每个子字符串都由偏移量和长度标识，以 Unicode 字符表示。 |
place_id |
类型：
string一个地点 ID，可用于通过地点详情服务检索有关此地点的详细信息（请参阅 PlacesService.getDetails）。 |
structured_formatting |
有关地点说明的结构化信息，分为主要文本和次要文本，包括自动补全输入中的匹配子字符串数组，由偏移量和长度标识，以 Unicode 字符表示。 |
terms |
类型：
Array<PredictionTerm>上述说明中各个术语的相关信息，按具体程度从高到低排列。例如，“Taco Bell”“Willitis”和“CA”。 |
types |
类型：
Array<string>联想查询所属类型的数组，例如 'establishment' 或 'geocode'。 |
distance_meters
可选 |
类型：
number optional地点与 AutocompletionRequest.origin 之间的距离（以米为单位）。 |
QueryAutocompletePrediction 接口
接口
google.maps.places.QueryAutocompletePrediction
表示单个查询自动补全联想查询。
属性 | |
|---|---|
description |
类型：
string这是地点服务建议的查询的未格式化版本。 |
matched_substrings |
地点说明中与用户输入中的元素相匹配的一组子字符串，适合用于突出显示这些子字符串。每个子字符串都由偏移量和长度标识，以 Unicode 字符表示。 |
terms |
类型：
Array<PredictionTerm>上述说明中各个术语的相关信息。类别字词排在最前面（例如“餐厅”）。地址字词按具体程度从高到低的顺序显示。例如，“San Francisco”和“CA”。 |
place_id
可选 |
类型：
string optional仅在联想查询是地点时可用。一个地点 ID，可用于通过地点详情服务检索有关此地点的详细信息（请参阅 PlacesService.getDetails）。 |
PredictionTerm 接口
接口
google.maps.places.PredictionTerm
表示预测字词。
属性 | |
|---|---|
offset |
类型：
number此字词在地点说明中的起始位置的偏移量（以 Unicode 字符为单位）。 |
value |
类型：
string此字词的值，例如“Taco Bell”。 |
PredictionSubstring 接口
接口
google.maps.places.PredictionSubstring
表示联想查询子字符串。
属性 | |
|---|---|
length |
类型：
number子字符串的长度。 |
offset |
类型：
number说明字符串中子字符串开头的偏移量。 |
StructuredFormatting 接口
接口
google.maps.places.StructuredFormatting
包含有关地点说明的结构化信息，分为主要文本和次要文本，包括自动补全输入中匹配的子字符串数组，由偏移量和长度标识，以 Unicode 字符表示。
属性 | |
|---|---|
main_text |
类型：
string这是地点服务建议的地点的未格式化说明的主要文本部分。通常是地点的名称。 |
main_text_matched_substrings |
主要文本中与用户输入中的元素相匹配的一组子字符串，适合用于突出显示这些子字符串。每个子字符串都由偏移量和长度标识，以 Unicode 字符表示。 |
secondary_text |
类型：
string这是地点服务建议的地点的未格式化说明的次要文本部分。通常是地点的地理位置。 |