Aracılığıyla paylaş


Search - Get Search Address Reverse Batch

Tek bir zaman uyumsuz istekte Arama Adresi Ters API'sine bir grup sorgu göndermek için kullanın.

Get Search Address Reverse Batch API,tek bir zaman uyumsuz API çağrısında GET API'sine toplu sorgular gönderen bir HTTP isteğidir. zaman uyumsuz (zaman uyumsuz) veya zaman uyumlu (eşitleme) çalıştırmak için Get Search Address Reverse Batch API'sini çağırabilirsiniz. Zaman uyumsuz API, çağıranın 10.000 kadar sorguyu toplu olarak çalıştırmasına ve API'yi 100 sorguya kadar eşitlemesine olanak tanır.

Zaman Uyumlu Toplu İş İsteği Gönderme

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 zaman aşımı hatası (408 yanıtı) döndürür. Toplu iş öğelerinin sayısı, bu API için 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, büyük hacimli nispeten karmaşık arama isteklerini 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ı beklenmemektedir.
  • Toplu iş öğelerinin sayısı, bu API için 10.000 ile sınırlıdır.

Zaman uyumsuz istek kullanarak istekte bulunduğunuzda, hizmet varsayılan olarak yanıt üst bilgisinin Konum alanında bir yeniden yönlendirme URL'si boyunca bir 202 yanıt kodu döndürür. Yanıt verileri veya hata bilgileri kullanılabilir olana kadar bu URL düzenli aralıklarla denetlenmelidir. Zaman uyumsuz yanıtlar 14 gün boyunca depolanır. Yeniden yönlendirme URL'si, süre sonundan 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:

  1. İstemci, Azure Haritalar'a bir Arama Adresi 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}
  1. 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 400 Bad Request veya başka bir Error durum kodu olabilir.

  2. Toplu iş isteği başarıyla kabul edildiyse, yanıttaki Location üst bilgisi toplu 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}
  1. İstemci, toplu iş sonuçlarını indirmek için 3. Adımda elde edilen GET bir isteği gönderir.

Toplu İstek için POST Gövdesi

arama adresi ters sorguları göndermek için, istek gövdesinin POST biçimde batchItems dizisini içereceği ve json üst bilgisinin Content-Typeolarak ayarlanacağı bir application/json isteği kullanırsı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, protokol, temel URL, yol, api sürümü ve abonelik anahtarı olmadan yalnızca kısmi bir URL. desteklenen arama adresi tersURI parametrelerinden herhangi birini kabul edebilir. arama adresi ters sorgudaki dize değerleri düzgün bir şekilde kaçılmalıdır (örneğin , " karakteri \ ile kaçış karakteri) ve ayrıca düzgün URL ile kodlanmış olmalıdır.

Zaman uyumsuz API, çağıranın en fazla 10.000 sorguyu toplu işlemesine ve API'yi 100 sorguya kadar 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 isteği gönderirsiniz. Bu indirme URL'si, başarılı bir Location toplu işleminin POST ü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:

  1. İstemci,indirme URL'sini kullanarak bir isteği gönderir.

  2. 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 iş isteği başarıyla işlendi. Yanıt gövdesi tüm toplu iş sonuçlarını içerir.

Batch 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şin işlenmesi tamamlandıysa, yanıt gövdesi toplu iş yanıtını içerir. Bu toplu iş yanıtı, özgün toplu iş isteğinin parçası olan summary ve başarıyla yürütülen sorgular totalRequestsgösteren bir successfulRequests bileşeni içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizisi de içerir. batchItems, sonuçları özgün sorguların toplu iş isteğinde gönderildiği sırayla içerir. batchItems'deki her öğe statusCode ve response alanları içerir. response'daki her batchItems aşağıdaki türlerden biridir:

  • SearchAddressReverseResponse - Sorgu başarıyla tamamlandıysa.

  • Error - Sorgu başarısız olduysa. Yanıt, bu durumda bir code ve bir message içerir.

Aşağıda 2 başarılı ve 1 başarısız sonucu içeren ö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."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

URI Parametreleri

Name İçinde Gerekli Tür Description
format
path True

string

İşlemi sorgulamak için batch kimliği.

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

Microsoft Entra ID güvenlik modeliyle kullanılması amaçlanan hesabı belirtir. Azure Haritalar hesabı için bu benzersiz kimlik, Azure Haritalar yönetim düzlemi Hesap API'sinden elde edilebilir. Azure Haritalar'da Microsoft Entra ID güvenliğini kullanma hakkında daha fazla bilgi için bkz.

Yanıtlar

Name Tür Description
200 OK

ReverseSearchAddressBatchProcessResult

Tamam

202 Accepted

Yalnızca zaman uyumsuz istek için desteklenir. İstek Kabul Edildi: İstek işlenmek üzere kabul edildi. Sonuçları yeniden denemek veya sonuçlara erişmek için lütfen Konum Üst Bilgisindeki URL'yi kullanın.

Üst Bilgiler

Location: string

Other Status Codes

ErrorResponse

Beklenmeyen bir hata oluştu.

Güvenlik

AADToken

Bunlar Microsoft Entra OAuth 2.0 Akışlarının . 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şim belirtmek 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çinkimlik 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.

Uyarı

  • Bu güvenlik tanımı kullanılmasını gerektirir. Bu, Haritalar yönetimi 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 platformuna 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ında Azure Haritalar hesabı oluşturma veya PowerShell, CLI, Azure SDK'ları veya REST API kullanarak 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 Azure Haritalar REST API'lerine erişmek için gizli istemci uygulamaları yaklaşımını kullanmanızı ö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ğı 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ölgelere ayrıntılı denetim ile erişim yetkisine sahiptir. 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, Eşleme hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmayı işleme kötüye kullanımını sınırlamak ve SAS Belirtecini düzenli olarak yenilemektir.

Tür: apiKey
İçinde: header

Örnekler

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Örnek isteği

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Ö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"
          }
        ]
      }
    }
  ]
}

Tanımlar

Name 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ının koordinatları eklenir.

BoundingBox

Görünüm penceresinin sol üst ve sağ alt koordinatlarıyla temsil edilen sonucu kapsayan görünüm penceresi.

BoundingBoxCompassNotation

Konumun sınırlayıcı kutusu.

Brand

POI ile ilişkili marka

Classification

Döndürülen POI sınıflandırması

ClassificationName

Sınıflandırmanın adı

DataSources

İsteğe bağlı bölüm. Get Search 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.

EntryPoint

Döndürülen POI için giriş noktası.

EntryPointType

Giriş noktası türü. Değer, ana veya küçük olabilir.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

GeographicEntityType

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.

LatLongPairAbbreviated

'lat' & 'lon' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

MatchType

Ters adres arama işlemi için eşleşme türleri.

OperatingHours

PoI için açılış saatleri (İlgi Çekici Noktalar).

OperatingHoursTime

Tarih ve saati temsil eder

OperatingHoursTimeRange

Bir gün için açık zaman aralığı

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ı.

PointOfInterestCategorySet

POI kategorisi

QueryType

Döndürülen sorgu türü: YAKINDA veya NON_NEAR.

Önemli: Bu özellik kullanımdan kaldırılmıştır ve yanıttan çıkarılabilir.

Response

Sorgunun sonucu. Sorgu başarıyla tamamlandıysa SearchAddressResult, aksi halde ErrorResponse.

ReverseSearchAddressBatchItem

Arama Adresi Ters Toplu İşlem hizmet çağrısından döndürülen bir öğe.

ReverseSearchAddressBatchProcessResult

Bu nesne başarılı bir Arama Adresi Ters Toplu İş hizmeti çağrısından döndürülür.

SearchAddressResultItem

Arama API'si yanıtı için sonuç nesnesi.

SearchAddressResultType

Bunlardan biri:

  • İlgi Noktası
  • Sokak
  • Coğrafya
  • Nokta Adresi
  • Adres Aralığı
  • Çapraz Cadde
SearchSummary

Arama API'si yanıtı için özet nesnesi.

Summary

Toplu iş isteğinin sonuçlarının özeti

Address

Sonucun adresi.

Name Tür Description
boundingBox

BoundingBoxCompassNotation

Konum için sınırlayıcı kutuyu tanımlar. Bu özellik yalnızca Arama Adresi Ters API'leri tarafından döndürülür. Diğer tüm Arama API'leri viewport nesnenin özelliğini SearchAddressResultItem döndürür.

buildingNumber

string

Sokaktaki bina numarası.

Önemli: Bu özellik kullanım dışıdır. Bunun yerine streetNumber kullanın.

country

string

Ülke/bölge adı.

countryCode

string

ISO 3166-1 Alpha-2 standardı tarafından tanımlanan iki harfli alfabetik kod, bir ülke/bölge ve bağımlı bölgeleri temsil eder.

countryCodeISO3

string

ISO 3166-1 Alpha-3 standardı tarafından tanımlanan üç harfli alfabetik kod, bir ülke/bölge ve bağımlı bölgeleri temsil eder.

countrySecondarySubdivision

string

Bir ülke/bölge içindeki ikinci seviye idari bölüm. Bu bölüm, eyalet veya eyalet gibi ana alt bölümün altında, ancak belediyeler veya mahalleler gibi daha küçük birimlerin üstünde olan bir alt bölümü tanımlar. Örnekler arasında Amerika Birleşik Devletleri'nde County ve Birleşik Krallık'ta District yer alır.

countrySubdivision

string

Bir ülke içindeki birincil idari bölünme, örneğin bir eyalet, bir eyalet. Ulusal seviyenin altındaki birinci seviye alt bölümü temsil etmek için kullanılır.

countrySubdivisionCode

string

countrySubdivisionCode öneki countryCode ( countryCode-countrySubdivisionCode ) ve kısa çizgi ISO 3166-2 kodunu oluşturur. Örnekler: Texas için TX, İskoçya için SCT ve Ontario için ON.

Bu özellik ve Get Search Nearby API'sinde mevcut Get Search POI değildir.

countrySubdivisionName

string

Bir ülke veya bölge içindeki birinci düzey idari bölümün (örneğin eyalet, eyalet veya bölge) tam adını temsil eder. Bu özellik yalnızca countrySubdivision değer kısaltılmış biçimde sunulduğunda dahil edilir. Şu anda Amerika Birleşik Devletleri, Kanada ve Birleşik Krallık için desteklenmektedir.

countryTertiarySubdivision

string

Bir ülke/bölge içindeki üçüncü düzey idari bölüm. Bu durum, ikincil alt bölümlerden (örneğin ilçe veya ilçe) bile daha ince ayrıntı sağlar. Örnekler arasında şehir, kasaba, köy, ilçe veya kasaba gibi belediyeler ve Seattle'daki Capitol Hill, Green Lake ve Wallingford gibi belediye içindeki daha küçük, gayri resmi coğrafi alan mahalleleri verilebilir.

crossStreet

string

Karşıya geçilen caddenin adı.

Bu özellik yalnızca API'de Get Search Address Reverse Cross Street mevcuttur.

extendedPostalCode

string

Genişletilmiş posta kodu, standart rakam setinin ötesine geçen ve daha yüksek konum hassasiyeti sağlayan bir posta kodu formatını ifade eder. Diğer ülkelerde/bölgelerde U.S. ZIP+4 kodu veya benzeri genişletilmiş formatlarda yaygın olarak kullanılır. Erişilebilirlik bölgeye bağlıdır.

API'de Get Search Address Reverse Cross Street mevcut değil.

freeformAddress

string

Bir sonucun ülke/bölgesinin biçimlendirme kurallarına göre biçimlendirilmiş bir adres satırı, ya da bir ülke/bölge durumunda tam ülke/bölge adıdı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, freeformAddress özelliğini oluşturmak için kullanılır. localName, posta belediyesini temsil eder. Konuma bağlı olarak, localName bir şehrin veya şehrin yaygın olarak bilinen adıdır. Bir şehrin veya şehrin yaygın olarak bilinen adı için localNameyerine municipality kullanın.

municipality

string

Şehir / Şehir
Not: municipality yerleşim belediyesini temsil eder. Konuma bağlı olarak, municipality değeri bir şehrin veya şehrin yaygın olarak bilinen adından farklı olabilir. Şehir veya kasabanın yaygın bilinen adı için, değer yerine localName değerin municipality kullanılması önerilir.

municipalitySubdivision

string

Bir belediye içinde bir alt bölüm. Bir şehir, kasaba veya diğer belediye birimi içinde daha küçük bir idari veya coğrafi birimi temsil eder.

neighbourhood

string

Mahalle, bir şehir veya şehir içinde, farklı özelliklere ve sakinler arasındaki sosyal etkileşimlere sahip coğrafi olarak yerelleştirilmiş bir alandır.

postalCode

string

Belirli bir coğrafi bölgeyi tanımlamaya yardımcı olmak için adrese eklenen bir dizi sayı veya harf (veya her ikisi) bu. Posta Kodu, bir posta kodunun ABD versiyonudur, diğer ülkeler/bölgeler ise Posta Kodu, PIN Kodu ve PLZ gibi diğer formatları kullanır.

routeNumbers

string[]

Sokağın net bir şekilde tanımlanması için kullanılan kodlar.

Yalnızca Arama Adresi Ters API'leri için kullanılabilir.

street

string

Sokak adı.

Önemli: Bu özellik kullanım dışıdır. Bunun yerine streetName kullanın.

streetName

string

Sokak adı.

streetNameAndNumber

string

Sokak adı ve numarası.

Yalnızca Arama Adresi Ters API'leri için kullanılabilir.

streetNumber

string

Sokaktaki bina numarası.

API'de Get Search Address Reverse Cross Street mevcut değil.

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ının koordinatları eklenir.

Name Tür Description
from

LatLongPairAbbreviated

'lat' & 'lon' 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

LatLongPairAbbreviated

'lat' & 'lon' 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 temsil edilen sonucu kapsayan görünüm penceresi.

Name Tür Description
btmRightPoint

LatLongPairAbbreviated

'lat' & 'lon' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

topLeftPoint

LatLongPairAbbreviated

'lat' & 'lon' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

BoundingBoxCompassNotation

Konumun sınırlayıcı kutusu.

Name Tür Description
entity

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 enlemi,boylam koordinatı

southWest

string

Güney-batı enlemi,sınırlayıcı kutunun boylam koordinatı virgülle ayrılmış float'lar olarak

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

ClassificationName[]

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 Search Polygon API'si ile kullanmak için başvuru kimlikleri.

Name Tür Description
geometry

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.

Değer Description
position

Konum varlığı

EntryPoint

Döndürülen POI için giriş noktası.

Name Tür Description
position

LatLongPairAbbreviated

'lat' & 'lon' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

type

EntryPointType

Giriş noktası türü. Değer, ana veya küçük olabilir.

EntryPointType

Giriş noktası türü. Değer, ana veya küçük olabilir.

Değer Description
main
minor

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

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

GeographicEntityType

Coğrafya varlık türü. Yalnızca entityType istendiğinde ve kullanılabilir olduğunda bulunur.

Değer Description
Country

ülke/bölge adı

CountrySubdivision

Eyalet veya İl

CountrySecondarySubdivision

County

CountryTertiarySubdivision

Adlandırılmış Alan

Municipality

Şehir / Şehir

MunicipalitySubdivision

Alt / Süper Şehir

Neighbourhood

Komşuluk

PostalCodeArea

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 Arama Al Çokgen API'sine geometryId olarak geçirin.

LatLongPairAbbreviated

'lat' & 'lon' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

Name Tür Description
lat

number (double)

Latitude özelliği

lon

number (double)

Longitude özelliği

MatchType

Ters adres arama işlemi için eşleşme türleri.

Değer Description
AddressPoint
HouseNumberRange
Street

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

OperatingHoursTimeRange[]

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, bir POI'nin yerel saatinde 24 saat biçimindedir; olası değerler 0 - 23'dür.

minute

integer

Dakikalar, 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

OperatingHoursTime

Belirli bir POI'nin kapatıldığı sonraki 7 gün aralığındaki nokta veya aralık öncesinde kapatıldıysa aralığın başlangıcı.

startTime

OperatingHoursTime

Belirli bir POI'nin açıldığı sonraki 7 gün aralığındaki nokta veya aralık öncesinde açıldıysa 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

PointOfInterestCategorySet[]

En özel POI kategorilerinin listesi

classifications

Classification[]

Sınıflandırma dizisi

name

string

POI özelliğinin adı

openingHours

OperatingHours

PoI için açılış 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.

Önemli: Bu özellik kullanımdan kaldırılmıştır ve yanıttan çıkarılabilir.

Değer Description
NEARBY

Belirli bir enlem ve boylam etrafında belirli bir yarıçapla arama yapıldı.

NON_NEAR

Arama, belirli bir enlem ve boylama sapma olmadan ve tanımlı yarıçap olmadan genel olarak gerçekleştirildi

Response

Sorgunun sonucu. Sorgu başarıyla tamamlandıysa SearchAddressResult, aksi halde ErrorResponse.

Name Tür Description
error

ErrorDetail

Hata nesnesi.

results

SearchAddressResultItem[]

Arama API'sinin sonuçlarının listesi.

summary

SearchSummary

Arama API'si yanıtı için özet nesnesi

ReverseSearchAddressBatchItem

Arama Adresi Ters Toplu İşlem hizmet çağrısından döndürülen bir öğe.

Name Tür Description
response

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 Adresi Ters Toplu İş hizmeti çağrısından döndürülür.

Name Tür Description
batchItems

ReverseSearchAddressBatchItem[]

Toplu iş sonuçlarını içeren dizi.

summary

Summary

Toplu iş isteğinin sonuçlarının özeti

SearchAddressResultItem

Arama API'si yanıtı için sonuç nesnesi.

Name Tür Description
address

Address

Sonucun adresi.

addressRanges

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ının koordinatları eklenir.

dataSources

DataSources

İsteğe bağlı bölüm. Get Search Çokgen API'si ile kullanmak için başvuru geometri kimliği.

detourTime

integer

Saniyeler içinde saptırma süresi. Yalnızca Yol Boyunca Ara API'sine yapılan çağrılar için döndürülür.

dist

number (double)

Metre cinsinden sonuç ile geobias konumu arasındaki düz çizgi uzaklığı.

entityType

GeographicEntityType

Coğrafya varlık türü. Yalnızca entityType istendiğinde ve kullanılabilir olduğunda bulunur.

entryPoints

EntryPoint[]

EntryPoint dizisi. Bunlar, konumdaki giriş türlerini açıklar. Tip, ö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

MatchType

Eşleşme türüyle ilgili bilgiler.

Bunlardan biri:

  • AddressPoint
  • HouseNumberRange
  • Sokak
poi

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ı.

position

LatLongPairAbbreviated

'lat' & 'lon' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

score

number (double)

Sonuçlar arasındaki göreli eşleştirme puanını belirtmek için bir sonuç kümesi içindeki değer. X değerinin y değerinin 2 katı olması durumunda x sonucunun y sonucunun iki kat daha uygun 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.

Önemli: Bu özellik kullanımdan kaldırılmıştır ve yanıttan çıkarılabilir.

type

SearchAddressResultType

Bunlardan biri:

  • İlgi Noktası
  • Sokak
  • Coğrafya
  • Nokta Adresi
  • Adres Aralığı
  • Çapraz Cadde
viewport

BoundingBox

Görünüm penceresinin sol üst ve sağ alt koordinatlarıyla temsil edilen sonucu kapsayan görünüm penceresi.

SearchAddressResultType

Bunlardan biri:

  • İlgi Noktası
  • Sokak
  • Coğrafya
  • Nokta Adresi
  • Adres Aralığı
  • Çapraz Cadde
Değer Description
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchSummary

Arama API'si 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

LatLongPairAbbreviated

İç arama altyapısının sonuçların derecelendirmesini geliştirmek için jeo-uzamsal bir sapma uyguladığını gösterir. Bazı yöntemlerde, kullanılabilir durumdaki lat ve lon parametreleri ayarlanarak bu 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

Sorguyu çözümlemek için milisaniye cinsinden harcanan süre.

queryType

QueryType

Döndürülen sorgu türü: YAKINDA veya NON_NEAR.

Önemli: Bu özellik kullanımdan kaldırılmıştır ve yanıttan çıkarılabilir.

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ı isteklerin sayısı

totalRequests

integer

Toplu işlemdeki toplam istek sayısı