Search - Get Geocoding Batch

Başvuru

Hizmet:: Maps

API Sürümü:: 2023-06-01

Tek bir istekte Coğrafi Kodlama API'sine bir grup sorgu göndermek için kullanın.

Get Geocoding Batch API, Coğrafi Kodlama API'sine tek bir istekte en çok 100 sorgudan oluşan toplu işlemler gönderen bir HTTP POST isteğidir.

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

Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplandığında hemen yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API bir zaman aşımı hatası (408 yanıtı) döndürür. Bu API için toplu iş öğelerinin sayısı 100 ile sınırlıdır.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Toplu İstek için POST Gövdesi

Coğrafi kodlama sorgularını göndermek için istek gövdesinin diziyi json biçiminde içerdiği batchItems ve Content-Type üst bilginin olarak ayarlanacağı application/jsonbir POST istek kullanacaksınız. Burada 2 coğrafi kodlama sorgusu içeren bir örnek istek gövdesi verilmişti :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Coğrafi kodlama batchItem nesnesi desteklenen coğrafi kodlamaURI parametrelerinden herhangi birini kabul edebilir.

Toplu işlem en az 1 sorgu içermelidir.

Toplu Yanıt Modeli

Toplu yanıt, özgün toplu iş isteğinin totalRequests parçası olan öğesini ve successfulRequests örneğin başarıyla yürütülen sorguları gösteren bir summary bileşen içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizi de içerir. , batchItems sonuçları özgün sorguların toplu istekte gönderildiği sırayla içerir. Her öğe aşağıdaki türlerden biridir:

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

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
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	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 Azure AD güvenliğini kullanmak için rehberlik için aşağıdaki makalelere bakın.
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.

Name

Gerekli

Tür

Description

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

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.

İstek Gövdesi

Name	Tür	Description
batchItems	GeocodingBatchRequestItem[]	İşlenmek üzere sorguların listesi.

Yanıtlar

Name	Tür	Description
200 OK	GeocodingBatchResponse	Tamam
Other Status Codes	ErrorResponse	Beklenmeyen bir hata oluştu.

Güvenlik

AADToken

Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimi ile 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ç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ğını 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 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 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.

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

Tür: apiKey
İçinde: header

Örnekler

A Geocoding Batch API call containing 2 Geocoding queries

Örnek isteği

HTTP

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Örnek yanıt

Durum kodu:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' was passed"
      }
    }
  ]
}

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	Ö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.
GeocodingBatchRequestBody	İşlenmek üzere adres coğrafi kodlama sorgularının/isteklerinin listesi. Liste en fazla 100 sorgu içerebilir ve en az 1 sorgu içermelidir.
GeocodingBatchRequestItem	Batch Query nesnesi
GeocodingBatchResponse	Bu nesne başarılı bir Coğrafi Kodlama Batch hizmeti çağrısından döndürülür.
GeocodingBatchResponseItem
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
Summary	Toplu iş isteğinin özeti
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

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 `Medium`ayarlanı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 `Medium`ayarlanı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.

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	Özelliğin türü Özellik olmalıdır.

FeatureTypeEnum

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

GeocodingBatchRequestBody

İşlenmek üzere adres coğrafi kodlama sorgularının/isteklerinin listesi. Liste en fazla 100 sorgu içerebilir ve en az 1 sorgu içermelidir.

Name	Tür	Description
batchItems	GeocodingBatchRequestItem[]	İşlenmek üzere sorguların listesi.

GeocodingBatchRequestItem

Batch Query nesnesi

Name	Tür	Default value	Description
addressLine	string		Yerellik veya postaKod özellikleri tarafından belirtilen, 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 verildiyse, bu parametreyi kullanmamalıdır.
adminDistrict	string		Wa gibi bir adresin ülke alt bölümü. Sorgu verildiyse, bu parametreyi kullanmamalıdır.
adminDistrict2	string		King gibi yapılandırılmış adresin ilçesi. Sorgu verildiyse, bu parametreyi kullanmamalıdır.
adminDistrict3	string		Yapılandırılmış adresin adlandırılmış alanı. Sorgu verildiyse, bu parametreyi kullanmamalıdır.
bbox	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. Daha fazla bilgi için bkz. Konum ve Alan Türleri. Bu parametreyi belirttiğinizde, konum sorgusunun sonuçları hesaplanırken coğrafi alan dikkate alınır. Örnek: [lon1, lat1, lon2, lat2]
coordinates	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: [lon, lat]
countryRegion	string		Coğrafi kodlama sonucu için belirtilen ISO 3166-1 Alfa-2 bölge/ülke kodu sinyali(fr./ gibi) Sorgu verildiyse, bu parametreyi kullanmamalıdır.
locality	string		Adresin seattle gibi yerellik bölümü. Sorgu verildiyse, bu parametreyi kullanmamalıdır.
optionalId	string		karşılık gelen batchItem içinde gösterilecek isteğin kimliği
postalCode	string		Adresin posta kodu bölümü. Sorgu verildiyse, bu parametreyi kullanmamalıdır.
query	string		Adres veya yer işareti adı gibi bir konum hakkında bilgi içeren dize.
top	integer	5	Döndürülecek en fazla yanıt sayısı. Varsayılan: 5, en az: 1 ve maksimum: 20.
view	string	auto	ISO 3166-1 Alfa-2 bölge/ülke kodunu belirten bir dize. Bu işlem Jeopolitik olarak tartışmalı kenarlıkları ve etiketleri belirtilen kullanıcı bölgesiyle uyumlu olacak şekilde değiştirir.

GeocodingBatchResponse

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

Name	Tür	Description
batchItems	GeocodingBatchResponseItem[]	Toplu iş sonuçlarını içeren dizi.
nextLink	string	, döndürülen özelliklerin sonraki sayfasının bağlantısıdır. Bu son sayfaysa, bu alan yok.
summary	Summary	Toplu iş isteğinin özeti

GeocodingBatchResponseItem

Name	Tür	Description
error	ErrorDetail	Hata ayrıntısı.
features	FeaturesItem[]
nextLink	string	, döndürülen özelliklerin sonraki sayfasının bağlantısıdır. Bu son sayfaysa, bu alan yok.
optionalId	string	istekteki kimlikle aynı olacak batchItem kimliği
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ştirme hakkında daha eksiksiz bilgi için bu değeri eşleştirme koduyla 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 bağlıdır.
geocodePoints	GeocodePoints[]	Hesaplanma şekli ve önerilen kullanımları bakımından farklılık gösteren 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, eşleşme kodları `Good` olan coğrafi kodlu 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 yukarı hiyerarşide arama yapmadığı anlamına gelir. Benzer şekilde, eşleşme kodları `Ambiguous` olan coğrafi kodlu bir konum ve `UpHierarchy` belirtilen tüm konum bilgileriyle eşleşen bir coğrafi kod konumunun bulunamadığını gösterir, bu nedenle coğrafi kod hizmetinin hiyerarşiyi araması gerekiyordu ve bu düzeyde birden çok eşleşme buldu. Ve sonucunun `AmbiguousUpHierarchy` bir örneği, tam adres bilgilerini sağladığınızda, ancak coğrafi kod hizmeti sokak adresi için bir eşleşme bulamadığınızda ve bunun yerine birden fazla RoadBlock değeri için bilgi döndürdüğünde ortaya çıkar. Olası değerler şunlardır: `Good`: Konumda yalnızca bir eşleşme var 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 Main St. 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. Bu, konum isteği için bir eşleşme bulunamadığında 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 eşleşme kodu `UpHierarchy` döndürülebilir.
type	string	Bunlardan biri: Adres Barikat RoadIntersection Mahalle Doldurulan Yer Posta kodu1 AdminDivision1 AdminDivision2 CountryRegion

Summary

Toplu iş isteğinin özeti

Name	Tür	Description
successfulRequests	integer	Toplu işlemdeki başarılı istek sayısı
totalRequests	integer	Toplu işlemdeki toplam istek sayısı

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

Aracılığıyla paylaş

Search - Get Geocoding Batch

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

Toplu İstek için POST Gövdesi

Toplu Yanıt Modeli

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

AADToken

Kapsamlar

subscription-key

SAS Token

Örnekler

A Geocoding Batch API call containing 2 Geocoding queries

Örnek isteği

Örnek yanıt

Tanımlar

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum

Ek kaynaklar