Aracılığıyla paylaş

Search - Get Geocoding

Hizmet:
Maps
API Sürümü:
2025-01-01

Bir sokak adresinin veya bir yerin adının boylam ve enlem koordinatlarını almak için kullanın.

Get Geocoding API,aranmakta olan konumun boylam ve enlem koordinatlarını döndüren bir HTTP GET isteğidir.

Çoğu durumda, yalnızca geleneksel coğrafi kodlamayla ilgileniyorsanız, tam arama hizmeti çok fazla olabilir. Yalnızca adres arama için de arama yapılabilir. Coğrafi kodlama, yalnızca söz konusu adres veya kısmi adresle coğrafi kodlama uç noktasına isabet ederek gerçekleştirilir. Coğrafi kodlama arama dizini, sokak düzeyindeki verilerin üzerindeki her şey için sorgulanır. İlgi Noktası (POI) döndürülmeyecek. Coğrafi kodlayıcının yazım hatalarına ve eksik adreslere çok dayanıklı olduğunu unutmayın. Ayrıca sokak adreslerinden, sokak veya kavşaklardan ve şehir merkezleri, ilçeler ve eyaletler gibi daha üst düzey coğrafyalardan her şeyi ele alacaktır. Yanıt ayrıca sokak, posta kodu, belediye ve ülke/bölge bilgileri gibi ayrıntılı adres özelliklerini döndürür.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01
İsteğe bağlı parametrelerle: 
GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

URI Parametreleri

Name İçinde Gerekli Tür Description
api-version
 query True

string

Azure Haritalar API'sinin sürüm numarası.
addressLine
 query

string

Yerellik veya postakod özellikleri tarafından belirtilen, alana göre bir adresin resmi sokak satırı. Bu öğenin tipik kullanımı bir sokak adresi veya herhangi bir resmi adres sağlamaktır.

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
adminDistrict
 query

string

Adresin WA gibi ülke alt bölümü.

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
adminDistrict2
 query

string

Yapılandırılmış adresin ilçesi, örneğin King.

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
adminDistrict3
 query

string

Yapılandırılmış adres için adlandırılmış alan.

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
bbox
 query

number[]

Yeryüzünde sınırlayıcı kutu nesnesi olarak tanımlanan dikdörtgen bir alan. Dikdörtgenlerin kenarları boylam ve enlem değerleriyle tanımlanır. Bu parametreyi belirttiğinizde, konum sorgusunun sonuçları hesaplanırken coğrafi alan dikkate alınır.

Örnek: lon1,lat1,lon2,lat2
coordinates
 query

number[]

Yeryüzünde boylam ve enlem olarak belirtilen bir nokta. Bu parametreyi belirttiğinizde, kullanıcının konumu dikkate alınır ve döndürülen sonuçlar kullanıcıyla daha ilgili olabilir. Örnek: &koordinatları=lon,lat
countryRegion
 query

string

Coğrafi kodlama sonucunun, belirtilen ISO 3166-1 Alfa-2 bölge/ülke kodu (fr/ gibi) için sinyal

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
locality
 query

string

Adresin seattle gibi yerellik bölümü.

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
postalCode
 query

string

Adresin posta kodu bölümü.

Parametre isteğe dahil edildiğinde query bu parametre kullanılmamalıdır.
query
 query

string

Adres veya yer işareti adı gibi bir konum hakkında bilgi içeren dize.
top
 query

integer (int32)

minimum: 1
maximum: 20

Döndürülecek en fazla yanıt sayısı. Varsayılan: 5, en az: 1 ve en fazla: 20.
view
 query

string

ISO 3166-1 Alfa-2 bölge/ülke kodunutemsil eden bir dize. Bu, jeopolitik ihtilaflı kenarlıkları ve etiketleri belirtilen kullanıcı bölgesiyle uyumlu olacak şekilde değiştirir. Varsayılan olarak, görünüm parametresi istekte tanımlamamış olsanız bile "Otomatik" olarak ayarlanır.

Ayrıntılar ve kullanılabilir Görünümleri görmek için lütfen Desteklenen Görünümler bakın.

İstek Başlığı

Name Gerekli Tür Description
Accept-Language

string

Arama sonuçlarının döndürülmesi gereken dil.

Ayrıntılar için lütfen Desteklenen Diller bakın.
x-ms-client-id

string

Azure AD güvenlik modeliyle birlikte hangi hesabın 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'da Microsoft Entra ID güvenliğini kullanma hakkında daha fazla bilgi için bkz.

Yanıtlar

Name Tür Description
200 OK

GeocodingResponse

Tamam

Media Types: "application/geo+json"

Üst Bilgiler

x-ms-request-id: string
Other Status Codes

ErrorResponse

Beklenmeyen bir hata oluştu.

Media Types: "application/geo+json"

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önetim API'sindenedinilebilir.
  • 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, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla bir Azure Haritalar kaynağı oluşturulurken sağlanan paylaşılan bir anahtardır.

Bu anahtarla, tüm uygulamalar tüm REST API'lerine erişim yetkisine sahip olur. Başka bir deyişle, bunlar şu anda verildikleri hesabın ana anahtarları olarak değerlendirilebilir.

Genel kullanıma sunulan uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabildiği Azure Haritalar REST API'lerinin sunucudan sunucuya erişimini kullanmaktır.

Tür: apiKey
İçinde: header

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

Search detail address 15127 NE 24th Street, Redmond, WA
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Search detail address 15127 NE 24th Street, Redmond, WA by query
Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

Örnek isteği

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Örnek yanıt

Durum kodu:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Örnek isteği

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Örnek yanıt

Durum kodu:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

Örnek isteği

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=15127 NE 24th Street Redmond WA

Örnek yanıt

Durum kodu:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

Örnek isteği

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=empire state building

Örnek yanıt

Durum kodu:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Tanımlar

Name Description
Address

Sonucun adresi
AdminDistricts

Bir adresin ülke veya bölgedeki alt bölüm adı. Bu öğe genellikle ilk sıra yönetim alt bölümü olarak değerlendirilir, ancak bazı durumlarda bir ülke, bağımlılık veya bölgedeki ikinci, üçüncü veya dördüncü sıra alt bölümünü de içerir.
CalculationMethodEnum

Coğrafi kod noktasını hesaplamak için kullanılan yöntem.
ConfidenceEnum

Coğrafi olarak kodlanmış konum sonucunun eşleşmesi güven düzeyi. Eşleşme hakkında daha ayrıntılı bilgi için bu değeri eşleştirme koduyla birlikte kullanın.

Coğrafi olarak kodlanmış bir konumun güvenilirliği, coğrafi olarak kodlanmış konumun ve belirtildiyse kullanıcının konumunun göreli önemi de dahil olmak üzere birçok faktöre dayanır.
CountryRegion
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.
ErrorDetail

Hata ayrıntısı.
ErrorResponse

Hata yanıtı
FeatureCollectionEnum

FeatureCollection nesnesinin türü FeatureCollection olmalıdır.
FeaturesItem
FeatureTypeEnum

Bir özelliğin türü Özellik olmalıdır.
GeocodePoints

Hesaplanma şekli ve önerilen kullanımları bakımından farklılık gösteren bir coğrafi kod noktaları koleksiyonu.
GeocodingResponse

Bu nesne başarılı bir Coğrafi Kodlama çağrısından döndürülür
GeoJsonPoint

Geçerli bir GeoJSON Point geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.
Intersection

Sonucun adresi.
MatchCodesEnum

Yanıttaki her konumun coğrafi kodlama düzeyini temsil eden bir veya daha fazla eşleşme kodu değeri.

Örneğin, Good ve Ambiguous eşleşme kodlarıyla coğrafi olarak kodlanmış bir konum, konum bilgileri için birden fazla coğrafi kod konumu bulunduğu ve coğrafi kod hizmetinin eşleşme bulmak için hiyerarşiyi aramadığı anlamına gelir.

Benzer şekilde, Ambiguous ve UpHierarchy eşleşme kodlarıyla coğrafi olarak kodlanmış bir konum, sağlanan tüm konum bilgileriyle eşleşen bir coğrafi kod konumunun bulunamadığını gösterir, bu nedenle coğrafi kod hizmetinin yukarı hiyerarşiyi araması ve bu düzeyde birden çok eşleşme bulması gerekir. bir Ambiguous ve UpHierarchy sonucunun bir örneği, tam adres bilgileri sağladığınız, ancak coğrafi kod hizmetinin sokak adresi için bir eşleşme bulamaması ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürmesidir.

Olası değerler şunlardır:

Good: Konumda yalnızca bir eşleşme vardır veya döndürülen tüm eşleşmeler güçlü eşleşmeler olarak kabul edilir. Örneğin, New York sorgusu birkaç İyi eşleşme döndürür.

Ambiguous: Konum, bir dizi olası eşleşmeden biridir. Örneğin, 128 Ana Cadde sokak adresini sorguladığınızda, hangi seçeneğin seçileceğini belirlemek için yeterli bilgi olmadığından, yanıt 128 Kuzey Ana Cadde ve 128 Güney Ana Cadde için iki konum döndürebilir.

UpHierarchy: Konum, coğrafi hiyerarşide yukarı taşımayı temsil eder. Konum isteği için bir eşleşme bulunamadığında bu durum oluşur, bu nedenle daha az kesin bir sonuç döndürülür. Örneğin, istenen adres için eşleşme bulunamazsa, RoadBlock varlık türüne sahip UpHierarchy eşleşme kodu döndürülebilir.
Properties
UsageTypeEnum

Coğrafi kod noktası için en iyi kullanım. Her coğrafi kod noktası bir Route noktası, Display noktası veya her ikisi olarak tanımlanır. Konuma bir yol oluşturuyorsanız Route noktaları kullanın. Konumu haritada gösteriyorsanız Display noktaları kullanın. Örneğin, konum bir parksa, Route noktası bir araba ile girebileceğiniz bir park girişi belirtebilir ve Display noktası parkın merkezini belirten bir nokta olabilir.

Address

Object

Sonucun adresi

Name Tür Description
addressLine

string

Sokak Adı ve Numarası içeren Adres Çizgisi
adminDistricts

AdminDistricts[]

Bir adresin ülke veya bölgedeki alt bölüm adı. Bu öğe genellikle ilk sıra yönetim alt bölümü olarak değerlendirilir, ancak bazı durumlarda bir ülke, bağımlılık veya bölgedeki ikinci, üçüncü veya dördüncü sıra alt bölümünü de içerir.
countryRegion

CountryRegion

formattedAddress

string

Biçimlendirilmiş Adres özelliği
intersection

Intersection

Sonucun adresi.
locality

string

locality özelliği
neighborhood

string

mahalle özelliği
postalCode

string

Posta Kodu özelliği
streetName

string

formattedAddress'teki sokağın adı
streetNumber

string

Sokaktaki numara (varsa) formattedAddress

AdminDistricts

Object

Bir adresin ülke veya bölgedeki alt bölüm adı. Bu öğe genellikle ilk sıra yönetim alt bölümü olarak değerlendirilir, ancak bazı durumlarda bir ülke, bağımlılık veya bölgedeki ikinci, üçüncü veya dördüncü sıra alt bölümünü de içerir.

Name Tür Description
name

string

karşılık gelen adminDistrict alanının adı olan adminDistrict[0] için bu, Washington, For adminDistrict[1] gibi bir eyaletin tam adı olabilir; bu, ilçenin tam adı olabilir
shortName

string

Karşılık gelen adminDistrict alanının kısa adı olan adminDistrict[0] için bu, WA, For adminDistrict[1] gibi kısa bir durum adı olabilir; bu, ilçenin kısa adı olabilir

CalculationMethodEnum

Listeleme

Coğrafi kod noktasını hesaplamak için kullanılan yöntem.

Değer Description
Interpolation

Coğrafi kod noktası, enterpolasyon kullanılarak bir yoldaki bir noktayla eşleştirildi.
InterpolationOffset

Coğrafi kod noktası, noktayı caddenin kenarına kaydırmak için ek bir ofset ile enterpolasyon kullanılarak bir yoldaki bir noktayla eşleştirildi.
Parcel

Coğrafi kod noktası, bir parselin merkeziyle eşleştirildi.
Rooftop

Coğrafi kod noktası, bir binanın çatısıyla eşleştirildi.

ConfidenceEnum

Listeleme

Coğrafi olarak kodlanmış konum sonucunun eşleşmesi güven düzeyi. Eşleşme hakkında daha ayrıntılı bilgi için bu değeri eşleştirme koduyla birlikte kullanın.

Coğrafi olarak kodlanmış bir konumun güvenilirliği, coğrafi olarak kodlanmış konumun ve belirtildiyse kullanıcının konumunun göreli önemi de dahil olmak üzere birçok faktöre dayanır.

Değer Description
High

Güvenilirlik olarak Highayarlanırsa, bir veya daha fazla güçlü eşleşme bulundu. Çoklu High güvenilirlik eşleşmeleri, uygun olduğunda önem derecesine göre sıralanır. Örneğin, yer işaretlerinin önemi vardır, ancak adreslerin önemi yoktur.

Bir istek bir konum veya görünüm içeriyorsa sıralama uygun şekilde değişebilir. Örneğin, "Paris" için bir konum sorgusu, hem "Paris, Fransa" hem de High "Paris, TX" değerlerini güvenle döndürür. "Paris, Fransa", bir kullanıcı konumu kullanıcının Paris, Teksas'ta veya çok yakınında olduğunu göstermedikçe veya harita görünümü kullanıcının o bölgede arama yaptığını göstermedikçe, önem nedeniyle her zaman ilk sırada yer alır.
Medium

Bazı durumlarda, iade edilen eşleşme, istekte sağlanan bilgilerle aynı seviyede olmayabilir. Örneğin, bir istek adres bilgilerini belirtebilir ve coğrafi kod hizmeti yalnızca bir posta koduyla eşleşebilir. Bu durumda, coğrafi kod hizmetinin posta kodunun verilerle eşleştiğine dair bir güveni varsa, güven olarak Medium ayarlanır ve eşleşme kodu, tüm bilgilerle eşleşemediğini ve hiyerarşide arama yapması gerektiğini belirtmek için olarak UpHierarchy ayarlanır.

Sorgudaki konum bilgileri belirsizse ve konumları sıralamak için ek bilgi yoksa (kullanıcı konumu veya konumun göreli önemi gibi), güvenilirlik olarak Mediumayarlanır. Örneğin, "148th Ave, Bellevue" için bir konum sorgusu, "148th Ave SE" ve "148th Ave NE" ifadelerinin her ikisini de Medium güvenle döndürebilir.

Sorgudaki konum bilgileri belirli bir konumu coğrafi olarak kodlamak için yeterli bilgi sağlamıyorsa, daha az kesin bir konum değeri döndürülebilir ve güvenilirlik olarak Mediumayarlanır. Örneğin, bir adres sağlanmışsa ancak bina numarası için bir eşleşme bulunamazsa, Roadblock varlık türüne sahip coğrafi kod sonucu döndürülebilir.
Low

CountryRegion

Object
Name Tür Description
ISO

string

Iso ülke/bölge
name

string

ülke/bölge adı

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.
type

string

Ek bilgi türü.

ErrorDetail

Object

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

Object

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

FeatureCollectionEnum

Listeleme

FeatureCollection nesnesinin türü FeatureCollection olmalıdır.

Değer Description
FeatureCollection

FeaturesItem

Object
Name Tür Description
bbox

number[] (double)

Sınırlayıcı kutu. Projeksiyon kullanıldı - EPSG:3857. Ayrıntılar için lütfen RFC 7946 bakın.
geometry

GeoJsonPoint

Geçerli bir GeoJSON Point geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.
id

string

Döndürülen özelliğin kimliği
properties

Properties

type

FeatureTypeEnum

Bir özelliğin türü Özellik olmalıdır.

FeatureTypeEnum

Listeleme

Bir özelliğin türü Özellik olmalıdır.

Değer Description
Feature

GeocodePoints

Object

Hesaplanma şekli ve önerilen kullanımları bakımından farklılık gösteren bir coğrafi kod noktaları koleksiyonu.

Name Tür Description
calculationMethod

CalculationMethodEnum

Coğrafi kod noktasını hesaplamak için kullanılan yöntem.
geometry

GeoJsonPoint

Geçerli bir GeoJSON Point geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.
usageTypes

UsageTypeEnum[]

Coğrafi kod noktası için en iyi kullanım. Her coğrafi kod noktası bir Route noktası, Display noktası veya her ikisi olarak tanımlanır. Konuma bir yol oluşturuyorsanız Route noktaları kullanın. Konumu haritada gösteriyorsanız Display noktaları kullanın. Örneğin, konum bir parksa, Route noktası bir araba ile girebileceğiniz bir park girişi belirtebilir ve Display noktası parkın merkezini belirten bir nokta olabilir.

GeocodingResponse

Object

Bu nesne başarılı bir Coğrafi Kodlama çağrısından döndürülür

Name Tür Description
features

FeaturesItem[]

nextLink

string

, döndürülen özelliklerin sonraki sayfasının bağlantısıdır. Bu son sayfaysa, bu alan yok.
type

FeatureCollectionEnum

FeatureCollection nesnesinin türü FeatureCollection olmalıdır.

GeoJsonPoint

Object

Geçerli bir GeoJSON Point geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.

Name Tür Description
bbox

number[] (double)

Sınırlayıcı kutu. Projeksiyon kullanıldı - EPSG:3857. Ayrıntılar için lütfen RFC 7946 bakın.
coordinates

number[] (double)

Position, iki veya daha fazla öğe içeren bir sayı dizisidir. İlk iki öğe boylam ve enlemtam olarak bu sıradadır. Yükseklik/Yükseltme isteğe bağlı bir üçüncü öğedir. Ayrıntılar için lütfen RFC 7946 bakın.
type string:

Point

GeoJSON türünü belirtir. Dokuz geçerli GeoJSON nesne türünden biri olmalıdır: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature ve FeatureCollection.

Intersection

Object

Sonucun adresi.

Name Tür Description
baseStreet

string

Konum için birincil sokak.
displayName

string

Kesişimin tam adı.
intersectionType

string

Kesişim türü.
secondaryStreet1

string

kesişen ilk sokak.
secondaryStreet2

string

Eğer varsa, ikinci kesişen sokak.

MatchCodesEnum

Listeleme

Yanıttaki her konumun coğrafi kodlama düzeyini temsil eden bir veya daha fazla eşleşme kodu değeri.

Örneğin, Good ve Ambiguous eşleşme kodlarıyla coğrafi olarak kodlanmış bir konum, konum bilgileri için birden fazla coğrafi kod konumu bulunduğu ve coğrafi kod hizmetinin eşleşme bulmak için hiyerarşiyi aramadığı anlamına gelir.

Benzer şekilde, Ambiguous ve UpHierarchy eşleşme kodlarıyla coğrafi olarak kodlanmış bir konum, sağlanan tüm konum bilgileriyle eşleşen bir coğrafi kod konumunun bulunamadığını gösterir, bu nedenle coğrafi kod hizmetinin yukarı hiyerarşiyi araması ve bu düzeyde birden çok eşleşme bulması gerekir. bir Ambiguous ve UpHierarchy sonucunun bir örneği, tam adres bilgileri sağladığınız, ancak coğrafi kod hizmetinin sokak adresi için bir eşleşme bulamaması ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürmesidir.

Olası değerler şunlardır:

Good: Konumda yalnızca bir eşleşme vardır veya döndürülen tüm eşleşmeler güçlü eşleşmeler olarak kabul edilir. Örneğin, New York sorgusu birkaç İyi eşleşme döndürür.

Ambiguous: Konum, bir dizi olası eşleşmeden biridir. Örneğin, 128 Ana Cadde sokak adresini sorguladığınızda, hangi seçeneğin seçileceğini belirlemek için yeterli bilgi olmadığından, yanıt 128 Kuzey Ana Cadde ve 128 Güney Ana Cadde için iki konum döndürebilir.

UpHierarchy: Konum, coğrafi hiyerarşide yukarı taşımayı temsil eder. Konum isteği için bir eşleşme bulunamadığında bu durum oluşur, bu nedenle daha az kesin bir sonuç döndürülür. Örneğin, istenen adres için eşleşme bulunamazsa, RoadBlock varlık türüne sahip UpHierarchy eşleşme kodu döndürülebilir.

Değer Description
Good
Ambiguous
UpHierarchy

Properties

Object
Name Tür Description
address

Address

Sonucun adresi
confidence

ConfidenceEnum

Coğrafi olarak kodlanmış konum sonucunun eşleşmesi güven düzeyi. Eşleşme hakkında daha ayrıntılı bilgi için bu değeri eşleştirme koduyla birlikte kullanın.

Coğrafi olarak kodlanmış bir konumun güvenilirliği, coğrafi olarak kodlanmış konumun ve belirtildiyse kullanıcının konumunun göreli önemi de dahil olmak üzere birçok faktöre dayanır.
geocodePoints

GeocodePoints[]

Hesaplanma şekli ve önerilen kullanımları bakımından farklılık gösteren bir coğrafi kod noktaları koleksiyonu.
matchCodes

MatchCodesEnum[]

Yanıttaki her konumun coğrafi kodlama düzeyini temsil eden bir veya daha fazla eşleşme kodu değeri.

Örneğin, Good ve Ambiguous eşleşme kodlarıyla coğrafi olarak kodlanmış bir konum, konum bilgileri için birden fazla coğrafi kod konumu bulunduğu ve coğrafi kod hizmetinin eşleşme bulmak için hiyerarşiyi aramadığı anlamına gelir.

Benzer şekilde, Ambiguous ve UpHierarchy eşleşme kodlarıyla coğrafi olarak kodlanmış bir konum, sağlanan tüm konum bilgileriyle eşleşen bir coğrafi kod konumunun bulunamadığını gösterir, bu nedenle coğrafi kod hizmetinin yukarı hiyerarşiyi araması ve bu düzeyde birden çok eşleşme bulması gerekir. bir Ambiguous ve UpHierarchy sonucunun bir örneği, tam adres bilgileri sağladığınız, ancak coğrafi kod hizmetinin sokak adresi için bir eşleşme bulamaması ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürmesidir.

Olası değerler şunlardır:

Good: Konumda yalnızca bir eşleşme vardır veya döndürülen tüm eşleşmeler güçlü eşleşmeler olarak kabul edilir. Örneğin, New York sorgusu birkaç İyi eşleşme döndürür.

Ambiguous: Konum, bir dizi olası eşleşmeden biridir. Örneğin, 128 Ana Cadde sokak adresini sorguladığınızda, hangi seçeneğin seçileceğini belirlemek için yeterli bilgi olmadığından, yanıt 128 Kuzey Ana Cadde ve 128 Güney Ana Cadde için iki konum döndürebilir.

UpHierarchy: Konum, coğrafi hiyerarşide yukarı taşımayı temsil eder. Konum isteği için bir eşleşme bulunamadığında bu durum oluşur, bu nedenle daha az kesin bir sonuç döndürülür. Örneğin, istenen adres için eşleşme bulunamazsa, RoadBlock varlık türüne sahip UpHierarchy eşleşme kodu döndürülebilir.
type

string

Bunlardan biri:

  • Adres
  • Barikat
  • RoadIntersection
  • Mahalle
  • PopulatedPlace
  • Postcode1
  • AdminDivision1
  • AdminDivision2
  • ÜlkeBölge

UsageTypeEnum

Listeleme

Coğrafi kod noktası için en iyi kullanım. Her coğrafi kod noktası bir Route noktası, Display noktası veya her ikisi olarak tanımlanır. Konuma bir yol oluşturuyorsanız Route noktaları kullanın. Konumu haritada gösteriyorsanız Display noktaları kullanın. Örneğin, konum bir parksa, Route noktası bir araba ile girebileceğiniz bir park girişi belirtebilir ve Display noktası parkın merkezini belirten bir nokta olabilir.

Değer Description
Display
Route