Search - Post Search Address Reverse Batch
Tek bir zaman uyumsuz istekte Arama Adres Ters API'sine bir grup sorgu göndermek için kullanın.
Post Search Address Reverse Batch
API, tek bir zaman uyumsuz API çağrısında Arama Adres Ters API'sine toplu sorgular gönderen bir HTTP POST
isteğidir. API'yi çağırarak Post Search Address Reverse Batch
zaman uyumsuz (zaman uyumsuz) veya zaman uyumlu (eşitleme) çalıştırabilirsiniz. Zaman uyumsuz API, çağıranın en fazla 10.000 sorguyu toplu olarak toplamasına ve API'yi 100 sorguya kadar eşitlemesine olanak tanır.
Zaman Uyumlu Toplu İş İsteği Gönder
Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplanır hesaplanmaz yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API bir zaman aşımı hatası (408 yanıtı) döndürür. Bu API için toplu iş öğelerinin sayısı 100 ile sınırlıdır.
POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Zaman Uyumsuz Toplu İş İsteği Gönderme
Zaman Uyumsuz API, görece karmaşık arama isteklerinin büyük hacimlerini işlemek için uygundur
- Sonuçların ayrı bir çağrıda alınmasına izin verir (birden çok indirme mümkündür).
- Zaman uyumsuz API güvenilirlik için iyileştirilmiştir ve zaman aşımıyla karşılaşılmaması beklenmez.
- Bu API için toplu iş öğelerinin sayısı 10.000 ile sınırlıdır.
Zaman uyumsuz istek kullanarak istek yaptığınızda, hizmet varsayılan olarak yanıt üst bilgisinin Konum alanında yeniden yönlendirme URL'si boyunca bir 202 yanıt kodu döndürür. Yanıt verileri veya hata bilgileri sağlanana kadar bu URL düzenli aralıklarla denetlenmelidir. Zaman uyumsuz yanıtlar 14 gün boyunca depolanır. Yeniden yönlendirme URL'si, son kullanma süresinden sonra kullanılırsa bir 404 yanıtı döndürür.
Zaman uyumsuz toplu iş isteğinin uzun süre çalışan bir işlem olduğunu lütfen unutmayın. Aşağıda tipik bir işlem dizisi verilmiştir:
- İstemci, Azure Haritalar Arama Adres Ters Toplu İş
POST
isteği gönderir.
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}
Sunucu aşağıdakilerden biriyle yanıt verir:
HTTP
202 Accepted
- Toplu iş isteği kabul edildi.HTTP
Error
- Batch isteğiniz işlenirken bir hata oluştu. Bu bir veya başkaError
bir400 Bad Request
durum kodu olabilir.Toplu iş isteği başarıyla kabul edildiyse, yanıttaki üst bilgi toplu
Location
iş isteğinin sonuçlarını indirme URL'sini içerir. Bu durum URI'si aşağıdaki gibi görünür:
GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- İstemci, toplu iş sonuçlarını indirmek için 3. Adımda alınan indirme URL'sinde bir
GET
istek gönderir.
Toplu İstek için POST Gövdesi
Arama adresi ters sorgularını göndermek için istek gövdesinin diziyi batchItems
json
biçiminde içereceği ve Content-Type
üst bilginin olarak ayarlanacağı application/json
bir POST
istek kullanacaksınız. Aşağıda 5 arama adresi ters sorgu içeren bir örnek istek gövdesi verilmişti:
{
"batchItems": [
{"query": "?query=48.858561,2.294911"},
{"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
{"query": "?query=47.621028,-122.348170"},
{"query": "?query=43.722990,10.396695"},
{"query": "?query=40.750958,-73.982336"}
]
}
Toplu işteki arama adresi ters sorgusu yalnızca protokol, temel URL, yol, api sürümü ve abonelik anahtarı olmayan kısmi bir URL'dir. Desteklenen arama adresi tersURI parametrelerinden herhangi birini kabul edebilir. Arama adresi ters sorgusundaki dize değerleri düzgün bir şekilde kaçılmalıdır (örneğin , " karakteri \ ile kaçış karakteri olmalıdır) ve aynı zamanda düzgün URL ile kodlanmış olmalıdır.
Zaman uyumsuz API, çağıranın en çok 10.000 sorguyu toplu işlemesine ve API'yi en çok 100 sorguyu eşitlemesine olanak tanır ve toplu işlem en az 1 sorgu içermelidir.
Zaman Uyumsuz Toplu İş Sonuçlarını İndirme
Zaman uyumsuz toplu iş sonuçlarını indirmek için toplu indirme uç noktasına bir GET
istek gönderirsiniz. Bu indirme URL'si başarılı POST
bir toplu iş isteğinin Location
üst bilgisinden alınabilir ve aşağıdaki gibi görünür:
https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Toplu iş sonuçlarını indirmeye yönelik tipik işlem dizisi aşağıda verilmiştir:
İstemci, indirme URL'sini kullanarak bir
GET
istek gönderir.Sunucu aşağıdakilerden biriyle yanıt verir:
HTTP
202 Accepted
- Toplu iş isteği kabul edildi ancak hala işleniyor. Lütfen bir süre sonra yeniden deneyin.HTTP
200 OK
- Toplu istek başarıyla işlendi. Yanıt gövdesi tüm toplu iş sonuçlarını içerir.
Toplu Yanıt Modeli
Döndürülen veri içeriği, zaman uyumsuz ve eşitleme istekleri için benzerdir. Zaman uyumsuz toplu iş isteğinin sonuçları indirilirken, toplu iş işleme tamamlandıysa yanıt gövdesi toplu iş yanıtını içerir. Bu toplu yanıt, özgün toplu iş isteğinin totalRequests
parçası olan öğesini ve successfulRequests
örneğin başarıyla yürütülen sorguları gösteren bir summary
bileşen içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir dizi de içerir batchItems
. , batchItems
sonuçları, özgün sorguların toplu iş isteğinde gönderildiği sırayla tam olarak aynı sırada içerir. içindeki batchItems
her öğe ve response
alanlarını içerirstatusCode
. içindeki batchItems
her response
biri aşağıdaki türlerden biridir:
SearchAddressReverseResponse
- Sorgu başarıyla tamamlandıysa.Error
- Sorgu başarısız olduysa. Yanıt, bu durumda bircode
vemessage
içerir.
Aşağıda 2 başarılı ve 1 başarısız sonucu olan örnek bir Batch Yanıtı verilmişti :
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"queryTime": 11
},
"addresses": [
{
"address": {
"country": "France",
"freeformAddress": "Avenue Anatole France, 75007 Paris"
},
"position": "48.858490,2.294820"
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"queryTime": 1
},
"addresses": [
{
"address": {
"country": "United States of America",
"freeformAddress": "157th Pl NE, Redmond WA 98052"
},
"position": "47.640470,-122.129430"
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
format
|
path | True |
Yanıtın istenen biçimi. Yalnızca |
|
api-version
|
query | True |
string |
Azure Haritalar API'sinin sürüm numarası. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-client-id |
string |
Hangi hesabın Microsoft Entra ID güvenlik modeliyle birlikte kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar Microsoft Entra ID güvenliğini kullanmak için kılavuz için aşağıdaki makalelere bakın. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
batchItems |
İşlenmek üzere sorguların listesi. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Tamam |
|
202 Accepted |
Yalnızca zaman uyumsuz istek için desteklenir. İstek Kabul Edildi: İstek işlenmek üzere kabul edildi. Sonuçlara yeniden denemek veya erişmek için lütfen Konum Üst Bilgisindeki URL'yi kullanın. Üst Bilgiler Location: string |
|
Other Status Codes |
Beklenmeyen bir hata oluştu. |
Güvenlik
AADToken
Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağına erişimi tanımlamak için kullanılır. Herhangi bir kullanıcı, grup veya hizmet sorumlusuna yerleşik bir rol veya REST API'lerini Azure Haritalar için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.
Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemeye yönelik bir çözüm sağlar.
Not
- Bu güvenlik tanımı, uygulamanın erişim isteğinde
x-ms-client-id
bulunduğu Azure Haritalar kaynağı belirtmek için üst bilginin kullanılmasını gerektirir. Bu, Haritalar yönetim API'sinden edinilebilir. -
Authorization URL
, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır. - Azure rol tabanlı erişim denetimi Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden yapılandırılır.
- Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.
- Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformu genel bakış.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Bu, Azure portal Azure Haritalar hesabı oluşturduğunuzda veya PowerShell, CLI, Azure SDK'ları veya REST API kullandığınızda sağlanan paylaşılan bir anahtardır.
Bu anahtarla, tüm uygulamalar tüm REST API'lere erişebilir. Başka bir deyişle, bu anahtar, verildikleri hesapta ana anahtar olarak kullanılabilir.
Herkese açık uygulamalar için, anahtarınızın güvenli bir şekilde depolanabilmesi için gizli istemci uygulamaları yaklaşımını kullanarak Azure Haritalar REST API'lerine erişmenizi öneririz.
Tür:
apiKey
İçinde:
query
SAS Token
Bu paylaşılan erişim imzası belirteci, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağındaki Sas Listeleme işleminden oluşturulur.
Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirtecin kullanım süresi, oranı ve bölgelerine yönelik ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların erişimi paylaşılan anahtardan daha güvenli bir şekilde denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, uygunsuz işlemeyi sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmanızdır.
Tür:
apiKey
İçinde:
header
Örnekler
A Reverse Geocoding Batch API call containing 5 Reverse Geocoding API queries
Örnek isteği
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=48.858561,2.294911"
},
{
"query": "?query=47.639765,-122.127896&radius=5000&limit=2"
},
{
"query": "?query=47.621028,-122.348170"
}
]
}
Örnek yanıt
{
"summary": {
"successfulRequests": 3,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"queryTime": 8,
"numResults": 1
},
"addresses": [
{
"address": {
"streetNumber": "7",
"routeNumbers": [],
"streetName": "Avenue Anatole France",
"streetNameAndNumber": "7 Avenue Anatole France",
"countryCode": "FR",
"countrySubdivisionCode": "Île-de-France",
"countrySecondarySubdivision": "Paris",
"municipality": "Paris",
"postalCode": "75007",
"municipalitySubdivision": "7ème Arrondissement",
"country": "France",
"countryCodeISO3": "FRA",
"freeformAddress": "7 Avenue Anatole France, Paris, 75007",
"boundingBox": {
"northEast": "48.858321,2.295167",
"southWest": "48.858136,2.295027",
"entity": "position"
}
},
"position": "48.858231,2.295089"
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"queryTime": 8,
"numResults": 1
},
"addresses": [
{
"address": {
"routeNumbers": [],
"countryCode": "US",
"countrySubdivisionCode": "WA",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"municipality": "Redmond",
"postalCode": "98052",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Redmond, WA 98052",
"boundingBox": {
"northEast": "47.639765,-122.128661",
"southWest": "47.639502,-122.129456",
"entity": "position"
},
"countrySubdivisionName": "Washington"
},
"position": "47.639687,-122.128677"
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"queryTime": 19,
"numResults": 1
},
"addresses": [
{
"address": {
"streetNumber": "410",
"routeNumbers": [],
"streetName": "Thomas Street",
"streetNameAndNumber": "410 Thomas Street",
"countryCode": "US",
"countrySubdivisionCode": "WA",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"municipality": "Seattle",
"postalCode": "98109",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "410 Thomas Street, Seattle, WA 98109",
"boundingBox": {
"northEast": "47.620954,-122.347601",
"southWest": "47.620944,-122.348498",
"entity": "position"
},
"extendedPostalCode": "981094621",
"countrySubdivisionName": "Washington"
},
"position": "47.620945,-122.348175"
}
]
}
}
]
}
Operation-Location: URL to download the results of the long-running batch request.
Tanımlar
Name | Description |
---|---|
Address |
Sonucun adresi |
Address |
Arama sonucu için caddenin her iki tarafındaki adres aralığını açıklar. Adres aralığının başlangıç ve bitiş konumlarının koordinatları eklenir. |
Batch |
Bu tür, Batch hizmeti için istek gövdesini temsil eder. |
Batch |
Batch isteği nesnesi |
Bounding |
Görünüm penceresinin sol üst ve sağ alt koordinatlarıyla gösterilen sonucu kapsayan görünüm penceresi. |
Bounding |
Konumun sınırlayıcı kutusu. |
Brand |
POI ile ilişkili marka |
Classification |
Döndürülen POI sınıflandırması |
Classification |
Sınıflandırmanın adı |
Data |
İsteğe bağlı bölüm. Get Arama Polygon API'si ile kullanım için başvuru kimlikleri. |
Entity |
Sınırlayıcı kutunun varlık türü kaynağı. Ters coğrafi kodlama için bu her zaman konuma eşittir. |
Entry |
Döndürülen POI için giriş noktası. |
Entry |
Giriş noktası türü. Değer ana veya küçük olabilir. |
Error |
Kaynak yönetimi hatası ek bilgileri. |
Error |
Hata ayrıntısı. |
Error |
Hata yanıtı |
Geographic |
Coğrafya varlık türü. Yalnızca entityType istendiğinde ve kullanılabilir olduğunda bulunur. |
Geometry |
Sonucun geometrik şekli hakkında bilgi. Yalnızca == Coğrafya türünde mevcut. |
Json |
Yanıtın istenen biçimi. Yalnızca |
Lat |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
Match |
Ters adres arama işlemi için eşleşme türleri. |
Operating |
PoI için açılış saatleri (İlgi Çekici Noktalar). |
Operating |
Tarih ve saati temsil eder |
Operating |
Bir gün için açık zaman aralığı |
Point |
Ad, telefon, url adresi ve sınıflandırmalar gibi bilgiler de dahil olmak üzere döndürülen POI'nin ayrıntıları. |
Point |
POI kategorisi |
Query |
Döndürülen sorgu türü: YAKINDA veya NON_NEAR. |
Response |
Sorgunun sonucu. Sorgu başarıyla tamamlandıysa SearchAddressResult, aksi halde ErrorResponse. |
Reverse |
Arama Adres Ters Toplu İşlem hizmet çağrısından döndürülen bir öğe. |
Reverse |
Bu nesne başarılı bir Arama Adres Ters Toplu İşlem hizmet çağrısından döndürülür. |
Search |
Arama API yanıtı için sonuç nesnesi. |
Search |
Bunlardan biri:
|
Search |
Arama API yanıtı için özet nesnesi. |
Summary |
Toplu iş isteğinin sonuçlarının özeti |
Address
Sonucun adresi
Name | Tür | Description |
---|---|---|
boundingBox |
Konumun sınırlayıcı kutusu. |
|
buildingNumber |
string |
Sokaktaki bina numarası. KULLANIMSIZ, bunun yerine streetNumber kullanın. |
country |
string |
ülke/bölge adı |
countryCode |
string |
Ülke (Not: Bu iki harfli bir koddur, ülke/bölge adı değildir.) |
countryCodeISO3 |
string |
ISO alfa-3 ülke kodu |
countrySecondarySubdivision |
string |
İlçe |
countrySubdivision |
string |
Eyalet veya İl |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Ülke/bölge yönetim hiyerarşisinin ilk düzeyinin tam adı. Bu alan yalnızca countrySubdivision'ın kısaltılmış bir biçimde sunulması durumunda görünür. Yalnızca ABD, Kanada ve Birleşik Krallık için desteklenir. |
countryTertiarySubdivision |
string |
Adlandırılmış Alan |
crossStreet |
string |
Karşıya geçilen caddenin adı. |
extendedPostalCode |
string |
Genişletilmiş posta kodu (kullanılabilirlik bölgeye bağlıdır). |
freeformAddress |
string |
Sonucun kaynak ülkesinin/bölgesinin biçimlendirme kurallarına göre veya bir ülke/bölge söz konusu olduğunda tam ülke/bölge adına göre biçimlendirilmiş bir adres satırı. |
localName |
string |
Bir yönetim birimi olmadan adresleme amacıyla birden çok adreslenebilir nesneyi gruplandıran bir coğrafi alanın veya yerelliğin adını temsil eden bir adres bileşeni. Bu alan özelliği oluşturmak |
municipality |
string |
Şehir / Şehir |
municipalitySubdivision |
string |
Sub / Super City |
neighbourhood |
string |
Komşuluk, bir şehir veya kasaba içinde, ayırt edici özelliklere ve sakinler arasındaki sosyal etkileşimlere sahip coğrafi olarak yerelleştirilmiş bir alandır. |
postalCode |
string |
Posta Kodu / Posta Kodu |
routeNumbers |
string[] |
Caddeyi net bir şekilde tanımlamak için kullanılan kodlar |
street |
string |
Sokak adı. KULLANIMSIZ, bunun yerine streetName kullanın. |
streetName |
string |
Sokak adı. |
streetNameAndNumber |
string |
Sokak adı ve numarası. |
streetNumber |
string |
Sokaktaki bina numarası. |
AddressRanges
Arama sonucu için caddenin her iki tarafındaki adres aralığını açıklar. Adres aralığının başlangıç ve bitiş konumlarının koordinatları eklenir.
Name | Tür | Description |
---|---|---|
from |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
|
rangeLeft |
string |
Caddenin sol tarafındaki adres aralığı. |
rangeRight |
string |
Caddenin sağ tarafındaki adres aralığı. |
to |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
BatchRequest
Bu tür, Batch hizmeti için istek gövdesini temsil eder.
Name | Tür | Description |
---|---|---|
batchItems |
İşlenmek üzere sorguların listesi. |
BatchRequestItem
Batch isteği nesnesi
Name | Tür | Description |
---|---|---|
query |
string |
Bu parametre yapılandırılmamış bir coğrafi kodlama işlemi gerçekleştirmek için kullanılan bir sorgu dizesi içerir. Sorgu dizesi, işlenmek üzere arama API'sine ayrıntılı olarak geçirilir. |
BoundingBox
Görünüm penceresinin sol üst ve sağ alt koordinatlarıyla gösterilen sonucu kapsayan görünüm penceresi.
Name | Tür | Description |
---|---|---|
btmRightPoint |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
|
topLeftPoint |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
BoundingBoxCompassNotation
Konumun sınırlayıcı kutusu.
Name | Tür | Description |
---|---|---|
entity |
Sınırlayıcı kutunun varlık türü kaynağı. Ters coğrafi kodlama için bu her zaman konuma eşittir. |
|
northEast |
string |
Sınırlayıcı kutunun virgülle ayrılmış float'lar olarak kuzey-doğu enlem,boylam koordinatı |
southWest |
string |
Virgülle ayrılmış float olarak sınırlayıcı kutunun güney-batı enlemi,boylam koordinatı |
Brand
POI ile ilişkili marka
Name | Tür | Description |
---|---|---|
name |
string |
Markanın adı |
Classification
Döndürülen POI sınıflandırması
Name | Tür | Description |
---|---|---|
code |
string |
Kod özelliği |
names |
Ad dizisi |
ClassificationName
Sınıflandırmanın adı
Name | Tür | Description |
---|---|---|
name |
string |
Name özelliği |
nameLocale |
string |
Name Locale özelliği |
DataSources
İsteğe bağlı bölüm. Get Arama Polygon API'si ile kullanım için başvuru kimlikleri.
Name | Tür | Description |
---|---|---|
geometry |
Sonucun geometrik şekli hakkında bilgi. Yalnızca == Coğrafya türünde mevcut. |
Entity
Sınırlayıcı kutunun varlık türü kaynağı. Ters coğrafi kodlama için bu her zaman konuma eşittir.
Name | Tür | Description |
---|---|---|
position |
string |
Konum varlığı |
EntryPoint
Döndürülen POI için giriş noktası.
Name | Tür | Description |
---|---|---|
position |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
|
type |
Giriş noktası türü. Değer ana veya küçük olabilir. |
EntryPointType
Giriş noktası türü. Değer ana veya küçük olabilir.
Name | Tür | Description |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
Kaynak yönetimi hatası ek bilgileri.
Name | Tür | Description |
---|---|---|
info |
object |
Ek bilgiler. |
type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
Name | Tür | Description |
---|---|---|
additionalInfo |
Hata ek bilgileri. |
|
code |
string |
Hata kodu. |
details |
Hata ayrıntıları. |
|
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
ErrorResponse
Hata yanıtı
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |
GeographicEntityType
Coğrafya varlık türü. Yalnızca entityType istendiğinde ve kullanılabilir olduğunda bulunur.
Name | Tür | Description |
---|---|---|
Country |
string |
ülke/bölge adı |
CountrySecondarySubdivision |
string |
İlçe |
CountrySubdivision |
string |
Eyalet veya İl |
CountryTertiarySubdivision |
string |
Adlandırılmış Alan |
Municipality |
string |
Şehir / Şehir |
MunicipalitySubdivision |
string |
Sub / Super City |
Neighbourhood |
string |
Mahalle |
PostalCodeArea |
string |
Posta Kodu / Posta Kodu |
Geometry
Sonucun geometrik şekli hakkında bilgi. Yalnızca == Coğrafya türünde mevcut.
Name | Tür | Description |
---|---|---|
id |
string |
Bu sonucun geometri bilgilerini getirmek için bunu Get Arama Polygon API'sine geometryId olarak geçirin. |
JsonFormat
Yanıtın istenen biçimi. Yalnızca json
biçim desteklenir.
Name | Tür | Description |
---|---|---|
json |
string |
LatLongPairAbbreviated
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.
Name | Tür | Description |
---|---|---|
lat |
number |
Latitude özelliği |
lon |
number |
Boylam özelliği |
MatchType
Ters adres arama işlemi için eşleşme türleri.
Name | Tür | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
PoI için açılış saatleri (İlgi Çekici Noktalar).
Name | Tür | Description |
---|---|---|
mode |
string |
İstekte kullanılan değer: none veya "nextSevenDays" |
timeRanges |
Sonraki 7 günün zaman aralıkları listesi |
OperatingHoursTime
Tarih ve saati temsil eder
Name | Tür | Description |
---|---|---|
date |
string |
POI saat dilimindeki geçerli takvim tarihini temsil eder, örneğin "2019-02-07". |
hour |
integer |
Saatler, POI'nin yerel saatinde 24 saat biçimindedir; olası değerler 0 - 23'dür. |
minute |
integer |
Dakikalar bir POI'nin yerel saatindedir; olası değerler 0 - 59'dır. |
OperatingHoursTimeRange
Bir gün için açık zaman aralığı
Name | Tür | Description |
---|---|---|
endTime |
Belirli bir POI'nin kapatıldığı sonraki 7 gün aralığındaki nokta veya aralık öncesinde kapalıysa aralığın başlangıcı. |
|
startTime |
Belirli bir POI'nin açıldığı sonraki 7 gün aralığındaki nokta veya aralık öncesinde açılmışsa aralığın başlangıcı. |
PointOfInterest
Ad, telefon, url adresi ve sınıflandırmalar gibi bilgiler de dahil olmak üzere döndürülen POI'nin ayrıntıları.
Name | Tür | Description |
---|---|---|
brands |
Brand[] |
Markalar dizisi. İade edilen POI markasının adı. |
categories |
string[] |
Kategoriler dizisi |
categorySet |
En özel POI kategorilerinin listesi |
|
classifications |
Sınıflandırma dizisi |
|
name |
string |
POI özelliğinin adı |
openingHours |
PoI için açılış saatleri (İlgi Çekici Noktalar). |
|
phone |
string |
Telefon numarası özelliği |
url |
string |
Web sitesi URL'si özelliği |
PointOfInterestCategorySet
POI kategorisi
Name | Tür | Description |
---|---|---|
id |
integer |
Kategori Kimliği |
QueryType
Döndürülen sorgu türü: YAKINDA veya NON_NEAR.
Name | Tür | Description |
---|---|---|
NEARBY |
string |
Arama, tanımlanmış yarıçaplı belirli bir enlem ve boylam etrafında gerçekleştirildi |
NON_NEAR |
string |
Arama, belirli bir enlem ve boylama sapma olmadan ve tanımlı yarıçap olmadan küresel olarak gerçekleştirildi |
Response
Sorgunun sonucu. Sorgu başarıyla tamamlandıysa SearchAddressResult, aksi halde ErrorResponse.
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |
|
results |
Arama API sonuçlarının listesi. |
|
summary |
Arama API yanıtı için özet nesnesi |
ReverseSearchAddressBatchItem
Arama Adres Ters Toplu İşlem hizmet çağrısından döndürülen bir öğe.
Name | Tür | Description |
---|---|---|
response |
Sorgunun sonucu. Sorgu başarıyla tamamlandıysa SearchAddressReverseResponse, aksi halde ErrorResponse. |
|
statusCode |
integer |
HTTP isteği durum kodu. |
ReverseSearchAddressBatchProcessResult
Bu nesne başarılı bir Arama Adres Ters Toplu İşlem hizmet çağrısından döndürülür.
Name | Tür | Description |
---|---|---|
batchItems |
Toplu iş sonuçlarını içeren dizi. |
|
summary |
Toplu iş isteğinin sonuçlarının özeti |
SearchAddressResultItem
Arama API yanıtı için sonuç nesnesi.
Name | Tür | Description |
---|---|---|
address |
Sonucun adresi |
|
addressRanges |
Bir arama sonucu için caddenin her iki tarafındaki adres aralığını açıklar. Adres aralığının başlangıç ve bitiş konumları için koordinatlar eklenir. |
|
dataSources |
İsteğe bağlı bölüm. Get Arama Polygon API'si ile kullanmak için başvuru geometrisi kimliği. |
|
detourTime |
integer |
Saniyeler içinde dolambaçlı zaman. Yalnızca Arama Yol Boyunca API'sine yapılan çağrılar için döndürülür. |
dist |
number |
Ölçümlerdeki sonuç ve coğrafi konum arasındaki düz çizgi uzaklığı. |
entityType |
Coğrafya varlık türü. Yalnızca entityType istendiğinde ve kullanılabilir olduğunda bulunur. |
|
entryPoints |
EntryPoint dizisi. Bunlar, konumda bulunan giriş türlerini açıklar. Tür, ön kapı veya lobi gibi ana girişler için "ana" ve yan ve arka kapılar için "küçük" olabilir. |
|
id |
string |
Kimlik özelliği |
info |
string |
Sonucun özgün veri kaynağı hakkında bilgi. Destek istekleri için kullanılır. |
matchType |
Eşleşme türü hakkında bilgi. Bunlardan biri:
|
|
poi |
Ad, telefon, URL adresi ve sınıflandırmalar gibi bilgiler de dahil olmak üzere döndürülen POI'nin ayrıntıları. |
|
position |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
|
score |
number |
Sonuçlar arasındaki göreli eşleştirme puanını göstermek için sonuç kümesi içindeki değer. X değerinin y değerinin 2 katı olması durumunda x sonucunun y sonucunun iki katı kadar ilgili olma olasılığını belirlemek için bunu kullanabilirsiniz. Değerler sorgular arasında farklılık gösterir ve yalnızca bir sonuç kümesi için göreli değer olarak amaçlanır. |
type |
Bunlardan biri:
|
|
viewport |
Görünüm penceresinin sol üst ve sağ alt koordinatlarıyla gösterilen sonucu kapsayan görünüm penceresi. |
SearchAddressResultType
Bunlardan biri:
- POI
- Sokak
- Coğrafya
- Nokta Adresi
- Adres Aralığı
- Çapraz Cadde
Name | Tür | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchSummary
Arama API yanıtı için özet nesnesi.
Name | Tür | Description |
---|---|---|
fuzzyLevel |
integer |
Sonuçları sağlamak için gereken en yüksek bulanıklık düzeyi. |
geoBias |
İç arama motorunun sonuçların derecelendirmesini geliştirmek için jeo-uzamsal sapma uyguladığını gösterir. Bazı yöntemlerde, kullanılabilir durumdaki lat ve lon parametreleri ayarlanarak bu durum etkilenebilir. Diğer durumlarda tamamen içseldir. |
|
limit |
integer |
Döndürülecek en fazla yanıt sayısı |
numResults |
integer |
Yanıttaki sonuç sayısı. |
offset |
integer |
Döndürülen Sonuçların tam Sonuç kümesi içindeki başlangıç uzaklığı. |
query |
string |
Bu arama sonuçlarını üretmek için kullanılan sorgu parametresi. |
queryTime |
integer |
Milisaniye cinsinden sorguyu çözümlemek için harcanan süre. |
queryType |
Döndürülen sorgu türü: YAKINDA veya NON_NEAR. |
|
totalResults |
integer |
Bulunan toplam Sonuç sayısı. |
Summary
Toplu iş isteğinin sonuçlarının özeti
Name | Tür | Description |
---|---|---|
successfulRequests |
integer |
Toplu işlemdeki başarılı istek sayısı |
totalRequests |
integer |
Toplu iş içindeki toplam istek sayısı |