Places Autocomplete Service

AutocompleteService 类

google.maps.places.AutocompleteService 类

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

需要 &libraries=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 值作为参数的回调。 返回值：无 根据提供的查询自动补全请求检索查询自动补全预测结果。

AutocompletionRequest 接口

google.maps.places.AutocompletionRequest接口

要发送到 AutocompleteService.getPlacePredictions 的自动补全请求。

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

属性
input	类型：string 用户输入的输入字符串。
bounds optional	类型：LatLngBounds|LatLngBoundsLiteral optional 用于预测偏差的边界。预测结果将偏向于但不限于给定的 bounds。如果设置了 bounds，location 和 radius 都会被忽略。
componentRestrictions optional	类型：ComponentRestrictions optional 组件限制。组件限制用于将预测结果限制为仅父级组件中的预测结果。例如，国家/地区。
language optional	类型：string optional 返回结果所用语言的语言标识符（如果可能）。系统会以所选语言对搜索结果进行排名，但并不仅限于此语言的建议。请参阅支持的语言列表。
location optional	类型：LatLng optional 用于预测偏差的位置。预测结果将偏向于指定的 location 和 radius。或者，您也可以使用 bounds。
offset optional	类型：number optional 输入字词中的字符位置，服务会在此位置上使用文本（光标在输入字段中的位置）。
origin optional	类型：LatLng|LatLngLiteral optional AutocompletePrediction.distance_meters 的计算位置。
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 时返回的 Autocomplete 响应包含一系列 AutocompletePrediction。

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

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

QueryAutocompletionRequest 接口

google.maps.places.QueryAutocompletionRequest接口

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

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

属性
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 调用）。

需要 &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 这是 Google 商家信息服务建议的未格式化查询版本。
matched_substrings	类型：Array<PredictionSubstring> 地点说明中的一组子字符串，与用户输入中的元素相匹配，适合突出显示这些子字符串。每个子字符串都通过偏移量和长度标识（以 Unicode 字符表示）。
place_id	类型：string 可用于使用地点详情服务检索该地点详情的地点 ID（请参阅 PlacesService.getDetails）。
structured_formatting	类型：StructuredFormatting 有关地点说明的结构化信息，分为主要文本和辅助文本，包括来自自动填充输入的匹配子字符串数组（由 Unicode 字符表示，具有偏移量和长度）。
terms	类型：Array<PredictionTerm> 上述说明中各个字词的信息（从最具体到最宽泛）。例如，“塔可钟”、“威利斯”和“加拿大”。
types	类型：Array<string> 预测结果所属的类型数组，例如 'establishment' 或 'geocode'。
distance_meters optional	类型：number optional 地点与 AutocompletionRequest.origin 之间的距离（以米为单位）。

QueryAutocompletePrediction 接口

google.maps.places.QueryAutocompletePrediction接口

表示单个查询自动补全预测结果。

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

属性
description	类型：string 这是 Google 商家信息服务建议的未格式化查询版本。
matched_substrings	类型：Array<PredictionSubstring> 地点说明中的一组子字符串，与用户输入中的元素相匹配，适合突出显示这些子字符串。每个子字符串都通过偏移量和长度标识（以 Unicode 字符表示）。
terms	类型：Array<PredictionTerm> 上述说明中有关各个字词的信息。分类字词排在最前面（例如“餐馆”）。系统会按从最具体到最具体的顺序来显示地址。例如，“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 说明字符串中子字符串开始的偏移量。

结构化格式

google.maps.places.StructuredFormatting接口

包含关于地点说明的结构化信息，这些数据分为主要文本和辅助文本，包括来自自动填充输入的匹配子字符串数组（由 Unicode 字符表示的偏移量和长度）。

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

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