Search - Get Geocoding Batch

Referenz

Dienst:: Maps

API-Version:: 2023-06-01

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

Die Get Geocoding Batch API ist eine HTTP-Anforderung POST , die Batches mit bis zu 100 Abfragen in einer einzelnen Anforderung an die Geocodierungs-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/geocode:batch?api-version=2023-06-01

POST-Text für Batchanforderung

Zum Senden der 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 mit 2 Geocodierungsabfragen :

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

Ein BatchItem-Objekt für die Geocodierung kann alle unterstützten 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/geocode: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. Anleitungen 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 .

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. Anleitungen 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	GeocodingBatchRequestItem[]	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. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.
Der Authorization URL ist spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
Die rollenbasierte Zugriffssteuerung in 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 Geocoding Batch API call containing 2 Geocoding queries

Beispielanforderung

HTTP

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

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

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
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' 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 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.
GeocodingBatchRequestBody	Die Liste der zu verarbeitenden Adressgeocodierungsabfragen/-anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens eine Abfrage enthalten.
GeocodingBatchRequestItem	Batch Query-Objekt
GeocodingBatchResponse	Dieses Objekt wird von einem erfolgreichen Aufruf des Batch-Geocodierungsdiensts 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 Ü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
Summary	Zusammenfassung für die Batchanforderung
UsageTypeEnum	Die beste Verwendung für den Geocodierungspunkt. Jeder Geocodierungspunkt 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 zum Park angeben, in den Sie mit einem Auto gelangen können, und ein `Display` Punkt kann ein Punkt sein, der den Mittelpunkt 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 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.

Name	Typ	Beschreibung
name	string	Der Name für das entsprechende Feld adminDistrict, For adminDistrict[0], dies könnte der vollständige Name des Bundesstaats sein, z. B. Washington, For adminDistrict[1], dies könnte der vollständige Name des Countys sein.
shortName	string	Der kurze Name für das entsprechende Feld adminDistrict, For adminDistrict[0], dies könnte der kurze Name des Staates sein, z. B. WA, For adminDistrict[1], dies könnte der kurze Name des Landkreises sein.

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 mithilfe von Interpolation mit einem zusätzlichen Offset auf einen Punkt auf einer Straße abgeglichen, um den Punkt zur Straßenseite zu verschieben.
Parcel	string	Der Geocodepunkt wurde mit der Mitte eines Pakets abgeglichen.
Rooftop	string	Der Geocodepunkt wurde auf das Dach eines Gebäudes abgestimmt.

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 Geocodierungspunkt. Jeder Geocodierungspunkt 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 zum Park angeben, in den Sie mit einem Auto gelangen können, und ein `Display` Punkt kann ein Punkt sein, der den Mittelpunkt des Parks angibt.

GeocodingBatchRequestBody

Die Liste der zu verarbeitenden Adressgeocodierungsabfragen/-anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens eine Abfrage enthalten.

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

GeocodingBatchRequestItem

Batch Query-Objekt

Name	Typ	Standardwert	Beschreibung
addressLine	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	string		Der Teil der Länderunterteilung einer Adresse, z. B. WA. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict2	string		Der Landkreis für die strukturierte Adresse, z. B. King. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict3	string		Der benannte Bereich für die strukturierte Adresse. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
bbox	number[]		Ein rechteckiger Bereich auf der Erde, der als Begrenzungsrahmenobjekt definiert ist. Die Seiten des Rechtecks 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[]		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: [lon, lat]
countryRegion	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	string		Der Lokale Teil einer Adresse, z. B. Seattle. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
optionalId	string		ID der Anforderung, die im entsprechenden batchItem angezeigt wird
postalCode	string		Der Postleitzahlteil einer Adresse. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
query	string		Eine Zeichenfolge, die Informationen zu einem Speicherort enthält, z. B. einen Adress- oder Wahrzeichennamen.
top	integer	5	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 5, Minimum: 1 und Maximum: 20.
view	string	auto	Eine Zeichenfolge, die einen Iso 3166-1 Alpha-2-Regions-/Ländercode angibt. Dadurch werden die geopolitisch umstrittenen Grenzen und Bezeichnungen so geändert, dass sie der angegebenen Benutzerregion entsprechen.

GeocodingBatchResponse

Dieses Objekt wird von einem erfolgreichen Aufruf des Batch-Geocodierungsdiensts 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, das 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[]	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 kreuzende Straße.
secondaryStreet2	string	Falls vorhanden, die zweite sich kreuzende 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	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.
geocodePoints	GeocodePoints[]	Eine Sammlung von Geocodierungspunkten, die sich in ihrer Berechnung und ihrer vorgeschlagenen Verwendung unterscheiden.
matchCodes	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.
type	string	Enthält einen der folgenden Werte: Adresse Straßensperre RoadIntersection Viertel PopulatedPlace Postleitzahl1 AdminDivision1 AdminDivision2 CountryRegion

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 Geocodierungspunkt. Jeder Geocodierungspunkt 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 zum Park angeben, in den Sie mit einem Auto gelangen können, und ein Display Punkt kann ein Punkt sein, der den Mittelpunkt des Parks angibt.

Name	Typ	Beschreibung
Display	string
Route	string

Freigeben über

Search - Get Geocoding Batch

Senden einer synchronen Batchanforderung

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

Zusätzliche Ressourcen