Places Autocomplete Service

AutocompleteService 類別

google.maps.places.AutocompleteService class

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

請呼叫 const {AutocompleteService} = await google.maps.importLibrary("places") 存取。請參閱「Maps JavaScript API 中的程式庫」。
AutocompleteService
AutocompleteService()
參數：無
建立 AutocompleteService 的新例項。
getPlacePredictions
getPlacePredictions(request[, callback])
參數： 
傳回值：  Promise<AutocompleteResponse>
根據提供的自動完成要求，擷取地點自動完成預測結果。
getQueryPredictions
getQueryPredictions(request, callback)
參數： 
傳回值：無
根據提供的查詢自動完成要求，擷取查詢自動完成預測結果。

AutocompletionRequest 介面

google.maps.places.AutocompletionRequest 介面

要傳送至 AutocompleteService.getPlacePredictions 的自動完成要求。
input
類型：  string
使用者輸入了輸入字串。
bounds optional
類型：  LatLngBounds|LatLngBoundsLiteral optional
預測偏差的邊界。預測結果會優先 (但不限於) 顯示指定的 bounds。如果設定 bounds，系統會忽略 location 和 radius。
componentRestrictions optional
類型：  ComponentRestrictions optional
元件限制。元件限制可用於限制預測結果，只限於父項元件內的預測結果。例如國家/地區。
language optional
類型：  string optional
語言 ID，用於指定應傳回結果的語言 (如有可能)。系統可能會優先顯示所選語言的結果，但建議內容不限於該語言。請參閱支援語言清單。
location optional
類型：  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
類型：  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 時傳回的自動完成回應，其中包含 AutocompletePrediction 清單。
predictions
AutocompletePrediction 清單。

QueryAutocompletionRequest 介面

google.maps.places.QueryAutocompletionRequest 介面

要傳送至 QueryAutocompleteService 的 QueryAutocompletion 要求。
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 class

代表用於追蹤自動完成工作階段的工作階段符記，這可能包含一系列 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
這是 Places 服務建議的查詢未格式化版本。
matched_substrings
在地點說明中，一組與使用者輸入內容相符的子字串，適合用於強調這些子字串。每個子字串都會以偏移量和長度標示，以萬國碼字元表示。
place_id
類型：  string
可用於透過地點詳細資料服務擷取此地點詳細資料的地點 ID (請參閱 PlacesService.getDetails)。
structured_formatting
關於地點說明的結構化資訊，分為主要文字和次要文字，包括自動完成輸入內容的陣列相符子字串，以偏移量和長度識別，以萬國碼字元表示。
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
這是 Places 服務建議的查詢未格式化版本。
matched_substrings
在地點說明中，一組與使用者輸入內容相符的子字串，適合用於強調這些子字串。每個子字串都會以偏移量和長度標示，以萬國碼字元表示。
terms
類型：  Array<PredictionTerm>
上述說明中個別條款的相關資訊。先輸入類別字詞 (例如「餐廳」)，地址條件會依明確程度排序，例如「San Francisco」和「CA」。
place_id optional
類型：  string optional
只有在預測結果為地點時才能使用。可用於透過地點詳細資料服務擷取此地點詳細資料的地點 ID (請參閱 PlacesService.getDetails)。

PredictionTerm 介面

google.maps.places.PredictionTerm 介面

代表預測字詞。
offset
類型：  number
在地點說明中，這個字詞開頭的偏移量 (以萬國碼字元為單位)。
value
類型：  string
這個字詞的值，例如「Taco Bell」。

PredictionSubstring 介面

google.maps.places.PredictionSubstring 介面

代表預測子字串。
length
類型：  number
子字串的長度。
offset
類型：  number
在說明字串中，子字串起始位置的偏移量。

StructuredFormatting 介面

google.maps.places.StructuredFormatting 介面

包含關於地點說明的結構化資訊，分為主要文字和次要文字，包括自動完成輸入內容的配對子字串陣列，以偏移量和長度識別，以萬國碼字元表示。
main_text
類型：  string
這是 Places 服務建議地點的未格式化說明的主要文字部分。通常是地點的名稱。
main_text_matched_substrings
在主要文字中，一組與使用者輸入內容相符的元素，適合用於強調這些子字串。每個子字串都會以偏移量和長度標示，以萬國碼字元表示。
secondary_text
類型：  string
這是 Places 服務建議地點的未格式化說明內容的次要文字部分。通常是地點的位置。