Places Autocomplete Service

AutocompleteService 类

google.maps.places.AutocompleteService 类

包含与检索自动补全预测结果相关的方法。

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

构造函数
AutocompleteService	AutocompleteService() 参数：无 创建 AutocompleteService 的新实例。

方法
getPlacePredictions	getPlacePredictions(request[, callback]) 参数： request：AutocompletionRequest 自动补全请求。 callback：function(Array<AutocompletePrediction> optional, PlacesServiceStatus): void optional 接受一个 AutocompletePrediction 对象数组和一个 PlacesServiceStatus 值作为参数的回调。 返回值：Promise<AutocompleteResponse> 根据提供的自动补全请求检索地点自动补全预测结果。
getQueryPredictions	getQueryPredictions(request, callback) 参数： request：QueryAutocompletionRequest 查询自动填充请求。 callback：function(Array<QueryAutocompletePrediction> optional, PlacesServiceStatus): void 此类回调接受 QueryAutocompletePrediction 对象数组和一个 PlacesServiceStatus 值作为参数。 返回值：None 根据提供的查询自动补全请求，检索查询自动补全预测结果。

AutocompletionRequest 接口

google.maps.places.AutocompletionRequest 接口

要向 AutocompleteService.getPlacePredictions 发送的“自动补全”请求。

属性
input	类型：string 用户输入的输入字符串。
bounds optional	已废弃：bounds 自 2023 年 5 月起已废弃。请改用 AutocompletionRequest.locationBias 和 AutocompletionRequest.locationRestriction。 类型：LatLngBounds|LatLngBoundsLiteral optional 预测自定义调整的边界。预测结果将偏向于（但不限于）给定的 bounds。如果设置了 bounds，则 location 和 radius 都会被忽略。
componentRestrictions optional	类型：ComponentRestrictions optional 组件限制。组件限制用于将预测结果限制在父组件内。例如，国家/地区。
language optional	类型：string optional 返回结果时应使用的语言的语言标识符（如果可能）。系统可能会将所选语言的结果排名更高，但建议并非仅限于此语言。请参阅支持的语言列表。
location optional	已废弃：location 自 2023 年 5 月起已废弃。请改用 AutocompletionRequest.locationBias 和 AutocompletionRequest.locationRestriction。 类型：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 的位置。
radius optional	已废弃：radius 自 2023 年 5 月起已废弃。请改用 AutocompletionRequest.locationBias 和 AutocompletionRequest.locationRestriction。 类型：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 接口

对包含 AutocompletePrediction 列表的 AutocompleteService.getPlacePredictions 的调用所返回的 Autocomplete 响应。

属性
predictions	类型：Array<AutocompletePrediction> AutocompletePrediction 的列表。

QueryAutocompletionRequest 接口

google.maps.places.QueryAutocompletionRequest 接口

要发送到 QueryAutocompleteService 的“查询自动填充”请求。

属性
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。

AutocompleteSessionToken 类

google.maps.places.AutocompleteSessionToken 类

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

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

构造函数
AutocompleteSessionToken	AutocompleteSessionToken() 参数：无 创建 AutocompleteSessionToken 的新实例。

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	类型：StructuredFormatting 关于地点说明的结构化信息，分为主要文本和辅助文本（包含来自自动补全输入的一组匹配子字符串，通过偏移量和长度标识，以 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> 上述说明中各个术语的相关信息。分类字词排在最前面（例如“餐馆”）。地址字词按照具体程度由高到低的顺序显示。例如，“San Francisco”和“CA”。
place_id optional	类型：string optional 仅当预测为地点时才可用。地点 ID，可用于通过地点详情服务检索有关此地点的详细信息（请参阅 PlacesService.getDetails）。

PredictionTerm 接口

google.maps.places.PredictionTerm 接口

表示预测字词。

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

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 这是地点服务所建议地点的说明中不包含格式的辅助文本部分。通常是地点的位置。