AutocompleteService 类
google.maps.places.AutocompleteService 类
包含与检索自动补全预测结果相关的方法。
通过调用 const {AutocompleteService} = await google.maps.importLibrary("places") 进行访问。请参阅 Maps JavaScript API 中的库。
构造函数 | |
|---|---|
AutocompleteService |
AutocompleteService()参数：无
创建 AutocompleteService 的新实例。 |
方法 | |
|---|---|
getPlacePredictions |
getPlacePredictions(request[, callback])参数：
返回值：
Promise<AutocompleteResponse>根据提供的自动补全请求检索地点自动补全预测结果。 |
getQueryPredictions |
getQueryPredictions(request, callback)参数：
返回值：None
根据提供的查询自动补全请求检索查询自动补全联想查询。 |
AutocompletionRequest 接口
google.maps.places.AutocompletionRequest 接口
要发送给 AutocompleteService.getPlacePredictions 的自动补全请求。
属性 | |
|---|---|
input |
类型：
string用户输入了输入字符串。 |
|
类型：
LatLngBounds|LatLngBoundsLiteral optional预测偏差的边界。预测结果会偏向于给定的 bounds，但不限于此。如果设置了 bounds，系统会忽略 location 和 radius。 |
componentRestrictions optional |
类型：
ComponentRestrictions optional组件限制。组件限制用于将预测限制为仅在父级组件内进行。例如，国家/地区。 |
language optional |
类型：
string optional应返回结果的语言（如果可能）的语言标识符。系统可能会将以所选语言显示的结果排名更高，但建议并不局限于此语言。请参阅支持的语言列表。 |
|
类型：
LatLng optional用于预测偏差的位置。预测结果会偏向给定的 location 和 radius。或者，您也可以使用 bounds。 |
locationBias optional |
类型：
LocationBias optional搜索地点时使用的软边界或提示。 |
locationRestriction optional |
类型：
LocationRestriction optional用于限制搜索结果的边界。 |
offset optional |
类型：
number optional输入字词中服务使用文本进行预测的字符位置（输入字段中游标的位置）。 |
origin optional |
类型：
LatLng|LatLngLiteral optional计算 AutocompletePrediction.distance_meters 时所用的地点。 |
|
类型：
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 列表。
属性 | |
|---|---|
predictions |
|
QueryAutocompletionRequest 接口
google.maps.places.QueryAutocompletionRequest 接口
要发送给 QueryAutocompleteService 的 QueryAutocompletion 请求。
属性 | |
|---|---|
input |
类型：
string用户输入了输入字符串。 |
bounds optional |
类型：
LatLngBounds|LatLngBoundsLiteral optional预测偏差的边界。预测结果会偏向于给定的 bounds，但不限于此。如果设置了 bounds，系统会忽略 location 和 radius。 |
location optional |
类型：
LatLng optional用于预测偏差的位置。预测结果会偏向给定的 location 和 radius。或者，您也可以使用 bounds。 |
offset optional |
类型：
number optional输入字词中服务使用文本进行预测的字符位置（输入字段中游标的位置）。 |
radius optional |
类型：
number optional用于预测偏差的区域的半径。 radius 以米为单位指定，并且必须始终与 location 属性搭配使用。或者，您也可以使用 bounds。 |
ComponentRestrictions 接口
google.maps.places.ComponentRestrictions 接口
定义可与自动补全服务搭配使用的组件限制。
属性 | |
|---|---|
country optional |
类型：
string|Array<string> optional将预测结果限制在指定国家/地区（ISO 3166-1 Alpha-2 国家/地区代码，不区分大小写）。例如 'us'、'br' 或 'au'。您可以提供单个国家/地区代码，也可以提供最多五个国家/地区代码字符串的数组。 |
AutocompletePrediction 接口
google.maps.places.AutocompletePrediction 接口
表示单个自动补全预测结果。
属性 | |
|---|---|
description |
类型：
string这是地点服务建议的查询的原始格式。 |
matched_substrings |
类型：
Array<PredictionSubstring>地点说明中与用户输入中的元素匹配的一组子字符串，适合用于突出显示这些子字符串。每个子字符串都由偏移量和长度标识，以 Unicode 字符表示。 |
place_id |
类型：
string地点 ID，可用于使用地点详情服务（请参阅 PlacesService.getDetails）检索此地点的详细信息。 |
structured_formatting |
与地点说明相关的结构化信息，分为主要文本和次要文本，包括自动补全输入中匹配的子字符串数组，由偏移量和长度标识（以 Unicode 字符表示）。 |
terms |
类型：
Array<PredictionTerm>上述说明中各个字词的相关信息，从最具体到最不具体。例如“Taco Bell”“Willitis”和“CA”。 |
types |
类型：
Array<string>预测所属的类型数组，例如 'establishment' 或 'geocode'。 |
distance_meters optional |
类型：
number optional地点与 AutocompletionRequest.origin 之间的距离（以米为单位）。 |
QueryAutocompletePrediction 接口
google.maps.places.QueryAutocompletePrediction 接口
表示单个查询自动补全联想查询。
属性 | |
|---|---|
description |
类型：
string这是地点服务建议的查询的原始格式。 |
matched_substrings |
类型：
Array<PredictionSubstring>地点说明中与用户输入中的元素匹配的一组子字符串，适合用于突出显示这些子字符串。每个子字符串都由偏移量和长度标识，以 Unicode 字符表示。 |
terms |
类型：
Array<PredictionTerm>有关上述说明中各个字词的信息。类别术语放在前面（例如“餐厅”）。地址字词的显示顺序为从最具体到最不具体。例如，“旧金山”和“加利福尼亚州”。 |
place_id optional |
类型：
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 |
类型：
Array<PredictionSubstring>主要文本中与用户输入中的元素匹配的一组子字符串，适合用于突出显示这些子字符串。每个子字符串都由偏移量和长度标识，以 Unicode 字符表示。 |
secondary_text |
类型：
string这是地点服务建议的地点的未格式化说明的次要文本部分。通常是地点的位置。 |