Places Autocomplete Service

AutocompleteService 類別

google.maps.places.AutocompleteService 類別

包含與擷取 Autocomplete 預測結果相關的方法。

呼叫 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> 根據提供的自動完成要求擷取 Place Autocomplete 預測結果。
getQueryPredictions	getQueryPredictions(request, callback) 參數：  request：QueryAutocompletionRequest查詢自動完成要求。 callback：function(Array<QueryAutocompletePrediction> optional, PlacesServiceStatus): void 回呼接受 QueryAutocompletePrediction 物件陣列和 PlacesServiceStatus 值做為引數。 傳回值：無 根據提供的查詢自動完成要求擷取查詢自動完成預測。

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 傳回結果的語言 ID (如果可以的話)。所選語言的搜尋結果也許能獲得較高排名，但建議並不限於這個語言。請參閱支援語言清單。
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 介面

呼叫 AutocompleteService.getPlacePredictions 後傳回的 Autocomplete 回應，內含 AutocompletePrediction 清單。

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

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，可用來透過 Place Details 服務擷取這個地點的詳細資料 (請參閱 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> 上方說明中個別字詞的相關資訊。類別字詞最先顯示 (例如「餐廳」)。地址字詞由高到低顯示。例如「舊金山」和「CA」。
place_id optional	類型：  string optional 只有在含有地點的預測查詢字串時才能使用。地點 ID，可用來透過 Place Details 服務擷取這個地點的詳細資料 (請參閱 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 這是地點介面集服務建議地點的次要文字部分，未設定格式。通常是地點的位置。