Geocoder class
Class
google.maps.Geocoder
Layanan untuk mengonversi antara alamat dan LatLng
.
Akses dengan memanggil const {Geocoder} = await google.maps.importLibrary("geocoding")
.
Lihat Library di Maps JavaScript API.
Konstruktor | |
---|---|
Geocoder |
Geocoder() Parameter: Tidak ada
Membuat instance Geocoder baru yang mengirim permintaan geocode ke server Google. |
Metode | |
---|---|
geocode |
geocode(request[, callback]) Parameter:
Nilai yang Ditampilkan:
Promise<GeocoderResponse> Memberi geocode pada permintaan. |
GeocoderRequest interface
google.maps.GeocoderRequest
interface
Spesifikasi untuk permintaan geocoding yang akan dikirim ke Geocoder
.
Properti | |
---|---|
address optional |
Jenis:
string optional Alamat yang akan di-geocode. Salah satu, dan hanya salah satu, dari address , location , dan placeId yang harus diberikan. |
bounds optional |
Jenis:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds yang akan ditelusuri. Opsional. |
componentRestrictions optional |
Jenis:
GeocoderComponentRestrictions optional Komponen digunakan untuk membatasi hasil ke area tertentu. Filter terdiri dari satu atau beberapa hal berikut: route , locality , administrativeArea , postalCode , country . Hanya hasil yang cocok dengan semua filter yang akan dikembalikan. Nilai-nilai filter mendukung metode yang sama untuk koreksi ejaan dan kecocokan parsial seperti permintaan geocoding lainnya. Opsional. |
|
Jenis:
Array<ExtraGeocodeComputation> optional Daftar komputasi tambahan yang dapat digunakan untuk menyelesaikan permintaan. Catatan: Komputasi tambahan ini dapat menampilkan kolom tambahan pada respons. |
fulfillOnZeroResults optional |
Jenis:
boolean optional Penuhi janji pada status ZERO_RESULT dalam respons. Hal ini mungkin diinginkan karena meskipun dengan nol hasil geocoding, masih ada kolom tingkat respons tambahan yang ditampilkan. |
language optional |
Jenis:
string optional ID bahasa untuk bahasa yang digunakan untuk menampilkan hasil, jika memungkinkan. Lihat daftar bahasa yang didukung. |
location optional |
Jenis:
LatLng|LatLngLiteral optional LatLng (atau LatLngLiteral ) yang akan ditelusuri. Geocoder akan melakukan geocoding terbalik. Lihat Geocoding Terbalik untuk mengetahui informasi selengkapnya. Salah satu, dan hanya salah satu, dari address , location , dan placeId yang harus diberikan. |
placeId optional |
Jenis:
string optional ID tempat yang terkait dengan lokasi. ID tempat secara unik mengidentifikasi tempat di database Google Places dan Google Maps. Pelajari lebih lanjut ID tempat di panduan developer Places API. Geocoder akan melakukan geocoding terbalik. Lihat Geocoding Terbalik untuk mengetahui informasi selengkapnya. Salah satu, dan hanya salah satu, dari address , location , dan placeId yang harus diberikan. |
region optional |
Jenis:
string optional Kode negara yang digunakan untuk memengaruhi penelusuran, ditentukan sebagai subtag wilayah Unicode / ID CLDR dua karakter (non-numerik). Opsional. Lihat Detail Cakupan Google Maps Platform untuk wilayah yang didukung. |
GeocoderComponentRestrictions interface
google.maps.GeocoderComponentRestrictions
interface
GeocoderComponentRestrictions
mewakili serangkaian filter yang diselesaikan ke area tertentu. Untuk mengetahui detail cara kerjanya, lihat Pemfilteran Komponen Geocoding.
Properti | |
---|---|
administrativeArea optional |
Jenis:
string optional Mencocokkan semua administrative_area levels . Opsional. |
country optional |
Jenis:
string optional Cocok dengan nama negara atau kode negara ISO 3166-1 dua huruf. Opsional. |
locality optional |
Jenis:
string optional Cocok dengan jenis locality dan sublocality . Opsional. |
postalCode optional |
Jenis:
string optional Cocok dengan postal_code dan postal_code_prefix . Opsional. |
route optional |
Jenis:
string optional Mencocokkan nama panjang atau pendek route . Opsional. |
Konstanta ExtraGeocodeComputation
google.maps.ExtraGeocodeComputation
konstanta
Komputasi tambahan yang akan dilakukan saat menyelesaikan permintaan geocoding.
Akses dengan memanggil const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
.
Lihat Library di Maps JavaScript API.
Konstanta | |
---|---|
ADDRESS_DESCRIPTORS |
Buat deskripsi alamat. |
Konstanta GeocoderStatus
google.maps.GeocoderStatus
konstanta
Status yang ditampilkan oleh Geocoder
setelah panggilan ke geocode()
selesai. Tentukan ini berdasarkan nilai, atau menggunakan nama konstanta. Misalnya, 'OK'
atau google.maps.GeocoderStatus.OK
.
Akses dengan memanggil const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
.
Lihat Library di Maps JavaScript API.
Konstanta | |
---|---|
ERROR |
Ada masalah saat menghubungi server Google. |
INVALID_REQUEST |
GeocoderRequest ini tidak valid. |
OK |
Respons berisi GeocoderResponse yang valid. |
OVER_QUERY_LIMIT |
Halaman web telah melampaui batas permintaan dalam jangka waktu yang terlalu singkat. |
REQUEST_DENIED |
Halaman web tidak diizinkan menggunakan geocoder. |
UNKNOWN_ERROR |
Permintaan geocoding tidak dapat diproses karena terjadi error server. Permintaan mungkin berhasil jika Anda mencoba lagi. |
ZERO_RESULTS |
Tidak ada hasil yang ditemukan untuk GeocoderRequest ini. |
GeocoderResponse interface
google.maps.GeocoderResponse
interface
Respons Geocoder yang ditampilkan oleh Geocoder
yang berisi daftar GeocoderResult
.
Properti | |
---|---|
results |
Jenis:
Array<GeocoderResult> Daftar GeocoderResult . |
|
Jenis:
AddressDescriptor optional Deskripsi relasional lokasi. Mencakup serangkaian tempat terkenal di sekitar yang diberi peringkat dan area yang berisi lokasi target. Parameter ini hanya diisi untuk permintaan geocoding terbalik dan hanya jika ExtraGeocodeComputation.ADDRESS_DESCRIPTORS diaktifkan. |
plus_code optional |
Jenis:
PlacePlusCode optional Plus Code yang terkait dengan lokasi. |
GeocoderResult interface
google.maps.GeocoderResult
interface
Satu hasil geocoder yang diambil dari server geocode. Permintaan geocode dapat menampilkan beberapa objek hasil. Perhatikan bahwa meskipun hasil ini "mirip JSON", hasil ini bukan JSON sepenuhnya, karena secara tidak langsung menyertakan objek LatLng
.
Properti | |
---|---|
address_components |
Jenis:
Array<GeocoderAddressComponent> Array GeocoderAddressComponent |
formatted_address |
Jenis:
string String yang berisi alamat lokasi ini yang dapat dibaca manusia. |
geometry |
Jenis:
GeocoderGeometry Objek GeocoderGeometry |
place_id |
Jenis:
string ID tempat yang terkait dengan lokasi. ID tempat secara unik mengidentifikasi tempat di database Google Places dan Google Maps. Pelajari lebih lanjut ID Tempat di panduan developer Places API. |
types |
Jenis:
Array<string> Array string yang menunjukkan jenis elemen geocode yang ditampilkan. Untuk mengetahui daftar kemungkinan string, lihat bagian Jenis Komponen Alamat di Panduan Developer. |
|
Jenis:
AddressDescriptor optional Deskripsi relasional lokasi yang terkait dengan geocode ini. Mencakup serangkaian tempat terkenal di sekitar yang diberi peringkat dan area yang berisi lokasi target. Kolom ini hanya akan diisi untuk permintaan geocoding maju dan penelusuran ID tempat, hanya jika ExtraGeocodeComputation.ADDRESS_DESCRIPTORS diaktifkan, dan hanya untuk tempat tertentu yang dilokalkan. |
partial_match optional |
Jenis:
boolean optional Apakah geocoder tidak menampilkan kecocokan persis untuk permintaan asli, meskipun jika geocoder dapat menampilkan kecocokan parsial dengan alamat yang diminta. Jika kecocokan persis, nilainya adalah undefined . |
plus_code optional |
Jenis:
PlacePlusCode optional Plus Code yang terkait dengan lokasi. |
postcode_localities optional |
Jenis:
Array<string> optional Array string yang menunjukkan semua lokalitas yang dimuat dalam kode pos. Ini hanya ada bila hasilnya adalah kode pos yang berisi beberapa lokalitas. |
Antarmuka AddressDescriptor
google.maps.AddressDescriptor
interface
Deskripsi relasional lokasi. Mencakup serangkaian tempat terkenal di sekitar yang diberi peringkat dan area yang berisi lokasi target.
Properti | |
---|---|
areas |
Daftar berperingkat area yang berisi atau berdekatan. Area yang paling berguna (dapat dikenali dan akurat) diberi peringkat pertama. |
landmarks |
Daftar tempat terkenal di sekitar yang diurutkan berdasarkan peringkat. Tempat penting yang paling berguna (dapat dikenali dan terdekat) diberi peringkat pertama. |
GeocoderAddressComponent interface
google.maps.GeocoderAddressComponent
interface
Satu komponen alamat dalam GeocoderResult
. Alamat lengkap dapat terdiri dari beberapa komponen alamat.
Properti | |
---|---|
long_name |
Jenis:
string Teks lengkap komponen alamat |
short_name |
Jenis:
string Teks singkat yang disingkat dari komponen alamat yang diberikan |
types |
Jenis:
Array<string> Array string yang menunjukkan jenis komponen alamat ini. Daftar jenis yang valid dapat ditemukan di sini |
GeocoderGeometry interface
google.maps.GeocoderGeometry
interface
Informasi geometri tentang GeocoderResult
ini
Properti | |
---|---|
location |
Jenis:
LatLng Koordinat lintang/bujur hasil ini |
location_type |
Jenis:
GeocoderLocationType Jenis lokasi yang ditampilkan di location |
viewport |
Jenis:
LatLngBounds Batas area pandang yang direkomendasikan untuk menampilkan GeocoderResult ini |
bounds optional |
Jenis:
LatLngBounds optional Batas yang tepat dari GeocoderResult ini, jika berlaku |
Konstanta GeocoderLocationType
google.maps.GeocoderLocationType
konstanta
Menjelaskan jenis lokasi yang ditampilkan dari geocode. Tentukan ini berdasarkan nilai, atau menggunakan nama konstanta. Misalnya 'ROOFTOP'
atau google.maps.GeocoderLocationType.ROOFTOP
.
Akses dengan memanggil const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
.
Lihat Library di Maps JavaScript API.
Konstanta | |
---|---|
APPROXIMATE |
Hasil yang ditampilkan adalah perkiraan. |
GEOMETRIC_CENTER |
Hasil yang ditampilkan adalah pusat geometris dari hasil seperti garis (misalnya, jalan) atau poligon (wilayah). |
RANGE_INTERPOLATED |
Hasil yang ditampilkan mencerminkan perkiraan (biasanya pada jalan) interpolasi antara dua titik tepat (seperti persimpangan). Hasil interpolasi umumnya dikembalikan bila rooftop-geocode tidak tersedia untuk alamat jalan. |
ROOFTOP |
Hasil yang ditampilkan mencerminkan geocode yang akurat. |
Antarmuka Landmark
google.maps.Landmark
interface
Tempat yang mewakili titik referensi untuk alamat.
Properti | |
---|---|
display_name |
Jenis:
string Nama untuk penanda. |
display_name_language_code |
Jenis:
string Bahasa nama untuk tempat penting. |
place_id |
Jenis:
string ID Tempat dari tempat usaha yang mendasarinya dan berfungsi sebagai landmark. Dapat digunakan untuk mendapatkan informasi selengkapnya tentang landmark melalui Place Details atau Place ID Lookup. |
spatial_relationship |
Jenis:
SpatialRelationship Menentukan hubungan spasial antara target lokasi dan landmark. |
straight_line_distance_meters |
Jenis:
number Jarak garis lurus antara lokasi target dan landmark. |
types |
Jenis:
Array<string> Satu atau beberapa nilai yang menunjukkan jenis hasil yang ditampilkan. Lihat Jenis untuk mengetahui detail selengkapnya. |
travel_distance_meters optional |
Jenis:
number optional Jarak perjalanan di sepanjang jaringan jalan antara lokasi target dan landmark. Kolom ini dapat tidak diisi jika landmark terputus dari bagian jaringan jalan yang paling dekat dengan target ATAU jika lokasi target sebenarnya tidak dianggap berada di jaringan jalan. |
Antarmuka Area
google.maps.Area
interface
Tempat yang merupakan wilayah kecil, seperti lingkungan, sublokalitas, atau kompleks besar yang berisi lokasi target.
Properti | |
---|---|
containment |
Jenis:
Containment Menentukan hubungan spasial antara lokasi target dan area. |
display_name |
Jenis:
string Nama untuk area. |
display_name_language_code |
Jenis:
string Bahasa nama untuk area. |
place_id |
Jenis:
string ID Tempat area yang mendasarinya. Dapat digunakan untuk mendapatkan informasi selengkapnya tentang area melalui Place Details atau Place ID Lookup. |
Konstanta pembatasan
google.maps.Containment
konstanta
Enum yang merepresentasikan hubungan spasial antara area dan lokasi target.
Akses dengan memanggil const {Containment} = await google.maps.importLibrary("geocoding")
.
Lihat Library di Maps JavaScript API.
Konstanta | |
---|---|
NEAR |
Lokasi target berada di luar area wilayah, tetapi dekat. |
OUTSKIRTS |
Lokasi target berada dalam wilayah area, dekat dengan tepi. |
WITHIN |
Lokasi target berada dalam wilayah area, dekat dengan bagian tengah. |
Konstanta SpatialRelationship
google.maps.SpatialRelationship
konstanta
Enum yang merepresentasikan hubungan dalam ruang antara titik penting dan target.
Akses dengan memanggil const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
.
Lihat Library di Maps JavaScript API.
Konstanta | |
---|---|
ACROSS_THE_ROAD |
Target berada tepat di seberang bangunan di sisi lain jalan. |
AROUND_THE_CORNER |
Tidak berada di rute yang sama dengan lokasi, tetapi hanya berjarak satu belokan. |
BEHIND |
Dekat dengan struktur tempat terkenal, tetapi lebih jauh dari titik aksesnya. |
BESIDE |
Target berdekatan langsung dengan landmark. |
DOWN_THE_ROAD |
Di rute yang sama dengan lokasi penting, tetapi tidak di samping atau di seberang. |
NEAR |
Ini adalah hubungan default jika tidak ada yang lebih spesifik di bawah yang berlaku. |
WITHIN |
Landmark memiliki geometri spasial dan target berada dalam batasnya. |