Search - Get Geocoding

Referenz

Dienst:: Maps

API-Version:: 2023-06-01

Verwenden Sie , um Längen- und Breitenkoordinaten einer Straßenadresse oder eines Ortsnamens abzurufen.

Die Get Geocoding API ist eine HTTP-Anforderung GET , die die Längen- und Breitenkoordinaten des gesuchten Standorts zurückgibt.

In vielen Fällen kann der vollständige Suchdienst zu viel sein, z. B. wenn Sie nur an der herkömmlichen Geocodierung interessiert sind. Auf die Suche kann auch ausschließlich für die Adresssuche zugegriffen werden. Die Geocodierung erfolgt durch Erreichen des Geocodierungsendpunkts mit nur der betreffenden Adresse oder Teiladresse. Der Geocodierungssuchindex wird nach allen Daten abgefragt, die über den Daten auf Straßenebene liegen. Es werden keine Point of Interest (POIs) zurückgegeben. Beachten Sie, dass der Geocoder gegenüber Tippfehlern und unvollständigen Adressen sehr tolerant ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von geografischen Regionen auf höherer Ebene wie Stadtzentren, Landkreisen und Bundesstaaten. Die Antwort gibt auch detaillierte Adresseigenschaften wie Straße, Postleitzahl, Gemeinde und Informationen zu Land/Region zurück.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Versionsnummer der Azure Maps API.
addressLine	query		string	Die offizielle Straßenzeile einer Adresse relativ zum Gebiet, wie durch die Eigenschaften "locality" oder "postalCode" angegeben. In der Regel wird dieses Element verwendet, um eine Adresse oder eine offizielle Adresse anzugeben. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict	query		string	Der Teil der Länderunterteilung einer Adresse, z. B. WA. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict2	query		string	Der Landkreis für die strukturierte Adresse, z. B. King. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict3	query		string	Der benannte Bereich für die strukturierte Adresse. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
bbox	query		number[]	Ein rechteckiger Bereich auf der Erde, der als Begrenzungsrahmenobjekt definiert ist. Die Seiten des Rechtecks werden durch Längen- und Breitengradwerte definiert. Wenn Sie diesen Parameter angeben, wird der geografische Bereich beim Berechnen der Ergebnisse einer Standortabfrage berücksichtigt. Beispiel: lon1,lat1,lon2,lat2
coordinates	query		number[]	Ein Punkt auf der Erde, der als Längen- und Breitengrad angegeben ist. Wenn Sie diesen Parameter angeben, wird der Standort des Benutzers berücksichtigt, und die zurückgegebenen Ergebnisse können für den Benutzer relevanter sein. Beispiel: &coordinates=lon,lat
countryRegion	query		string	Signal für das Geocodierungsergebnis an einen iso 3166-1 Alpha-2-Regions-/Ländercode , der angegeben wird, z.B. FR./ Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
locality	query		string	Der Lokale Teil einer Adresse, z. B. Seattle. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
postalCode	query		string	Der Postleitzahlteil einer Adresse. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
query	query		string	Eine Zeichenfolge, die Informationen zu einem Speicherort enthält, z. B. einen Adress- oder Wahrzeichennamen.
top	query		integer int32	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 5, Minimum: 1 und Maximum: 20.
view	query		string	Eine Zeichenfolge, die einen Iso 3166-1 Alpha-2-Regions-/Ländercode darstellt. Dadurch werden die geopolitisch umstrittenen Grenzen und Bezeichnungen so geändert, dass sie der angegebenen Benutzerregion entsprechen. Standardmäßig ist der View-Parameter auf "Auto" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept-Language		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter Unterstützte Sprachen .
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Azure AD-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Name

Erforderlich

Typ

Beschreibung

Accept-Language

string

Sprache, in der Suchergebnisse zurückgegeben werden sollen.

Weitere Informationen finden Sie unter Unterstützte Sprachen .

x-ms-client-id

string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Azure AD-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name	Typ	Beschreibung
200 OK	GeocodingResponse	OK Media Types: "application/geo+json" Header x-ms-request-id: string
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten. Media Types: "application/geo+json"

Name

Typ

Beschreibung

200 OK

GeocodingResponse

Media Types: "application/geo+json"

Header

x-ms-request-id: string

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Media Types: "application/geo+json"

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweis

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Ist Authorization URL spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert.
Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps-REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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",
          "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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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",
          "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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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",
          "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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Address	Die Adresse des Ergebnisses
AdminDistricts	Der Name der Unterteilung im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als Administrative Unterteilung erster Ordnung behandelt, enthält aber in einigen Fällen auch die Unterteilung der zweiten, dritten oder vierten Ordnung in einem Land, einer Abhängigkeit oder einer Region.
CalculationMethodEnum	Die Methode, die zum Berechnen des Geocodierungspunkts verwendet wurde.
ConfidenceEnum	Die Zuverlässigkeit, dass das Ergebnis des geocodierten Standorts eine Übereinstimmung darstellt. Verwenden Sie diesen Wert mit dem Übereinstimmungscode, um ausführlichere Informationen zur Übereinstimmung zu ermitteln. Die Zuverlässigkeit eines geocodierten Standorts basiert auf vielen Faktoren, einschließlich der relativen Bedeutung des geocodierten Standorts und des Standorts des Benutzers, sofern angegeben.
CountryRegion
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
FeatureCollectionEnum	Der Typ eines FeatureCollection-Objekts muss FeatureCollection sein.
FeaturesItem
FeatureTypeEnum	Der Typ eines Features muss Feature sein.
GeocodePoints	Eine Sammlung von Geocodierungspunkten, die sich in ihrer Berechnung und ihrer vorgeschlagenen Verwendung unterscheiden.
GeocodingResponse	Dieses Objekt wird von einem erfolgreichen Geocodierungsaufruf zurückgegeben.
GeoJsonPoint	Ein gültiger `GeoJSON Point` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Intersection	Die Adresse des Ergebnisses.
MatchCodesEnum	Mindestens ein Übereinstimmen von Codewerten, die die Geocodierungsebene für jeden Standort in der Antwort darstellen. Ein geocodierter Standort mit Übereinstimmungscodes von `Good` und `Ambiguous` bedeutet beispielsweise, dass mehr als ein Geocodestandort für die Standortinformationen gefunden wurde und dass der Geocodedienst nicht über eine Suchhierarchie nach oben verfügt, um eine Übereinstimmung zu finden. Auf ähnliche Weise impliziert ein geocodierter Standort mit Übereinstimmungscodes von `Ambiguous` und `UpHierarchy` , dass kein Geocodestandort gefunden werden konnte, der allen bereitgestellten Standortinformationen entsprach, sodass der Geocodierungsdienst die Hierarchie nach oben durchsuchen musste und mehrere Übereinstimmungen auf dieser Ebene gefunden hat. Ein Beispiel für ein `AmbiguousUpHierarchy` und ergebnis ist, wenn Sie vollständige Adressinformationen bereitstellen, aber der Geocodierungsdienst keine Übereinstimmung für die Straßenadresse finden kann und stattdessen Informationen für mehrere RoadBlock-Werte zurückgibt. Mögliche Werte: `Good`: Der Speicherort weist nur eine Übereinstimmung auf, oder alle zurückgegebenen Übereinstimmungen gelten als starke Übereinstimmungen. Beispielsweise gibt eine Abfrage für New York mehrere Gute Übereinstimmungen zurück. `Ambiguous`: Der Speicherort ist eine von einer Reihe möglicher Übereinstimmungen. Wenn Sie beispielsweise die Straßenadresse 128 Main St. abfragen, kann die Antwort zwei Standorte für 128 North Main St. und 128 South Main St. zurückgeben, da nicht genügend Informationen vorhanden sind, um zu bestimmen, welche Option ausgewählt werden soll. `UpHierarchy`: Der Standort stellt einen Wechsel nach oben in der geografischen Hierarchie dar. Dies tritt auf, wenn eine Übereinstimmung für die Standortanforderung nicht gefunden wurde, sodass ein weniger präzises Ergebnis zurückgegeben wird. Wenn beispielsweise keine Übereinstimmung für die angeforderte Adresse gefunden werden kann, kann ein Übereinstimmungscode von `UpHierarchy` mit einem RoadBlock-Entitätstyp zurückgegeben werden.
Properties
UsageTypeEnum	Die beste Verwendung für den Geocodepunkt. Jeder Geocodepunkt wird als Punkt `Route` , `Display` Punkt oder beides definiert. Verwenden Sie `Route` Punkte, wenn Sie eine Route zum Standort erstellen. Verwenden Sie `Display` Punkte, wenn Sie den Standort auf einer Karte anzeigen. Wenn der Standort beispielsweise ein Park ist, kann ein `Route` Punkt einen Eingang in den Park angeben, in den Sie mit einem Auto gelangen können, und ein `Display` Punkt kann ein Punkt sein, der die Mitte des Parks angibt.

Address

Die Adresse des Ergebnisses

Name	Typ	Beschreibung
addressLine	string	AddressLine, die Straßenname und Nummer enthält
adminDistricts	AdminDistricts[]	Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung erster Ordnung behandelt, enthält aber in einigen Fällen auch die Unterteilung der zweiten, dritten oder vierten Ordnung in einem Land, einer Abhängigkeit oder einer Region.
countryRegion	CountryRegion
formattedAddress	string	Formatierte Address-Eigenschaft
intersection	Intersection	Die Adresse des Ergebnisses.
locality	string	Locality-Eigenschaft
neighborhood	string	Eigenschaft in der Nachbarschaft
postalCode	string	Postleitzahleigenschaft

AdminDistricts

Der Name der Unterteilung im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als Administrative Unterteilung erster Ordnung behandelt, enthält aber in einigen Fällen auch die Unterteilung der zweiten, dritten oder vierten Ordnung in einem Land, einer Abhängigkeit oder einer Region.

Name	Typ	Beschreibung
name	string	Der Name für das entsprechende Feld adminDistrict, For adminDistrict[0], this could be full name of state wie Washington, For adminDistrict[1], this could the full name of the county
shortName	string	Der Kurzname für das entsprechende Feld adminDistrict, For adminDistrict[0], this could be short name of state wie WA, For adminDistrict[1], this could the short name of the county

CalculationMethodEnum

Die Methode, die zum Berechnen des Geocodierungspunkts verwendet wurde.

Name	Typ	Beschreibung
Interpolation	string	Der Geocodepunkt wurde mithilfe von Interpolation mit einem Punkt auf einer Straße abgeglichen.
InterpolationOffset	string	Der Geocodepunkt wurde mit einem Punkt auf einer Straße durch Interpolation mit einem zusätzlichen Offset abgeglichen, um den Punkt auf die Straßenseite zu verschieben.
Parcel	string	Der Geocodepunkt wurde mit der Mitte eines Pakets abgeglichen.
Rooftop	string	Der Geocodepunkt wurde mit dem Dach eines Gebäudes abgeglichen.

ConfidenceEnum

Die Zuverlässigkeit, dass das Ergebnis des geocodierten Standorts eine Übereinstimmung darstellt. Verwenden Sie diesen Wert mit dem Übereinstimmungscode, um ausführlichere Informationen zur Übereinstimmung zu ermitteln.

Die Zuverlässigkeit eines geocodierten Standorts basiert auf vielen Faktoren, einschließlich der relativen Bedeutung des geocodierten Standorts und des Standorts des Benutzers, sofern angegeben.

Name Typ Beschreibung

High

Name	Typ	Beschreibung
High	string	Wenn die Konfidenz auf `High`festgelegt ist, wurden mindestens eine starke Übereinstimmung gefunden. Mehrere `High` Konfidenz-Übereinstimmungen werden nach Wichtigkeit sortiert, falls zutreffend. Beispielsweise haben Sehenswürdigkeiten Bedeutung, Adressen nicht. Wenn eine Anforderung einen Standort oder eine Ansicht enthält, kann sich die Rangfolge entsprechend ändern. Eine Standortabfrage für "Paris" gibt beispielsweise "Paris, Frankreich" und "Paris, TX" mit `High` Vertrauen zurück. "Paris, Frankreich" wird aufgrund der Wichtigkeit immer an erster Stelle eingestuft, es sei denn, ein Benutzerstandort gibt an, dass sich der Benutzer in Oder sehr nahe bei Paris, TX befindet, oder die Kartenansicht gibt an, dass der Benutzer in diesem Bereich sucht.
Low	string
Medium	string	In einigen Situationen ist die zurückgegebene Übereinstimmung möglicherweise nicht auf der gleichen Ebene wie die in der Anforderung bereitgestellten Informationen. Beispielsweise kann eine Anforderung Adressinformationen angeben, und der Geocodierungsdienst kann möglicherweise nur mit einer Postleitzahl übereinstimmen. Wenn der Geocodierungsdienst in diesem Fall sicher ist, dass die Postleitzahl mit den Daten übereinstimmt, wird die Konfidenz auf `Medium` festgelegt, und der Übereinstimmungscode wird auf `UpHierarchy` festgelegt, um anzugeben, dass nicht alle Informationen übereinstimmen können und die Hierarchie nach oben gesucht werden muss. Wenn die Standortinformationen in der Abfrage mehrdeutig sind und keine zusätzlichen Informationen zum Rangieren der Speicherorte vorhanden sind (z. B. Benutzerstandort oder die relative Bedeutung des Standorts), wird die Zuverlässigkeit auf `Medium`festgelegt. Beispielsweise kann eine Standortabfrage für "148th Ave, Bellevue" "148th Ave SE" und "148th Ave NE" beide vertrauensvoll `Medium` zurückgeben. Wenn die Standortinformationen in der Abfrage nicht genügend Informationen zum Geocodieren eines bestimmten Standorts bereitstellen, wird möglicherweise ein weniger präziser Standortwert zurückgegeben, und die Zuverlässigkeit ist auf `Medium`festgelegt. Wenn beispielsweise eine Adresse angegeben wird, aber keine Übereinstimmung für die Hausnummer gefunden wird, kann das Geocodierungsergebnis mit einem Roadblock-Entitätstyp zurückgegeben werden.

string

Wenn die Konfidenz auf Highfestgelegt ist, wurden mindestens eine starke Übereinstimmung gefunden. Mehrere High Konfidenz-Übereinstimmungen werden nach Wichtigkeit sortiert, falls zutreffend. Beispielsweise haben Sehenswürdigkeiten Bedeutung, Adressen nicht.

Wenn eine Anforderung einen Standort oder eine Ansicht enthält, kann sich die Rangfolge entsprechend ändern. Eine Standortabfrage für "Paris" gibt beispielsweise "Paris, Frankreich" und "Paris, TX" mit High Vertrauen zurück. "Paris, Frankreich" wird aufgrund der Wichtigkeit immer an erster Stelle eingestuft, es sei denn, ein Benutzerstandort gibt an, dass sich der Benutzer in Oder sehr nahe bei Paris, TX befindet, oder die Kartenansicht gibt an, dass der Benutzer in diesem Bereich sucht.

Low

string

Medium

string

In einigen Situationen ist die zurückgegebene Übereinstimmung möglicherweise nicht auf der gleichen Ebene wie die in der Anforderung bereitgestellten Informationen. Beispielsweise kann eine Anforderung Adressinformationen angeben, und der Geocodierungsdienst kann möglicherweise nur mit einer Postleitzahl übereinstimmen. Wenn der Geocodierungsdienst in diesem Fall sicher ist, dass die Postleitzahl mit den Daten übereinstimmt, wird die Konfidenz auf Medium festgelegt, und der Übereinstimmungscode wird auf UpHierarchy festgelegt, um anzugeben, dass nicht alle Informationen übereinstimmen können und die Hierarchie nach oben gesucht werden muss.

Wenn die Standortinformationen in der Abfrage mehrdeutig sind und keine zusätzlichen Informationen zum Rangieren der Speicherorte vorhanden sind (z. B. Benutzerstandort oder die relative Bedeutung des Standorts), wird die Zuverlässigkeit auf Mediumfestgelegt. Beispielsweise kann eine Standortabfrage für "148th Ave, Bellevue" "148th Ave SE" und "148th Ave NE" beide vertrauensvoll Medium zurückgeben.

Wenn die Standortinformationen in der Abfrage nicht genügend Informationen zum Geocodieren eines bestimmten Standorts bereitstellen, wird möglicherweise ein weniger präziser Standortwert zurückgegeben, und die Zuverlässigkeit ist auf Mediumfestgelegt. Wenn beispielsweise eine Adresse angegeben wird, aber keine Übereinstimmung für die Hausnummer gefunden wird, kann das Geocodierungsergebnis mit einem Roadblock-Entitätstyp zurückgegeben werden.

CountryRegion

Name	Typ	Beschreibung
ISO	string	ISO des Landes/der Region
name	string	Name des Landes/der Region

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FeatureCollectionEnum

Der Typ eines FeatureCollection-Objekts muss FeatureCollection sein.

Name	Typ	Beschreibung
FeatureCollection	string

FeaturesItem

Name	Typ	Beschreibung
bbox	number[]	Begrenzungsrahmen. Verwendete Projektion – EPSG:3857. Weitere Informationen finden Sie unter RFC 7946 .
geometry	GeoJsonPoint	Ein gültiger `GeoJSON Point` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
id	string	ID für zurückgegebenes Feature
properties	Properties
type	FeatureTypeEnum	Der Typ eines Features muss Feature sein.

FeatureTypeEnum

Der Typ eines Features muss Feature sein.

Name	Typ	Beschreibung
Feature	string

GeocodePoints

Eine Sammlung von Geocodierungspunkten, die sich in ihrer Berechnung und ihrer vorgeschlagenen Verwendung unterscheiden.

Name	Typ	Beschreibung
calculationMethod	CalculationMethodEnum	Die Methode, die zum Berechnen des Geocodierungspunkts verwendet wurde.
geometry	GeoJsonPoint	Ein gültiger `GeoJSON Point` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
usageTypes	UsageTypeEnum[]	Die beste Verwendung für den Geocodepunkt. Jeder Geocodepunkt wird als Punkt `Route` , `Display` Punkt oder beides definiert. Verwenden Sie `Route` Punkte, wenn Sie eine Route zum Standort erstellen. Verwenden Sie `Display` Punkte, wenn Sie den Standort auf einer Karte anzeigen. Wenn der Standort beispielsweise ein Park ist, kann ein `Route` Punkt einen Eingang in den Park angeben, in den Sie mit einem Auto gelangen können, und ein `Display` Punkt kann ein Punkt sein, der die Mitte des Parks angibt.

GeocodingResponse

Dieses Objekt wird von einem erfolgreichen Geocodierungsaufruf zurückgegeben.

Name	Typ	Beschreibung
features	FeaturesItem[]
nextLink	string	Ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.
type	FeatureCollectionEnum	Der Typ eines FeatureCollection-Objekts muss FeatureCollection sein.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
bbox	number[]	Begrenzungsrahmen. Verwendete Projektion – EPSG:3857. Weitere Informationen finden Sie unter RFC 7946 .
coordinates	number[]	A `Position` ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Altitude/Elevation ist ein optionales drittes Element. Weitere Informationen finden Sie unter RFC 7946 .
type	string: Point	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

Intersection

Die Adresse des Ergebnisses.

Name	Typ	Beschreibung
baseStreet	string	Primäre Straße für den Standort.
displayName	string	Vollständiger Name der Schnittmenge.
intersectionType	string	Art der Schnittmenge.
secondaryStreet1	string	Die erste sich überschneidende Straße.
secondaryStreet2	string	Falls vorhanden, die zweite sich überschneidende Straße.

MatchCodesEnum

Mindestens ein Übereinstimmen von Codewerten, die die Geocodierungsebene für jeden Standort in der Antwort darstellen.

Ein geocodierter Standort mit Übereinstimmungscodes von Good und Ambiguous bedeutet beispielsweise, dass mehr als ein Geocodestandort für die Standortinformationen gefunden wurde und dass der Geocodedienst nicht über eine Suchhierarchie nach oben verfügt, um eine Übereinstimmung zu finden.

Auf ähnliche Weise impliziert ein geocodierter Standort mit Übereinstimmungscodes von Ambiguous und UpHierarchy , dass kein Geocodestandort gefunden werden konnte, der allen bereitgestellten Standortinformationen entsprach, sodass der Geocodierungsdienst die Hierarchie nach oben durchsuchen musste und mehrere Übereinstimmungen auf dieser Ebene gefunden hat. Ein Beispiel für ein AmbiguousUpHierarchy und ergebnis ist, wenn Sie vollständige Adressinformationen bereitstellen, aber der Geocodierungsdienst keine Übereinstimmung für die Straßenadresse finden kann und stattdessen Informationen für mehrere RoadBlock-Werte zurückgibt.

Mögliche Werte:

Good: Der Speicherort weist nur eine Übereinstimmung auf, oder alle zurückgegebenen Übereinstimmungen gelten als starke Übereinstimmungen. Beispielsweise gibt eine Abfrage für New York mehrere Gute Übereinstimmungen zurück.

Ambiguous: Der Speicherort ist eine von einer Reihe möglicher Übereinstimmungen. Wenn Sie beispielsweise die Straßenadresse 128 Main St. abfragen, kann die Antwort zwei Standorte für 128 North Main St. und 128 South Main St. zurückgeben, da nicht genügend Informationen vorhanden sind, um zu bestimmen, welche Option ausgewählt werden soll.

UpHierarchy: Der Standort stellt einen Wechsel nach oben in der geografischen Hierarchie dar. Dies tritt auf, wenn eine Übereinstimmung für die Standortanforderung nicht gefunden wurde, sodass ein weniger präzises Ergebnis zurückgegeben wird. Wenn beispielsweise keine Übereinstimmung für die angeforderte Adresse gefunden werden kann, kann ein Übereinstimmungscode von UpHierarchy mit einem RoadBlock-Entitätstyp zurückgegeben werden.

Name	Typ	Beschreibung
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Name	Typ	Beschreibung
address	Address	Die Adresse des Ergebnisses
confidence	ConfidenceEnum	Die Zuverlässigkeit, dass das Ergebnis des geocodierten Standorts eine Übereinstimmung darstellt. Verwenden Sie diesen Wert mit dem Übereinstimmungscode, um ausführlichere Informationen zur Übereinstimmung zu ermitteln. Die Zuverlässigkeit eines geocodierten Standorts basiert auf vielen Faktoren, einschließlich der relativen Bedeutung des geocodierten Standorts und des Standorts des Benutzers, sofern angegeben.
geocodePoints	GeocodePoints[]	Eine Sammlung von Geocodierungspunkten, die sich in ihrer Berechnung und ihrer vorgeschlagenen Verwendung unterscheiden.
matchCodes	MatchCodesEnum[]	Mindestens ein Übereinstimmen von Codewerten, die die Geocodierungsebene für jeden Standort in der Antwort darstellen. Ein geocodierter Standort mit Übereinstimmungscodes von `Good` und `Ambiguous` bedeutet beispielsweise, dass mehr als ein Geocodestandort für die Standortinformationen gefunden wurde und dass der Geocodedienst nicht über eine Suchhierarchie nach oben verfügt, um eine Übereinstimmung zu finden. Auf ähnliche Weise impliziert ein geocodierter Standort mit Übereinstimmungscodes von `Ambiguous` und `UpHierarchy` , dass kein Geocodestandort gefunden werden konnte, der allen bereitgestellten Standortinformationen entsprach, sodass der Geocodierungsdienst die Hierarchie nach oben durchsuchen musste und mehrere Übereinstimmungen auf dieser Ebene gefunden hat. Ein Beispiel für ein `AmbiguousUpHierarchy` und ergebnis ist, wenn Sie vollständige Adressinformationen bereitstellen, aber der Geocodierungsdienst keine Übereinstimmung für die Straßenadresse finden kann und stattdessen Informationen für mehrere RoadBlock-Werte zurückgibt. Mögliche Werte: `Good`: Der Speicherort weist nur eine Übereinstimmung auf, oder alle zurückgegebenen Übereinstimmungen gelten als starke Übereinstimmungen. Beispielsweise gibt eine Abfrage für New York mehrere Gute Übereinstimmungen zurück. `Ambiguous`: Der Speicherort ist eine von einer Reihe möglicher Übereinstimmungen. Wenn Sie beispielsweise die Straßenadresse 128 Main St. abfragen, kann die Antwort zwei Standorte für 128 North Main St. und 128 South Main St. zurückgeben, da nicht genügend Informationen vorhanden sind, um zu bestimmen, welche Option ausgewählt werden soll. `UpHierarchy`: Der Standort stellt einen Wechsel nach oben in der geografischen Hierarchie dar. Dies tritt auf, wenn eine Übereinstimmung für die Standortanforderung nicht gefunden wurde, sodass ein weniger präzises Ergebnis zurückgegeben wird. Wenn beispielsweise keine Übereinstimmung für die angeforderte Adresse gefunden werden kann, kann ein Übereinstimmungscode von `UpHierarchy` mit einem RoadBlock-Entitätstyp zurückgegeben werden.
type	string	Enthält einen der folgenden Werte: Adresse Straßensperre RoadIntersection Viertel PopulatedPlace Postleitzahl1 AdminDivision1 AdminDivision2 CountryRegion

UsageTypeEnum

Die beste Verwendung für den Geocodepunkt. Jeder Geocodepunkt wird als Punkt Route , Display Punkt oder beides definiert. Verwenden Sie Route Punkte, wenn Sie eine Route zum Standort erstellen. Verwenden Sie Display Punkte, wenn Sie den Standort auf einer Karte anzeigen. Wenn der Standort beispielsweise ein Park ist, kann ein Route Punkt einen Eingang in den Park angeben, in den Sie mit einem Auto gelangen können, und ein Display Punkt kann ein Punkt sein, der die Mitte des Parks angibt.

Name	Typ	Beschreibung
Display	string
Route	string

Freigeben über

Search - Get Geocoding

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Bereiche

subscription-key

SAS Token

Beispiele

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

Beispielanforderung

Beispiel für eine Antwort

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

Beispielanforderung

Beispiel für eine Antwort

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

Beispielanforderung

Beispiel für eine Antwort

Search landmark Empire State Building by query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum

Zusätzliche Ressourcen