Search - Post Search Address Batch

Referensi

Layanan:: Maps

Versi API:: 1.0

Gunakan untuk mengirim batch kueri ke SEARCH Address API dalam satu permintaan asinkron.
Post Search Address Batch API adalah permintaan HTTP POST yang mengirim batch kueri ke Search Address API dalam satu panggilan API sinkron. Anda dapat memanggil Search Address Batch API untuk berjalan baik secara asinkron (asinkron) atau sinkron (sinkron). API asinkron memungkinkan pemanggil untuk mengumpulkan hingga 10.000 kueri dan menyinkronkan API hingga 100 kueri.

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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Batch Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan pencarian yang relatif kompleks

Ini memungkinkan pengambilan hasil dalam panggilan terpisah (beberapa unduhan dimungkinkan).
API asinkron dioptimalkan untuk keandalan dan tidak diharapkan mengalami batas waktu.
Jumlah item batch dibatasi hingga 10.000 untuk API ini.

Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Respons asinkron disimpan selama 14 hari. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

Harap dicatat bahwa permintaan batch asinkron adalah operasi yang berjalan lama. Berikut adalah urutan operasi yang khas:

Klien mengirimkan permintaan Batch POST Alamat Search ke Azure Maps.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

Server akan merespons dengan salah satu hal berikut ini:

HTTP 202 Accepted - Permintaan batch telah diterima.

HTTP Error - Terjadi kesalahan saat memproses permintaan Batch Anda. Ini bisa berupa 400 Bad Request atau kode status lainnya Error .
Jika permintaan batch berhasil diterima, Location header dalam respons berisi URL untuk mengunduh hasil permintaan batch. Status URI ini terlihat seperti berikut:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Klien mengeluarkan GET permintaan pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasil batch.

Isi POST untuk Permintaan Batch

Untuk mengirim kueri alamat pencarian , 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 5 kueri alamat pencarian :

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Kueri alamat pencarian dalam batch hanyalah URL parsial tanpa protokol, URL dasar, jalur, versi api, dan kunci langganan. Ini dapat menerima salah satu parameter URIalamat pencarian yang didukung. Nilai string dalam kueri alamat pencarian harus diloloskan dengan benar (misalnya " karakter harus diloloskan dengan \ ) dan juga harus dikodekan dengan URL dengan benar.

API asinkron memungkinkan pemanggil untuk mengumpulkan hingga 10.000 kueri dan menyinkronkan API hingga 100 kueri, dan batch harus berisi setidaknya 1 kueri.

Unduh Hasil Batch Asinkron

Untuk mengunduh hasil batch asinkron, Anda akan mengeluarkan GET permintaan ke titik akhir unduhan batch. URL unduhan ini dapat diperoleh dari Location header permintaan batch yang berhasil POST dan terlihat seperti berikut ini:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Berikut adalah urutan operasi umum untuk mengunduh hasil batch:

Klien mengirim GET permintaan menggunakan URL unduhan.
Server akan merespons dengan salah satu hal berikut ini:

HTTP 202 Accepted - Permintaan batch diterima tetapi masih diproses. Silakan coba lagi dalam beberapa waktu.

HTTP 200 OK - Permintaan batch berhasil diproses. Isi respons berisi semua hasil batch.

Model Respons Batch

Konten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi summary komponen yang menunjukkan totalRequests bahwa itu adalah bagian dari permintaan batch asli dan successfulRequestsyaitu 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 di batchItems berisi statusCode bidang dan response . Masing-masing response dari batchItems salah satu jenis berikut:

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

Berikut adalah sampel Respons Batch dengan 2 hasil yang berhasil dan 1 hasil gagal :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
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 Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Isi Permintaan

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

Respons

Nama	Jenis	Deskripsi
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Hanya didukung untuk permintaan asinkron. Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Lokasi untuk mencoba kembali atau mengakses hasilnya. Header Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

SearchAddressBatchProcessResult

202 Accepted

Hanya didukung untuk permintaan asinkron. Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Lokasi untuk mencoba kembali atau mengakses hasilnya.

Header

Location: string

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.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

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

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut diterbitkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Jenis: apiKey
Dalam: query

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.

Jenis: apiKey
Dalam: header

Contoh

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Permintaan sampel

HTTP

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Respon sampel

Kode status:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Kode status:: 202

Operation-Location: URL to download the results of the long-running batch request.

Definisi

Nama	Deskripsi
Address	Alamat hasil
AddressRanges	Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.
BatchRequest	Jenis ini mewakili isi permintaan untuk layanan Batch.
BatchRequestItem	Objek permintaan batch
BoundingBox	Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah dari viewport.
BoundingBoxCompassNotation	Kotak pembatas lokasi.
Brand	Merek yang terkait dengan POI
Classification	Klasifikasi untuk POI yang dikembalikan
ClassificationName	Nama untuk klasifikasi
DataSources	Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.
Entity	Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.
EntryPoint	Titik masuk untuk POI yang dikembalikan.
EntryPointType	Jenis titik masuk. Nilai dapat berupa utama atau kecil.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
GeographicEntityType	Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
Geometry	Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi.
JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
MatchType	Jenis kecocokan untuk operasi pencarian alamat terbalik.
OperatingHours	Jam buka untuk POI (Tempat Menarik).
OperatingHoursTime	Mewakili tanggal dan waktu
OperatingHoursTimeRange	Buka rentang waktu selama sehari
PointOfInterest	Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.
PointOfInterestCategorySet	Kategori POI
QueryType	Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.
Response	Hasil kueri. SearchAddressResult jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.
SearchAddressBatchItem	Item yang dikembalikan dari panggilan layanan Search Address Batch.
SearchAddressBatchProcessResult	Objek ini dikembalikan dari panggilan layanan Search Address Batch yang berhasil.
SearchAddressResultItem	Objek hasil untuk respons API Search.
SearchAddressResultType	Salah satu: POI Jalan Geografi Alamat Titik Rentang Alamat Lintas Jalan
SearchSummary	Objek ringkasan untuk respons API Search.
Summary	Ringkasan hasil untuk permintaan batch

Address

Alamat hasil

Nama	Jenis	Deskripsi
boundingBox	BoundingBoxCompassNotation	Kotak pembatas lokasi.
buildingNumber	string	Nomor bangunan di jalan. Tidak digunakan lagi, gunakan streetNumber sebagai gantinya.
country	string	nama negara/wilayah
countryCode	string	Negara (Catatan: Ini adalah kode dua huruf, bukan nama negara/wilayah.)
countryCodeISO3	string	Kode negara ISO alpha-3
countrySecondarySubdivision	string	County
countrySubdivision	string	Negara Bagian atau Provinsi
countrySubdivisionCode	string	`countrySubdivisionCode` diawali oleh `countryCode` ( countryCode-countrySubdivisionCode ) dan tanda hubung membentuk kode ISO 3166-2. Contoh: TX untuk Texas, SCT untuk Skotlandia dan AKTIF untuk Ontario.
countrySubdivisionName	string	Nama lengkap hierarki administratif negara/wilayah tingkat pertama. Bidang ini hanya muncul jika countrySubdivision disajikan dalam bentuk singkatan. Hanya didukung untuk Amerika Serikat, Kanada, dan Inggris Raya.
countryTertiarySubdivision	string	Area Bernama
crossStreet	string	Nama jalan yang disilangkan.
extendedPostalCode	string	Kode pos yang diperluas (ketersediaan tergantung pada wilayah).
freeformAddress	string	Baris alamat yang diformat sesuai dengan aturan pemformatan negara/wilayah asal Hasil, atau dalam kasus negara/wilayah, nama negara/wilayah lengkapnya.
localName	string	Komponen alamat yang mewakili nama area geografis atau lokalitas yang mengelompokkan beberapa objek yang dapat diatasi untuk tujuan alamat, tanpa menjadi unit administratif. Bidang ini digunakan untuk membangun `freeformAddress` properti . `localName` mewakili kotamadya pos. Tergantung pada lokasinya, `localName` adalah nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, gunakan `localName` alih-alih `municipality`.
municipality	string	Kota/Kota Catatan: `municipality` mewakili kotamadya perumahan. Tergantung pada lokasinya, nilainya `municipality` mungkin berbeda dari nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, disarankan agar `localName` nilai tersebut digunakan alih-alih nilainya `municipality` .
municipalitySubdivision	string	Sub / Kota Super
neighbourhood	string	Lingkungan adalah area yang dilokalkan secara geografis di dalam kota atau kota dengan karakteristik khas dan interaksi sosial antara penduduk.
postalCode	string	Kode Pos / Kode Pos
routeNumbers	string[]	Kode yang digunakan untuk secara tidak ambigu mengidentifikasi jalan
street	string	Nama jalan. TIDAK DIGUNAKAN LAGI, gunakan streetName sebagai gantinya.
streetName	string	Nama jalan.
streetNameAndNumber	string	Nama dan nomor jalan.
streetNumber	string	Nomor bangunan di jalan.

AddressRanges

Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.

Nama	Jenis	Deskripsi
from	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
rangeLeft	string	Rentang alamat di sisi kiri jalan.
rangeRight	string	Rentang alamat di sisi kanan jalan.
to	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

BatchRequest

Jenis ini mewakili isi permintaan untuk layanan Batch.

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

BatchRequestItem

Objek permintaan batch

Nama	Jenis	Deskripsi
query	string	Parameter ini berisi string kueri yang digunakan untuk melakukan operasi geocoding yang tidak terstruktur. String kueri akan diteruskan secara verbatim ke API pencarian untuk diproses.

BoundingBox

Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah dari viewport.

Nama	Jenis	Deskripsi
btmRightPoint	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

BoundingBoxCompassNotation

Kotak pembatas lokasi.

Nama	Jenis	Deskripsi
entity	Entity	Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.
northEast	string	Garis lintang utara-timur, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma
southWest	string	Garis lintang barat daya, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma

Brand

Merek yang terkait dengan POI

Nama	Jenis	Deskripsi
name	string	Nama merek

Classification

Klasifikasi untuk POI yang dikembalikan

Nama	Jenis	Deskripsi
code	string	Properti kode
names	ClassificationName[]	Array nama

ClassificationName

Nama untuk klasifikasi

Nama	Jenis	Deskripsi
name	string	Properti nama
nameLocale	string	Properti Lokal Nama

DataSources

Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.

Nama	Jenis	Deskripsi
geometry	Geometry	Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi.

Entity

Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.

Nama	Jenis	Deskripsi
position	string	Entitas posisi

EntryPoint

Titik masuk untuk POI yang dikembalikan.

Nama	Jenis	Deskripsi
position	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
type	EntryPointType	Jenis titik masuk. Nilai dapat berupa utama atau kecil.

EntryPointType

Jenis titik masuk. Nilai dapat berupa utama atau kecil.

Nama	Jenis	Deskripsi
main	string
minor	string

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.

GeographicEntityType

Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.

Nama	Jenis	Deskripsi
Country	string	nama negara/wilayah
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Negara Bagian atau Provinsi
CountryTertiarySubdivision	string	Area Bernama
Municipality	string	Kota/Kota
MunicipalitySubdivision	string	Sub / Kota Super
Neighbourhood	string	Lingkungan
PostalCodeArea	string	Kode Pos / Kode Pos

Geometry

Informasi tentang bentuk geometris hasil. Hanya ada jika jenis == Geografi.

Nama	Jenis	Deskripsi
id	string	Teruskan ini sebagai geometryId ke Get Search Polygon API untuk mengambil informasi geometri untuk hasil ini.

JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.

Nama	Jenis	Deskripsi
json	string	Format Pertukaran Data Notasi Objek JavaScript

LatLongPairAbbreviated

Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

Nama	Jenis	Deskripsi
lat	number	Properti garis lintang
lon	number	Properti garis bujur

MatchType

Jenis kecocokan untuk operasi pencarian alamat terbalik.

Nama	Jenis	Deskripsi
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Jam buka untuk POI (Tempat Menarik).

Nama	Jenis	Deskripsi
mode	string	Nilai yang digunakan dalam permintaan: tidak ada atau "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Daftar rentang waktu selama 7 hari ke depan

OperatingHoursTime

Mewakili tanggal dan waktu

Nama	Jenis	Deskripsi
date	string	Mewakili tanggal kalender saat ini di zona waktu POI, misalnya "2019-02-07".
hour	integer	Jam dalam format 24 jam dalam waktu lokal LYD; nilai yang mungkin adalah 0 - 23.
minute	integer	Menit berada di waktu lokal LYD; nilai yang mungkin adalah 0 - 59.

OperatingHoursTimeRange

Buka rentang waktu selama sehari

Nama	Jenis	Deskripsi
endTime	OperatingHoursTime	Titik dalam rentang 7 hari berikutnya ketika LYD tertentu ditutup, atau awal rentang jika ditutup sebelum rentang.
startTime	OperatingHoursTime	Titik dalam rentang 7 hari berikutnya ketika LYD tertentu sedang dibuka, atau awal rentang jika dibuka sebelum rentang.

PointOfInterest

Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.

Nama	Jenis	Deskripsi
brands	Brand[]	Array merek. Nama merek untuk POI yang dikembalikan.
categories	string[]	Kategori array
categorySet	PointOfInterestCategorySet[]	Daftar kategori POI yang paling spesifik
classifications	Classification[]	Array klasifikasi
name	string	Nama properti POI
openingHours	OperatingHours	Jam buka untuk POI (Tempat Menarik).
phone	string	Properti nomor telepon
url	string	Properti URL Situs Web

PointOfInterestCategorySet

Kategori POI

Nama	Jenis	Deskripsi
id	integer	ID Kategori

QueryType

Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.

Nama	Jenis	Deskripsi
NEARBY	string	Search dilakukan di sekitar lintang dan bujur tertentu dengan radius yang ditentukan
NON_NEAR	string	Search dilakukan secara global, tanpa bias pada lintang dan bujur tertentu, dan tidak ada radius yang ditentukan

Response

Hasil kueri. SearchAddressResult jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.
results	SearchAddressResultItem[]	Daftar hasil API Search.
summary	SearchSummary	Objek ringkasan untuk respons API Search

SearchAddressBatchItem

Item yang dikembalikan dari panggilan layanan Search Address Batch.

Nama	Jenis	Deskripsi
response	Response	Hasil kueri. SearchAddressResult jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.
statusCode	integer	Kode status permintaan HTTP.

SearchAddressBatchProcessResult

Objek ini dikembalikan dari panggilan layanan Search Address Batch yang berhasil.

Nama	Jenis	Deskripsi
batchItems	SearchAddressBatchItem[]	Array yang berisi hasil batch.
summary	Summary	Ringkasan hasil untuk permintaan batch

SearchAddressResultItem

Objek hasil untuk respons API Search.

Nama	Jenis	Deskripsi
address	Address	Alamat hasil
addressRanges	AddressRanges	Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.
dataSources	DataSources	Bagian opsional. Mereferensikan id geometri untuk digunakan dengan Get Search Polygon API.
detourTime	integer	Waktu memutar dalam hitung detik. Hanya dikembalikan untuk panggilan ke Search Along Route API.
dist	number	Jarak garis lurus antara lokasi hasil dan geobias dalam meter.
entityType	GeographicEntityType	Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
entryPoints	EntryPoint[]	Array of EntryPoints. Mereka menjelaskan jenis pintu masuk yang tersedia di lokasi tersebut. Jenisnya bisa "utama" untuk pintu masuk utama seperti pintu depan, atau lobi, dan "minor", untuk pintu samping dan belakang.
id	string	Properti id
info	string	Informasi tentang sumber data asli Hasil. Digunakan untuk permintaan dukungan.
matchType	MatchType	Informasi tentang jenis kecocokan. Salah satu: AddressPoint HouseNumberRange Jalan
poi	PointOfInterest	Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.
position	LatLongPairAbbreviated	Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
score	number	Nilai dalam hasil diatur untuk menunjukkan skor pencocokan relatif antara hasil. Anda dapat menggunakan ini untuk menentukan bahwa hasil x dua kali lebih mungkin sama relevannya dengan hasil y jika nilai x adalah 2x nilai y. Nilai bervariasi di antara kueri dan hanya dimaksudkan sebagai nilai relatif untuk satu tataan hasil.
type	SearchAddressResultType	Salah satu: POI Jalan Geografi Alamat Titik Rentang Alamat Lintas Jalan
viewport	BoundingBox	Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah viewport.

SearchAddressResultType

Salah satu:

POI
Jalan
Geografi
Alamat Titik
Rentang Alamat
Lintas Jalan

Nama	Jenis	Deskripsi
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Objek ringkasan untuk respons API Search.

Nama	Jenis	Deskripsi
fuzzyLevel	integer	Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil.
geoBias	LatLongPairAbbreviated	Indikasi ketika mesin pencari internal telah menerapkan bias geospasial untuk meningkatkan peringkat hasil. Dalam beberapa metode, ini dapat dipengaruhi dengan mengatur parameter lat dan lon jika tersedia. Dalam kasus lain itu murni internal.
limit	integer	Jumlah maksimum respons yang akan dikembalikan
numResults	integer	Jumlah hasil dalam respons.
offset	integer	Offset awal dari Hasil yang dikembalikan dalam tataan Hasil lengkap.
query	string	Parameter kueri yang digunakan untuk menghasilkan hasil pencarian ini.
queryTime	integer	Waktu yang dihabiskan untuk menyelesaikan kueri, dalam milidetik.
queryType	QueryType	Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.
totalResults	integer	Jumlah total Hasil yang ditemukan.

Summary

Ringkasan hasil untuk permintaan batch

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

Bagikan melalui

Search - Post Search Address Batch

Kirim Permintaan Batch Sinkron

Kirim Permintaan Batch Asinkron

Isi POST untuk Permintaan Batch

Unduh Hasil Batch Asinkron

Model Respons Batch

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

AADToken

Cakupan

subscription-key

SAS Token

Contoh

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Permintaan sampel

Respon sampel

Definisi

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Sumber Daya Tambahan: