Search - Post Search Inside Geometry
Gunakan untuk melakukan pencarian formulir gratis di dalam satu geometri lagi.
Post Search Inside Geometry
API adalah dan HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a
POSTrequest where the request body will contain the
geometriobject represented as a
GeoJSONtype and the
Content-Typeheader will be set to
application/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following
GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>The
geometrican be represented as a
GeoJSON FeatureCollection FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. The
can contain a max of 50
GeoJSONobjects. Each
Fiturobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A
object for the Circle geometry is composed of a _center_ represented using a
object should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A
GeoJSON Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sample
FeatureColle geometrican be represented as a
geoJSONrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>The
GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. The
GeometryCollectioncan contain a max of 50
GeoJSON Polygonobjects. Each
object can have a max of 50 coordinates. Please see the Examples section below for a sample
GeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>The
geometrican be represented as a
GeoJSON Polygon Polygon Polygonobject. This is the recommended option if the geometry contains a single Polygon. The
object can have a max of 50 coordinates. Please see the Examples section below for a sample
Representasi poligon.
.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Response |
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 untuk dicari (misalnya, "patung kebebasan", "starbucks", "pizza"). Harus dikodekan URL dengan benar. |
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
|
|
extended
|
query |
Search |
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 |
Search |
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. |
|
limit
|
query |
integer |
Jumlah maksimum respons yang akan dikembalikan. Default: 10, minimum: 1 dan maksimum: 100 |
|
opening
|
query |
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 |
|
view
|
query |
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 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. |
Isi Permintaan
Nama | Jenis | Deskripsi |
---|---|---|
geometry |
GeoJsonObject:
|
Objek yang valid |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Search |
OK |
Other Status Codes |
Error |
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.
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 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.
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 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.
Type:
apiKey
In:
header
Contoh
Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Sample Request
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
Sample Response
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Sample Request
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
Sample Response
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
Sample Request
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
Sample Response
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
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. |
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. |
Geo |
Jenis objek yang valid |
Geo |
Jenis objek yang valid |
Geo |
Objek geometri yang valid |
Geo |
Jenis objek yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis objek yang valid |
Geo |
Jenis geometri yang valid |
Geo |
Jenis geometri yang valid |
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 |
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 |
Jenis ini mewakili isi permintaan untuk layanan Search Inside Geometry. |
Search |
Objek ringkasan untuk respons API Search. |
Address
Alamat hasil
Nama | Jenis | Deskripsi |
---|---|---|
boundingBox |
Bounding |
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 |
Lat |
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 |
Lat |
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 |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
topLeftPoint |
Lat |
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 |
Classification |
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. |
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 |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
type |
Entry |
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 |
Error |
Info tambahan kesalahan. |
code |
string |
Kode kesalahan. |
details |
Error |
Detail kesalahan. |
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
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 |
GeoJsonFeature
Jenis objek yang valid GeoJSON Feature
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
featureType |
string |
Jenis fitur. Nilai tergantung pada model data, fitur saat ini adalah bagian dari. Beberapa model data mungkin memiliki nilai kosong. |
geometry |
GeoJsonGeometry:
|
Objek geometri yang valid |
id |
string |
Pengidentifikasi untuk fitur tersebut. |
type |
string:
Feature |
Menentukan jenis. |
GeoJsonFeatureCollection
Jenis objek yang valid GeoJSON FeatureCollection
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
features |
Geo |
Berisi daftar objek yang valid |
type |
string:
Feature |
Menentukan jenis. |
GeoJsonGeometry
Objek geometri yang valid GeoJSON
. Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
type |
Geo |
Menentukan jenis. |
GeoJsonGeometryCollection
Jenis objek yang valid GeoJSON GeometryCollection
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
geometries |
GeoJsonGeometry[]:
|
Berisi daftar objek geometri yang valid |
type |
string:
Geometry |
Menentukan jenisnya |
GeoJsonLineString
Jenis geometri yang valid GeoJSON LineString
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Line |
Menentukan jenisnya |
GeoJsonMultiLineString
Jenis geometri yang valid GeoJSON MultiLineString
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Multi |
Menentukan jenisnya |
GeoJsonMultiPoint
Jenis geometri yang valid GeoJSON MultiPoint
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Multi |
Menentukan jenisnya |
GeoJsonMultiPolygon
Jenis objek yang valid GeoJSON MultiPolygon
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Berisi daftar objek yang valid |
type |
string:
Multi |
Menentukan jenisnya |
GeoJsonPoint
Jenis geometri yang valid GeoJSON Point
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
|
type |
string:
Point |
Menentukan jenisnya |
GeoJsonPolygon
Jenis geometri yang valid GeoJSON Polygon
. Silakan merujuk ke RFC 7946 untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
coordinates |
number[] |
Koordinat |
type |
string:
Polygon |
Menentukan jenisnya |
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 |
Operating |
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 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 |
Operating |
Titik dalam rentang 7 hari berikutnya ketika LYD tertentu ditutup, atau awal rentang jika ditutup sebelum rentang. |
startTime |
Operating |
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 |
Point |
Daftar kategori POI yang paling spesifik |
classifications |
Array klasifikasi |
|
name |
string |
Nama properti POI |
openingHours |
Operating |
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 |
Search |
Daftar hasil API Search. |
summary |
Search |
Objek ringkasan untuk respons API Search |
SearchAddressResultItem
Objek hasil untuk respons API Search.
Nama | Jenis | Deskripsi |
---|---|---|
address |
Alamat hasil |
|
addressRanges |
Address |
Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan. |
dataSources |
Data |
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 |
Geographic |
Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia. |
entryPoints |
Entry |
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 |
Match |
Informasi tentang jenis kecocokan. Salah satu:
|
poi |
Point |
Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi. |
position |
Lat |
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 |
Search |
Salah satu:
|
viewport |
Bounding |
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 |
SearchInsideGeometryRequest
Jenis ini mewakili isi permintaan untuk layanan Search Inside Geometry.
Nama | Jenis | Deskripsi |
---|---|---|
geometry |
GeoJsonObject:
|
Objek yang valid |
SearchSummary
Objek ringkasan untuk respons API Search.
Nama | Jenis | Deskripsi |
---|---|---|
fuzzyLevel |
integer |
Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil. |
geoBias |
Lat |
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 |
Query |
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. |
totalResults |
integer |
Jumlah total Hasil yang ditemukan. |