Search - Get Search Address

Referensi

Service:: Maps

API Version:: 1.0

Gunakan untuk mendapatkan koordinat lintang dan bujur alamat jalan dalam format input yang tidak terstruktur atau kueri.

Get Search Address API adalah permintaan HTTP GET mengembalikan koordinat lintang dan bujur saat diteruskan di alamat jalan atau nama tempat sebagai kriteria pencarian.

Dalam banyak kasus, layanan pencarian lengkap mungkin terlalu banyak, misalnya jika Anda hanya tertarik dengan geocoding tradisional. Search juga dapat diakses untuk pencarian alamat secara eksklusif. Geocoding dilakukan dengan menekan titik akhir geocode hanya dengan alamat atau alamat parsial yang dimaksud. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada POI yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, negara bagian, dll.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	ResponseFormat	Format respons yang diinginkan. Nilai dapat berupa json atau xml.
api-version	query	True	string	Nomor versi API Azure Maps.
query	query	True	string	Alamat yang akan dicari (misalnya, "1 cara Microsoft, Redmond, WA"), harus dikodekan DENGAN BENAR URL.
btmRight	query		string	Posisi kanan bawah kotak pembatas. Misalnya 37.553,-122.453
countrySet	query		string[]	String kode negara/wilayah yang dipisahkan koma, misalnya FR,ES. Ini akan membatasi pencarian ke negara/wilayah yang ditentukan
entityType	query		GeographicEntityType	Menentukan tingkat pemfilteran yang dilakukan pada geografi. Mempersempit pencarian untuk jenis entitas geografi tertentu, misalnya hanya mengembalikan kotamadya. Respons yang dihasilkan akan berisi ID geografi serta jenis entitas yang cocok. Jika Anda menyediakan lebih dari satu entitas sebagai daftar yang dipisahkan koma, titik akhir akan mengembalikan 'entitas terkecil yang tersedia'. ID Geometri yang dikembalikan dapat digunakan untuk mendapatkan geometri geografi tersebut melalui Get Search Polygon API. Parameter berikut diabaikan saat entityType diatur: Menuju nomor returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Indeks yang kode pos yang diperluas harus disertakan dalam hasil. Indeks yang tersedia adalah: Addr = Rentang alamat Geografi = Geografi PAD = Alamat Titik POI = Tempat Menarik Str = Jalanan XStr = Lintas Jalan (persimpangan) Nilai harus berupa daftar jenis indeks yang dipisahkan koma (dalam urutan apa pun) atau Tidak ada untuk tanpa indeks. Secara default kode pos yang diperluas disertakan untuk semua indeks kecuali Geo. Daftar kode pos yang diperluas untuk geografi bisa sangat panjang sehingga harus diminta secara eksplisit saat diperlukan. Contoh penggunaan: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Kode pos yang diperluas dikembalikan sebagai properti extendedPostalCode dari alamat. Ketersediaan bergantung pada wilayah.
language	query		string	Bahasa tempat hasil pencarian harus dikembalikan. Harus menjadi salah satu tag bahasa IETF yang didukung, tidak peka huruf besar/kecil. Saat data dalam bahasa tertentu tidak tersedia untuk bidang tertentu, bahasa default digunakan. Silakan merujuk ke Bahasa yang Didukung untuk detailnya.
lat	query		number double	Garis lintang di mana hasil harus bias. Misalnya 37.337
limit	query		integer	Jumlah maksimum respons yang akan dikembalikan. Default: 10, minimum: 1 dan maksimum: 100
lon	query		number double	Garis bujur di mana hasil harus bias. Misalnya -121.89
ofs	query		integer	Memulai offset hasil yang dikembalikan dalam tataan hasil lengkap. Default: 0
radius	query		integer	Radius dalam meter hingga hasil dibatasi ke area yang ditentukan
topLeft	query		string	Posisi kiri atas kotak pembatas. Misalnya 37.553,-122.453
typeahead	query		boolean	Boolean. Jika bendera typeahead diatur, kueri akan ditafsirkan sebagai input parsial dan pencarian akan memasuki mode prediktif
view	query		LocalizedMapView	Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara/wilayah yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara/wilayah yang akan dilayani aplikasi Anda. Secara default, parameter Tampilan diatur ke "Terpadu" meskipun Anda belum menentukannya dalam permintaan. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Atau, Anda memiliki opsi untuk mengatur 'View=Auto', yang akan mengembalikan data peta berdasarkan alamat IP permintaan. Parameter Tampilan di Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang anda berwenang untuk mengakses melalui Azure Maps tersedia. Contoh: view=IN. Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps .
Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID.
Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Sample Response

Status code:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definisi

Nama	Deskripsi
Address	Alamat hasil
AddressRanges	Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.
BoundingBox	Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah viewport.
BoundingBoxCompassNotation	Kotak pembatas lokasi.
Brand	Merek yang terkait dengan POI
Classification	Klasifikasi untuk POI yang dikembalikan
ClassificationName	Nama untuk klasifikasi
DataSources	Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.
Entity	Sumber jenis entitas dari kotak pembatas. Untuk geocoding terbalik, ini selalu sama dengan posisi.
EntryPoint	Titik masuk untuk POI yang dikembalikan.
EntryPointType	Jenis titik masuk. Nilai dapat berupa utama atau minor.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
GeographicEntityType	Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
Geometry	Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi.
LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
LocalizedMapView	Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara/wilayah yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara/wilayah yang akan dilayani aplikasi Anda. Secara default, parameter Tampilan diatur ke "Terpadu" meskipun Anda belum menentukannya dalam permintaan. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Atau, Anda memiliki opsi untuk mengatur 'View=Auto', yang akan mengembalikan data peta berdasarkan alamat IP permintaan. Parameter Tampilan di Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang anda berwenang untuk mengakses melalui Azure Maps tersedia. Contoh: view=IN. Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.
MatchType	Jenis kecocokan untuk operasi pencarian alamat terbalik.
OperatingHours	Jam buka untuk POI (Tempat Menarik).
OperatingHoursTime	Mewakili tanggal dan waktu
OperatingHoursTimeRange	Rentang waktu buka selama sehari
PointOfInterest	Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.
PointOfInterestCategorySet	Kategori POI
QueryType	Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.
ResponseFormat	Format respons yang diinginkan. Nilai dapat berupa json atau xml.
SearchAddressResult	Objek ini dikembalikan dari panggilan Search yang berhasil.
SearchAddressResultItem	Objek hasil untuk respons API Search.
SearchAddressResultType	Salah satu: POI Jalan Geografi Alamat Titik Rentang Alamat Lintas Jalan
SearchIndexes	Indeks yang kode pos yang diperluas harus disertakan dalam hasil. Indeks yang tersedia adalah: Addr = Rentang alamat Geo = Geografi PAD = Alamat Titik POI = Lokasi Menarik Str = Jalanan XStr = Lintas Jalan (persimpangan) Nilai harus berupa daftar tipe indeks yang dipisahkan koma (dalam urutan apa pun) atau Tidak Ada tanpa indeks. Secara default kode pos yang diperluas disertakan untuk semua indeks kecuali Geo. Daftar kode pos yang diperluas untuk geografi bisa sangat panjang sehingga harus diminta secara eksplisit saat diperlukan. Contoh penggunaan: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Kode pos yang diperluas dikembalikan sebagai properti extendedPostalCode dari alamat. Ketersediaan bergantung pada wilayah.
SearchSummary	Objek ringkasan untuk respons API Search.

Address

Alamat hasil

Nama	Jenis	Deskripsi
boundingBox	BoundingBoxCompassNotation	Kotak pembatas lokasi.
buildingNumber	string	Nomor bangunan di jalan. TIDAK DIGUNAKAN LAGI, gunakan streetNumber sebagai gantinya.
country	string	nama negara/wilayah
countryCode	string	Negara (Catatan: Ini adalah kode dua huruf, bukan nama negara/wilayah.)
countryCodeISO3	string	Kode negara ISO alpha-3
countrySecondarySubdivision	string	County
countrySubdivision	string	Negara Bagian atau Provinsi
countrySubdivisionCode	string	`countrySubdivisionCode` diawali oleh `countryCode` ( countryCode-countrySubdivisionCode ) dan tanda hubung membentuk kode ISO 3166-2. Contoh: TX untuk Texas, SCT untuk Skotlandia dan ON untuk Ontario.
countrySubdivisionName	string	Nama lengkap hierarki administratif negara/wilayah tingkat pertama. Bidang ini hanya muncul jika countrySubdivision disajikan dalam bentuk singkatan. Hanya didukung untuk AS, Kanada, dan Inggris Raya.
countryTertiarySubdivision	string	Area Bernama
crossStreet	string	Nama jalan yang disilangkan.
extendedPostalCode	string	Kode pos yang diperluas (ketersediaan tergantung pada wilayah).
freeformAddress	string	Baris alamat yang diformat sesuai dengan aturan pemformatan negara/wilayah asal Hasil, atau dalam kasus negara/wilayah, nama negara/wilayah lengkapnya.
localName	string	Komponen alamat yang mewakili nama area geografis atau lokalitas yang mengelompokkan beberapa objek yang dapat dialamatkan untuk tujuan alamat, tanpa menjadi unit administratif. Bidang ini digunakan untuk membangun `freeformAddress` properti . `localName` mewakili kotamadya pos. Tergantung pada lokasinya, `localName` adalah nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, gunakan `localName` alih-alih `municipality`.
municipality	string	Kota /Kota Catatan: `municipality` mewakili kotamadya perumahan. Tergantung pada lokasinya, nilainya `municipality` mungkin berbeda dari nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, disarankan agar `localName` nilai digunakan alih-alih `municipality` nilai .
municipalitySubdivision	string	Sub / Kota Super
neighbourhood	string	Lingkungan adalah daerah yang secara geografis terlokalisasi dalam kota atau kota dengan karakteristik yang khas dan interaksi sosial antara penduduk.
postalCode	string	Kode Pos / Kode Pos
routeNumbers	string[]	Kode yang digunakan untuk mengidentifikasi jalan secara tidak ambigu
street	string	Nama jalan. TIDAK DIGUNAKAN LAGI, gunakan streetName sebagai gantinya.
streetName	string	Nama jalan.
streetNameAndNumber	string	Nama dan nomor jalan.
streetNumber	string	Nomor bangunan di jalan.

AddressRanges

Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.

Nama	Jenis	Deskripsi
from	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
rangeLeft	string	Rentang alamat di sisi kiri jalan.
rangeRight	string	Rentang alamat di sisi kanan jalan.
to	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

BoundingBox

Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah viewport.

Nama	Jenis	Deskripsi
btmRightPoint	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

BoundingBoxCompassNotation

Kotak pembatas lokasi.

Nama	Jenis	Deskripsi
entity	Entity	Sumber jenis entitas dari kotak pembatas. Untuk geocoding terbalik, ini selalu sama dengan posisi.
northEast	string	Garis lintang utara-timur, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma
southWest	string	Garis lintang selatan-barat, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma

Brand

Merek yang terkait dengan POI

Nama	Jenis	Deskripsi
name	string	Nama merek

Classification

Klasifikasi untuk POI yang dikembalikan

Nama	Jenis	Deskripsi
code	string	Properti kode
names	ClassificationName[]	Array nama

ClassificationName

Nama untuk klasifikasi

Nama	Jenis	Deskripsi
name	string	Properti nama
nameLocale	string	Properti Name Locale

DataSources

Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.

Nama	Jenis	Deskripsi
geometry	Geometry	Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi.

Entity

Sumber jenis entitas dari kotak pembatas. Untuk geocoding terbalik, ini selalu sama dengan posisi.

Nama	Jenis	Deskripsi
position	string	Entitas posisi

EntryPoint

Titik masuk untuk POI yang dikembalikan.

Nama	Jenis	Deskripsi
position	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
type	EntryPointType	Jenis titik masuk. Nilai dapat berupa utama atau minor.

EntryPointType

Jenis titik masuk. Nilai dapat berupa utama atau minor.

Nama	Jenis	Deskripsi
main	string
minor	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

GeographicEntityType

Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.

Nama	Jenis	Deskripsi
Country	string	nama negara/wilayah
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Negara Bagian atau Provinsi
CountryTertiarySubdivision	string	Area Bernama
Municipality	string	Kota/Kota
MunicipalitySubdivision	string	Sub / Kota Super
Neighbourhood	string	Lingkungan
PostalCodeArea	string	Kode Pos / Kode Pos

Geometry

Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi.

Nama	Jenis	Deskripsi
id	string	Teruskan ini sebagai geometryId ke Get Search Polygon API untuk mengambil informasi geometri untuk hasil ini.

LatLongPairAbbreviated

Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

Nama	Jenis	Deskripsi
lat	number	Properti garis lintang
lon	number	Properti garis bujur

LocalizedMapView

Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara/wilayah yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara/wilayah yang akan dilayani aplikasi Anda. Secara default, parameter Tampilan diatur ke "Terpadu" meskipun Anda belum menentukannya dalam permintaan. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Atau, Anda memiliki opsi untuk mengatur 'View=Auto', yang akan mengembalikan data peta berdasarkan alamat IP permintaan. Parameter Tampilan di Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang anda berwenang untuk mengakses melalui Azure Maps tersedia. Contoh: view=IN.

Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

Nama	Jenis	Deskripsi
AE	string	Uni Emirat Arab (Tampilan Arab)
AR	string	Argentina (Tampilan Argentina)
Auto	string	Kembalikan data peta berdasarkan alamat IP permintaan.
BH	string	Bahrain (Tampilan Arab)
IN	string	India (Tampilan India)
IQ	string	Irak (Tampilan Arab)
JO	string	Yordania (Tampilan Arab)
KW	string	Kuwait (Tampilan Arab)
LB	string	Lebanon (Tampilan Arab)
MA	string	Maroko (Tampilan Maroko)
OM	string	Oman (Tampilan Arab)
PK	string	Pakistan (Tampilan Pakistan)
PS	string	Otoritas Palestina (Tampilan Arab)
QA	string	Qatar (Tampilan Arab)
SA	string	Arab Saudi (Tampilan Arab)
SY	string	Suriah (Tampilan Arab)
Unified	string	Tampilan Terpadu (Lainnya)
YE	string	Yaman (Tampilan Arab)

MatchType

Jenis kecocokan untuk operasi pencarian alamat terbalik.

Nama	Jenis	Deskripsi
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Jam buka untuk POI (Tempat Menarik).

Nama	Jenis	Deskripsi
mode	string	Nilai yang digunakan dalam permintaan: tidak ada atau "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Daftar rentang waktu selama 7 hari ke depan

OperatingHoursTime

Mewakili tanggal dan waktu

Nama	Jenis	Deskripsi
date	string	Mewakili tanggal kalender saat ini di zona waktu POI, misalnya "2019-02-07".
hour	integer	Jam dalam format 24 jam dalam waktu lokal POI; nilai yang mungkin adalah 0 - 23.
minute	integer	Menit berada di waktu lokal POI; nilai yang mungkin adalah 0 - 59.

OperatingHoursTimeRange

Rentang waktu buka selama sehari

Nama	Jenis	Deskripsi
endTime	OperatingHoursTime	Titik dalam rentang 7 hari berikutnya ketika POI tertentu ditutup, atau awal rentang jika ditutup sebelum rentang.
startTime	OperatingHoursTime	Titik dalam rentang 7 hari berikutnya ketika POI tertentu sedang dibuka, atau awal rentang jika dibuka sebelum rentang.

PointOfInterest

Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.

Nama	Jenis	Deskripsi
brands	Brand[]	Array merek. Nama merek untuk POI yang dikembalikan.
categories	string[]	Kategori array
categorySet	PointOfInterestCategorySet[]	Daftar kategori POI yang paling spesifik
classifications	Classification[]	Array klasifikasi
name	string	Nama properti POI
openingHours	OperatingHours	Jam buka untuk POI (Tempat Menarik).
phone	string	Properti nomor telepon
url	string	Properti URL Situs Web

PointOfInterestCategorySet

Kategori POI

Nama	Jenis	Deskripsi
id	integer	ID Kategori

QueryType

Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.

Nama	Jenis	Deskripsi
NEARBY	string	Search dilakukan di sekitar lintang dan bujur tertentu dengan radius yang ditentukan
NON_NEAR	string	Search dilakukan secara global, tanpa bias pada lintang dan bujur tertentu, dan tidak ada radius yang ditentukan

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml.

Nama	Jenis	Deskripsi
json	string	Format Pertukaran Data Notasi Objek JavaScript
xml	string	Bahasa Markup yang Dapat Diperluas

SearchAddressResult

Objek ini dikembalikan dari panggilan Search yang berhasil.

Nama	Jenis	Deskripsi
results	SearchAddressResultItem[]	Daftar hasil API Search.
summary	SearchSummary	Objek ringkasan untuk respons API Search

SearchAddressResultItem

Objek hasil untuk respons API Search.

Nama	Jenis	Deskripsi
address	Address	Alamat hasil
addressRanges	AddressRanges	Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.
dataSources	DataSources	Bagian opsional. Mereferensikan id geometri untuk digunakan dengan Get Search Polygon API.
detourTime	integer	Waktu memutar dalam hitung detik. Hanya dikembalikan untuk panggilan ke Search Along Route API.
dist	number	Jarak garis lurus antara lokasi hasil dan geobias dalam meter.
entityType	GeographicEntityType	Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
entryPoints	EntryPoint[]	Array of EntryPoints. Mereka menggambarkan jenis pintu masuk yang tersedia di lokasi. Jenisnya bisa "utama" untuk pintu masuk utama seperti pintu depan, atau lobi, dan "kecil", untuk pintu samping dan belakang.
id	string	Properti id
info	string	Informasi tentang sumber data asli Hasil. Digunakan untuk permintaan dukungan.
matchType	MatchType	Informasi tentang jenis kecocokan. Salah satu: AddressPoint HouseNumberRange Jalan
poi	PointOfInterest	Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.
position	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
score	number	Nilai dalam hasil diatur untuk menunjukkan skor pencocokan relatif antara hasil. Anda dapat menggunakan ini untuk menentukan bahwa hasil x dua kali lebih mungkin relevan sebagai hasil y jika nilai x adalah 2x nilai y. Nilai bervariasi di antara kueri dan hanya dimaksudkan sebagai nilai relatif untuk satu tataan hasil.
type	SearchAddressResultType	Salah satu: POI Jalan Geografi Alamat Titik Rentang Alamat Lintas Jalan
viewport	BoundingBox	Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah dari viewport.

SearchAddressResultType

Salah satu:

POI
Jalan
Geografi
Alamat Titik
Rentang Alamat
Lintas Jalan

Nama	Jenis	Deskripsi
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchIndexes

Indeks yang kode pos yang diperluas harus disertakan dalam hasil.

Indeks yang tersedia adalah:

Addr = Rentang alamat

Geo = Geografi

PAD = Alamat Titik

POI = Lokasi Menarik

Str = Jalanan

XStr = Lintas Jalan (persimpangan)

Nilai harus berupa daftar tipe indeks yang dipisahkan koma (dalam urutan apa pun) atau Tidak Ada tanpa indeks.

Secara default kode pos yang diperluas disertakan untuk semua indeks kecuali Geo. Daftar kode pos yang diperluas untuk geografi bisa sangat panjang sehingga harus diminta secara eksplisit saat diperlukan.

Contoh penggunaan:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Kode pos yang diperluas dikembalikan sebagai properti extendedPostalCode dari alamat. Ketersediaan bergantung pada wilayah.

Nama	Jenis	Deskripsi
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	string

SearchSummary

Objek ringkasan untuk respons API Search.

Nama	Jenis	Deskripsi
fuzzyLevel	integer	Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil.
geoBias	LatLongPairAbbreviated	Indikasi ketika mesin pencari internal telah menerapkan bias geospasial untuk meningkatkan peringkat hasil. Dalam beberapa metode, ini dapat dipengaruhi dengan mengatur parameter lat dan lon jika tersedia. Dalam kasus lain itu murni internal.
limit	integer	Jumlah maksimum respons yang akan dikembalikan
numResults	integer	Jumlah hasil dalam respons.
offset	integer	Offset awal dari Hasil yang dikembalikan dalam tataan Hasil lengkap.
query	string	Parameter kueri yang digunakan untuk menghasilkan hasil pencarian ini.
queryTime	integer	Waktu yang dihabiskan untuk menyelesaikan kueri, dalam milidetik.
queryType	QueryType	Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.
totalResults	integer	Jumlah total Hasil yang ditemukan.

Share via