Search - Get Geocoding Batch

Dienst:: Maps

API-Version:: 2025-01-01

Verwenden Sie diese Option, um einen Batch von Abfragen in einer einzigen Anforderung an die Geokodierungs-API zu senden.

Die Get Geocoding Batch-API ist eine HTTP-POST-Anforderung, die Batches von bis zu 100 Abfragen an die Geocodierungs--API in einer einzigen Anforderung sendet.

Synchrone Batchanforderung übermitteln

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt.

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

POST-Text für Batchanforderung

Um die Geocodierung Abfragen zu senden, verwenden Sie eine POST Anforderung, bei der der Anforderungstext das batchItems Array im json Format enthält und der Content-Type Header auf application/jsonfestgelegt wird. Hier sehen Sie einen Beispielanforderungstext mit 2 Geocodierung Abfragen:

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

Ein Geocodierungsobjekt batchItem-Objekt kann alle unterstützten GeocodierungsparameterURI-Parameterakzeptieren.

Der Batch sollte mindestens 1 Abfrage enthalten.

Batchantwortmodell

Die Batchantwort enthält eine summary Komponente, die die totalRequests angibt, die Teil der ursprünglichen Batchanforderung waren, und successfulRequests d. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede und jede Abfrage in der Batchanforderung enthält. Die batchItems enthält die Ergebnisse in der genauen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element weist einen der folgenden Typen auf:

GeocodingResponse – Wenn die Abfrage erfolgreich abgeschlossen wurde.
Error – Wenn die Abfrage fehlgeschlagen ist. Die Antwort enthält in diesem Fall eine code und eine message.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Versionsnummer der Azure Maps-API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Azure AD-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps.
Accept-Language		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter unterstützten Sprachen.

Name

Erforderlich

Typ

Beschreibung

x-ms-client-id

string

Gibt an, welches Konto in Verbindung mit dem Azure AD-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps.

Accept-Language

string

Sprache, in der Suchergebnisse zurückgegeben werden sollen.

Weitere Informationen finden Sie unter unterstützten Sprachen.

Anforderungstext

Name	Typ	Beschreibung
batchItems	GeocodingBatchRequestItem[]	Die Liste der zu verarbeitenden Abfragen.

Antworten

Name	Typ	Beschreibung
200 OK	GeocodingBatchResponse	OKAY
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

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 Karten-Verwaltungs-APIerworben werden.
Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die 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 genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. 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 empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

A Geocoding Batch API call containing 2 Geocoding queries

Beispielanforderung

HTTP

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

{
  "batchItems": [
    {
      "addressLine": "15127 NE 24th Street, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "query": "Pike Pl",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King County"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
              "streetName": "NE 24th St",
              "streetNumber": "15127",
              "addressLine": "15127 NE 24th St"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.138669,
                    47.630359
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.1387383,
                    47.630563
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.138669,
              47.630359
            ]
          },
          "bbox": [
            -122.14631082421619,
            47.62649628242932,
            -122.1310271757838,
            47.634221717570675
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Address	Die Adresse des Ergebnisses
AdminDistricts	Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung der ersten Reihenfolge behandelt, enthält aber in einigen Fällen auch die zweite, dritte oder vierte Ordnungsunterteilung in einem Land, einer Abhängigkeit oder region.
CalculationMethodEnum	Die Methode, die zum Berechnen des Geocodepunkts verwendet wurde.
ConfidenceEnum	Das Konfidenzniveau, dass das geocodierte Standortergebnis eine Übereinstimmung ist. Verwenden Sie diesen Wert mit dem Übereinstimmungscode, um ausführlichere Informationen zur Übereinstimmung zu ermitteln. Die Konfidenz eines geocodierten Standorts basiert auf vielen Faktoren, einschließlich der relativen Wichtigkeit des geocodierten Standorts und des Standorts des Benutzers, sofern angegeben.
CountryRegion
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das 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 Geocodepunkten, die sich bei der Berechnung und deren vorgeschlagene Verwendung unterscheiden.
GeocodingBatchRequestBody	Die Liste der Zu verarbeitenden Adress-Geocodierungsabfragen/Anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens 1 Abfrage enthalten.
GeocodingBatchRequestItem	Batchabfrageobjekt
GeocodingBatchResponse	Dieses Objekt wird von einem erfolgreichen Geocoding Batch-Dienstaufruf zurückgegeben.
GeocodingBatchResponseItem
GeoJsonPoint	Ein gültiger `GeoJSON Point` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
Intersection	Die Adresse des Ergebnisses.
MatchCodesEnum	Mindestens ein Übereinstimmungscodewert, der die Geocodierungsebene für jeden Standort in der Antwort darstellt. Beispielsweise bedeutet ein geocodierter Standort mit Übereinstimmungscodes von `Good` und `Ambiguous`, dass für die Standortinformationen mehrere Geocode-Standorte gefunden wurden und dass der Geocode-Dienst keine Suchhierarchie zum Suchen nach einer Übereinstimmung hat. Ebenso bedeutet ein geocodierter Standort mit Übereinstimmungscodes von `Ambiguous` und `UpHierarchy`, dass ein Geocodestandort nicht gefunden werden konnte, der mit allen bereitgestellten Standortinformationen übereinstimmte, sodass der Geocode-Dienst die Hierarchie nach oben durchsuchen und mehrere Übereinstimmungen auf dieser Ebene gefunden hatte. Ein Beispiel für eine `Ambiguous` und `UpHierarchy` Ergebnis ist, wenn Sie vollständige Adressinformationen angeben, der Geocode-Dienst kann jedoch keine Übereinstimmung für die Straßenadresse finden und gibt stattdessen Informationen für mehr als einen RoadBlock-Wert zurück. Mögliche Werte sind: `Good`: Der Standort hat nur eine Übereinstimmung, oder alle zurückgegebenen Übereinstimmungen gelten als starke Übereinstimmungen. Eine Abfrage für New York gibt z. B. mehrere gute Übereinstimmungen zurück. `Ambiguous`: Die Position ist eine der möglichen Übereinstimmungen. Wenn Sie beispielsweise die Straße 128 Main St. abfragen, gibt die Antwort möglicherweise zwei Standorte für 128 North Main St. und 128 South Main St. zurück, da nicht genügend Informationen vorhanden sind, um zu bestimmen, welche Option sie auswählen soll. `UpHierarchy`: Der Standort stellt eine Verschiebung 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 eine Übereinstimmung für die angeforderte Adresse nicht gefunden werden kann, kann ein Übereinstimmungscode von `UpHierarchy` mit einem RoadBlock-Entitätstyp zurückgegeben werden.
Properties
Summary	Zusammenfassung für die Batchanforderung
UsageTypeEnum	Die beste Verwendung für den Geocodepunkt. Jeder Geocodepunkt wird als `Route` Punkt, ein `Display` Punkt oder beides definiert. Verwenden Sie `Route` Punkte, wenn Sie eine Route zum Standort erstellen. Verwenden Sie `Display` Punkte, wenn Sie die Position auf einer Karte anzeigen. Wenn es sich beispielsweise um einen Park handelt, kann ein `Route` Punkt einen Eingang zum 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

Objekt

Die Adresse des Ergebnisses

Name	Typ	Beschreibung
addressLine	string	AddressLine, die Street Name und Number enthält
adminDistricts	AdminDistricts[]	Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung der ersten Reihenfolge behandelt, enthält aber in einigen Fällen auch die zweite, dritte oder vierte Ordnungsunterteilung in einem Land, einer Abhängigkeit oder region.
countryRegion	CountryRegion
formattedAddress	string	Formatierte Address-Eigenschaft
intersection	Intersection	Die Adresse des Ergebnisses.
locality	string	Locality-Eigenschaft
neighborhood	string	Nachbarschaftsobjekt
postalCode	string	Postleitzahl-Eigenschaft
streetName	string	Der Name der Straße aus formattedAddress
streetNumber	string	Die Nummer in der Straße, falls verfügbar, von formattedAddress

AdminDistricts

Objekt

Der Unterteilungsname im Land oder der Region für eine Adresse. Dieses Element wird in der Regel als administrative Unterteilung der ersten Reihenfolge behandelt, enthält aber in einigen Fällen auch die zweite, dritte oder vierte Ordnungsunterteilung in einem Land, einer Abhängigkeit oder region.

Name	Typ	Beschreibung
name	string	Der Name für das entsprechende Feld "adminDistrict", "For adminDistrict[0], this could be full name of state such as Washington, For adminDistrict[1], this could be 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 such as WA, For adminDistrict[1], this could be the short name of the county

CalculationMethodEnum

Enumeration

Die Methode, die zum Berechnen des Geocodepunkts verwendet wurde.

Wert	Beschreibung
Interpolation	Der Geokodierungspunkt wurde mithilfe der Interpolation mit einem Punkt auf einer Straße abgeglichen.
InterpolationOffset	Der Geokodierungspunkt wurde mithilfe der Interpolation mit einem Punkt auf einer Straße abgeglichen, wobei ein zusätzlicher Versatz hinzugefügt wurde, um den Punkt an die Straßenseite zu verschieben.
Parcel	Der Geokodierungspunkt wurde mit dem Mittelpunkt eines Flurstücks abgeglichen.
Rooftop	Der Geokodierungspunkt wurde mit dem Dach eines Gebäudes abgeglichen.

ConfidenceEnum

Enumeration

Das Konfidenzniveau, dass das geocodierte Standortergebnis eine Übereinstimmung ist. Verwenden Sie diesen Wert mit dem Übereinstimmungscode, um ausführlichere Informationen zur Übereinstimmung zu ermitteln.

Die Konfidenz eines geocodierten Standorts basiert auf vielen Faktoren, einschließlich der relativen Wichtigkeit des geocodierten Standorts und des Standorts des Benutzers, sofern angegeben.

Wert Beschreibung

High

Wert	Beschreibung
High	Wenn die Konfidenz auf `High`festgelegt ist, wurden eine oder mehrere starke Übereinstimmungen gefunden. Mehrere `High` Konfidenzübereinstimmungen werden gegebenenfalls in der Rangfolge nach Wichtigkeit sortiert. Orientierungspunkte sind z. B. wichtig, Adressen jedoch nicht. Wenn eine Anforderung einen Standort oder eine Ansicht enthält, kann sich die Rangfolge entsprechend ändern. Eine Standortabfrage für "Paris" gibt z. B. "Paris, Frankreich" und "Paris, TX" `High` mit Konfidenz zurück. "Paris, Frankreich" wird aufgrund seiner Wichtigkeit immer an erster Stelle eingestuft, es sei denn, ein Benutzerstandort gibt an, dass sich der Benutzer in oder sehr nahe an Paris, TX, befindet, oder die Kartenansicht zeigt an, dass der Benutzer in diesem Gebiet sucht.
Medium	In einigen Situationen kann es vorkommen, dass die zurückgegebene Übereinstimmung nicht auf der gleichen Ebene ist wie die in der Anforderung bereitgestellten Informationen. In einer Anforderung können z. B. Adressinformationen angegeben werden, und der Geokodierungsservice kann nur eine Postleitzahl abgleichen. Wenn der Geokodierungsservice in diesem Fall die Konfidenz hat, dass die Postleitzahl mit den Daten übereinstimmt, wird die Konfidenz auf `Medium` und der Abgleichscode auf festgelegt `UpHierarchy` , um anzugeben, dass nicht alle Informationen übereinstimmen konnten und in der übergeordneten Hierarchie gesucht werden musste. Wenn die Standortinformationen in der Abfrage mehrdeutig sind und keine zusätzlichen Informationen zur Einstufung der Standorte vorhanden sind (z. B. der Standort des Benutzers oder die relative Wichtigkeit des Standorts), wird die Konfidenz auf `Medium`festgelegt. Eine Standortabfrage für "148th Ave, Bellevue" kann z. B. "148th Ave SE" und "148th Ave NE" `Medium` mit Konfidenz zurückgeben. Wenn die Positionsinformationen in der Abfrage nicht genügend Informationen für die Geokodierung einer bestimmten Position liefern, wird möglicherweise ein weniger genauer Positionswert zurückgegeben und die Konfidenz auf `Medium`festgelegt. Wenn z. B. eine Adresse angegeben wird, aber keine Übereinstimmung für die Hausnummer gefunden wird, kann das Geokodierungsergebnis mit dem Entitätstyp Roadblock zurückgegeben werden.
Low

Wenn die Konfidenz auf Highfestgelegt ist, wurden eine oder mehrere starke Übereinstimmungen gefunden. Mehrere High Konfidenzübereinstimmungen werden gegebenenfalls in der Rangfolge nach Wichtigkeit sortiert. Orientierungspunkte sind z. B. wichtig, Adressen jedoch nicht.

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

Medium

In einigen Situationen kann es vorkommen, dass die zurückgegebene Übereinstimmung nicht auf der gleichen Ebene ist wie die in der Anforderung bereitgestellten Informationen. In einer Anforderung können z. B. Adressinformationen angegeben werden, und der Geokodierungsservice kann nur eine Postleitzahl abgleichen. Wenn der Geokodierungsservice in diesem Fall die Konfidenz hat, dass die Postleitzahl mit den Daten übereinstimmt, wird die Konfidenz auf Medium und der Abgleichscode auf festgelegt UpHierarchy , um anzugeben, dass nicht alle Informationen übereinstimmen konnten und in der übergeordneten Hierarchie gesucht werden musste.

Wenn die Standortinformationen in der Abfrage mehrdeutig sind und keine zusätzlichen Informationen zur Einstufung der Standorte vorhanden sind (z. B. der Standort des Benutzers oder die relative Wichtigkeit des Standorts), wird die Konfidenz auf Mediumfestgelegt. Eine Standortabfrage für "148th Ave, Bellevue" kann z. B. "148th Ave SE" und "148th Ave NE" Medium mit Konfidenz zurückgeben.

Wenn die Positionsinformationen in der Abfrage nicht genügend Informationen für die Geokodierung einer bestimmten Position liefern, wird möglicherweise ein weniger genauer Positionswert zurückgegeben und die Konfidenz auf Mediumfestgelegt. Wenn z. B. eine Adresse angegeben wird, aber keine Übereinstimmung für die Hausnummer gefunden wird, kann das Geokodierungsergebnis mit dem Entitätstyp Roadblock zurückgegeben werden.

Low

CountryRegion

Objekt

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

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FeatureCollectionEnum

Enumeration

Der Typ eines FeatureCollection-Objekts muss FeatureCollection sein.

Wert	Beschreibung
FeatureCollection

FeaturesItem

Objekt

Name	Typ	Beschreibung
bbox	number[] (double)	Begrenzungsrahmen. Projektion verwendet - 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ückgegebene Funktion
properties	Properties
type	FeatureTypeEnum	Der Typ eines Features muss feature sein.

FeatureTypeEnum

Enumeration

Der Typ eines Features muss feature sein.

Wert	Beschreibung
Feature

GeocodePoints

Objekt

Eine Sammlung von Geocodepunkten, die sich bei der Berechnung und deren vorgeschlagene Verwendung unterscheiden.

Name	Typ	Beschreibung
calculationMethod	CalculationMethodEnum	Die Methode, die zum Berechnen des Geocodepunkts 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 `Route` Punkt, ein `Display` Punkt oder beides definiert. Verwenden Sie `Route` Punkte, wenn Sie eine Route zum Standort erstellen. Verwenden Sie `Display` Punkte, wenn Sie die Position auf einer Karte anzeigen. Wenn es sich beispielsweise um einen Park handelt, kann ein `Route` Punkt einen Eingang zum 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.

GeocodingBatchRequestBody

Objekt

Die Liste der Zu verarbeitenden Adress-Geocodierungsabfragen/Anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens 1 Abfrage enthalten.

Name	Typ	Beschreibung
batchItems	GeocodingBatchRequestItem[]	Die Liste der zu verarbeitenden Abfragen.

GeocodingBatchRequestItem

Objekt

Batchabfrageobjekt

Name	Typ	Standardwert	Beschreibung
addressLine	string		Die offizielle Straßenzeile einer Adresse relativ zum Gebiet, wie durch die Lokalität oder Postleitzahl angegeben, Eigenschaften. Die typische Verwendung dieses Elements wäre die Angabe einer Straße oder einer offiziellen Adresse. Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
adminDistrict	string		Der Teil der Landesunterteilung einer Adresse, z. B. WA. Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
adminDistrict2	string		Die Grafschaft für die strukturierte Adresse, z. B. König. Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
adminDistrict3	string		Der benannte Bereich für die strukturierte Adresse. Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
bbox	number[] (double)		Ein rechteckiger Bereich auf der Erde, der als umgebendes Boxobjekt definiert ist. Die Seiten der Rechtecke werden durch Längen- und Breitengradwerte definiert. Weitere Informationen finden Sie unter Standort- und Bereichstypen. Wenn Sie diesen Parameter angeben, wird der geografische Bereich beim Berechnen der Ergebnisse einer Standortabfrage berücksichtigt. Beispiel: [lon1, lat1, lon2, lat2]
coordinates	number[] (double)		Ein Punkt auf der Erde, der als Längengrad und Breitengrad angegeben ist. Wenn Sie diesen Parameter angeben, wird der Standort des Benutzers berücksichtigt, und die zurückgegebenen Ergebnisse sind möglicherweise für den Benutzer relevanter. Beispiel: [lon, lat]
countryRegion	string		Signal für das Geocodierungsergebnis an eine ISO 3166-1 Alpha-2-Region/Ländercode, die angegeben wird, z. B. FR./ Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
locality	string		Der Gebietsschemateil einer Adresse, z. B. Seattle. Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
optionalId	string		ID der Anforderung, die im entsprechenden batchItem angezeigt wird
postalCode	string		Der Postleitzahlteil einer Adresse. Dieser Parameter sollte nicht verwendet werden, wenn der `query` Parameter in der Anforderung enthalten ist.
query	string		Eine Zeichenfolge, die Informationen zu einem Speicherort enthält, z. B. eine Adresse oder einen Orientierungspunktnamen.
top	integer (int32) minimum: 1 maximum: 20	5	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 5, Minimum: 1 und maximal: 20.
view	string	auto	Eine Zeichenfolge, die eine ISO 3166-1 Alpha-2-Region/Ländercodeangibt. Dies wird geopolitische umstrittene Grenzen und Bezeichnungen ändern, um sie an die angegebene Benutzerregion auszurichten.

GeocodingBatchResponse

Objekt

Dieses Objekt wird von einem erfolgreichen Geocoding Batch-Dienstaufruf zurückgegeben.

Name	Typ	Beschreibung
batchItems	GeocodingBatchResponseItem[]	Array, das die Batchergebnisse enthält.
nextLink	string	Dies ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.
summary	Summary	Zusammenfassung für die Batchanforderung

GeocodingBatchResponseItem

Objekt

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerdetails.
features	FeaturesItem[]
nextLink	string	Dies ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.
optionalId	string	id des batchItem, das mit der ID in der Anforderung identisch wäre
type	FeatureCollectionEnum	Der Typ eines FeatureCollection-Objekts muss FeatureCollection sein.

GeoJsonPoint

Objekt

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

Name	Typ	Beschreibung
bbox	number[] (double)	Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-.
coordinates	number[] (double)	Ein `Position` ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längengrad und Breitengradgenau 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

Objekt

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	Schnittmengetyp.
secondaryStreet1	string	Die erste überschneidende Straße.
secondaryStreet2	string	Wenn vorhanden, die zweite überschneidende Straße.

MatchCodesEnum

Enumeration

Mindestens ein Übereinstimmungscodewert, der die Geocodierungsebene für jeden Standort in der Antwort darstellt.

Beispielsweise bedeutet ein geocodierter Standort mit Übereinstimmungscodes von Good und Ambiguous, dass für die Standortinformationen mehrere Geocode-Standorte gefunden wurden und dass der Geocode-Dienst keine Suchhierarchie zum Suchen nach einer Übereinstimmung hat.

Ebenso bedeutet ein geocodierter Standort mit Übereinstimmungscodes von Ambiguous und UpHierarchy, dass ein Geocodestandort nicht gefunden werden konnte, der mit allen bereitgestellten Standortinformationen übereinstimmte, sodass der Geocode-Dienst die Hierarchie nach oben durchsuchen und mehrere Übereinstimmungen auf dieser Ebene gefunden hatte. Ein Beispiel für eine Ambiguous und UpHierarchy Ergebnis ist, wenn Sie vollständige Adressinformationen angeben, der Geocode-Dienst kann jedoch keine Übereinstimmung für die Straßenadresse finden und gibt stattdessen Informationen für mehr als einen RoadBlock-Wert zurück.

Mögliche Werte sind:

Good: Der Standort hat nur eine Übereinstimmung, oder alle zurückgegebenen Übereinstimmungen gelten als starke Übereinstimmungen. Eine Abfrage für New York gibt z. B. mehrere gute Übereinstimmungen zurück.

Ambiguous: Die Position ist eine der möglichen Übereinstimmungen. Wenn Sie beispielsweise die Straße 128 Main St. abfragen, gibt die Antwort möglicherweise zwei Standorte für 128 North Main St. und 128 South Main St. zurück, da nicht genügend Informationen vorhanden sind, um zu bestimmen, welche Option sie auswählen soll.

UpHierarchy: Der Standort stellt eine Verschiebung 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 eine Übereinstimmung für die angeforderte Adresse nicht gefunden werden kann, kann ein Übereinstimmungscode von UpHierarchy mit einem RoadBlock-Entitätstyp zurückgegeben werden.

Wert	Beschreibung
Good
Ambiguous
UpHierarchy

Properties

Objekt

Name	Typ	Beschreibung
address	Address	Die Adresse des Ergebnisses
confidence	ConfidenceEnum	Das Konfidenzniveau, dass das geocodierte Standortergebnis eine Übereinstimmung ist. Verwenden Sie diesen Wert mit dem Übereinstimmungscode, um ausführlichere Informationen zur Übereinstimmung zu ermitteln. Die Konfidenz eines geocodierten Standorts basiert auf vielen Faktoren, einschließlich der relativen Wichtigkeit des geocodierten Standorts und des Standorts des Benutzers, sofern angegeben.
geocodePoints	GeocodePoints[]	Eine Sammlung von Geocodepunkten, die sich bei der Berechnung und deren vorgeschlagene Verwendung unterscheiden.
matchCodes	MatchCodesEnum[]	Mindestens ein Übereinstimmungscodewert, der die Geocodierungsebene für jeden Standort in der Antwort darstellt. Beispielsweise bedeutet ein geocodierter Standort mit Übereinstimmungscodes von `Good` und `Ambiguous`, dass für die Standortinformationen mehrere Geocode-Standorte gefunden wurden und dass der Geocode-Dienst keine Suchhierarchie zum Suchen nach einer Übereinstimmung hat. Ebenso bedeutet ein geocodierter Standort mit Übereinstimmungscodes von `Ambiguous` und `UpHierarchy`, dass ein Geocodestandort nicht gefunden werden konnte, der mit allen bereitgestellten Standortinformationen übereinstimmte, sodass der Geocode-Dienst die Hierarchie nach oben durchsuchen und mehrere Übereinstimmungen auf dieser Ebene gefunden hatte. Ein Beispiel für eine `Ambiguous` und `UpHierarchy` Ergebnis ist, wenn Sie vollständige Adressinformationen angeben, der Geocode-Dienst kann jedoch keine Übereinstimmung für die Straßenadresse finden und gibt stattdessen Informationen für mehr als einen RoadBlock-Wert zurück. Mögliche Werte sind: `Good`: Der Standort hat nur eine Übereinstimmung, oder alle zurückgegebenen Übereinstimmungen gelten als starke Übereinstimmungen. Eine Abfrage für New York gibt z. B. mehrere gute Übereinstimmungen zurück. `Ambiguous`: Die Position ist eine der möglichen Übereinstimmungen. Wenn Sie beispielsweise die Straße 128 Main St. abfragen, gibt die Antwort möglicherweise zwei Standorte für 128 North Main St. und 128 South Main St. zurück, da nicht genügend Informationen vorhanden sind, um zu bestimmen, welche Option sie auswählen soll. `UpHierarchy`: Der Standort stellt eine Verschiebung 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 eine Übereinstimmung für die angeforderte Adresse nicht gefunden werden kann, kann ein Übereinstimmungscode von `UpHierarchy` mit einem RoadBlock-Entitätstyp zurückgegeben werden.
type	string	Einer von: Adresse Straßensperre RoadIntersection Nachbarschaft Aufgefüllter Platz Postleitzahl1 AdminDivision1 AdminDivision2 Land/Region

Summary

Objekt

Zusammenfassung für die Batchanforderung

Name	Typ	Beschreibung
successfulRequests	integer (int32)	Anzahl der erfolgreichen Anforderungen im Batch
totalRequests	integer (int32)	Gesamtanzahl der Anforderungen im Batch

UsageTypeEnum

Enumeration

Die beste Verwendung für den Geocodepunkt. Jeder Geocodepunkt wird als Route Punkt, ein Display Punkt oder beides definiert. Verwenden Sie Route Punkte, wenn Sie eine Route zum Standort erstellen. Verwenden Sie Display Punkte, wenn Sie die Position auf einer Karte anzeigen. Wenn es sich beispielsweise um einen Park handelt, kann ein Route Punkt einen Eingang zum 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.

Wert	Beschreibung
Display
Route

Freigeben über

Search - Get Geocoding Batch

Synchrone Batchanforderung übermitteln

POST-Text für Batchanforderung

Batchantwortmodell

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AADToken

Bereiche

subscription-key

SAS Token

Beispiele

A Geocoding Batch API call containing 2 Geocoding queries

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum