Lớp Bộ mã hoá địa lý
Lớp google.maps.Geocoder
Dịch vụ để chuyển đổi giữa địa chỉ và LatLng
.
Truy cập bằng cách gọi const {Geocoder} = await google.maps.importLibrary("geocoding")
. Xem Thư viện trong API JavaScript Maps.
Hàm dựng | |
---|---|
Geocoder |
Geocoder() Tham số: Không có
Tạo một thực thể mới của Geocoder để gửi yêu cầu mã hoá địa lý đến máy chủ của Google. |
Phương thức | |
---|---|
geocode |
geocode(request[, callback]) Các thông số:
Giá trị trả về:
Promise<GeocoderResponse> Mã hoá địa lý cho yêu cầu. |
Giao diện GeocoderRequest
Giao diện google.maps.GeocoderRequest
Thông số kỹ thuật của một yêu cầu mã hóa địa lý cần gửi đến Geocoder
.
Thuộc tính | |
---|---|
address optional |
Loại:
string optional Địa chỉ để mã hoá địa lý. Phải cung cấp một và chỉ một trong số address , location và placeId . |
bounds optional |
Loại:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds mà trong đó cần tìm kiếm. Không bắt buộc. |
componentRestrictions optional |
Loại:
GeocoderComponentRestrictions optional Các thành phần được dùng để giới hạn kết quả ở một khu vực cụ thể. Mỗi bộ lọc bao gồm một hoặc nhiều giá trị sau: route , locality , administrativeArea , postalCode , country . Hệ thống sẽ chỉ trả về những kết quả phù hợp với tất cả bộ lọc. Giá trị bộ lọc hỗ trợ các phương pháp sửa chính tả và khớp một phần giống như các yêu cầu mã hoá địa lý khác. Không bắt buộc. |
extraComputations optional |
Loại:
Array<ExtraGeocodeComputation> optional Danh sách các phép tính bổ sung có thể dùng để hoàn tất yêu cầu. Lưu ý: Những phép tính bổ sung này có thể trả về các trường bổ sung trong câu trả lời. |
fulfillOnZeroResults optional |
Loại:
boolean optional Thực hiện lời hứa về trạng thái ZERO_RESULT trong phản hồi. Điều này có thể được mong muốn bởi vì ngay cả khi không có kết quả mã hoá địa lý thì có thể vẫn có các trường cấp phản hồi bổ sung được trả về. |
language optional |
Loại:
string optional Giá trị nhận dạng ngôn ngữ của ngôn ngữ mà kết quả sẽ được trả về, khi có thể. Xem danh sách ngôn ngữ được hỗ trợ. |
location optional |
Loại:
LatLng|LatLngLiteral optional LatLng (hoặc LatLngLiteral ) cần tìm kiếm. Bộ mã hoá địa lý thực hiện mã địa lý ngược. Xem Đảo ngược mã hóa địa lý để biết thêm thông tin. Phải cung cấp một và chỉ một trong số address , location và placeId . |
placeId optional |
Loại:
string optional Mã địa điểm được liên kết với vị trí. Mã địa điểm xác định duy nhất một địa điểm trong cơ sở dữ liệu Google Địa điểm và trên Google Maps. Tìm hiểu thêm về mã địa điểm trong hướng dẫn cho nhà phát triển Places API. Bộ mã hoá địa lý thực hiện mã địa lý ngược. Xem Mã hóa địa lý ngược để biết thêm thông tin. Phải cung cấp một và chỉ một trong số address , location và placeId . |
region optional |
Loại:
string optional Mã quốc gia dùng để phân biệt nội dung tìm kiếm, được chỉ định dưới dạng thẻ phụ khu vực Unicode / mã nhận dạng CLDR gồm hai ký tự (không phải chữ số). Không bắt buộc. Xem Thông tin chi tiết về phạm vi áp dụng của Nền tảng Google Maps để biết các khu vực được hỗ trợ. |
Giao diện GeocoderComponentRestrictions
Giao diện google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
đại diện cho một tập hợp các bộ lọc phân giải cho một khu vực cụ thể. Để biết chi tiết về cách tính năng này hoạt động, hãy xem Lọc thành phần mã hóa địa lý.
Thuộc tính | |
---|---|
administrativeArea optional |
Loại:
string optional Khớp với tất cả administrative_area levels . Không bắt buộc. |
country optional |
Loại:
string optional Khớp với tên một quốc gia hoặc mã quốc gia gồm hai chữ cái theo ISO 3166-1. Không bắt buộc. |
locality optional |
Loại:
string optional So khớp với cả loại locality và sublocality . Không bắt buộc. |
postalCode optional |
Loại:
string optional Khớp với postal_code và postal_code_prefix . Không bắt buộc. |
route optional |
Loại:
string optional Khớp với tên dài hoặc tên ngắn của route . Không bắt buộc. |
Hằng số ExtraGeocodeComputation
Hằng số google.maps.ExtraGeocodeComputation
Các phép tính bổ sung cần thực hiện trong khi hoàn tất yêu cầu mã hoá địa lý.
Truy cập bằng cách gọi const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
. Xem Thư viện trong API JavaScript Maps.
Hằng số | |
---|---|
ADDRESS_DESCRIPTORS |
Tạo mã mô tả địa chỉ. |
Hằng số GeocoderStatus
Hằng số google.maps.GeocoderStatus
Trạng thái được Geocoder
trả về khi hoàn tất lệnh gọi đến geocode()
. Hãy chỉ định các biến này theo giá trị hoặc bằng cách sử dụng tên của hằng số. Ví dụ: 'OK'
hoặc google.maps.GeocoderStatus.OK
.
Truy cập bằng cách gọi const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
. Xem Thư viện trong API JavaScript Maps.
Hằng số | |
---|---|
ERROR |
Đã xảy ra sự cố khi kết nối với máy chủ Google. |
INVALID_REQUEST |
GeocoderRequest này không hợp lệ. |
OK |
Phản hồi chứa GeocoderResponse hợp lệ. |
OVER_QUERY_LIMIT |
Trang web đã vượt quá giới hạn yêu cầu trong một khoảng thời gian quá ngắn. |
REQUEST_DENIED |
Trang web không được phép sử dụng bộ mã hoá địa lý. |
UNKNOWN_ERROR |
Không thể xử lý yêu cầu mã hóa địa lý do lỗi máy chủ. Yêu cầu có thể thành công nếu bạn thử lại. |
ZERO_RESULTS |
Không tìm thấy kết quả nào cho GeocoderRequest này. |
Giao diện GeocoderResponse
Giao diện google.maps.GeocoderResponse
Một phản hồi của Bộ mã hoá địa lý được Geocoder
trả về, chứa danh sách các GeocoderResult
.
Thuộc tính | |
---|---|
results |
Loại:
Array<GeocoderResult> Danh sách GeocoderResult . |
address_descriptor optional |
Loại:
AddressDescriptor optional Nội dung mô tả quan hệ về một vị trí. Bao gồm một tập hợp các địa danh được xếp hạng lân cận và các khu vực có chứa vị trí mục tiêu. Mã này chỉ được điền cho các yêu cầu mã hoá địa lý ngược và chỉ khi ExtraGeocodeComputation.ADDRESS_DESCRIPTORS được bật. |
plus_code optional |
Loại:
PlacePlusCode optional Mã cộng được liên kết với vị trí. |
Giao diện GeocoderResult
Giao diện google.maps.GeocoderResult
Một kết quả của bộ mã hoá địa lý duy nhất được truy xuất từ máy chủ mã hoá địa lý. Một yêu cầu mã địa lý có thể trả về nhiều đối tượng kết quả. Xin lưu ý rằng mặc dù kết quả "giống JSON" nhưng không hoàn toàn là JSON vì nó gián tiếp bao gồm một đối tượng LatLng
.
Thuộc tính | |
---|---|
address_components |
Loại:
Array<GeocoderAddressComponent> Một mảng GeocoderAddressComponent |
formatted_address |
Loại:
string Một chuỗi ký tự chứa địa chỉ mà con người có thể đọc được của vị trí này. |
geometry |
Loại:
GeocoderGeometry Một đối tượng GeocoderGeometry |
place_id |
Loại:
string Mã địa điểm được liên kết với vị trí. Mã địa điểm xác định duy nhất một địa điểm trong cơ sở dữ liệu Google Địa điểm và trên Google Maps. Tìm hiểu thêm về Mã địa điểm trong hướng dẫn cho nhà phát triển Places API. |
types |
Loại:
Array<string> Một mảng chuỗi biểu thị loại phần tử được mã hoá địa lý được trả về. Để biết danh sách các chuỗi có thể sử dụng, hãy tham khảo phần Loại thành phần địa chỉ trong Hướng dẫn dành cho nhà phát triển. |
address_descriptor optional |
Loại:
AddressDescriptor optional Mô tả tương quan của vị trí được liên kết với mã địa lý này. Bao gồm một tập hợp các địa danh được xếp hạng lân cận và các khu vực có chứa vị trí mục tiêu. Mã này sẽ chỉ được điền sẵn cho các yêu cầu mã hoá địa lý chuyển tiếp và tra cứu mã địa điểm, chỉ khi ExtraGeocodeComputation.ADDRESS_DESCRIPTORS được bật và chỉ dành cho một số địa điểm đã được bản địa hoá. |
partial_match optional |
Loại:
boolean optional Liệu bộ mã hoá địa lý có trả về kết quả khớp hoàn toàn với yêu cầu ban đầu hay không, mặc dù bộ mã hoá có thể khớp một phần địa chỉ được yêu cầu. Nếu khớp chính xác, giá trị sẽ là undefined . |
plus_code optional |
Loại:
PlacePlusCode optional Mã cộng được liên kết với vị trí. |
postcode_localities optional |
Loại:
Array<string> optional Một mảng chuỗi biểu thị tất cả các khu vực có trong mã bưu chính. Thông tin này chỉ hiển thị khi kết quả là một mã bưu chính chứa nhiều khu vực. |
Giao diện AddressDescriptor
Giao diện google.maps.AddressDescriptor
Nội dung mô tả quan hệ về một vị trí. Bao gồm một tập hợp các địa danh được xếp hạng lân cận và các khu vực có chứa vị trí mục tiêu.
Thuộc tính | |
---|---|
areas |
Một danh sách xếp hạng gồm các khu vực lân cận hoặc khu vực lân cận. Những khu vực hữu ích (có thể nhận diện và chính xác) nhất sẽ được xếp hạng đầu tiên. |
landmarks |
Danh sách xếp hạng các địa danh lân cận. Các địa danh hữu ích nhất (dễ nhận ra và ở gần) sẽ được xếp hạng đầu tiên. |
Giao diện GeocoderAddressComponent
Giao diện google.maps.GeocoderAddressComponent
Một thành phần địa chỉ trong GeocoderResult
. Một địa chỉ đầy đủ có thể bao gồm nhiều thành phần địa chỉ.
Thuộc tính | |
---|---|
long_name |
Loại:
string Văn bản đầy đủ của thành phần địa chỉ |
short_name |
Loại:
string Văn bản viết tắt, ngắn của thành phần địa chỉ đã cho |
types |
Loại:
Array<string> Một mảng chuỗi cho biết loại của thành phần địa chỉ này. Bạn có thể xem danh sách các loại hợp lệ tại đây |
Giao diện GeocoderGeometry
Giao diện google.maps.GeocoderGeometry
Thông tin hình học về GeocoderResult
này
Thuộc tính | |
---|---|
location |
Loại:
LatLng Vĩ độ/kinh độ của kết quả này |
location_type |
Loại:
GeocoderLocationType Loại vị trí được trả về trong location |
viewport |
Loại:
LatLngBounds Các giới hạn của khung nhìn được đề xuất để hiển thị GeocoderResult này |
bounds optional |
Loại:
LatLngBounds optional Giới hạn chính xác của GeocoderResult này, nếu có |
Hằng số GeocoderLocationType
Hằng số google.maps.GeocoderLocationType
Mô tả loại vị trí được trả về từ một mã địa lý. Hãy chỉ định các biến này theo giá trị hoặc bằng cách sử dụng tên của hằng số. Ví dụ: 'ROOFTOP'
hoặc google.maps.GeocoderLocationType.ROOFTOP
.
Truy cập bằng cách gọi const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
. Xem Thư viện trong API JavaScript Maps.
Hằng số | |
---|---|
APPROXIMATE |
Kết quả trả về là gần đúng. |
GEOMETRIC_CENTER |
Kết quả được trả về là trung tâm hình học của kết quả như một đường (ví dụ: đường phố) hoặc đa giác (vùng). |
RANGE_INTERPOLATED |
Kết quả được trả về phản ánh một giá trị gần đúng (thường là trên một con đường) được nội suy giữa hai điểm chính xác (chẳng hạn như giao lộ). Kết quả nội suy thường được trả về khi không có mã địa lý trên mái nhà cho một địa chỉ đường phố. |
ROOFTOP |
Kết quả được trả về phản ánh một mã địa lý chính xác. |
Giao diện Landmark
Giao diện google.maps.Landmark
Địa điểm đại diện cho một điểm tham chiếu cho địa chỉ.
Thuộc tính | |
---|---|
display_name |
Loại:
string Tên của điểm mốc. |
display_name_language_code |
Loại:
string Ngôn ngữ của tên cho điểm mốc. |
place_id |
Loại:
string Mã địa điểm của cơ sở cơ sở được dùng làm điểm mốc. Có thể được sử dụng để phân giải thêm thông tin về mốc địa điểm thông qua Chi tiết địa điểm hoặc Tra cứu mã địa điểm. |
spatial_relationship |
Loại:
SpatialRelationship Xác định mối quan hệ về không gian giữa vị trí mục tiêu và mốc. |
straight_line_distance_meters |
Loại:
number Khoảng cách theo đường thẳng giữa vị trí mục tiêu và điểm mốc. |
types |
Loại:
Array<string> Một hoặc nhiều giá trị cho biết loại kết quả được trả về. Vui lòng xem phần Các loại để biết thêm chi tiết. |
travel_distance_meters optional |
Loại:
number optional Khoảng cách di chuyển dọc theo mạng lưới đường giữa vị trí mục tiêu và điểm mốc. Bạn có thể không điền sẵn thông tin này nếu mốc bị ngắt kết nối khỏi phần của mạng lưới đường mà mục tiêu ở gần nhất HOẶC nếu vị trí mục tiêu thực sự không được coi là có trên mạng lưới đường. |
Giao diện Area (Khu vực)
Giao diện google.maps.Area
Địa điểm là một khu vực nhỏ, chẳng hạn như vùng lân cận, quận/huyện hoặc khu phức hợp lớn chứa vị trí mục tiêu.
Thuộc tính | |
---|---|
containment |
Loại:
Containment Xác định mối quan hệ về mặt không gian giữa vị trí mục tiêu và khu vực. |
display_name |
Loại:
string Tên của khu vực. |
display_name_language_code |
Loại:
string Ngôn ngữ của tên khu vực. |
place_id |
Loại:
string Mã địa điểm của khu vực cơ bản. Có thể được sử dụng để giải quyết thêm thông tin về khu vực thông qua Chi tiết địa điểm hoặc Tra cứu mã địa điểm. |
Hằng số vùng chứa
Hằng số google.maps.Containment
Một enum thể hiện mối quan hệ về không gian giữa khu vực và vị trí mục tiêu.
Truy cập bằng cách gọi const {Containment} = await google.maps.importLibrary("geocoding")
. Xem Thư viện trong API JavaScript Maps.
Hằng số | |
---|---|
NEAR |
Vị trí mục tiêu nằm ngoài khu vực khu vực, nhưng gần đó. |
OUTSKIRTS |
Vị trí mục tiêu nằm trong khu vực, gần với cạnh. |
WITHIN |
Vị trí mục tiêu nằm trong khu vực, gần trung tâm. |
Hằng số SpatialRelationship
Hằng số google.maps.SpatialRelationship
Một enum biểu thị mối quan hệ trong không gian giữa điểm mốc và mục tiêu.
Truy cập bằng cách gọi const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
. Xem Thư viện trong API JavaScript Maps.
Hằng số | |
---|---|
ACROSS_THE_ROAD |
Mục tiêu nằm ngay đối diện cột mốc ở phía bên kia đường. |
AROUND_THE_CORNER |
Không nằm trên cùng tuyến đường với địa danh đó nhưng chỉ quay đầu một bên. |
BEHIND |
Gần với công trình của địa danh nhưng cách xa điểm truy cập của địa danh hơn. |
BESIDE |
Mục tiêu ngay sát mốc. |
DOWN_THE_ROAD |
Trên cùng một tuyến đường với địa danh, nhưng không nằm bên cạnh hoặc phía bên kia. |
NEAR |
Đây là mối quan hệ mặc định khi không có mối quan hệ cụ thể hơn nào bên dưới được áp dụng. |
WITHIN |
Mốc này có hình học không gian và mục tiêu nằm trong giới hạn của nó. |