Lớp Geocoder
lớp
google.maps.Geocoder
thư viện "geocoding"
Dịch vụ chuyển đổi giữa địa chỉ và LatLng.
const {Geocoder} = await google.maps.importLibrary("geocoding");
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])Tham số:
Giá trị trả về:
Promise<GeocoderResponse>Mã hoá địa lý một yêu cầu. |
Giao diện GeocoderRequest
giao diện
google.maps.GeocoderRequest
Quy cách cho yêu cầu mã hoá địa lý được gửi đến Geocoder.
Thuộc tính | |
|---|---|
address
không bắt buộc |
Loại:
string optionalĐịa chỉ cần mã hoá địa lý. Bạn chỉ được cung cấp một trong các thuộc tính address, location và placeId. |
bounds
không bắt buộc |
Loại:
LatLngBounds|LatLngBoundsLiteral optionalLatLngBounds để tìm kiếm. Không bắt buộc. |
componentRestrictions
không bắt buộc |
Loại:
GeocoderComponentRestrictions optionalCác thành phần được dùng để giới hạn kết quả trong một khu vực cụ thể. Bộ lọc bao gồm một hoặc nhiều thành phần sau: route, locality, administrativeArea, postalCode, country. Chỉ những kết quả khớp với tất cả bộ lọc mới được trả về. Giá trị bộ lọc hỗ trợ các phương thức sửa lỗi chính tả và so 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. |
không bắt buộc |
Loại:
Array<ExtraGeocodeComputation> optionalDanh sách các phép tính bổ sung có thể được 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 phản hồi. |
fulfillOnZeroResults
không bắt buộc |
Loại:
boolean optionalThự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ể là do ngay cả khi không có kết quả mã hoá địa lý, vẫn có thể có thêm các trường cấp phản hồi được trả về. |
language
không bắt buộc |
Loại:
string optionalGiá trị nhận dạng ngôn ngữ cho ngôn ngữ mà kết quả sẽ được trả về, nếu có thể. Xem danh sách ngôn ngữ được hỗ trợ. |
location
không bắt buộc |
Loại:
LatLng|LatLngLiteral optionalLatLng (hoặc LatLngLiteral) cần tìm. Bộ mã hoá địa lý thực hiện mã hoá địa lý ngược. Hãy xem phần Mã hoá địa lý ngược để biết thêm thông tin. Bạn chỉ được cung cấp một trong các thuộc tính address, location và placeId. |
placeId
không bắt buộc |
Loại:
string optionalMã địa điểm liên kết với vị trí. Mã địa điểm giúp xác định riêng một địa điểm trong cơ sở dữ liệu của 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 dành cho nhà phát triển Places API. Bộ mã hoá địa lý thực hiện mã hoá địa lý ngược. Hãy xem phần Mã hoá địa lý ngược để biết thêm thông tin. Bạn chỉ được cung cấp một trong các thuộc tính address, location và placeId. |
region
không bắt buộc |
Loại:
string optionalMã quốc gia dùng để thiên vị kết quả tìm kiếm, được chỉ định dưới dạng thẻ phụ vùng Unicode gồm hai ký tự (không phải số)/mã nhận dạng CLDR. Không bắt buộc. Xem Thông tin chi tiết về phạm vi cung cấp của Google Maps Platform để 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 nhóm bộ lọc phân giải thành một khu vực cụ thể. Để biết thông tin chi tiết về cách hoạt động của tính năng này, hãy xem phần Lọc thành phần mã hoá địa lý.
Thuộc tính | |
|---|---|
administrativeArea
không bắt buộc |
Loại:
string optionalKhớp với tất cả administrative_area levels. Không bắt buộc. |
country
không bắt buộc |
Loại:
string optionalKhớp với tên quốc gia hoặc mã quốc gia gồm hai chữ cái theo chuẩn ISO 3166-1. Không bắt buộc. |
locality
không bắt buộc |
Loại:
string optionalKhớp với cả loại locality và sublocality. Không bắt buộc. |
postalCode
không bắt buộc |
Loại:
string optionalKhớp với postal_code và postal_code_prefix. Không bắt buộc. |
route
không bắt buộc |
Loại:
string optionalKhớ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
thư viện "geocoding"
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ý.
Bạn cũng có thể sử dụng các hằng số này dưới dạng chuỗi. Trong TypeScript, giá trị cố định kiểu chuỗi được xác định bằng loại ExtraGeocodeComputationString.
const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");
Hằng số | |
|---|---|
ADDRESS_DESCRIPTORS |
Tạo chỉ số mô tả địa chỉ. |
Hằng số GeocoderStatus
hằng số
google.maps.GeocoderStatus
thư viện "geocoding"
Trạng thái do Geocoder trả về khi hoàn tất lệnh gọi đến geocode(). Chỉ định các giá trị 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.
Bạn cũng có thể sử dụng các hằng số này dưới dạng chuỗi. Trong TypeScript, giá trị cố định kiểu chuỗi được xác định bằng loại GeocoderStatusString.
const {GeocoderStatus} = await google.maps.importLibrary("geocoding");
Hằng số | |
|---|---|
ERROR |
Đã xảy ra sự cố khi kết nối với máy chủ của 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ã hoá địa lý do lỗi phía 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
Phản hồi của Bộ mã hoá địa lý do Geocoder trả về, chứa danh sách GeocoderResult.
Thuộc tính | |
|---|---|
results |
Loại:
Array<GeocoderResult>Danh sách GeocoderResult. |
không bắt buộc |
Loại:
AddressDescriptor optionalNội dung mô tả liên quan đến một vị trí. Bao gồm một nhóm địa danh lân cận được xếp hạng và các khu vực chứa vị trí mục tiêu. Trường này chỉ được điền sẵ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
không bắt buộc |
Loại:
PlacePlusCode optionalPlus Code liên kết với vị trí. |
Giao diện GeocoderResult
giao diện
google.maps.GeocoderResult
Một kết quả mã hoá địa lý duy nhất được truy xuất từ máy chủ mã hoá địa lý. Yêu cầu mã hoá đị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ả này "giống JSON" nhưng không hoàn toàn là JSON, vì kết quả này 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:
stringMộ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:
GeocoderGeometryMột đối tượng GeocoderGeometry |
place_id |
Loại:
stringMã địa điểm liên kết với vị trí. Mã địa điểm giúp xác định riêng một địa điểm trong cơ sở dữ liệu của 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 dành 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ể có, hãy tham khảo phần Các loại thành phần địa chỉ trong Hướng dẫn dành cho nhà phát triển. |
không bắt buộc |
Loại:
AddressDescriptor optionalNội dung mô tả quan hệ của vị trí liên kết với mã địa lý này. Bao gồm một nhóm địa danh lân cận được xếp hạng và các khu vực chứa vị trí mục tiêu. Trường này sẽ chỉ được điền sẵn cho các yêu cầu tra cứu mã địa điểm và mã hoá địa lý chuyển tiếp, chỉ khi ExtraGeocodeComputation.ADDRESS_DESCRIPTORS được bật và chỉ cho một số địa điểm được bản địa hoá. |
partial_match
không bắt buộc |
Loại:
boolean optionalLiệu bộ mã hoá địa lý có trả về kết quả khớp chính xác cho yêu cầu ban đầu hay không, mặc dù bộ mã hoá địa lý 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
không bắt buộc |
Loại:
PlacePlusCode optionalPlus Code liên kết với vị trí. |
postcode_localities
không bắt buộc |
Loại:
Array<string> optionalMột mảng chuỗi biểu thị tất cả địa phương có trong một mã bưu chính. Thông tin này chỉ xuất hiện khi kết quả là một mã bưu chính chứa nhiều địa phương. |
AddressDescriptor giao diện
giao diện
google.maps.AddressDescriptor
Nội dung mô tả liên quan đến một vị trí. Bao gồm một nhóm địa danh lân cận được xếp hạng và các khu vực chứa vị trí mục tiêu.
Thuộc tính | |
|---|---|
areas |
Danh sách xếp hạng các khu vực chứa hoặc lân cận. Những khu vực hữu ích nhất (dễ nhận biết và chính xác) sẽ được xếp hạng đầu tiên. |
landmarks |
Danh sách địa danh lân cận được xếp hạng. Những địa danh hữu ích nhất (dễ nhận biết 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ỉ duy nhất 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:
stringVăn bản đầy đủ của thành phần địa chỉ |
short_name |
Loại:
stringVăn bản viết tắt, ngắn gọn của thành phần địa chỉ đã cho |
types |
Loại:
Array<string>Một mảng chuỗi biểu thị loại 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:
LatLngToạ độ vĩ độ/kinh độ của kết quả này |
location_type |
Loại:
GeocoderLocationTypeLoại vị trí được trả về trong location |
viewport |
Loại:
LatLngBoundsRanh giới của khung nhìn được đề xuất để hiển thị GeocoderResult này |
bounds
không bắt buộc |
Loại:
LatLngBounds optionalRanh giới chính xác của GeocoderResult này (nếu có) |
Hằng số GeocoderLocationType
hằng số
google.maps.GeocoderLocationType
thư viện "geocoding"
Mô tả loại vị trí được trả về từ một mã địa lý. Chỉ định các giá trị 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.
Bạn cũng có thể sử dụng các hằng số này dưới dạng chuỗi. Trong TypeScript, giá trị cố định kiểu chuỗi được xác định bằng loại GeocoderLocationTypeString.
const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");
Hằng số | |
|---|---|
APPROXIMATE |
Kết quả trả về là gần đúng. |
GEOMETRIC_CENTER |
Kết quả trả về là tâm hình học của một kết quả, chẳng hạn như một đường thẳng (ví dụ: đường phố) hoặc đa giác (khu vực). |
RANGE_INTERPOLATED |
Kết quả trả về phản ánh giá trị gần đúng (thường là trên đườ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ả trả về phản ánh một mã địa lý chính xác. |
Giao diện Landmark
giao diện
google.maps.Landmark
Một địa điểm đóng vai trò là điểm tham chiếu cho địa chỉ.
Thuộc tính | |
|---|---|
display_name |
Loại:
stringTên của địa danh. |
display_name_language_code |
Loại:
stringNgôn ngữ của tên địa danh. |
place_id |
Loại:
stringMã địa điểm của cơ sở chính đóng vai trò là địa danh. Có thể dùng để phân giải thêm thông tin về địa danh thông qua tính năng Chi tiết địa điểm hoặc Tra cứu mã địa điểm. |
spatial_relationship |
Loại:
SpatialRelationshipXác định mối quan hệ không gian giữa vị trí mục tiêu và địa danh. |
straight_line_distance_meters |
Loại:
numberKhoảng cách theo đường thẳng giữa vị trí mục tiêu và địa danh. |
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 Loại để biết thêm chi tiết. |
travel_distance_meters
không bắt buộc |
Loại:
number optionalKhoảng cách di chuyển dọc theo mạng lưới đường bộ giữa vị trí mục tiêu và địa danh. Trường này có thể không được điền nếu địa danh bị ngắt kết nối khỏi phần mạng lưới đường gần mục tiêu nhất HOẶC nếu vị trí mục tiêu thực sự không được coi là nằm trên mạng lưới đường. |
Giao diện Area
giao diện
google.maps.Area
Một địa điểm là một khu vực nhỏ, chẳng hạn như khu phố, khu vực nhỏ hoặc khu phức hợp lớn có chứa vị trí mục tiêu.
Thuộc tính | |
|---|---|
containment |
Loại:
ContainmentXác định mối quan hệ không gian giữa vị trí mục tiêu và khu vực. |
display_name |
Loại:
stringTên của khu vực. |
display_name_language_code |
Loại:
stringNgôn ngữ của tên khu vực. |
place_id |
Loại:
stringMã địa điểm của khu vực cơ sở. Có thể dùng để phân giải 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ố chứa
hằng số
google.maps.Containment
thư viện "geocoding"
Một enum đại diện cho mối quan hệ không gian giữa khu vực và vị trí mục tiêu.
Bạn cũng có thể sử dụng các hằng số này dưới dạng chuỗi. Trong TypeScript, giá trị cố định kiểu chuỗi được xác định bằng loại ContainmentString.
const {Containment} = await google.maps.importLibrary("geocoding");
Hằng số | |
|---|---|
NEAR |
Vị trí mục tiêu nằm ngoài khu vực nhưng ở gần. |
OUTSKIRTS |
Vị trí mục tiêu nằm trong khu vực, gần rìa. |
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
thư viện "geocoding"
Một enum đại diện cho mối quan hệ trong không gian giữa điểm mốc và mục tiêu.
Bạn cũng có thể sử dụng các hằng số này dưới dạng chuỗi. Trong TypeScript, giá trị cố định kiểu chuỗi được xác định bằng loại SpatialRelationshipString.
const {SpatialRelationship} = await google.maps.importLibrary("geocoding");
Hằng số | |
|---|---|
ACROSS_THE_ROAD |
Mục tiêu nằm ngay đối diện địa danh ở 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ỉ cách một ngã rẽ. |
BEHIND |
Gần cấu trúc của địa danh nhưng xa điểm vào của địa danh. |
BESIDE |
Mục tiêu nằm ngay cạnh địa danh. |
DOWN_THE_ROAD |
Nằm trên cùng tuyến đường với địa danh nhưng không nằm bên cạnh hoặc đối diện. |
NEAR |
Đây là mối quan hệ mặc định khi không có mối quan hệ nào cụ thể hơn dưới đây được áp dụng. |
WITHIN |
Địa danh có hình học không gian và mục tiêu nằm trong ranh giới của địa danh đó. |