Geocoder 類別
google.maps.Geocoder
類別
用於在地址和 LatLng
之間進行轉換的服務。
呼叫 const {Geocoder} = await google.maps.importLibrary("geocoding")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
建構函式 | |
---|---|
Geocoder |
Geocoder() 參數:無
建立 Geocoder 的新執行個體,將地理編碼要求傳送至 Google 伺服器。 |
方法 | |
---|---|
geocode |
geocode(request[, callback]) 參數:
傳回值:
Promise<GeocoderResponse> 進行要求的地理編碼。 |
GeocoderRequest 介面
google.maps.GeocoderRequest
介面
傳送至 Geocoder
的地理編碼要求規範。
屬性 | |
---|---|
address optional |
類型:
string optional 要進行地理編碼的地址。必須提供一項,且只能擇一提供 address 、location 和 placeId 其中之一。 |
bounds optional |
類型:
LatLngBounds|LatLngBoundsLiteral optional 要搜尋時使用的 LatLngBounds 。選用。 |
componentRestrictions optional |
類型:
GeocoderComponentRestrictions optional 元件可用來將結果限制在特定區域。篩選器包含一或多個: route 、locality 、administrativeArea 、postalCode 、country 。系統只會傳回符合所有篩選器的結果。篩選器值與其他地理編碼要求一樣,支援相同的拼字校正及部分比對方法。選用。 |
extraComputations optional |
類型:
Array<ExtraGeocodeComputation> optional 可用來完成要求的額外運算清單。注意:這些額外運算可能會在回應中傳回額外欄位。 |
fulfillOnZeroResults optional |
類型:
boolean optional 在回應中實現 ZERO_RESULT 狀態的承諾。因為即使沒有地理編碼結果,仍可能會傳回額外的回應層級欄位,因此可能需要進行這項動作。 |
language optional |
類型:
string optional 結果傳回該語言的語言 ID (可能的話)。請參閱支援語言清單。 |
location optional |
類型:
LatLng|LatLngLiteral optional 要搜尋的 LatLng (或 LatLngLiteral )。地理編碼器會執行反向地理編碼。詳情請參閱 反向地理編碼。必須提供一項,且只能擇一提供 address 、location 和 placeId 其中之一。 |
placeId optional |
類型:
string optional |
region optional |
類型:
string optional 用於自訂調整搜尋的國家/地區代碼,以雙字元 (非數字) Unicode 區域子標記/CLDR 識別碼指定。選用設定。如要瞭解支援的區域,請參閱 Google 地圖平台涵蓋範圍詳細資料。 |
GeocoderComponentRestrictions 介面
google.maps.GeocoderComponentRestrictions
介面
GeocoderComponentRestrictions
代表一組會解析為特定區域的篩選器。若要進一步瞭解相關運作方式,請參閱「 地理編碼元件篩選」一文。
屬性 | |
---|---|
administrativeArea optional |
類型:
string optional 符合所有 administrative_area levels 。選用。 |
country optional |
類型:
string optional 比對國家/地區名稱或雙字母 ISO 3166-1 國家/地區代碼。選用。 |
locality optional |
類型:
string optional 比對 locality 和 sublocality 類型。選用。 |
postalCode optional |
類型:
string optional 符合 postal_code 和 postal_code_prefix 。選用。 |
route optional |
類型:
string optional 比對 route 的長或簡稱。選用。 |
ExtraGeocodeComputation 常數
google.maps.ExtraGeocodeComputation
常數
完成地理編碼要求時要執行的額外運算作業。
呼叫 const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
常數 | |
---|---|
ADDRESS_DESCRIPTORS |
產生地址描述元。 |
GeocoderStatus 常數
google.maps.GeocoderStatus
常數
呼叫 geocode()
完成後,由 Geocoder
傳回的狀態。您可以採用值或常數名稱來指定這些參數。例如 'OK'
或 google.maps.GeocoderStatus.OK
。
呼叫 const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
常數 | |
---|---|
ERROR |
與 Google 伺服器連線時發生問題。 |
INVALID_REQUEST |
這個GeocoderRequest 無效。 |
OK |
回應包含有效的 GeocoderResponse 。 |
OVER_QUERY_LIMIT |
網頁已在過短的時間內超過要求限制。 |
REQUEST_DENIED |
不允許這個網頁使用 Geocoder。 |
UNKNOWN_ERROR |
伺服器發生錯誤,因此無法處理地理編碼要求。如果您再試一次,可能會成功進行要求。 |
ZERO_RESULTS |
找不到這個GeocoderRequest 的結果。 |
GeocoderResponse 介面
google.maps.GeocoderResponse
介面
由 Geocoder
傳回的地理編碼器回應,內含 GeocoderResult
清單。
屬性 | |
---|---|
results |
類型:
Array<GeocoderResult> GeocoderResult 清單。 |
address_descriptor optional |
類型:
AddressDescriptor optional 地點的相關性說明。包括一組已排名的鄰近地標,以及包含指定地區的區域。只有在 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 啟用時,才會針對反向地理編碼要求填入這個值。 |
plus_code optional |
類型:
PlacePlusCode optional 與位置相關的 Plus Code。 |
GeocoderResult 介面
google.maps.GeocoderResult
介面
擷取自地理編碼伺服器的單一 Geocoder 結果。地理編碼要求可能會傳回多個結果物件。請注意,雖然這個結果很類似 JSON,但因其間接包含 LatLng
物件,所以不算是 JSON。
屬性 | |
---|---|
address_components |
GeocoderAddressComponent 的陣列 |
formatted_address |
類型:
string 包含這個位置人類可讀地址的字串。 |
geometry |
類型:
GeocoderGeometry GeocoderGeometry 物件 |
place_id |
類型:
string 與地點相關聯的地點 ID。地點 ID 可以用來辨識 Google 地點介面集資料庫和 Google 地圖中的特定地點。請參閱 Places API 開發人員指南,進一步瞭解地點 ID。 |
types |
類型:
Array<string> 註明傳回地理編碼元素類型的字串陣列。如要查看可能的字串清單,請參閱開發人員指南的「 地址元件類型」一節。 |
address_descriptor optional |
類型:
AddressDescriptor optional 與此地理編碼相關聯的地點相關關聯說明。包括一組已排名的鄰近地標,以及包含指定地區的區域。只有在 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 已啟用,且僅適用於某些本地化地點時,才會填入正向地理編碼和地點 ID 查詢要求。 |
partial_match optional |
類型:
boolean optional 指出地理編碼器是否沒有傳回與原始要求完全相符的結果,但可以比對部分要求的地址。如果完全相符,則值會是 undefined 。 |
plus_code optional |
類型:
PlacePlusCode optional 與位置相關的 Plus Code。 |
postcode_localities optional |
類型:
Array<string> optional 字串陣列,表示郵遞區號內含的所有縣市。系統只會在所傳回結果是包含多個位置的郵遞區號時,才會顯示這個陣列。 |
AddressDescriptor 介面
google.maps.AddressDescriptor
介面
地點的相關性說明。包括一組已排名的鄰近地標,以及包含指定地區的區域。
屬性 | |
---|---|
areas |
包含區域或鄰近區域的排名清單。最實用 (易於辨識且精確) 的區域會優先排名。 |
landmarks |
附近地標的排名清單。最實用 (可識別附近) 的地標會優先排序。 |
GeocoderAddressComponent 介面
google.maps.GeocoderAddressComponent
介面
GeocoderResult
中的單一地址元件。完整的地址可能包含多個地址元件。
屬性 | |
---|---|
long_name |
類型:
string 地址元件的全文 |
short_name |
類型:
string 指定地址元件的縮寫文字 |
types |
類型:
Array<string> 表示地址元件類型的字串陣列。如需瞭解有效類型清單,請參閱這篇文章 |
GeocoderGeometry 介面
google.maps.GeocoderGeometry
介面
這個「GeocoderResult
」的幾何圖形資訊
屬性 | |
---|---|
location |
類型:
LatLng 這個結果的緯度/經度座標 |
location_type |
location 中傳回的位置類型 |
viewport |
類型:
LatLngBounds 顯示這個 GeocoderResult 的建議可視區域邊界 |
bounds optional |
類型:
LatLngBounds optional 這個 GeocoderResult 的精確邊界 (如適用) |
GeocoderLocationType 常數
google.maps.GeocoderLocationType
常數
說明地理編碼傳回的位置類型。您可以採用值或常數名稱來指定這些參數。例如 'ROOFTOP'
或 google.maps.GeocoderLocationType.ROOFTOP
呼叫 const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
常數 | |
---|---|
APPROXIMATE |
傳回的結果是約略的。 |
GEOMETRIC_CENTER |
傳回的結果為一條線 (例如街道) 或多邊形 (區域) 結果的地理中心點。 |
RANGE_INTERPOLATED |
傳回的結果反映插入在兩個精確點之間 (例如十字路口) 的約略位置 (通常在道路上)。如果 Geocoder 無法取得街道地址的精確定點地理編碼,就會傳回插入的結果。 |
ROOFTOP |
傳回的結果反映精確的地理編碼。 |
Landmark 介面
google.maps.Landmark
介面
代表地址參考點的位置。
屬性 | |
---|---|
display_name |
類型:
string 地標的名稱。 |
display_name_language_code |
類型:
string 地標名稱的語言。 |
place_id |
類型:
string 代表地標的基礎建築物的地點 ID。可用於透過 Place Details 或 Place Id Lookup 解析地標相關資訊。 |
spatial_relationship |
定義目標位置和地標之間的空間關係。 |
straight_line_distance_meters |
類型:
number 目標位置與地標之間的直線距離。 |
types |
類型:
Array<string> 一或多個值,指出傳回結果的類型。詳情請參閱「類型 」一文。 |
travel_distance_meters optional |
類型:
number optional 路網上目標位置和地標之間的移動距離。如果地標與目標最接近的路網部分中斷,「或」如果目標位置並未實際在路網上,則不會再填入這個欄位。 |
Area 介面
google.maps.Area
介面
某個小型區域的地點,例如包含目標地區的社區、鄉鎮或大型建築群。
屬性 | |
---|---|
containment |
類型:
Containment 定義目標位置和區域之間的空間關係。 |
display_name |
類型:
string 區域的名稱。 |
display_name_language_code |
類型:
string 區域名稱的語言。 |
place_id |
類型:
string 基礎區域的地點 ID。可用於透過 Place Details 或 Place ID Lookup 解析區域詳細資訊。 |
遏制常數
google.maps.Containment
常數
列舉代表區域與目標位置之間的空間關係。
呼叫 const {Containment} = await google.maps.importLibrary("geocoding")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
常數 | |
---|---|
NEAR |
指定位置不在該區域內,但距離太遠。 |
OUTSKIRTS |
目標位置位於區域內且靠近邊緣。 |
WITHIN |
目標位置位於該區域內,靠近中心點。 |
SpatialRelationship常數
google.maps.SpatialRelationship
常數
列舉代表地標與目標之間空間之間的關係。
呼叫 const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
即可存取。請參閱 Maps JavaScript API 中的程式庫。
常數 | |
---|---|
ACROSS_THE_ROAD |
目標與道路另一側的地標相反。 |
AROUND_THE_CORNER |
與地標不是同一條路線,只可轉彎一次。 |
BEHIND |
靠近地標建築,但離地遠一點。 |
BESIDE |
目標就在地標附近。 |
DOWN_THE_ROAD |
與地標在同一條路線上,但不在旁邊或另一側。 |
NEAR |
當下方沒有更具體的情況時,這就是預設的關係。 |
WITHIN |
地標包含空間幾何圖形,且目標落在邊界內。 |