Bagikan melalui

Search - Get Geocoding

Layanan:
Maps
Versi API:
2025-01-01

Gunakan untuk mendapatkan koordinat bujur dan lintang alamat jalan atau nama suatu tempat.

API Get Geocoding adalah permintaan GET HTTP yang mengembalikan koordinat bujur dan lintang lokasi yang sedang dicari.

Dalam banyak kasus, layanan pencarian lengkap mungkin terlalu banyak, misalnya jika Anda hanya tertarik dengan geocoding tradisional. Pencarian juga dapat diakses untuk pencarian alamat secara eksklusif. Geocoding dilakukan dengan mencapai titik akhir geocoding hanya dengan alamat atau alamat parsial yang dimaksud. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada Point of Interest (POI) yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, dan negara bagian. Respons juga mengembalikan properti alamat terperinci seperti informasi jalan, kode pos, kotamadya, dan negara/wilayah.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01
Dengan parameter opsional: 
GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
api-version
 query True

string

Nomor versi Azure Maps API.
addressLine
 query

string

Garis jalan resmi alamat 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.

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
adminDistrict
 query

string

Bagian subdivisi negara dari alamat, seperti WA.

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
adminDistrict2
 query

string

Wilayah untuk alamat terstruktur, seperti King.

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
adminDistrict3
 query

string

Area bernama untuk alamat terstruktur.

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
bbox
 query

number[]

Area persegi panjang di bumi didefinisikan sebagai objek kotak pembatas. Sisi persegi panjang didefinisikan oleh nilai garis bujur dan garis lintang. Saat Anda menentukan parameter ini, area geografis diperhitungkan saat menghitung hasil kueri lokasi.

Contoh: lon1,lat1,lon2,lat2
coordinates
 query

number[]

Sebuah titik di bumi ditentukan sebagai garis bujur dan lintang. Saat Anda menentukan parameter ini, lokasi pengguna diperhitungkan dan hasil yang dikembalikan mungkin lebih relevan bagi pengguna. Contoh: &coordinates=lon,lat
countryRegion
 query

string

Sinyal untuk hasil geocoding ke kode wilayah/negara ISO 3166-1 Alpha-2 yang ditentukan misalnya FR./

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
locality
 query

string

Bagian lokalitas alamat, seperti Seattle.

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
postalCode
 query

string

Bagian kode pos dari alamat.

Parameter ini tidak boleh digunakan saat query parameter disertakan dalam permintaan.
query
 query

string

String yang berisi informasi tentang lokasi, seperti alamat atau nama landmark.
top
 query

integer (int32)

minimum: 1
maximum: 20

Jumlah maksimum respons yang akan dikembalikan. Default: 5, minimum: 1 dan maksimum: 20.
view
 query

string

String yang mewakili kode wilayah/negara ISO 3166-1 Alpha-2. Ini akan mengubah batas dan label geopolitik yang disengketakan agar selaras dengan wilayah pengguna yang ditentukan. Secara default, parameter Tampilan diatur ke "Otomatis" meskipun Anda belum menentukannya dalam permintaan.

Silakan merujuk ke Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
Accept-Language

string

Bahasa tempat hasil pencarian harus dikembalikan.

Silakan merujuk ke Bahasa yang Didukung untuk detailnya.
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 sarana manajemen Azure Maps. Untuk informasi selengkapnya tentang menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat Mengelola autentikasi di Azure Maps.

Respons

Nama Jenis Deskripsi
200 OK

GeocodingResponse

OK

Media Types: "application/geo+json"

Header

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

ErrorResponse

Terjadi kesalahan tak terduga.

Media Types: "application/geo+json"

Keamanan

AADToken

Ini adalah Microsoft Entra OAuth 2.0 Flows. Saat dipasangkan dengan akses berbasis peran Azure kontrol dapat digunakan untuk mengontrol akses ke REST API Azure Maps. 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 ke REST API Azure Maps.

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

Nota

  • Definisi keamanan ini mengharuskan penggunaan header x-ms-client-id untuk menunjukkan sumber daya Azure Maps mana yang diminta 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 ID Microsoft Entra.
  • Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft 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 membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft 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 DARI REST API Azure Maps tempat kunci ini dapat disimpan dengan aman.

Jenis: apiKey
Dalam: 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 Microsoft 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 butir halus ke kedaluwarsa, laju, 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 penyajian dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

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

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

Permintaan sampel

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

Respon sampel

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

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

Permintaan sampel

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

Respon sampel

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

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

Permintaan sampel

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

Respon sampel

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

Search landmark Empire State Building by query

Permintaan sampel

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

Respon sampel

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

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 dikodekan secara geografis didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi yang dikodekan secara geografis dan lokasi pengguna, jika ditentukan.
CountryRegion
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Tanggapan kesalahan
FeatureCollectionEnum

Jenis objek FeatureCollection harus FeatureCollection.
FeaturesItem
FeatureTypeEnum

Jenis fitur harus Berupa Fitur.
GeocodePoints

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

Objek ini dikembalikan dari panggilan Geocoding yang berhasil
GeoJsonPoint

Jenis geometri GeoJSON Point yang valid. Silakan lihat 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 dengan kode kecocokan Good 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 dengan kode kecocokan Ambiguous dan UpHierarchy menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki atas dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil Ambiguous dan UpHierarchy adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan 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 sekumpulan kemungkinan kecocokan. Misalnya, ketika Anda mengkueri alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada informasi yang cukup untuk menentukan opsi mana yang akan dipilih.

UpHierarchy: Lokasi mewakili pemindahan 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 kecocokan UpHierarchy dengan jenis entitas RoadBlock dapat dikembalikan.
Properties
UsageTypeEnum

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

Address

Objek

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 Terformat
intersection

Intersection

Alamat hasilnya.
locality

string

properti lokalitas
neighborhood

string

properti lingkungan
postalCode

string

Properti Kode Pos
streetName

string

Nama jalan dari formattedAddress
streetNumber

string

Nomor di jalan, jika tersedia, dari formattedAddress

AdminDistricts

Objek

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 kabupaten
shortName

string

Nama pendek untuk bidang adminDistrict yang sesuai, Untuk adminDistrict[0], ini bisa berupa nama pendek status seperti WA, Untuk adminDistrict[1], ini bisa menjadi nama pendek kabupaten

CalculationMethodEnum

Enumeration

Metode yang digunakan untuk menghitung titik geocode.

Nilai Deskripsi
Interpolation

Titik geocode dicocokkan dengan titik di jalan menggunakan interpolasi.
InterpolationOffset

Titik geocode dicocokkan dengan titik di jalan menggunakan interpolasi dengan offset tambahan untuk menggeser titik ke sisi jalan.
Parcel

Titik geocode dicocokkan dengan bagian tengah parsel.
Rooftop

Titik geocode dicocokkan dengan atap bangunan.

ConfidenceEnum

Enumeration

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 dikodekan secara geografis didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi yang dikodekan secara geografis dan lokasi pengguna, jika ditentukan.

Nilai Deskripsi
High

Jika kepercayaan diatur ke High, satu atau lebih kecocokan kuat ditemukan. Beberapa High kecocokan kepercayaan diurutkan dalam urutan peringkat berdasarkan kepentingannya 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" menampilkan "Paris, Prancis" dan "Paris, TX" dengan High percaya diri. "Paris, Prancis" selalu diberi peringkat pertama karena kepentingannya 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.
Medium

Dalam beberapa situasi, kecocokan yang ditampilkan mungkin tidak pada level 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 pencocokan diatur ke UpHierarchy untuk menentukan bahwa kode tersebut tidak dapat mencocokkan semua informasi dan harus mencari hierarki ke atas.

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 menampilkan "148th Ave SE" dan "148th Ave NE" dengan Medium percaya diri.

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

CountryRegion

Objek
Nama Jenis Deskripsi
ISO

string

ISO negara/wilayah
name

string

nama negara/wilayah

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.
type

string

Jenis info tambahan.

ErrorDetail

Objek

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

Objek

Tanggapan kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

FeatureCollectionEnum

Enumeration

Jenis objek FeatureCollection harus FeatureCollection.

Nilai Deskripsi
FeatureCollection

FeaturesItem

Objek
Nama Jenis Deskripsi
bbox

number[] (double)

Kotak pembatas. Proyeksi yang digunakan - EPSG:3857. Silakan lihat RFC 7946 untuk detailnya.
geometry

GeoJsonPoint

Jenis geometri GeoJSON Point yang valid. Silakan lihat RFC 7946 untuk detailnya.
id

string

ID untuk fitur yang dikembalikan
properties

Properties

type

FeatureTypeEnum

Jenis fitur harus Berupa Fitur.

FeatureTypeEnum

Enumeration

Jenis fitur harus Berupa Fitur.

Nilai Deskripsi
Feature

GeocodePoints

Objek

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 GeoJSON Point yang valid. Silakan lihat RFC 7946 untuk detailnya.
usageTypes

UsageTypeEnum[]

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

GeocodingResponse

Objek

Objek ini dikembalikan dari panggilan Geocoding yang berhasil

Nama Jenis Deskripsi
features

FeaturesItem[]

nextLink

string

adalah tautan ke halaman berikutnya dari fitur yang dikembalikan. Jika ini adalah halaman terakhir, tidak ada bidang ini.
type

FeatureCollectionEnum

Jenis objek FeatureCollection harus FeatureCollection.

GeoJsonPoint

Objek

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

Nama Jenis Deskripsi
bbox

number[] (double)

Kotak pembatas. Proyeksi yang digunakan - EPSG:3857. Silakan lihat RFC 7946 untuk detailnya.
coordinates

number[] (double)

Position adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah bujur dan garis lintang, tepatnya dalam urutan tersebut. Altitude/Elevation adalah elemen ketiga opsional. Silakan lihat RFC 7946 untuk detailnya.
type string:

Point

Menentukan jenis GeoJSON. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

Intersection

Objek

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 persimpangan kedua.

MatchCodesEnum

Enumeration

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

Misalnya, lokasi yang dikodekan secara geografis dengan kode kecocokan Good 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 dengan kode kecocokan Ambiguous dan UpHierarchy menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki atas dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil Ambiguous dan UpHierarchy adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan 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 sekumpulan kemungkinan kecocokan. Misalnya, ketika Anda mengkueri alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada informasi yang cukup untuk menentukan opsi mana yang akan dipilih.

UpHierarchy: Lokasi mewakili pemindahan 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 kecocokan UpHierarchy dengan jenis entitas RoadBlock dapat dikembalikan.

Nilai Deskripsi
Good
Ambiguous
UpHierarchy

Properties

Objek
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 dikodekan secara geografis didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi yang dikodekan secara geografis 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 dengan kode kecocokan Good 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 dengan kode kecocokan Ambiguous dan UpHierarchy menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki atas dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil Ambiguous dan UpHierarchy adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan 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 sekumpulan kemungkinan kecocokan. Misalnya, ketika Anda mengkueri alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada informasi yang cukup untuk menentukan opsi mana yang akan dipilih.

UpHierarchy: Lokasi mewakili pemindahan 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 kecocokan UpHierarchy dengan jenis entitas RoadBlock dapat dikembalikan.
type

string

Salah satu dari:

  • Alamat
  • Roadblock
  • RoadIntersection
  • Lingkungan
  • PopulatedPlace
  • Kode pos1
  • AdminDivision1
  • AdminDivision2
  • NegaraWilayah

UsageTypeEnum

Enumeration

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

Nilai Deskripsi
Display
Route