Search - Get Search Address
Sokak adresinin enlem ve boylam koordinatlarını yapılandırılmamış veya sorgu giriş biçiminde almak için kullanın.
Get Search Address
API bir HTTP GET
isteğidir, arama ölçütü olarak bir sokak adresi veya bir yerin adı geçirildiğinde enlem ve boylam koordinatlarını döndürür.
Çoğu durumda, örneğin yalnızca geleneksel coğrafi kodlamayla ilgileniyorsanız arama hizmetinin tamamı çok fazla olabilir. Arama yalnızca adres arama için de erişilebilir. Coğrafi kodlama, söz konusu adresin veya kısmi adresin yer aldığı coğrafi kod uç noktasına basılarak gerçekleştirilir. Coğrafi kodlama arama dizini, sokak düzeyindeki verilerin üzerindeki her şey için sorgulanır. Hiçbir POI döndürülmeyecek. Coğrafi kodlayıcının yazım hatasına ve eksik adreslere çok dayanıklı olduğunu unutmayın. Ayrıca tam sokak adreslerinden, sokak veya kavşaklardan şehir merkezleri, ilçeler, eyaletler gibi daha üst düzey coğrafyalardan her şeyi ele alacaktır.
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
format
|
path | True |
Response |
Yanıtın istenen biçimi. Değer json veya xml olabilir. |
api-version
|
query | True |
string |
Azure Haritalar API'sinin sürüm numarası. |
query
|
query | True |
string |
Aranacak adres (ör. "1 Microsoft way, Redmond, WA"), düzgün bir URL kodlanmış olmalıdır. |
btm
|
query |
string |
Sınırlayıcı kutunun sağ alt konumu. Örn. 37.553,-122.453 |
|
country
|
query |
string[] |
Ülke/bölge kodlarının virgülle ayrılmış dizesi, örneğin FR,ES. Bu, aramayı belirtilen ülkeler/bölgeler ile sınırlandıracaktır |
|
entity
|
query |
Geographic |
Coğrafyalarda gerçekleştirilen filtreleme düzeyini belirtir. Belirtilen coğrafya varlık türleri için aramayı daraltıyor, örneğin yalnızca belediyeyi döndür. Sonuçta elde edilen yanıt, hem coğrafya kimliğini hem de eşleşen varlık türünü içerir. Virgülle ayrılmış liste olarak birden fazla varlık sağlarsanız, uç nokta 'kullanılabilir en küçük varlık' değerini döndürür. Döndürülen Geometri Kimliği, Get Arama Polygon API aracılığıyla bu coğrafyanın geometrisini almak için kullanılabilir. entityType ayarlandığında aşağıdaki parametreler yoksayılır:
|
|
extended
|
query |
Search |
Genişletilmiş posta kodlarının sonuçlara eklenmesi gereken dizinler. Kullanılabilir dizinler şunlardır: Addr = Adres aralıkları Coğrafi = Coğrafyalar PAD = Nokta Adresleri POI = İlgi Çekici Noktalar Str = Sokaklar XStr = Caddeler Arası (kesişimler) Değer, dizin türlerinin virgülle ayrılmış bir listesi (herhangi bir sırada ) veya dizin yok olmalıdır. Varsayılan olarak, Geo dışındaki tüm dizinler için genişletilmiş posta kodları eklenir. Coğrafyalar için genişletilmiş posta kodu listeleri oldukça uzun olabilir, bu nedenle gerektiğinde açıkça istenmeleri gerekir. Kullanım örnekleri: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Genişletilmiş posta kodu, bir adresin extendedPostalCode özelliği olarak döndürülür. Kullanılabilirlik bölgeye bağlıdır. |
|
language
|
query |
string |
Arama sonuçlarının döndürülmesi gereken dil. Büyük/küçük harfe duyarsız, desteklenen IETF dil etiketlerinden biri olmalıdır. Belirtilen dildeki veriler belirli bir alan için kullanılabilir olmadığında, varsayılan dil kullanılır. Ayrıntılar için lütfen Desteklenen Diller'e bakın. |
|
lat
|
query |
number double |
Sonuçların sapmalı olması gereken enlem. Örn. 37.337 |
|
limit
|
query |
integer |
Döndürülecek en fazla yanıt sayısı. Varsayılan: 10, en az: 1 ve maksimum: 100 |
|
lon
|
query |
number double |
Sonuçların sapmalı olması gereken boylam. Örn. -121.89 |
|
ofs
|
query |
integer |
Döndürülen sonuçların tam sonuç kümesi içindeki uzaklığını başlatma. Varsayılan: 0 |
|
radius
|
query |
integer |
Sonuçların tanımlı alanla kısıtlanması için metre cinsinden yarıçap |
|
top
|
query |
string |
Sınırlayıcı kutunun sol üst konumu. Örn. 37.553,-122.453 |
|
typeahead
|
query |
boolean |
Boolean. Typeahead bayrağı ayarlanırsa, sorgu kısmi giriş olarak yorumlanır ve arama tahmin moduna girer |
|
view
|
query |
Localized |
View parametresi ("kullanıcı bölgesi" parametresi olarak da adlandırılır), coğrafi olarak tartışmalı bölgeler için belirli bir ülke/bölge için doğru haritaları göstermenizi sağlar. Farklı ülkelerin/bölgelerin bu tür bölgelerin farklı görünümleri vardır ve View parametresi uygulamanızın, uygulamanızın hizmet verecek olduğu ülke/bölge için gereken görünümle uyumlu olmasını sağlar. Varsayılan olarak, görünüm parametresi istekte tanımlamamış olsanız bile "Birleştirilmiş" olarak ayarlanır. Kullanıcılarınızın konumunu belirlemek ve ardından bu konum için View parametresini doğru ayarlamak sizin sorumluluğunuzdadır. Alternatif olarak, isteğin IP adresine göre harita verilerini döndürecek olan 'View=Auto' ayarını da belirleyebilirsiniz. Azure Haritalar'de View parametresi, haritaların, görüntülerin ve diğer verilerin ve Azure Haritalar üzerinden erişim yetkisine sahip olduğunuz üçüncü taraf içeriğinin bulunduğu ülkenin/bölgenin haritalanmasıyla ilgili olanlar da dahil olmak üzere geçerli yasalara uygun olarak kullanılmalıdır. Örnek: view=IN. Ayrıntılar ve kullanılabilir Görünümleri görmek için lütfen Desteklenen Görünümler'e bakın. |
İ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'de Microsoft Entra ID güvenliği kullanmak için rehberlik için aşağıdaki makalelere bakın. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Search |
Tamam |
Other Status Codes |
Error |
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ğa erişim tanımlamak için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri 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ı modellemek için bir çözüm sağlar.
Not
- Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağı belirtmek için üst bilgi kullanımını
x-ms-client-id
gerektirir. Bu, Haritalar yönetim API'sinden alınabilir. 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ış.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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'sini 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.
Type:
apiKey
In:
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 belirteç için kullanım süre sonu, oran ve bölgeler için ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların paylaşılan anahtardan daha güvenli bir şekilde erişimi denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, işleme kötüye kullanımını 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ırmayı önermektedir.
Type:
apiKey
In:
header
Örnekler
Search detail address 15127 NE 24th Street, Redmond, WA 98052
Sample Request
GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052
Sample Response
{
"summary": {
"query": "15127 NE 24th Street, Redmond, WA 98052",
"queryType": "NON_NEAR",
"queryTime": 58,
"numResults": 1,
"offset": 0,
"totalResults": 1,
"fuzzyLevel": 1
},
"results": [
{
"type": "Point Address",
"id": "US/PAD/p0/19173426",
"score": 14.51,
"address": {
"streetNumber": "15127",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525544",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6308,
"lon": -122.1385
},
"viewport": {
"topLeftPoint": {
"lat": 47.6317,
"lon": -122.13983
},
"btmRightPoint": {
"lat": 47.6299,
"lon": -122.13717
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6315,
"lon": -122.13852
}
}
]
}
]
}
Tanımlar
Name | Description |
---|---|
Address |
Sonucun adresi |
Address |
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. |
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 kullanmak 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. |
Lat |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
Localized |
View parametresi ("kullanıcı bölgesi" parametresi olarak da adlandırılır), coğrafi olarak tartışmalı bölgeler için belirli bir ülke/bölge için doğru haritaları göstermenizi sağlar. Farklı ülkelerin/bölgelerin bu tür bölgelerin farklı görünümleri vardır ve View parametresi uygulamanızın, uygulamanızın hizmet verecek olduğu ülke/bölge için gereken görünümle uyumlu olmasını sağlar. Varsayılan olarak, görünüm parametresi istekte tanımlamamış olsanız bile "Birleştirilmiş" olarak ayarlanır. Kullanıcılarınızın konumunu belirlemek ve ardından bu konum için View parametresini doğru ayarlamak sizin sorumluluğunuzdadır. Alternatif olarak, isteğin IP adresine göre harita verilerini döndürecek olan 'View=Auto' ayarını da belirleyebilirsiniz. Azure Haritalar'de View parametresi, haritaların, görüntülerin ve diğer verilerin ve Azure Haritalar üzerinden erişim yetkisine sahip olduğunuz üçüncü taraf içeriğinin bulunduğu ülkenin/bölgenin haritalanmasıyla ilgili olanlar da dahil olmak üzere geçerli yasalara uygun olarak kullanılmalıdır. Örnek: view=IN. Ayrıntılar ve kullanılabilir Görünümleri görmek için lütfen Desteklenen Görünümler'e bakın. |
Match |
Ters adres arama işlemi için eşleşme türleri. |
Operating |
PoI için çalışma 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 |
Yanıtın istenen biçimi. Değer json veya xml olabilir. |
Search |
Bu nesne başarılı bir Arama çağrılarından döndürülür. |
Search |
Arama API yanıtı için sonuç nesnesi. |
Search |
Bunlardan biri:
|
Search |
Genişletilmiş posta kodlarının sonuçlara eklenmesi gereken dizinler. Kullanılabilir dizinler şunlardır: Addr = Adres aralıkları Coğrafi = Coğrafyalar PAD = Nokta Adresleri POI = İlgi Çekici Noktalar Str = Sokaklar XStr = Caddeler Arası (kesişimler) Değer, dizin türlerinin virgülle ayrılmış bir listesi (herhangi bir sırada ) veya dizin yok olmalıdır. Varsayılan olarak, Geo dışındaki tüm dizinler için genişletilmiş posta kodları eklenir. Coğrafyalar için genişletilmiş posta kodu listeleri oldukça uzun olabilir, bu nedenle gerektiğinde açıkça istenmeleri gerekir. Kullanım örnekleri: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Genişletilmiş posta kodu, bir adresin extendedPostalCode özelliği olarak döndürülür. Kullanılabilirlik bölgeye bağlıdır. |
Search |
Arama API yanıtı için özet nesnesi. |
Address
Sonucun adresi
Name | Tür | Description |
---|---|---|
boundingBox |
Bounding |
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 |
Geçilen caddenin adı. |
extendedPostalCode |
string |
Genişletilmiş posta kodu (kullanılabilirlik bölgeye bağlıdır). |
freeformAddress |
string |
Bir Sonucun çıkış ü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 |
Yönetim birimi olmadan birden çok adreslenebilir nesneyi adresleme amacıyla 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 yer alan ve sakinleri arasındaki ayırt edici özelliklere ve sosyal etkileşimlere sahip coğrafi olarak yerelleştirilmiş bir alandır. |
postalCode |
string |
Posta Kodu / Posta Kodu |
routeNumbers |
string[] |
Açık bir şekilde sokak 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
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.
Name | Tür | Description |
---|---|---|
from |
Lat |
'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 |
Lat |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
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 |
Lat |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
topLeftPoint |
Lat |
'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 |
Virgülle ayrılmış float olarak sınırlayıcı kutunun kuzey-doğu enlemi,boylam koordinatı |
southWest |
string |
Virgülle ayrılmış float olarak sınırlayıcı kutunun güney-batı enlem,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 |
Classification |
Ad dizisi |
ClassificationName
Sınıflandırmanın adı
Name | Tür | Description |
---|---|---|
name |
string |
Name özelliği |
nameLocale |
string |
Ad Yerel Ayarı özelliği |
DataSources
İsteğe bağlı bölüm. Get Arama Polygon API'si ile kullanmak 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 |
Lat |
'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum. |
type |
Entry |
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 |
Error |
Hata ek bilgileri. |
code |
string |
Hata kodu. |
details |
Error |
Hata ayrıntıları. |
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
ErrorResponse
Hata yanıtı
Name | Tür | Description |
---|---|---|
error |
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. |
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 |
LocalizedMapView
View parametresi ("kullanıcı bölgesi" parametresi olarak da adlandırılır), coğrafi olarak tartışmalı bölgeler için belirli bir ülke/bölge için doğru haritaları göstermenizi sağlar. Farklı ülkelerin/bölgelerin bu tür bölgelerin farklı görünümleri vardır ve View parametresi uygulamanızın, uygulamanızın hizmet verecek olduğu ülke/bölge için gereken görünümle uyumlu olmasını sağlar. Varsayılan olarak, görünüm parametresi istekte tanımlamamış olsanız bile "Birleştirilmiş" olarak ayarlanır. Kullanıcılarınızın konumunu belirlemek ve ardından bu konum için View parametresini doğru ayarlamak sizin sorumluluğunuzdadır. Alternatif olarak, isteğin IP adresine göre harita verilerini döndürecek olan 'View=Auto' ayarını da belirleyebilirsiniz. Azure Haritalar'de View parametresi, haritaların, görüntülerin ve diğer verilerin ve Azure Haritalar üzerinden erişim yetkisine sahip olduğunuz üçüncü taraf içeriğinin bulunduğu ülkenin/bölgenin haritalanmasıyla ilgili olanlar da dahil olmak üzere geçerli yasalara uygun olarak kullanılmalıdır. Örnek: view=IN.
Ayrıntılar ve kullanılabilir Görünümleri görmek için lütfen Desteklenen Görünümler'e bakın.
Name | Tür | Description |
---|---|---|
AE |
string |
Birleşik Arap Emirlikleri (Arap Görünümü) |
AR |
string |
Arjantin (Arjantin Görünümü) |
Auto |
string |
harita verilerini isteğin IP adresine göre döndürür. |
BH |
string |
Bahreyn (Arapça Görünümü) |
IN |
string |
Hindistan (Hint Görünümü) |
IQ |
string |
Irak (Arapça Görünümü) |
JO |
string |
Ürdün (Arapça Görünüm) |
KW |
string |
Kuveyt (Arapça Görünüm) |
LB |
string |
Lübnan (Arapça Görünümü) |
MA |
string |
Fas (Fas Görünümü) |
OM |
string |
Umman (Arapça Görünümü) |
PK |
string |
Pakistan (Pakistan Görünümü) |
PS |
string |
Filistin Yönetimi (Arap Görünümü) |
QA |
string |
Katar (Arapça Görünümü) |
SA |
string |
Suudi Arabistan (Arap Görünümü) |
SY |
string |
Suriye (Arapça Görünümü) |
Unified |
string |
Birleşik Görünüm (Diğerleri) |
YE |
string |
Yemen (Arapça Görünümü) |
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 çalışma saatleri (İlgi Çekici Noktalar).
Name | Tür | Description |
---|---|---|
mode |
string |
İstekte kullanılan değer: none veya "nextSevenDays" |
timeRanges |
Operating |
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 |
Operating |
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 |
Operating |
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[] |
Brands dizisi. İade edilen POI markasının adı. |
categories |
string[] |
Kategoriler dizisi |
categorySet |
Point |
En özel POI kategorilerinin listesi |
classifications |
Sınıflandırma dizisi |
|
name |
string |
POI özelliğinin adı |
openingHours |
Operating |
PoI için çalışma saatleri (İlgi Çekici Noktalar). |
phone |
string |
Telefon numarası özelliği |
url |
string |
Web sitesi URL ö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 |
ResponseFormat
Yanıtın istenen biçimi. Değer json veya xml olabilir.
Name | Tür | Description |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
Bu nesne başarılı bir Arama çağrılarından döndürülür.
Name | Tür | Description |
---|---|---|
results |
Search |
Arama API sonuçlarının listesi. |
summary |
Search |
Arama API yanıtı için özet nesnesi |
SearchAddressResultItem
Arama API yanıtı için sonuç nesnesi.
Name | Tür | Description |
---|---|---|
address |
Sonucun adresi |
|
addressRanges |
Address |
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 |
Data |
İ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 |
Geographic |
Coğrafya varlık türü. Yalnızca entityType istendiğinde ve kullanılabilir olduğunda bulunur. |
entryPoints |
Entry |
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 |
Match |
Eşleşme türü hakkında bilgi. Bunlardan biri:
|
poi |
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ı. |
position |
Lat |
'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 |
Search |
Bunlardan biri:
|
viewport |
Bounding |
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 |
SearchIndexes
Genişletilmiş posta kodlarının sonuçlara eklenmesi gereken dizinler.
Kullanılabilir dizinler şunlardır:
Addr = Adres aralıkları
Coğrafi = Coğrafyalar
PAD = Nokta Adresleri
POI = İlgi Çekici Noktalar
Str = Sokaklar
XStr = Caddeler Arası (kesişimler)
Değer, dizin türlerinin virgülle ayrılmış bir listesi (herhangi bir sırada ) veya dizin yok olmalıdır.
Varsayılan olarak, Geo dışındaki tüm dizinler için genişletilmiş posta kodları eklenir. Coğrafyalar için genişletilmiş posta kodu listeleri oldukça uzun olabilir, bu nedenle gerektiğinde açıkça istenmeleri gerekir.
Kullanım örnekleri:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
Genişletilmiş posta kodu, bir adresin extendedPostalCode özelliği olarak döndürülür. Kullanılabilirlik bölgeye bağlıdır.
Name | Tür | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
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 |
Lat |
İç 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 |
Query |
Döndürülen sorgu türü: YAKINDA veya NON_NEAR. |
totalResults |
integer |
Bulunan toplam Sonuç sayısı. |