Search - Get Search Fuzzy
Gunakan saat Anda memerlukan permintaan pencarian yang dapat menangani kombinasi alamat dan token POI.
Get Search Fuzzy
API (Free Form Search), permintaan HTTP GET
yang dengan mulus menangani kombinasi pencarian POI dan geocoding. Ini adalah API Search Formulir Gratis yang menangani fuzzy input yang berisi kombinasi alamat atau token POI sebagai 'pencarian satu baris' kanonis. Ini juga dapat ditimbang dengan posisi kontekstual (pasangan lat/lon), atau sepenuhnya dibatasi oleh koordinat dan radius, atau dapat dieksekusi lebih umum tanpa titik jangkar geo biasing.
Kami sangat menyarankan Anda untuk menggunakan parameter 'countrySet' untuk menentukan hanya negara/wilayah tempat aplikasi Anda membutuhkan cakupan, karena perilaku defaultnya adalah mencari di seluruh dunia, yang berpotensi mengembalikan hasil yang tidak perlu.
Misalnya: countrySet
=US,FR
Silakan lihat Cakupan Search untuk daftar lengkap semua negara/wilayah yang didukung.
Sebagian besar Search kueri default ke maxFuzzyLevel
=2 untuk mendapatkan performa dan juga mengurangi hasil yang tidak biasa. Default baru ini dapat ditimpa sesuai kebutuhan per permintaan dengan meneruskan param maxFuzzyLevel
kueri =3 atau 4.
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{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}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&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 |
String kueri yang berlaku (misalnya, "seattle", "pizza"). Juga dapat ditentukan sebagai string yang dipisahkan koma yang terdiri dari garis lintang diikuti dengan bujur (misalnya, "47.641268, -122.125679"). Harus dikodekan URL dengan benar. |
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 |
|
entity
|
query |
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:
|
||
extended
|
query |
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. |
||
idx
|
query |
Daftar indeks yang dipisahkan koma yang harus digunakan untuk pencarian. Urutan item tidak masalah. Indeks yang tersedia adalah: Addr = Interpolasi rentang alamat, Geo = Geografi, PAD = Alamat Titik, POI = Tempat menarik, Str = Jalan, Xstr = Lintas Jalan (persimpangan) |
||
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 |
|
max
|
query |
integer |
Tingkat fuzziness maksimum yang akan digunakan. Default: 2, minimum: 1 dan maksimum: 4
Mesin pencari akan mulai mencari kecocokan pada tingkat yang ditentukan oleh minFuzzyLevel, dan akan berhenti mencari pada tingkat yang ditentukan oleh maxFuzzyLevel. |
|
min
|
query |
integer |
Tingkat fuzziness minimum yang akan digunakan. Default: 1, minimum: 1 dan maksimum: 4
Mesin pencari akan mulai mencari kecocokan pada tingkat yang ditentukan oleh minFuzzyLevel, dan akan berhenti mencari pada tingkat yang ditentukan oleh maxFuzzyLevel. |
|
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 City Seattle
Permintaan sampel
GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays
Respon sampel
{
"summary": {
"query": "seattle",
"queryType": "NON_NEAR",
"queryTime": 66,
"numResults": 10,
"offset": 0,
"totalResults": 3720,
"fuzzyLevel": 1
},
"results": [
{
"type": "Geography",
"id": "US/GEO/p0/188055",
"score": 2.531,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60323,
"lon": -122.33028
},
"viewport": {
"topLeftPoint": {
"lat": 47.7344,
"lon": -122.4594
},
"btmRightPoint": {
"lat": 47.48106,
"lon": -122.22497
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-0000596ae8ed"
}
}
},
{
"type": "Geography",
"id": "US/GEO/p0/183911",
"score": 2.382,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.55342,
"lon": -122.25007
},
"viewport": {
"topLeftPoint": {
"lat": 47.58995,
"lon": -122.26723
},
"btmRightPoint": {
"lat": 47.5169,
"lon": -122.23291
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-00006553f33d"
}
}
},
{
"type": "POI",
"id": "ZA/POI/p0/449288",
"score": 2.226,
"info": "search:ta:710009004165863-ZA",
"poi": {
"name": "Seattle Coffee Co - Groote Kerk Sentrum",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Kloof Street",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "8001",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
"localName": "Gardens"
},
"position": {
"lat": -33.92917,
"lon": 18.41178
},
"viewport": {
"topLeftPoint": {
"lat": -33.92827,
"lon": 18.4107
},
"btmRightPoint": {
"lat": -33.93007,
"lon": 18.41286
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.92907,
"lon": 18.41162
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/449396",
"score": 2.226,
"info": "search:ta:710009004163591-ZA",
"poi": {
"name": "Seattle Coffee Co - Pietermaritzburg",
"phone": "+(27)-(33)-3458486",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "9",
"streetName": "Armitage Road",
"municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
"municipality": "Pietermaritzburg",
"countrySecondarySubdivision": "The Msunduzi",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "3201",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
"localName": "Athlone"
},
"position": {
"lat": -29.58611,
"lon": 30.37508
},
"viewport": {
"topLeftPoint": {
"lat": -29.58521,
"lon": 30.37405
},
"btmRightPoint": {
"lat": -29.58701,
"lon": 30.37611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -29.58668,
"lon": 30.37531
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/451868",
"score": 2.226,
"info": "search:ta:710009002195538-ZA",
"poi": {
"name": "Seattle Coffee Co - Bedford Village",
"phone": "+(27)-(84)-5451111",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Van Buuren Road",
"municipalitySubdivision": "Bedfordview",
"municipality": "Germiston",
"countrySecondarySubdivision": "Ekurhuleni",
"countrySubdivisionCode": "Gauteng",
"postalCode": "2007",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
"localName": "Bedfordview"
},
"position": {
"lat": -26.18009,
"lon": 28.13544
},
"viewport": {
"topLeftPoint": {
"lat": -26.17919,
"lon": 28.13444
},
"btmRightPoint": {
"lat": -26.18099,
"lon": 28.13644
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -26.18006,
"lon": 28.13636
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/488888",
"score": 2.226,
"info": "search:ta:710009002102639-ZA",
"poi": {
"name": "Seattle Coffee Co - Caltex Starstop Milly's",
"phone": "+(27)-(13)-2560340",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipality": "Wonderfontein",
"countrySecondarySubdivision": "Emakhazeni",
"countrySubdivisionCode": "Mpumalanga",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
},
"position": {
"lat": -25.68842,
"lon": 30.21291
},
"viewport": {
"topLeftPoint": {
"lat": -25.68752,
"lon": 30.21191
},
"btmRightPoint": {
"lat": -25.68932,
"lon": 30.21391
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -25.68913,
"lon": 30.21343
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489433",
"score": 2.226,
"info": "search:ta:710009002184068-ZA",
"poi": {
"name": "Seattle Coffee Co - Southcoast Mall",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79937,
"lon": 30.40569
},
"viewport": {
"topLeftPoint": {
"lat": -30.79847,
"lon": 30.40464
},
"btmRightPoint": {
"lat": -30.80027,
"lon": 30.40674
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.7994,
"lon": 30.40618
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489976",
"score": 2.226,
"info": "search:ta:710009004261897-ZA",
"poi": {
"name": "Seattle Cofee Co",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79801,
"lon": 30.40557
},
"viewport": {
"topLeftPoint": {
"lat": -30.79711,
"lon": 30.40452
},
"btmRightPoint": {
"lat": -30.79891,
"lon": 30.40662
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.79784,
"lon": 30.40523
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/490056",
"score": 2.226,
"info": "search:ta:710009004149612-ZA",
"poi": {
"name": "Seattle Coffee Co - Constantia Village",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Constantia Main Road",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7708",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
"localName": "Constantia"
},
"position": {
"lat": -34.02087,
"lon": 18.44503
},
"viewport": {
"topLeftPoint": {
"lat": -34.01997,
"lon": 18.44394
},
"btmRightPoint": {
"lat": -34.02177,
"lon": 18.44612
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -34.02017,
"lon": 18.44476
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/494340",
"score": 2.226,
"info": "search:ta:710009004152570-ZA",
"poi": {
"name": "Seattle Coffee Co - Canal Walk Shopping Centre",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Century Boulevard",
"municipalitySubdivision": "Milnerton",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7441",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
"localName": "Century City"
},
"position": {
"lat": -33.89348,
"lon": 18.5122
},
"viewport": {
"topLeftPoint": {
"lat": -33.89258,
"lon": 18.51112
},
"btmRightPoint": {
"lat": -33.89438,
"lon": 18.51328
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.8943,
"lon": 18.51328
}
}
]
}
]
}
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 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 geocoding terbalik, ini selalu sama dengan posisi. |
Entry |
Titik masuk untuk POI yang dikembalikan. |
Entry |
Jenis titik masuk. Nilai dapat berupa utama atau minor. |
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 |
Rentang waktu buka selama sehari |
Point |
Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi. |
Point |
Kategori POI |
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 |
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. |
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 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 |
municipality |
string |
Kota /Kota |
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 |
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 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 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 |
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 |
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 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 |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
|
type |
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 |
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 berikutnya, dimulai dengan hari saat ini di waktu lokal POI. |
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 |
Titik dalam rentang 7 hari berikutnya ketika POI tertentu ditutup, atau awal rentang jika ditutup sebelum rentang. |
|
startTime |
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 |
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 |
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 |
|
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 menjelaskan jenis pintu masuk yang tersedia di lokasi tersebut. Jenisnya bisa "utama" untuk pintu masuk utama seperti pintu depan, atau lobi, dan "minor", 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 sama relevannya dengan 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 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
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.
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 |
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. |