Aracılığıyla paylaş

Search - Get Geocoding

  • Başvuru
Service:
Maps
API Version:
2023-06-01

Sokak adresinin boylam ve enlem koordinatlarını veya bir yerin adı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, ö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, 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 Çekici Nokta (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 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 de döndürür.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01
With optional parameters: 
GET https://atlas.microsoft.com/geocode?api-version=2023-06-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 belirtildiği gibi, alana göre adresin resmi sokak satırı. Bu öğenin tipik kullanımı bir sokak adresi veya herhangi bir resmi adres sağlamaktır.

Sorgu verilirse, bu parametreyi kullanmamalıdır.
adminDistrict
 query

string

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

Sorgu verilirse, bu parametreyi kullanmamalıdır.
adminDistrict2
 query

string

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

Sorgu verilirse, bu parametreyi kullanmamalıdır.
adminDistrict3
 query

string

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

Sorgu verilirse, bu parametreyi kullanmamalıdır.
bbox
 query

number[]

Dünya üzerinde 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[]

Dünyada 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ı için daha ilgili olabilir. Örnek: &koordinatları=lon,lat
countryRegion
 query

string

Coğrafi kodlama sonucu için belirtilen ISO 3166-1 Alfa-2 bölge/ülke koduna yönelik sinyal (örn. FR./

Sorgu verilirse, bu parametreyi kullanmamalıdır.
locality
 query

string

Adresin seattle gibi yerellik bölümü.

Sorgu verilirse, bu parametreyi kullanmamalıdır.
postalCode
 query

string

Adresin posta kodu bölümü.

Sorgu verildiyse, bu parametreyi kullanmamalıdır.
query
 query

string

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

integer

int32

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

string

ISO 3166-1 Alfa-2 bölge/ülke kodunu temsil 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'e 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'e bakın.
x-ms-client-id

string

Hangi hesabın Azure AD 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 Azure AD güvenliği kullanmak için rehberlik için aşağıdaki makalelere bakın.

Yanıtlar

Name Tür Description
200 OK

GeocodingResponse

Tamam

Media Types: "application/geo+json"

Headers

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ı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-idgerektirir. 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, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağı oluştururken 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.

Herkese açık uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabileceği Azure Haritalar REST API'lerinin sunucudan sunucuya erişiminin kullanılmasıdır.

Type: apiKey
In: 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ğı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
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

Sample Request

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

Sample Response

Status code:
200 
Content-Type: application/geo+json
Response Body
{
  "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",
          "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

Sample Request

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

Sample Response

Status code:
200 
Content-Type: application/geo+json
Response Body
{
  "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",
          "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

Sample Request

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

Sample Response

Status code:
200 
Content-Type: application/geo+json
Response Body
{
  "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",
          "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

Sample Request

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

Sample Response

Status code:
200 
Content-Type: application/geo+json
Response Body
{
  "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 birinci 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 fazla 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 şekline ve önerilen kullanımlarına göre 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 GeoJSON Point bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Intersection

Sonucun adresi.
MatchCodesEnum

Yanıttaki her konum için coğrafi kodlama düzeyini temsil eden bir veya daha fazla kod değeri eşleştirin.

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

Benzer şekilde, eşleme kodları Ambiguous ve UpHierarchy ile 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 hiyerarşiyi yukarı araması gerekiyordu ve bu düzeyde birden çok eşleşme buldu. Ve sonucunun AmbiguousUpHierarchy bir örneği, tam adres bilgilerini sağladığınız, ancak coğrafi kod hizmetinin sokak adresi için bir eşleşme bulamadığı ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürdüğü durumdur.

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, olası eşleşme kümelerinden 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 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 bir eşleşme bulunamazsa, RoadBlock varlık türüyle eşleşme kodu UpHierarchy döndürülebilir.
Properties
UsageTypeEnum

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

Address

Sonucun adresi

Name Tür Description
addressLine

string

Sokak Adı ve Numarası içeren AddressLine
adminDistricts

AdminDistricts[]

Bir adresin ülke veya bölgedeki alt bölüm adı. Bu öğe genellikle birinci 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

AdminDistricts

Bir adresin ülke veya bölgedeki alt bölüm adı. Bu öğe genellikle birinci 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

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

Name Tür Description
Interpolation

string

Coğrafi kod noktası, ilişkilendirme kullanılarak yol üzerindeki bir noktayla eşleştirildi.
InterpolationOffset

string

Coğrafi kod noktası, noktayı caddenin kenarına kaydırmak için ek bir uzaklık ile ilişkilendirme kullanılarak yol üzerindeki bir noktayla eşleştirildi.
Parcel

string

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

string

Coğrafi kod noktası bir binanın çatısı ile eşleşti.

ConfidenceEnum

Coğrafi olarak kodlanmış konum sonucunun eşleşmesi güven düzeyi. Eşleşme hakkında daha fazla 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.

Name Tür Description
High

string

Güven olarak ayarlandıysa High, bir veya daha fazla güçlü eşleşme bulundu. Birden çok High güvenilirlik eşleşmesi, uygun olduğunda önem derecelerine göre sıralanır. Örneğin, yer işaretlerinin önemi vardır ancak adresler önemli değildir.

bir istek bir konum veya görünüm içeriyorsa, sıralama uygun şekilde değişebilir. Örneğin, "Paris" için konum sorgusu "Paris, Fransa" ve "Paris, TX" ifadelerini High güvenle döndürür. "Paris, Fransa", bir kullanıcı konumu kullanıcının Paris, TX veya harita görünümü içinde veya çok yakın olduğunu belirtmediği sürece önem derecesi nedeniyle her zaman birinci sırada yer alır.
Low

string

Medium

string

Bazı durumlarda, döndürülen eşleşme istekte sağlanan bilgilerle aynı düzeyde 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 hizmeti posta kodunun verilerle eşleştiğinden eminse, güvenilirlik olarak ayarlanır Medium ve eşleştirme kodu tüm bilgilerle eşleşmediğini ve hiyerarşide arama yapmak zorunda kaldığını belirtmek için olarak ayarlanır UpHierarchy .

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

Sorgudaki konum bilgileri belirli bir konumu coğrafi 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 ev numarası için eşleşme bulunamazsa, Roadblock varlık türüne sahip coğrafi kod sonucu döndürülebilir.

CountryRegion

Name Tür Description
ISO

string

Ülke/bölge ISO'sunun
name

string

ülke/bölge adı

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.

FeatureCollectionEnum

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

Name Tür Description
FeatureCollection

string

FeaturesItem

Name Tür Description
bbox

number[]

Sınırlayıcı kutu. Kullanılan projeksiyon - EPSG:3857. Ayrıntılar için lütfen RFC 7946'ya bakın.
geometry

GeoJsonPoint

Geçerli GeoJSON Point bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya 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

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

Name Tür Description
Feature

string

GeocodePoints

Hesaplanma şekline ve önerilen kullanımlarına göre 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 GeoJSON Point bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
usageTypes

UsageTypeEnum[]

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

GeocodingResponse

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

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

Name Tür Description
bbox

number[]

Sınırlayıcı kutu. Kullanılan projeksiyon - EPSG:3857. Ayrıntılar için lütfen RFC 7946'ya bakın.
coordinates

number[]

A Position , iki veya daha fazla öğe içeren bir sayı dizisidir. İlk iki öğe boylam ve enlemdir ve tam olarak bu sıradadır. Rakım/Yükseklik isteğe bağlı bir üçüncü öğedir. Ayrıntılar için lütfen RFC 7946'ya 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

Sonucun adresi.

Name Tür Description
baseStreet

string

Yer için birincil cadde.
displayName

string

Kesişimin tam adı.
intersectionType

string

Kesişim türü.
secondaryStreet1

string

kesişen ilk sokak.
secondaryStreet2

string

Varsa, kesişen ikinci sokak.

MatchCodesEnum

Yanıttaki her konum için coğrafi kodlama düzeyini temsil eden bir veya daha fazla kod değeri eşleştirin.

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

Benzer şekilde, eşleme kodları Ambiguous ve UpHierarchy ile 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 hiyerarşiyi yukarı araması gerekiyordu ve bu düzeyde birden çok eşleşme buldu. Ve sonucunun AmbiguousUpHierarchy bir örneği, tam adres bilgilerini sağladığınız, ancak coğrafi kod hizmetinin sokak adresi için bir eşleşme bulamadığı ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürdüğü durumdur.

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, olası eşleşme kümelerinden 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 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 bir eşleşme bulunamazsa, RoadBlock varlık türüyle eşleşme kodu UpHierarchy döndürülebilir.

Name Tür Description
Ambiguous

string

Good

string

UpHierarchy

string

Properties

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 fazla 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 şekline ve önerilen kullanımlarına göre farklılık gösteren bir coğrafi kod noktaları koleksiyonu.
matchCodes

MatchCodesEnum[]

Yanıttaki her konum için coğrafi kodlama düzeyini temsil eden bir veya daha fazla kod değeri eşleştirin.

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

Benzer şekilde, eşleme kodları Ambiguous ve UpHierarchy ile 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 hiyerarşiyi yukarı araması gerekiyordu ve bu düzeyde birden çok eşleşme buldu. Ve sonucunun AmbiguousUpHierarchy bir örneği, tam adres bilgilerini sağladığınız, ancak coğrafi kod hizmetinin sokak adresi için bir eşleşme bulamadığı ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürdüğü durumdur.

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, olası eşleşme kümelerinden 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 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 bir eşleşme bulunamazsa, RoadBlock varlık türüyle eşleşme kodu UpHierarchy döndürülebilir.
type

string

Bunlardan biri:

  • Adres
  • Barikat
  • RoadIntersection
  • Mahalle
  • PopulatedPlace
  • Postcode1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

UsageTypeEnum

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

Name Tür Description
Display

string

Route

string