AutocompleteService 類別
google.maps.places.AutocompleteService
類別
包含擷取自動完成預測功能的相關方法。
呼叫 const {AutocompleteService} = await google.maps.importLibrary("places")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
建構函式 | |
---|---|
AutocompleteService |
AutocompleteService() 參數:無
建立新的 AutocompleteService 執行個體。 |
方法 | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) 參數:
傳回價值:
Promise<AutocompleteResponse> 根據提供的自動完成要求擷取 Place Autocomplete 預測結果。 |
getQueryPredictions |
getQueryPredictions(request, callback) 參數:
傳回值:無
根據提供的查詢自動完成要求,擷取查詢自動完成預測結果。 |
AutoAutocompleteRequest 介面
google.maps.places.AutocompletionRequest
介面
傳送至 AutocompleteService.getPlacePredictions
的自動完成要求。
屬性 | |
---|---|
input |
類型:
string 使用者輸入字串。 |
|
類型:
LatLngBounds|LatLngBoundsLiteral optional 預測自訂調整的邊界。預測結果將針對特定 bounds 進行調整 (但不限於)。如果設定了 bounds ,系統會忽略 location 和 radius 。 |
componentRestrictions optional |
類型:
ComponentRestrictions optional 元件限制。元件限制僅用於將預測結果限制在父項元件中。例如國家/地區。 |
language optional |
類型:
string optional 要傳回結果的語言語言 ID (如果可能的話)。所選語言的結果可能會獲得較高的排名,但建議可能不受此語言限制。請參閱支援語言清單。 |
|
類型:
LatLng optional 預測自訂調整位置。預測結果會針對指定的 location 和 radius 進行調整。或者,您也可以使用 bounds 。 |
locationBias optional |
類型:
LocationBias optional 搜尋地點時使用的柔軟界線。 |
locationRestriction optional |
類型:
LocationRestriction optional 要限制搜尋結果的邊界。 |
offset optional |
類型:
number optional 輸入字詞中的字元位置,也就是服務使用預測文字 (遊標在輸入欄位中的位置) 的字元位置。 |
origin optional |
類型:
LatLng|LatLngLiteral 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
清單。
屬性 | |
---|---|
predictions |
QueryAutocompleteRequest 介面
google.maps.places.QueryAutocompletionRequest
介面
傳送至 QueryAutocompleteService
的 QueryAutocomplete 要求。
屬性 | |
---|---|
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,可用於使用 Place Details 服務擷取這個地點的詳細資料 (請參閱 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,可用於使用 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 子字串內說明字串內的開始偏移值。 |
結構化格式介面
google.maps.places.StructuredFormatting
介面
包含地點說明的結構化資訊,分類為主要文字和次要文字,包括透過 Autocomplete 輸入識別的相符子字串陣列,以偏移時間和長度 (以萬國碼 (Unicode) 字元表示) 。
屬性 | |
---|---|
main_text |
類型:
string 這是地點介面集建議地點未格式化說明的主要文字部分。通常是地點名稱。 |
main_text_matched_substrings |
類型:
Array<PredictionSubstring> 主要文字內的一組子字串,這些內容與使用者輸入內容相符,適合用來突顯這些子字串。每個子字串都會以 Unicode 字元表示,並使用長度和長度來識別。 |
secondary_text |
類型:
string 這是地點介面集建議地點未格式化說明的次要文字部分。通常都是地點。 |