Places Autocomplete Service

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

AutocompleteService 類別

google.maps.places.AutocompleteService 類別

包含與擷取自動完成預測相關的方法。

使用 &libraries=places 網址參數載入。請參閱 Maps JavaScript API 中的程式庫

使用 v=beta 時,可透過呼叫 const {AutocompleteService} = await google.map.importLibrary("places") 來存取請參閱 Maps JavaScript API 中的程式庫

AutocompleteService
AutocompleteService()
參數:
建立新的 AutocompleteService 執行個體。
getPlacePredictions
getPlacePredictions(request[, callback])
參數:
根據所提供的自動完成要求,擷取地點自動完成預測。
getQueryPredictions
getQueryPredictions(request, callback)
參數:
傳回值:
根據所提供的查詢自動完成要求擷取查詢自動完成預測。

AutoAutocompleteRequest 介面介面。

google.maps.places.AutocompletionRequest 介面

要傳送給 AutocompleteService.getPlacePredictions 的自動完成要求。

使用 &libraries=places 網址參數載入。請參閱 Maps JavaScript API 中的程式庫

input
類型:string
使用者輸入的輸入字串。
bounds optional
預測偏誤的邊界。預測值會偏向指定的 bounds。如果設定了 bounds,則系統會忽略 locationradius
componentRestrictions optional
類型:ComponentRestrictions optional
元件限制。元件限制可用於將預測限制在父項元件內部預測。例如國家/地區。
language optional
類型:string optional
如果可以的話,請提供傳回結果的語言所使用的語言識別碼。對於所選語言的結果,系統可能會給予較高的排名,但這類建議不僅限於該語言。請參閱支援語言清單
location optional
類型:LatLng optional
預測偏誤位置。預測值將偏向指定的 locationradius。您也可以使用 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

QueryAutocompleteRequest 介面

google.maps.places.QueryAutocompletionRequest 介面

要傳送至 QueryAutocompleteService 的 QueryAutoAutocomplete 要求。

使用 &libraries=places 網址參數載入。請參閱 Maps JavaScript API 中的程式庫

input
類型:string
使用者輸入的輸入字串。
bounds optional
預測偏誤的邊界。預測值會偏向指定的 bounds。如果設定了 bounds,則系統會忽略 locationradius
location optional
類型:LatLng optional
預測偏誤位置。預測值將偏向指定的 locationradius。您也可以使用 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 中的程式庫

使用 v=beta 時,可透過呼叫 const {AutocompleteSessionToken} = await google.map.importLibrary("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'。您可以提供一個或一組最多 5 個國家/地區代碼字串。

AutocompletePrediction 介面

google.maps.places.AutocompletePrediction 介面

代表單一自動預測。

使用 &libraries=places 網址參數載入。請參閱 Maps JavaScript API 中的程式庫

description
類型:string
這是「地點」服務建議的查詢 (未格式化的版本)。
matched_substrings
地點說明中的一組子字串,與使用者輸入內容中的元素相符,適合用來突顯這些子字串。每個子字串都有一個偏移值和長度值 (以萬國碼 (Unicode) 字元表示)。
place_id
類型:string
可使用地點詳細資料服務擷取地點詳細資料的地點 ID (請參閱 PlacesService.getDetails)。
structured_formatting
地點說明的結構化資訊,分為主要文字和次要文字,包含自動完成輸入中比對子字串的一系列子字串 (以偏移和長度表示),並以萬國碼 (Unicode) 字元表示。
terms
上述說明中的個別字詞相關資訊 (從最具體到最明確)。例如,「塔可餅」、「小威」和「加拿大」。
types
類型:Array<string>
預測所屬的類型陣列,例如 'establishment''geocode'
distance_meters optional
類型:number optional
AutocompletionRequest.origin之間的地點距離 (單位為公尺)。

QueryAutocompletePrediction 介面

google.maps.places.QueryAutocompletePrediction 介面

代表單一「查詢自動完成」的預測。

使用 &libraries=places 網址參數載入。請參閱 Maps JavaScript API 中的程式庫

description
類型:string
這是「地點」服務建議的查詢 (未格式化的版本)。
matched_substrings
地點說明中的一組子字串,與使用者輸入內容中的元素相符,適合用來突顯這些子字串。每個子字串都有一個偏移值和長度值 (以萬國碼 (Unicode) 字元表示)。
terms
上述說明中個別字詞的相關資訊。開頭是類別字詞 (例如「餐廳」)。以最明確到最明確的方式顯示地址字詞。例如:「臺北」和「加拿大」。
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
在說明字串中,子字串開頭的偏移量。

StructuredFormat 介面

google.maps.places.StructuredFormatting 介面

包含地點說明的結構化資訊,分為主要文字和次要文字,包含自動完成輸入中符合條件的子字串陣列 (以偏移和長度表示),並以萬國碼 (Unicode) 字元表示。

使用 &libraries=places 網址參數載入。請參閱 Maps JavaScript API 中的程式庫

main_text
類型:string
這是「地點」服務所建議地點的未格式化說明主要文字部分。通常是地點的名稱。
main_text_matched_substrings
主要文字中的一組子字串與使用者輸入內容中的元素相符,適合用來突顯這些子字串。每個子字串都有一個偏移值和長度值 (以萬國碼 (Unicode) 字元表示)。
secondary_text
類型:string
這是「地點」服務所建議地點的無格式說明的次要文字部分。通常是地點的位置。