Search - Get Reverse Geocoding Batch

Dienst:

Maps

API-Version:

2023-06-01

Verwenden Sie, um einen Batch von Abfragen an die Reverse Geocoding-API in einer einzelnen Anforderung zu senden.

Die Get Reverse Geocoding Batch API ist eine HTTP-Anforderung POST , die Batches mit bis zu 100 Abfragen mithilfe einer einzelnen Anforderung an die Reverse Geocoding-API sendet.

Senden einer synchronen Batchanforderung

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

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

POST-Text für Batchanforderung

Zum Senden der Reverse-Geocodierungsabfragen 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, der 2 Umgekehrte Geocodierungsabfragen enthält:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Ein batchItem-Objekt mit umgekehrter Geocodierung kann alle unterstützten Reverse-Geocodierungs-URI-Parameter akzeptieren.

Der Batch sollte mindestens eine Abfrage enthalten.

Batchantwortmodell

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

• GeocodingResponse – Wenn die Abfrage erfolgreich abgeschlossen wurde.

• Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-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 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 .
Accept-Language		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter Unterstützte Sprachen .

Anforderungstext

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

Antworten

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

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 das konfigurationsbasierte Einrichten 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 genutzter 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 wurden.

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

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

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

Typ: apiKey
In: header

Beispiele

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Beispielanforderung

HTTP

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

{
  "batchItems": [
    {
      "coordinates": [
        -122.128275,
        47.639429
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        -122.341979399674,
        47.6095253501216
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:

200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ]
    },
    {
      "optionalId": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
      "error": {
        "code": "400 Bad Request",
        "message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
      }
    }
  ]
}

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	Der Grad der Zuverlässigkeit, dass das Ergebnis des geocodierten Standorts eine Übereinstimmung ist. 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.
GeocodingBatchResponse	Dieses Objekt wird von einem erfolgreichen Aufruf des Geocoding Batch-Diensts 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 Ort in der Antwort darstellt. 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 keine Suchhierarchie auf der Up-Hierarchie zum Suchen einer Übereinstimmung hatte. Ebenso impliziert ein geocodierter Standort mit Übereinstimmungscodes von Ambiguous und UpHierarchy , dass kein Geocodestandort gefunden werden konnte, der mit allen bereitgestellten Standortinformationen übereinstimmte, sodass der Geocodierungsdienst die Hierarchie nach oben durchsuchen musste und mehrere Übereinstimmungen auf dieser Ebene gefunden hat. Ein Beispiel für ein Ambiguous - und UpHierarchy -Ergebnis ist, wenn Sie vollständige Adressinformationen angeben, aber der Geocodedienst keine Übereinstimmung für die Straßenadresse finden kann und stattdessen Informationen für mehrere RoadBlock-Werte zurückgibt. Mögliche Werte: Good: Der Standort weist nur eine Übereinstimmung auf, oder alle zurückgegebenen Übereinstimmungen werden als starke Übereinstimmungen betrachtet. 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 z. B. die Adresse 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 ausgewählt werden soll. UpHierarchy: Der Standort stellt eine Verschiebung nach oben in der geografischen Hierarchie dar. Dies tritt auf, wenn keine Übereinstimmung für die Standortanforderung 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
ResultTypeEnum	Geben Sie Entitätstypen an, die Sie in der Antwort benötigen. Es werden nur die von Ihnen angegebenen Typen zurückgegeben. Wenn der Punkt nicht den von Ihnen angegebenen Entitätstypen zugeordnet werden kann, werden in der Antwort keine Standortinformationen zurückgegeben. Standardwert sind alle möglichen Entitäten. Eine durch Trennzeichen getrennte Liste von Entitätstypen, die aus den folgenden Optionen ausgewählt sind. Adresse Viertel PopulatedPlace Postleitzahl1 AdminDivision1 AdminDivision2 CountryRegion Diese Entitätstypen werden von der spezifischsten Entität bis zur am wenigsten spezifischen Entität sortiert. Wenn Entitäten mit mehr als einem Entitätstyp gefunden werden, wird nur die spezifischste Entität zurückgegeben. Wenn Sie beispielsweise Address und AdminDistrict1 angeben, als Entitätstypen und Entitäten für beide Typen gefunden wurden, werden in der Antwort nur die Informationen zur Adressentität zurückgegeben.
ReverseGeocodingBatchRequestBody	Die Liste der zu verarbeitenden Umgekehrten Geocodierungsabfragen/Anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens eine Abfrage enthalten.
ReverseGeocodingBatchRequestItem	Batch Query-Objekt
Summary	Zusammenfassung für die Batchanforderung
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 Street Name und Number enthält
adminDistricts	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.
countryRegion	CountryRegion
formattedAddress	string	Formatierte Address-Eigenschaft
intersection	Intersection	Die Adresse des Ergebnisses.
locality	string	locality-Eigenschaft
neighborhood	string	Eigenschaft "neighborhood"
postalCode	string	Postleitzahl-Eigenschaft

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

Der Grad der Zuverlässigkeit, dass das Ergebnis des geocodierten Standorts eine Übereinstimmung ist. 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	string	Wenn die Konfidenz auf Highfestgelegt ist, wurden mindestens eine starke Übereinstimmung gefunden. Mehrere High Konfidenzmatches werden ggf. nach Wichtigkeit sortiert. Beispielsweise haben Sehenswürdigkeiten Bedeutung, 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 beispielsweise "Paris, Frankreich" und "Paris, TX" beide mit High Zuversicht zurück. "Paris, France" wird aufgrund der Wichtigkeit immer an erster Stelle platziert, es sei denn, ein Benutzerstandort gibt an, dass sich der Benutzer in Paris, TX oder ganz in der Nähe von Paris befindet, oder die Kartenansicht gibt an, dass der Benutzer in diesem Bereich sucht.
Low	string
Medium	string	In einigen Situationen liegt 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 Geocodedienst in diesem Fall die Gewissheit hat, 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 konnten und die Hierarchie nach oben suchen musste. 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 Wichtigkeit 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 mit Medium Zuversicht zurückgeben. Wenn die Standortinformationen in der Abfrage nicht genügend Informationen zum Geocodieren eines bestimmten Standorts enthalten, kann ein weniger präziser Standortwert zurückgegeben werden, und die Zuverlässigkeit wird auf Mediumfestgelegt. Wenn beispielsweise eine Adresse angegeben wird, aber keine Übereinstimmung für die Hausnummer gefunden wird, kann das Geocodeergebnis 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.

GeocodingBatchResponse

Dieses Objekt wird von einem erfolgreichen Aufruf des Geocoding Batch-Diensts zurückgegeben.

Name	Typ	Beschreibung
batchItems	GeocodingBatchResponseItem[]	Array mit den Batchergebnissen.
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.
summary	Summary	Zusammenfassung für die Batchanforderung

GeocodingBatchResponseItem

Name	Typ	Beschreibung
error	ErrorDetail	Die Fehlerdetails.
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.
optionalId	string	ID des batchItem-Objekts, die mit der ID in der Anforderung identisch wäre
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[]	Ein Position ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Höhe/Höhe 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 Übereinstimmungscodewert, der die Geocodierungsebene für jeden Ort in der Antwort darstellt.

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 keine Suchhierarchie auf der Up-Hierarchie zum Suchen einer Übereinstimmung hatte.

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

Mögliche Werte:

Good: Der Standort weist nur eine Übereinstimmung auf, oder alle zurückgegebenen Übereinstimmungen werden als starke Übereinstimmungen betrachtet. 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 z. B. die Adresse 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 ausgewählt werden soll.

UpHierarchy: Der Standort stellt eine Verschiebung nach oben in der geografischen Hierarchie dar. Dies tritt auf, wenn keine Übereinstimmung für die Standortanforderung 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

ResultTypeEnum

Geben Sie Entitätstypen an, die Sie in der Antwort benötigen. Es werden nur die von Ihnen angegebenen Typen zurückgegeben. Wenn der Punkt nicht den von Ihnen angegebenen Entitätstypen zugeordnet werden kann, werden in der Antwort keine Standortinformationen zurückgegeben. Standardwert sind alle möglichen Entitäten. Eine durch Trennzeichen getrennte Liste von Entitätstypen, die aus den folgenden Optionen ausgewählt sind.

• Adresse
• Viertel
• PopulatedPlace
• Postleitzahl1
• AdminDivision1
• AdminDivision2
• CountryRegion

Diese Entitätstypen werden von der spezifischsten Entität bis zur am wenigsten spezifischen Entität sortiert. Wenn Entitäten mit mehr als einem Entitätstyp gefunden werden, wird nur die spezifischste Entität zurückgegeben. Wenn Sie beispielsweise Address und AdminDistrict1 angeben, als Entitätstypen und Entitäten für beide Typen gefunden wurden, werden in der Antwort nur die Informationen zur Adressentität zurückgegeben.

Name	Typ	Beschreibung
Address	string
AdminDivision1	string
AdminDivision2	string
CountryRegion	string
Neighborhood	string
PopulatedPlace	string
Postcode1	string

ReverseGeocodingBatchRequestBody

Die Liste der zu verarbeitenden Umgekehrten Geocodierungsabfragen/Anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens eine Abfrage enthalten.

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

ReverseGeocodingBatchRequestItem

Batch Query-Objekt

Name	Typ	Beschreibung
coordinates	number[]	Die Koordinaten der Position, an der Sie die Geocodierung umkehren möchten. Beispiel: [lon,lat]
optionalId	string	ID der Anforderung, die im entsprechenden batchItem angezeigt wird
resultTypes	ResultTypeEnum[]	Geben Sie Entitätstypen an, die Sie in der Antwort benötigen. Es werden nur die von Ihnen angegebenen Typen zurückgegeben. Wenn der Punkt nicht den von Ihnen angegebenen Entitätstypen zugeordnet werden kann, werden in der Antwort keine Standortinformationen zurückgegeben. Standardwert sind alle möglichen Entitäten. Eine durch Trennzeichen getrennte Liste von Entitätstypen, die aus den folgenden Optionen ausgewählt sind. Adresse Viertel PopulatedPlace Postleitzahl1 AdminDivision1 AdminDivision2 CountryRegion Diese Entitätstypen werden von der spezifischsten Entität bis zur am wenigsten spezifischen Entität sortiert. Wenn Entitäten mit mehr als einem Entitätstyp gefunden werden, wird nur die spezifischste Entität zurückgegeben. Wenn Sie beispielsweise Address und AdminDistrict1 angeben, als Entitätstypen und Entitäten für beide Typen gefunden wurden, werden in der Antwort nur die Informationen zur Adressentität zurückgegeben.
view	string	Eine Zeichenfolge, die einen Iso 3166-1 Alpha-2-Regions-/Ländercode angibt. Dadurch werden geopolitische strittige Grenzen und Bezeichnungen so geändert, dass sie an der angegebenen Benutzerregion ausgerichtet sind.

Summary

Zusammenfassung für die Batchanforderung

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

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