Search - Get Search POI
Gunakan untuk mencari tempat menarik berdasarkan nama.
Points of Interest (POI) Search
API adalah permintaan HTTP GET
yang memungkinkan Anda meminta hasil POI berdasarkan nama. Ini juga mendukung parameter kueri tambahan seperti bahasa dan hasil pemfilteran berdasarkan area minat yang didorong oleh negara/wilayah atau kotak pembatas. Titik Akhir hanya akan mengembalikan hasil POI yang cocok dengan string kueri. Respons mencakup detail POI seperti alamat, lokasi koordinat, dan kategori.
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
|
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
query
|
query | True |
string |
Nama POI yang akan dicari (misalnya, "statue of liberty", "starbucks"), harus dikodekan dengan benar URL. |
brand
|
query |
string[] |
Daftar nama merek yang dipisahkan koma yang dapat digunakan untuk membatasi hasilnya ke merek tertentu. Urutan item tidak masalah. Ketika beberapa merek disediakan, hanya hasil milik (setidaknya) salah satu daftar yang disediakan yang akan dikembalikan. Merek yang berisi "," dalam namanya harus dimasukkan ke dalam tanda kutip. Contoh penggunaan: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar |
|
btm
|
query |
string |
Posisi kanan bawah kotak pembatas. Misalnya 37.553,-122.453 |
|
category
|
query |
integer[] |
Daftar ID set kategori yang dipisahkan koma yang dapat digunakan untuk membatasi hasilnya ke kategori Poin Minat tertentu. Pesanan ID tidak masalah. Jumlah maksimum nilai yang
|
|
connector
|
query |
Daftar jenis konektor yang dipisahkan koma yang dapat digunakan untuk membatasi hasilnya ke Stasiun Kendaraan Listrik yang mendukung jenis konektor tertentu. Urutan item tidak masalah. Ketika beberapa jenis konektor disediakan, hanya hasil milik (setidaknya) salah satu daftar yang disediakan yang akan dikembalikan. Jenis konektor yang tersedia adalah:
Contoh penggunaan: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
String kode negara/wilayah yang dipisahkan koma, misalnya FR,ES. Ini akan membatasi pencarian ke negara/wilayah yang ditentukan |
|
extended
|
query |
Indeks yang kode pos yang diperluas harus disertakan dalam hasil. Indeks yang tersedia adalah: POI = Lokasi Menarik Nilai harus LYD atau Tidak Ada untuk menonaktifkan kode pos yang diperluas. Secara default kode pos yang diperluas disertakan. Contoh penggunaan: extendedPostalCodesFor=POI extendedPostalCodesFor=None Kode pos yang diperluas dikembalikan sebagai properti extendedPostalCode dari alamat. Ketersediaan bergantung pada wilayah. |
||
language
|
query |
string |
Bahasa di mana 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 dari hasil yang dikembalikan dalam tataan hasil lengkap. Default: 0 |
|
opening
|
query |
Jam operasional untuk POI (Tempat Menarik). Ketersediaan jam operasi akan bervariasi berdasarkan data yang tersedia. Jika tidak lulus, maka tidak ada informasi jam buka yang akan dikembalikan. Nilai yang didukung: nextSevenDays |
||
radius
|
query |
integer |
Radius dalam meter ke agar hasil dibatasi ke area yang ditentukan |
|
top
|
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 |
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 |
OK |
|
Other Status Codes |
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 akun sumber daya atau sub-sumber daya Azure Maps. 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 pemodelan 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 meminta 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.
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
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 diterbitkan.
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.
Jenis:
apiKey
Dalam:
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 fine-grain ke kedaluwarsa, tarif, 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 spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.
Jenis:
apiKey
Dalam:
header
Contoh
Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Permintaan sampel
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
Respon sampel
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Address |
Alamat hasil |
Address |
Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan. |
Bounding |
Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah dari viewport. |
Bounding |
Kotak pembatas lokasi. |
Brand |
Merek yang terkait dengan POI |
Classification |
Klasifikasi untuk POI yang dikembalikan |
Classification |
Nama untuk klasifikasi |
Data |
Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API. |
Electric |
Daftar jenis konektor yang dipisahkan koma yang dapat digunakan untuk membatasi hasilnya ke Stasiun Kendaraan Listrik yang mendukung jenis konektor tertentu. Urutan item tidak masalah. Ketika beberapa jenis konektor disediakan, hanya hasil yang termasuk dalam (setidaknya) salah satu daftar yang disediakan yang akan dikembalikan. Jenis konektor yang tersedia adalah:
Contoh penggunaan: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi. |
Entry |
Titik masuk untuk POI yang dikembalikan. |
Entry |
Jenis titik masuk. Nilai dapat berupa utama atau kecil. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Geographic |
Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia. |
Geometry |
Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi. |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
Localized |
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 hukum yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang berwenang untuk Anda akses melalui Azure Maps tersedia. Contoh: view=IN. Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia. |
Match |
Jenis kecocokan untuk operasi pencarian alamat terbalik. |
Operating |
Jam buka untuk POI (Tempat Menarik). |
Operating |
Jam operasional untuk POI (Tempat Menarik). Ketersediaan jam operasi akan bervariasi berdasarkan data yang tersedia. Jika tidak lulus, maka tidak ada informasi jam buka yang akan dikembalikan. Nilai yang didukung: nextSevenDays |
Operating |
Mewakili tanggal dan waktu |
Operating |
Buka rentang waktu selama sehari |
Point |
Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi. |
Point |
Kategori POI |
Point |
Indeks yang kode pos yang diperluas harus disertakan dalam hasil. Indeks yang tersedia adalah: POI = Tempat Menarik Nilai harus POI atau Tidak Ada untuk menonaktifkan kode pos yang diperluas. Secara default, kode pos yang diperluas disertakan. Contoh penggunaan: extendedPostalCodesFor=POI extendedPostalCodesFor=None Kode pos yang diperluas dikembalikan sebagai properti extendedPostalCode dari alamat. Ketersediaan bergantung pada wilayah. |
Query |
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. |
Response |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
Search |
Objek ini dikembalikan dari panggilan Search yang berhasil. |
Search |
Objek hasil untuk respons API Search. |
Search |
Salah satu:
|
Search |
Objek ringkasan untuk respons API Search. |
Address
Alamat hasil
Nama | Jenis | Deskripsi |
---|---|---|
boundingBox |
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 |
|
countrySubdivisionName |
string |
Nama lengkap hierarki administratif negara/wilayah tingkat pertama. Bidang ini hanya muncul jika countrySubdivision disajikan dalam bentuk singkatan. Hanya didukung untuk Amerika Serikat, 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 diatasi untuk tujuan alamat, tanpa menjadi unit administratif. Bidang ini digunakan untuk membangun |
municipality |
string |
Kota/Kota |
municipalitySubdivision |
string |
Sub / Kota Super |
neighbourhood |
string |
Lingkungan adalah area yang dilokalkan secara geografis di dalam kota atau kota dengan karakteristik khas dan interaksi sosial antara penduduk. |
postalCode |
string |
Kode Pos / Kode Pos |
routeNumbers |
string[] |
Kode yang digunakan untuk secara tidak ambigu mengidentifikasi jalan |
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 |
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 |
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 dari viewport.
Nama | Jenis | Deskripsi |
---|---|---|
btmRightPoint |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
|
topLeftPoint |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
BoundingBoxCompassNotation
Kotak pembatas lokasi.
Nama | Jenis | Deskripsi |
---|---|---|
entity |
Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi. |
|
northEast |
string |
Garis lintang utara-timur, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma |
southWest |
string |
Garis lintang barat daya, 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 |
Array nama |
ClassificationName
Nama untuk klasifikasi
Nama | Jenis | Deskripsi |
---|---|---|
name |
string |
Properti nama |
nameLocale |
string |
Properti Lokal Nama |
DataSources
Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.
Nama | Jenis | Deskripsi |
---|---|---|
geometry |
Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi. |
ElectricVehicleConnector
Daftar jenis konektor yang dipisahkan koma yang dapat digunakan untuk membatasi hasilnya ke Stasiun Kendaraan Listrik yang mendukung jenis konektor tertentu. Urutan item tidak masalah. Ketika beberapa jenis konektor disediakan, hanya hasil yang termasuk dalam (setidaknya) salah satu daftar yang disediakan yang akan dikembalikan.
Jenis konektor yang tersedia adalah:
-
StandardHouseholdCountrySpecific
- Ini adalah konektor rumah tangga standar untuk wilayah tertentu. Semuanya adalah fase tunggal AC dan Tegangan standar dan Amperase standar. Lihat juga: Plug & jenis soket - Standar Dunia. -
IEC62196Type1
- Konektor Tipe 1 seperti yang didefinisikan dalam standar IEC 62196-2. Juga disebut Yazaki setelah produsen asli atau SAE J1772 setelah standar yang pertama kali menerbitkannya. Sebagian besar digunakan dalam kombinasi dengan fase tunggal 120V atau infrastruktur fase tunggal hingga 240V. -
IEC62196Type1CCS
- Konektor kombo berbasis Tipe 1 seperti yang didefinisikan dalam standar IEC 62196-3. Konektor didasarkan pada konektor Tipe 1 - seperti yang didefinisikan dalam standar IEC 62196-2 - dengan dua kontak arus langsung (DC) tambahan untuk memungkinkan pengisian daya cepat DC. -
IEC62196Type2CableAttached
- Konektor Tipe 2 seperti yang didefinisikan dalam standar IEC 62196-2. Disediakan sebagai kabel dan dicolokkan ke titik pengisian daya. -
IEC62196Type2Outlet
- Konektor Tipe 2 seperti yang didefinisikan dalam standar IEC 62196-2. Disediakan sebagai soket yang diatur ke dalam titik pengisian daya. -
IEC62196Type2CCS
- Konektor kombo berbasis Tipe 2 seperti yang didefinisikan dalam standar IEC 62196-3. Konektor didasarkan pada konektor Tipe 2 – seperti yang didefinisikan dalam standar IEC 62196-2 – dengan dua kontak arus langsung (DC) tambahan untuk memungkinkan pengisian daya cepat DC. -
IEC62196Type3
- Konektor Tipe 3 seperti yang didefinisikan dalam standar IEC 62196-2. Juga disebut Scame setelah produsen asli. Sebagian besar digunakan dalam kombinasi dengan fase tunggal hingga 240V atau hingga 420V tiga fase infrastruktur. -
Chademo
- Konektor CHAdeMO dinamai sesuai dengan asosiasi yang dibentuk oleh Tokyo Electric Power Company dan mitra industri. Karena itu juga dikenal sebagai konektor TEPCO. Ini mendukung pengisian daya DC yang cepat. -
IEC60309AC1PhaseBlue
- Konektor Biru Industri adalah konektor yang ditentukan dalam standar IEC 60309. Ini kadang-kadang disebut sebagai oleh beberapa kombinasi standar, warna dan fakta bahwa adalah konektor fase tunggal. Konektor biasanya memiliki konfigurasi "P+N+E, 6h". -
IEC60309DCWhite
- Konektor Industrial White adalah konektor DC yang ditentukan dalam standar IEC 60309. -
Tesla
- Konektor Tesla adalah konektor Tesla Supercharger khusus regional. Yaitu mengacu pada konektor milik Tesla, kadang-kadang disebut sebagai Tesla Port yang sebagian besar terbatas pada Amerika Utara atau Tipe 2 yang dimodifikasi (DC melalui Tipe 2) di Eropa.
Contoh penggunaan:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Nama | Jenis | Deskripsi |
---|---|---|
Chademo |
string |
Konektor CHAdeMO dinamai sesuai dengan asosiasi yang dibentuk oleh Tokyo Electric Power Company dan mitra industri. Karena itu juga dikenal sebagai konektor TEPCO. Ini mendukung pengisian daya DC yang cepat. |
IEC60309AC1PhaseBlue |
string |
Konektor Industrial Blue adalah konektor yang ditentukan dalam standar IEC 60309. Ini kadang-kadang disebut sebagai oleh beberapa kombinasi standar, warna dan fakta bahwa adalah konektor fase tunggal. Konektor biasanya memiliki konfigurasi "P+N+E, 6h". |
IEC60309DCWhite |
string |
Konektor Industrial White adalah konektor DC yang ditentukan dalam standar IEC 60309. |
IEC62196Type1 |
string |
Konektor Tipe 1 seperti yang didefinisikan dalam standar IEC 62196-2. Juga disebut Yazaki setelah produsen asli atau SAE J1772 setelah standar yang pertama kali menerbitkannya. Sebagian besar digunakan dalam kombinasi dengan fase tunggal 120V atau infrastruktur fase tunggal hingga 240V. |
IEC62196Type1CCS |
string |
Konektor kombo berbasis tipe 1 seperti yang didefinisikan dalam standar IEC 62196-3. Konektor didasarkan pada konektor Tipe 1 - seperti yang didefinisikan dalam standar IEC 62196-2 - dengan dua kontak arus langsung (DC) tambahan untuk memungkinkan pengisian daya cepat DC. |
IEC62196Type2CCS |
string |
Konektor kombo berbasis tipe 2 seperti yang didefinisikan dalam standar IEC 62196-3. Konektor didasarkan pada konektor Tipe 2 – seperti yang didefinisikan dalam standar IEC 62196-2 – dengan dua kontak arus langsung (DC) tambahan untuk memungkinkan pengisian daya cepat DC. |
IEC62196Type2CableAttached |
string |
Konektor Tipe 2 seperti yang didefinisikan dalam standar IEC 62196-2. Disediakan sebagai kabel dan steker yang terpasang pada titik pengisian daya |
IEC62196Type2Outlet |
string |
Konektor Tipe 2 seperti yang didefinisikan dalam standar IEC 62196-2. Disediakan sebagai soket yang diatur ke dalam titik pengisian daya. |
IEC62196Type3 |
string |
Konektor Tipe 3 seperti yang didefinisikan dalam standar IEC 62196-2. Juga disebut Scame setelah produsen asli. Sebagian besar digunakan dalam kombinasi dengan fase tunggal hingga 240V atau hingga 420V tiga fase infrastruktur. |
StandardHouseholdCountrySpecific |
string |
Ini adalah konektor rumah tangga standar untuk wilayah tertentu. Semuanya adalah fase tunggal AC dan Tegangan standar dan Amperase standar. Lihat juga: Plug & jenis soket - Standar Dunia |
Tesla |
string |
Konektor Tesla adalah konektor Tesla Supercharger khusus regional. Yaitu mengacu pada konektor milik Tesla, kadang-kadang disebut sebagai Tesla Port yang sebagian besar terbatas pada Amerika Utara atau Tipe 2 yang dimodifikasi (DC melalui Tipe 2) di Eropa. |
Entity
Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.
Nama | Jenis | Deskripsi |
---|---|---|
position |
string |
Entitas posisi |
EntryPoint
Titik masuk untuk POI yang dikembalikan.
Nama | Jenis | Deskripsi |
---|---|---|
position |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
|
type |
Jenis titik masuk. Nilai dapat berupa utama atau kecil. |
EntryPointType
Jenis titik masuk. Nilai dapat berupa utama atau kecil.
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 |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
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 hukum yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang berwenang untuk Anda akses 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 |
Daftar rentang waktu selama 7 hari ke depan |
OperatingHoursRange
Jam operasional untuk POI (Tempat Menarik). Ketersediaan jam operasi akan bervariasi berdasarkan data yang tersedia. Jika tidak lulus, maka tidak ada informasi jam buka yang akan dikembalikan. Nilai yang didukung: nextSevenDays
Nama | Jenis | Deskripsi |
---|---|---|
nextSevenDays |
string |
Menunjukkan jam operasi untuk minggu depan, dimulai dengan hari saat ini di waktu lokal LYD. |
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 LYD; nilai yang mungkin adalah 0 - 23. |
minute |
integer |
Menit berada di waktu lokal LYD; nilai yang mungkin adalah 0 - 59. |
OperatingHoursTimeRange
Buka rentang waktu selama sehari
Nama | Jenis | Deskripsi |
---|---|---|
endTime |
Titik dalam rentang 7 hari berikutnya ketika LYD tertentu ditutup, atau awal rentang jika ditutup sebelum rentang. |
|
startTime |
Titik dalam rentang 7 hari berikutnya ketika LYD 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 |
Daftar kategori POI yang paling spesifik |
|
classifications |
Array klasifikasi |
|
name |
string |
Nama properti POI |
openingHours |
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 |
PointOfInterestExtendedPostalCodes
Indeks yang kode pos yang diperluas harus disertakan dalam hasil.
Indeks yang tersedia adalah:
POI = Tempat Menarik
Nilai harus POI atau Tidak Ada untuk menonaktifkan kode pos yang diperluas.
Secara default, kode pos yang diperluas disertakan.
Contoh penggunaan:
extendedPostalCodesFor=POI
extendedPostalCodesFor=None
Kode pos yang diperluas dikembalikan sebagai properti extendedPostalCode dari alamat. Ketersediaan bergantung pada wilayah.
Nama | Jenis | Deskripsi |
---|---|---|
None |
string |
|
POI |
string |
QueryType
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.
Nama | Jenis | Deskripsi |
---|---|---|
NEARBY |
string |
Search dilakukan di sekitar garis 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 |
|
xml |
string |
SearchAddressResult
Objek ini dikembalikan dari panggilan Search yang berhasil.
Nama | Jenis | Deskripsi |
---|---|---|
results |
Daftar hasil API Search. |
|
summary |
Objek ringkasan untuk respons API Search |
SearchAddressResultItem
Objek hasil untuk respons API Search.
Nama | Jenis | Deskripsi |
---|---|---|
address |
Alamat hasil |
|
addressRanges |
Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan. |
|
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 |
Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia. |
|
entryPoints |
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 |
Informasi tentang jenis kecocokan. Salah satu:
|
|
poi |
Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi. |
|
position |
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 |
Salah satu:
|
|
viewport |
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 |
SearchSummary
Objek ringkasan untuk respons API Search.
Nama | Jenis | Deskripsi |
---|---|---|
fuzzyLevel |
integer |
Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil. |
geoBias |
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 |
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. |
|
totalResults |
integer |
Jumlah total Hasil yang ditemukan. |