Search - Get Geocoding Batch

Referensi

Service:: Maps

API Version:: 2023-06-01

Gunakan untuk mengirim batch kueri ke API Geocoding dalam satu permintaan.

Get Geocoding Batch API adalah permintaan HTTP POST yang mengirim batch hingga 100 kueri ke API Geocoding dalam satu permintaan.

Kirim Permintaan Batch Sinkron

API Sinkron direkomendasikan untuk permintaan batch yang ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan memakan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.

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

Isi POST untuk Permintaan Batch

Untuk mengirim kueri geocoding , Anda akan menggunakan POST permintaan di mana isi permintaan akan berisi batchItems array dalam json format dan Content-Type header akan diatur ke application/json. Berikut adalah isi permintaan sampel yang berisi 2 kueri geocoding :

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

Objek batchItem geocoding dapat menerima salah satu parameter URIgeocoding yang didukung.

Batch harus berisi setidaknya 1 kueri.

Model Respons Batch

Respons batch berisi summary komponen yang menunjukkan totalRequests bahwa yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan batchItems array yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item adalah dari salah satu jenis berikut:

GeocodingResponse - Jika kueri berhasil diselesaikan.
Error - Jika kueri gagal. Respons akan berisi code dan message dalam hal ini.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Nomor versi API Azure Maps.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Azure AD. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Azure AD di Azure Maps lihat artikel berikut untuk panduan.
Accept-Language		string	Bahasa di mana hasil pencarian harus dikembalikan. Silakan merujuk ke Bahasa yang Didukung untuk detailnya.

Nama

Diperlukan

Jenis

Deskripsi

x-ms-client-id

string

Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Azure AD. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Azure AD di Azure Maps lihat artikel berikut untuk panduan.

Accept-Language

string

Bahasa di mana hasil pencarian harus dikembalikan.

Silakan merujuk ke Bahasa yang Didukung untuk detailnya.

Isi Permintaan

Nama	Jenis	Deskripsi
batchItems	GeocodingBatchRequestItem[]	Daftar kueri yang akan diproses.

Respons

Nama	Jenis	Deskripsi
200 OK	GeocodingBatchResponse	OK
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.
Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID.
Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, ini saat ini dapat diperlakukan sebagai kunci master ke akun tempat mereka dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server Azure Maps REST API tempat kunci ini dapat disimpan dengan aman.

Type: apiKey
In: header

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol fine-grain ke kedaluwarsa, tarif, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

A Geocoding Batch API call containing 2 Geocoding queries

Sample Request

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

Sample Response

Status code:: 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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
Address	Alamat hasil
AdminDistricts	Nama subdivisi di negara atau wilayah untuk alamat. Elemen ini biasanya diperlakukan sebagai subdivisi administratif urutan pertama, tetapi dalam beberapa kasus juga berisi subdivisi urutan kedua, ketiga, atau keempat di negara, dependensi, atau wilayah.
CalculationMethodEnum	Metode yang digunakan untuk menghitung titik geocode.
ConfidenceEnum	Tingkat keyakinan bahwa hasil lokasi yang dikodekan secara geografis adalah kecocokan. Gunakan nilai ini dengan kode kecocokan untuk menentukan informasi lebih lengkap tentang kecocokan. Keyakinan lokasi yang di-geocode didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi geocoded dan lokasi pengguna, jika ditentukan.
CountryRegion
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
FeatureCollectionEnum	Jenis objek FeatureCollection harus FeatureCollection.
FeaturesItem
FeatureTypeEnum	Jenis fitur harus Fitur.
GeocodePoints	Kumpulan titik geocode yang berbeda dalam cara penghitungannya dan penggunaan yang disarankan.
GeocodingBatchRequestBody	Daftar kueri/permintaan geocoding alamat untuk diproses. Daftar dapat berisi maksimal 100 kueri dan harus berisi setidaknya 1 kueri.
GeocodingBatchRequestItem	Objek Kueri Batch
GeocodingBatchResponse	Objek ini dikembalikan dari panggilan layanan Batch Geocoding yang berhasil.
GeocodingBatchResponseItem
GeoJsonPoint	Jenis geometri yang valid `GeoJSON Point` . Silakan merujuk ke RFC 7946 untuk detailnya.
Intersection	Alamat hasilnya.
MatchCodesEnum	Satu atau beberapa nilai kode yang cocok yang mewakili tingkat geocoding untuk setiap lokasi dalam respons. Misalnya, lokasi yang dikodekan secara geografis `Good` dengan kode kecocokan dan `Ambiguous` berarti bahwa lebih dari satu lokasi geocode ditemukan untuk informasi lokasi dan bahwa layanan geocode tidak memiliki hierarki pencarian untuk menemukan kecocokan. Demikian pula, lokasi yang dikodekan secara geografis `Ambiguous` dengan kode kecocokan dan `UpHierarchy` menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil dan `UpHierarchy` adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan `Ambiguous` untuk alamat jalan dan sebaliknya mengembalikan informasi untuk lebih dari satu nilai RoadBlock. Nilai yang mungkin adalah: `Good`: Lokasi hanya memiliki satu kecocokan atau semua kecocokan yang dikembalikan dianggap cocok dengan kuat. Misalnya, kueri untuk New York mengembalikan beberapa Kecocokan yang baik. `Ambiguous`: Lokasi adalah salah satu dari serangkaian kemungkinan kecocokan. Misalnya, saat Anda meminta alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada cukup informasi untuk menentukan opsi mana yang akan dipilih. `UpHierarchy`: Lokasi mewakili perpindahan ke atas hierarki geografis. Ini terjadi ketika kecocokan untuk permintaan lokasi tidak ditemukan, sehingga hasil yang kurang tepat dikembalikan. Misalnya, jika kecocokan untuk alamat yang diminta tidak dapat ditemukan, maka kode `UpHierarchy` kecocokan dengan jenis entitas RoadBlock dapat dikembalikan.
Properties
Summary	Ringkasan untuk permintaan batch
UsageTypeEnum	Penggunaan terbaik untuk titik geocode. Setiap titik geocode didefinisikan sebagai `Route` titik, `Display` titik atau keduanya. Gunakan `Route` titik jika Anda membuat rute ke lokasi. Gunakan `Display` titik jika Anda menampilkan lokasi di peta. Misalnya, jika lokasinya adalah taman, `Route` titik dapat menentukan pintu masuk ke taman tempat Anda dapat masuk dengan mobil, dan `Display` titik mungkin merupakan titik yang menentukan pusat taman.

Address

Alamat hasil

Nama	Jenis	Deskripsi
addressLine	string	AddressLine yang menyertakan Nama Dan Nomor Jalan
adminDistricts	AdminDistricts[]	Nama subdivisi di negara atau wilayah untuk alamat. Elemen ini biasanya diperlakukan sebagai subdivisi administratif urutan pertama, tetapi dalam beberapa kasus juga berisi subdivisi urutan kedua, ketiga, atau keempat di negara, dependensi, atau wilayah.
countryRegion	CountryRegion
formattedAddress	string	Properti Alamat Yang Diformat
intersection	Intersection	Alamat hasilnya.
locality	string	properti lokalitas
neighborhood	string	properti lingkungan
postalCode	string	Properti Kode Pos

AdminDistricts

Nama subdivisi di negara atau wilayah untuk alamat. Elemen ini biasanya diperlakukan sebagai subdivisi administratif urutan pertama, tetapi dalam beberapa kasus juga berisi subdivisi urutan kedua, ketiga, atau keempat di negara, dependensi, atau wilayah.

Nama	Jenis	Deskripsi
name	string	Nama untuk bidang adminDistrict yang sesuai, Untuk adminDistrict[0], ini bisa menjadi nama lengkap negara bagian seperti Washington, Untuk adminDistrict[1], ini bisa menjadi nama lengkap negara bagian
shortName	string	Nama pendek untuk bidang adminDistrict yang sesuai, Untuk adminDistrict[0], ini bisa menjadi nama pendek status seperti WA, Untuk adminDistrict[1], ini bisa menjadi nama pendek kabupaten

CalculationMethodEnum

Metode yang digunakan untuk menghitung titik geocode.

Nama	Jenis	Deskripsi
Interpolation	string	Titik geocode dicocokkan dengan titik di jalan menggunakan interpolasi.
InterpolationOffset	string	Titik geocode dicocokkan dengan titik di jalan menggunakan interpolasi dengan offset tambahan untuk menggeser titik ke sisi jalan.
Parcel	string	Titik geocode dicocokkan dengan pusat paket.
Rooftop	string	Titik geocode dicocokkan dengan atap gedung.

ConfidenceEnum

Tingkat keyakinan bahwa hasil lokasi yang dikodekan secara geografis adalah kecocokan. Gunakan nilai ini dengan kode kecocokan untuk menentukan informasi lebih lengkap tentang kecocokan.

Keyakinan lokasi yang di-geocode didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi geocoded dan lokasi pengguna, jika ditentukan.

Nama Jenis Deskripsi

High

Nama	Jenis	Deskripsi
High	string	Jika kepercayaan diri diatur ke `High`, satu atau beberapa kecocokan kuat ditemukan. Beberapa `High` kecocokan keyakinan diurutkan dalam urutan peringkat berdasarkan kepentingan jika berlaku. Misalnya, landmark memiliki kepentingan tetapi alamat tidak. Jika permintaan menyertakan lokasi atau tampilan, peringkat dapat berubah dengan tepat. Misalnya, kueri lokasi untuk "Paris" mengembalikan "Paris, Prancis" dan "Paris, TX" keduanya dengan `High` percaya diri. "Paris, Prancis" selalu diberi peringkat pertama karena pentingnya kecuali lokasi pengguna menunjukkan bahwa pengguna berada di atau sangat dekat dengan Paris, TX atau tampilan peta menunjukkan bahwa pengguna sedang mencari di area tersebut.
Low	string
Medium	string	Dalam beberapa situasi, kecocokan yang dikembalikan mungkin tidak berada pada tingkat yang sama dengan informasi yang diberikan dalam permintaan. Misalnya, permintaan dapat menentukan informasi alamat dan layanan geocode mungkin hanya dapat mencocokkan kode pos. Dalam hal ini, jika layanan geocode memiliki keyakinan bahwa kode pos cocok dengan data, keyakinan diatur ke `Medium` dan kode kecocokan diatur ke `UpHierarchy` untuk menentukan bahwa itu tidak dapat cocok dengan semua informasi dan harus mencari hierarki. Jika informasi lokasi dalam kueri ambigu, dan tidak ada informasi tambahan untuk memberi peringkat lokasi (seperti lokasi pengguna atau kepentingan relatif lokasi), keyakinan diatur ke `Medium`. Misalnya, kueri lokasi untuk "148th Ave, Bellevue" dapat mengembalikan "148th Ave SE" dan "148th Ave NE" keduanya dengan `Medium` percaya diri. Jika informasi lokasi dalam kueri tidak memberikan informasi yang cukup untuk geocode lokasi tertentu, nilai lokasi yang kurang tepat dapat dikembalikan dan keyakinan diatur ke `Medium`. Misalnya, jika alamat disediakan, tetapi kecocokan tidak ditemukan untuk nomor rumah, hasil geocode dengan jenis entitas Roadblock dapat dikembalikan.

string

Jika kepercayaan diri diatur ke High, satu atau beberapa kecocokan kuat ditemukan. Beberapa High kecocokan keyakinan diurutkan dalam urutan peringkat berdasarkan kepentingan jika berlaku. Misalnya, landmark memiliki kepentingan tetapi alamat tidak.

Jika permintaan menyertakan lokasi atau tampilan, peringkat dapat berubah dengan tepat. Misalnya, kueri lokasi untuk "Paris" mengembalikan "Paris, Prancis" dan "Paris, TX" keduanya dengan High percaya diri. "Paris, Prancis" selalu diberi peringkat pertama karena pentingnya kecuali lokasi pengguna menunjukkan bahwa pengguna berada di atau sangat dekat dengan Paris, TX atau tampilan peta menunjukkan bahwa pengguna sedang mencari di area tersebut.

Low

string

Medium

string

Dalam beberapa situasi, kecocokan yang dikembalikan mungkin tidak berada pada tingkat yang sama dengan informasi yang diberikan dalam permintaan. Misalnya, permintaan dapat menentukan informasi alamat dan layanan geocode mungkin hanya dapat mencocokkan kode pos. Dalam hal ini, jika layanan geocode memiliki keyakinan bahwa kode pos cocok dengan data, keyakinan diatur ke Medium dan kode kecocokan diatur ke UpHierarchy untuk menentukan bahwa itu tidak dapat cocok dengan semua informasi dan harus mencari hierarki.

Jika informasi lokasi dalam kueri ambigu, dan tidak ada informasi tambahan untuk memberi peringkat lokasi (seperti lokasi pengguna atau kepentingan relatif lokasi), keyakinan diatur ke Medium. Misalnya, kueri lokasi untuk "148th Ave, Bellevue" dapat mengembalikan "148th Ave SE" dan "148th Ave NE" keduanya dengan Medium percaya diri.

Jika informasi lokasi dalam kueri tidak memberikan informasi yang cukup untuk geocode lokasi tertentu, nilai lokasi yang kurang tepat dapat dikembalikan dan keyakinan diatur ke Medium. Misalnya, jika alamat disediakan, tetapi kecocokan tidak ditemukan untuk nomor rumah, hasil geocode dengan jenis entitas Roadblock dapat dikembalikan.

CountryRegion

Nama	Jenis	Deskripsi
ISO	string	ISO negara/wilayah
name	string	nama negara/wilayah

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

FeatureCollectionEnum

Jenis objek FeatureCollection harus FeatureCollection.

Nama	Jenis	Deskripsi
FeatureCollection	string

FeaturesItem

Nama	Jenis	Deskripsi
bbox	number[]	Kotak pembatas. Proyeksi yang digunakan - EPSG:3857. Silakan merujuk ke RFC 7946 untuk detailnya.
geometry	GeoJsonPoint	Jenis geometri yang valid `GeoJSON Point` . Silakan merujuk ke RFC 7946 untuk detailnya.
id	string	ID untuk fitur yang dikembalikan
properties	Properties
type	FeatureTypeEnum	Jenis fitur harus Fitur.

FeatureTypeEnum

Jenis fitur harus Fitur.

Nama	Jenis	Deskripsi
Feature	string

GeocodePoints

Kumpulan titik geocode yang berbeda dalam cara penghitungannya dan penggunaan yang disarankan.

Nama	Jenis	Deskripsi
calculationMethod	CalculationMethodEnum	Metode yang digunakan untuk menghitung titik geocode.
geometry	GeoJsonPoint	Jenis geometri yang valid `GeoJSON Point` . Silakan merujuk ke RFC 7946 untuk detailnya.
usageTypes	UsageTypeEnum[]	Penggunaan terbaik untuk titik geocode. Setiap titik geocode didefinisikan sebagai `Route` titik, `Display` titik atau keduanya. Gunakan `Route` titik jika Anda membuat rute ke lokasi. Gunakan `Display` titik jika Anda menampilkan lokasi di peta. Misalnya, jika lokasinya adalah taman, `Route` titik dapat menentukan pintu masuk ke taman tempat Anda dapat masuk dengan mobil, dan `Display` titik mungkin merupakan titik yang menentukan pusat taman.

GeocodingBatchRequestBody

Daftar kueri/permintaan geocoding alamat untuk diproses. Daftar dapat berisi maksimal 100 kueri dan harus berisi setidaknya 1 kueri.

Nama	Jenis	Deskripsi
batchItems	GeocodingBatchRequestItem[]	Daftar kueri yang akan diproses.

GeocodingBatchRequestItem

Objek Kueri Batch

Nama	Jenis	Nilai Default	Deskripsi
addressLine	string		Garis jalan resmi alamat yang relatif terhadap area, seperti yang ditentukan oleh lokalitas, atau postalCode, properti. Penggunaan umum elemen ini adalah untuk memberikan alamat jalan atau alamat resmi apa pun. Jika kueri diberikan, tidak boleh menggunakan parameter ini.
adminDistrict	string		Bagian subdivisi negara dari alamat, seperti WA. Jika kueri diberikan, tidak boleh menggunakan parameter ini.
adminDistrict2	string		Daerah untuk alamat terstruktur, seperti Raja. Jika kueri diberikan, tidak boleh menggunakan parameter ini.
adminDistrict3	string		Area bernama untuk alamat terstruktur. Jika kueri diberikan, tidak boleh menggunakan parameter ini.
bbox	number[]		Area persegi panjang di bumi didefinisikan sebagai objek kotak pembatas. Sisi persegi panjang didefinisikan oleh nilai bujur dan lintang. Untuk informasi selengkapnya, lihat Jenis Lokasi dan Area. Saat Anda menentukan parameter ini, area geografis diperhitungkan saat menghitung hasil kueri lokasi. Contoh: [lon1, lat1, lon2, lat2]
coordinates	number[]		Titik di bumi ditentukan sebagai bujur dan lintang. Saat Anda menentukan parameter ini, lokasi pengguna dipertanyakan dan hasil yang dikembalikan mungkin lebih relevan dengan pengguna. Contoh: [lon, lat]
countryRegion	string		Sinyal untuk hasil geocoding ke kode wilayah/negara ISO 3166-1 Alpha-2 yang ditentukan misalnya FR./ Jika kueri diberikan, tidak boleh menggunakan parameter ini.
locality	string		Bagian lokalitas alamat, seperti Seattle. Jika kueri diberikan, tidak boleh menggunakan parameter ini.
optionalId	string		id permintaan yang akan ditampilkan dalam batchItem yang sesuai
postalCode	string		Bagian kode pos dari alamat. Jika kueri diberikan, tidak boleh menggunakan parameter ini.
query	string		String yang berisi informasi tentang lokasi, seperti alamat atau nama tengara.
top	integer	5	Jumlah maksimum respons yang akan dikembalikan. Default: 5, minimum: 1 dan maksimum: 20.
view	string	auto	String yang menentukan kode wilayah/negara ISO 3166-1 Alpha-2. Ini akan mengubah batas dan label geopolitik yang disengketakan untuk menyelaraskan dengan wilayah pengguna yang ditentukan.

GeocodingBatchResponse

Objek ini dikembalikan dari panggilan layanan Batch Geocoding yang berhasil.

Nama	Jenis	Deskripsi
batchItems	GeocodingBatchResponseItem[]	Array yang berisi hasil batch.
nextLink	string	adalah tautan ke halaman berikutnya dari fitur yang dikembalikan. Jika itu halaman terakhir, tidak ada bidang ini.
summary	Summary	Ringkasan untuk permintaan batch

GeocodingBatchResponseItem

Nama	Jenis	Deskripsi
error	ErrorDetail	Detail kesalahan.
features	FeaturesItem[]
nextLink	string	adalah tautan ke halaman berikutnya dari fitur yang dikembalikan. Jika itu halaman terakhir, tidak ada bidang ini.
optionalId	string	id batchItem yang akan sama dengan id dalam permintaan
type	FeatureCollectionEnum	Jenis objek FeatureCollection harus FeatureCollection.

GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
bbox	number[]	Kotak pembatas. Proyeksi yang digunakan - EPSG:3857. Silakan merujuk ke RFC 7946 untuk detailnya.
coordinates	number[]	`Position` adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah garis bujur dan lintang, tepatnya dalam urutan tersebut. Ketinggian/Elevasi adalah elemen ketiga opsional. Silakan merujuk ke RFC 7946 untuk detailnya.
type	string: Point	Menentukan jenisnya `GeoJSON` . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

Intersection

Alamat hasilnya.

Nama	Jenis	Deskripsi
baseStreet	string	Jalan utama untuk lokasi.
displayName	string	Nama lengkap persimpangan.
intersectionType	string	Jenis persimpangan.
secondaryStreet1	string	Jalan persimpangan pertama.
secondaryStreet2	string	Jika ada, jalan kedua berpotongan.

MatchCodesEnum

Satu atau beberapa nilai kode yang cocok yang mewakili tingkat geocoding untuk setiap lokasi dalam respons.

Misalnya, lokasi yang dikodekan secara geografis Good dengan kode kecocokan dan Ambiguous berarti bahwa lebih dari satu lokasi geocode ditemukan untuk informasi lokasi dan bahwa layanan geocode tidak memiliki hierarki pencarian untuk menemukan kecocokan.

Demikian pula, lokasi yang dikodekan secara geografis Ambiguous dengan kode kecocokan dan UpHierarchy menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil dan UpHierarchy adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan Ambiguous untuk alamat jalan dan sebaliknya mengembalikan informasi untuk lebih dari satu nilai RoadBlock.

Nilai yang mungkin adalah:

Good: Lokasi hanya memiliki satu kecocokan atau semua kecocokan yang dikembalikan dianggap cocok dengan kuat. Misalnya, kueri untuk New York mengembalikan beberapa Kecocokan yang baik.

Ambiguous: Lokasi adalah salah satu dari serangkaian kemungkinan kecocokan. Misalnya, saat Anda meminta alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada cukup informasi untuk menentukan opsi mana yang akan dipilih.

UpHierarchy: Lokasi mewakili perpindahan ke atas hierarki geografis. Ini terjadi ketika kecocokan untuk permintaan lokasi tidak ditemukan, sehingga hasil yang kurang tepat dikembalikan. Misalnya, jika kecocokan untuk alamat yang diminta tidak dapat ditemukan, maka kode UpHierarchy kecocokan dengan jenis entitas RoadBlock dapat dikembalikan.

Nama	Jenis	Deskripsi
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nama	Jenis	Deskripsi
address	Address	Alamat hasil
confidence	ConfidenceEnum	Tingkat keyakinan bahwa hasil lokasi yang dikodekan secara geografis adalah kecocokan. Gunakan nilai ini dengan kode kecocokan untuk menentukan informasi lebih lengkap tentang kecocokan. Keyakinan lokasi yang di-geocode didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi geocoded dan lokasi pengguna, jika ditentukan.
geocodePoints	GeocodePoints[]	Kumpulan titik geocode yang berbeda dalam cara penghitungannya dan penggunaan yang disarankan.
matchCodes	MatchCodesEnum[]	Satu atau beberapa nilai kode yang cocok yang mewakili tingkat geocoding untuk setiap lokasi dalam respons. Misalnya, lokasi yang dikodekan secara geografis `Good` dengan kode kecocokan dan `Ambiguous` berarti bahwa lebih dari satu lokasi geocode ditemukan untuk informasi lokasi dan bahwa layanan geocode tidak memiliki hierarki pencarian untuk menemukan kecocokan. Demikian pula, lokasi yang dikodekan secara geografis `Ambiguous` dengan kode kecocokan dan `UpHierarchy` menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil dan `UpHierarchy` adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan `Ambiguous` untuk alamat jalan dan sebaliknya mengembalikan informasi untuk lebih dari satu nilai RoadBlock. Nilai yang mungkin adalah: `Good`: Lokasi hanya memiliki satu kecocokan atau semua kecocokan yang dikembalikan dianggap cocok dengan kuat. Misalnya, kueri untuk New York mengembalikan beberapa Kecocokan yang baik. `Ambiguous`: Lokasi adalah salah satu dari serangkaian kemungkinan kecocokan. Misalnya, saat Anda meminta alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada cukup informasi untuk menentukan opsi mana yang akan dipilih. `UpHierarchy`: Lokasi mewakili perpindahan ke atas hierarki geografis. Ini terjadi ketika kecocokan untuk permintaan lokasi tidak ditemukan, sehingga hasil yang kurang tepat dikembalikan. Misalnya, jika kecocokan untuk alamat yang diminta tidak dapat ditemukan, maka kode `UpHierarchy` kecocokan dengan jenis entitas RoadBlock dapat dikembalikan.
type	string	Salah satu: Alamat Roadblock RoadIntersection Neighborhood PopulatedPlace Kode pos1 AdminDivision1 AdminDivision2 CountryRegion

Summary

Ringkasan untuk permintaan batch

Nama	Jenis	Deskripsi
successfulRequests	integer	Jumlah permintaan yang berhasil dalam batch
totalRequests	integer	Jumlah total permintaan dalam batch

UsageTypeEnum

Penggunaan terbaik untuk titik geocode. Setiap titik geocode didefinisikan sebagai Route titik, Display titik atau keduanya. Gunakan Route titik jika Anda membuat rute ke lokasi. Gunakan Display titik jika Anda menampilkan lokasi di peta. Misalnya, jika lokasinya adalah taman, Route titik dapat menentukan pintu masuk ke taman tempat Anda dapat masuk dengan mobil, dan Display titik mungkin merupakan titik yang menentukan pusat taman.

Nama	Jenis	Deskripsi
Display	string
Route	string

Search - Get Geocoding Batch

Kirim Permintaan Batch Sinkron

Isi POST untuk Permintaan Batch

Model Respons Batch

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

AADToken

Scopes

subscription-key

SAS Token

Contoh

A Geocoding Batch API call containing 2 Geocoding queries

Sample Request

Sample Response

Definisi

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum

Sumber Daya Tambahan: