Geocoder

Geocoder 類別

class google.maps.Geocoder
library "geocoding"

這項服務可轉換地址和 LatLng。

const {Geocoder} = await google.maps.importLibrary("geocoding");
Geocoder
Geocoder()
參數:無
建立新的 Geocoder 例項,將地理編碼要求傳送至 Google 伺服器。
geocode
geocode(request[, callback])
參數:
進行要求的地理編碼。

GeocoderRequest 介面

介面 google.maps.GeocoderRequest

傳送至 Geocoder 的地理編碼要求規格。

address
選填
類型: string optional
要進行地理編碼的地址。address、location 和 placeId 只能擇一提供。
bounds
選填
要搜尋的LatLngBounds。選用項目。
componentRestrictions
選填
元件可用於將結果限制在特定區域。篩選器包含一或多個:route、locality、administrativeArea、postalCode、country。系統只會傳回符合所有篩選器的結果。篩選器值與其他地理編碼要求一樣,支援相同的拼字校正及部分比對方法。選用項目。
BetaextraComputations
選填
類型: Array<ExtraGeocodeComputation> optional
可能用於完成要求的額外運算清單。注意:這些額外計算可能會在回應中傳回額外欄位。
fulfillOnZeroResults
選填
類型: boolean optional
在回應中履行 ZERO_RESULT 狀態的承諾。即使地理編碼結果為零,系統仍可能傳回其他回應層級欄位,因此您可能需要這項功能。
language
選填
類型: string optional
語言 ID,用於指定傳回結果時應盡可能使用的語言。請參閱支援語言清單。
location
選填
類型: LatLng|LatLngLiteral optional
要搜尋的 LatLng (或 LatLngLiteral)。地理編碼器會執行反向地理編碼。詳情請參閱「 反向地理編碼」一文。address、location 和 placeId 只能擇一提供。
placeId
選填
類型: string optional
與地點相關聯的地點 ID。地點 ID 可以用來辨識 Google 地點介面集資料庫和 Google 地圖中的特定地點。如要進一步瞭解地點 ID,請參閱 Places API 開發人員指南。地理編碼器會執行反向地理編碼。詳情請參閱「反向地理編碼」一文。address、location 和 placeId 只能擇一提供。
region
選填
類型: string optional
用於偏誤搜尋的國家/地區代碼,指定為雙字元 (非數字) Unicode 區域子標記/CLDR ID。(選用步驟) 如需支援區域的相關資訊,請參閱 Google 地圖平台涵蓋範圍詳細資料。

GeocoderComponentRestrictions 介面

介面 google.maps.GeocoderComponentRestrictions

GeocoderComponentRestrictions 代表一組篩選器,可解析為特定區域。如要進一步瞭解運作方式,請參閱「 地理編碼元件篩選」。

administrativeArea
選填
類型: string optional
比對所有 administrative_area levels。選用項目。
country
選填
類型: string optional
用於比對國家/地區名稱或雙字母 ISO 3166-1 國家/地區代碼。選用項目。
locality
選填
類型: string optional
比對 locality 和 sublocality 類型。選用項目。
postalCode
選填
類型: string optional
符合 postal_code 和 postal_code_prefix。選用項目。
route
選填
類型: string optional
比對route的全名或簡稱。選用項目。

ExtraGeocodeComputation 常數

constants google.maps.ExtraGeocodeComputation
library "geocoding"

完成地理編碼要求時,要執行的額外運算。

這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 ExtraGeocodeComputationString 類型定義。

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");
ADDRESS_DESCRIPTORS 產生地址描述元。

GeocoderStatus 常數

constants google.maps.GeocoderStatus
library "geocoding"

呼叫 geocode() 完成後,Geocoder 傳回的狀態。請依值或使用常數名稱指定這些值。例如 'OK' 或 google.maps.GeocoderStatus.OK。

這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 GeocoderStatusString 類型定義。

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");
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
GeocoderResult 清單。
Betaaddress_descriptor
選填
類型: AddressDescriptor optional
位置的相對描述。包含一組經過排序的附近地標,以及包含目標地區的區域。只有在啟用 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 時,系統才會針對反向地理編碼要求填入這個欄位。
plus_code
選填
類型: PlacePlusCode optional
與地點相關聯的 Plus Code。

GeocoderResult 介面

介面 google.maps.GeocoderResult

擷取自地理編碼伺服器的單一 Geocoder 結果。地理編碼要求可能會傳回多個結果物件。請注意,雖然這個結果「類似 JSON」,但並非嚴格意義上的 JSON,因為它間接包含 LatLng 物件。

address_components
GeocoderAddressComponent 陣列
formatted_address
類型: string
字串,包含這個地點的人類可讀地址。
geometry
GeocoderGeometry 物件
place_id
類型: string
與地點相關聯的地點 ID。地點 ID 可以用來辨識 Google 地點介面集資料庫和 Google 地圖中的特定地點。如要進一步瞭解地點 ID,請參閱 Places API 開發人員指南。
types
類型: Array<string>
註明傳回地理編碼元素類型的字串陣列。如需可能字串的清單,請參閱開發人員指南的「 地址元件類型」一節。
Betaaddress_descriptor
選填
類型: AddressDescriptor optional
與這個地理編碼相關聯的位置關係說明。包含一組經過排序的附近地標,以及包含目標地區的區域。只有在啟用 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS 時,系統才會針對正向地理編碼和地點 ID 查詢要求,填入特定本地化地點的這項資訊。
partial_match
選填
類型: boolean optional
地理編碼器是否未傳回與原始要求完全比對的結果,但可以比對部分要求的地址。如果完全比對,值會是 undefined。
plus_code
選填
類型: PlacePlusCode optional
與地點相關聯的 Plus Code。
postcode_localities
選填
類型: Array<string> optional
字串陣列,表示郵遞區號內含的所有縣市。系統只會在所傳回結果是包含多個位置的郵遞區號時,才會顯示這個陣列。

AddressDescriptor 介面

介面 google.maps.AddressDescriptor

位置的相對描述。包含附近地標和指定地區所在區域的排名組合。

areas
類型: Array<Area>
包含或相鄰區域的排名清單。最實用 (可辨識且精確) 的區域會排在最前面。
landmarks
類型: Array<Landmark>
附近地標的排名清單。最實用 (可辨識且位於附近) 的地標會排在最前面。

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
選填
類型: LatLngBounds optional
這個GeocoderResult的精確界限 (如適用)

GeocoderLocationType 常數

constants google.maps.GeocoderLocationType
library "geocoding"

說明地理編碼傳回的位置類型。請依值或使用常數名稱指定這些值。例如 'ROOFTOP' 或 google.maps.GeocoderLocationType.ROOFTOP

這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 GeocoderLocationTypeString 類型定義。

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");
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 或地點 ID 查詢,解析地標的更多資訊。
spatial_relationship
定義目標位置與地標之間的空間關係。
straight_line_distance_meters
類型: number
目標位置與地標之間的直線距離。
types
類型: Array<string>
一或多個值,指出傳回結果的類型。詳情請參閱「類型 」一節。
travel_distance_meters
選填
類型: number optional
目標位置與地標之間沿著道路網路的移動距離。如果地標與目標最接近的路網部分中斷連線,或目標位置實際上不屬於路網,則這個欄位可能不會填入資料。

Area 介面

介面 google.maps.Area

小型區域,例如鄰里、次級行政區,或包含指定地區的大型建築群。

containment
類型: Containment
定義指定地區與區域之間的空間關係。
display_name
類型: string
區域的名稱。
display_name_language_code
類型: string
區域名稱的語言。
place_id
類型: string
基礎區域的地點 ID。可透過 Place Details 或地點 ID Lookup 解析區域的更多資訊。

Containment 常數

constants google.maps.Containment
library "geocoding"

列舉,代表區域與目標地區之間的空間關係。

這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 ContainmentString 類型定義。

const {Containment} = await google.maps.importLibrary("geocoding");
NEAR 指定地區在區域外,但距離不遠。
OUTSKIRTS 目標位置位於區域內,靠近邊緣。
WITHIN 目標位置位於區域內,靠近中心。

SpatialRelationship 常數

constants google.maps.SpatialRelationship
library "geocoding"

代表地標和目標之間空間關係的列舉。

這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 SpatialRelationshipString 類型定義。

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");
ACROSS_THE_ROAD 目標位於地標正對面,在道路另一側。
AROUND_THE_CORNER 與地標不在同一條路線上,但只要轉一次彎就會到。
BEHIND 靠近地標結構,但距離入口較遠。
BESIDE 目標緊鄰地標。
DOWN_THE_ROAD 與地標位於同一條路線上,但不在地標旁邊或對面。
NEAR 如果下方沒有更具體的關係,則預設為此關係。
WITHIN 地標具有空間幾何圖形,且目標位於其範圍內。