Search - Post Search Address Batch

Referenz

Dienst:: Maps

API-Version:: 1.0

Dient zum Senden eines Batches von Abfragen an die Suchadresse-API in einer einzigen asynchronen Anforderung.
Die Post Search Address Batch-API ist eine HTTP-POST-Anforderung, die Batches von Abfragen an Suchadresse-API in einem einzigen synchronen API-Aufruf sendet. Sie können die Suchadressenbatch-API aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Mit der asynchronen API können Aufrufer bis zu 10.000 Abfragen und Synchronisierungs-API bis zu 100 Abfragen stapeln.

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/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Asynchrone Batchanforderung übermitteln

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Suchanforderungen.

Es ermöglicht das Abrufen von Ergebnissen in einem separaten Anruf (mehrere Downloads sind möglich).
Die asynchrone API ist für Zuverlässigkeit optimiert und wird nicht erwartet, dass ein Timeout eintritt.
Die Anzahl der Batchelemente ist auf 10.000 für diese API beschränkt.

Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden für 14 Tage gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

Beachten Sie, dass die asynchrone Batchanforderung ein lang ausgeführter Vorgang ist. Hier ist eine typische Abfolge von Vorgängen:

Der Client sendet einen Suchadressenbatch POST Anforderung an Azure Maps.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

Der Server antwortet mit einer der folgenden Aktionen:

HTTP-202 Accepted – Batchanforderung wurde akzeptiert.

HTTP-Error – Fehler beim Verarbeiten der Batchanforderung. Dies kann entweder ein 400 Bad Request oder ein anderer Error Statuscode sein.
Wenn die Batchanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Batchanforderung. Dieser Status-URI sieht wie folgt aus:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Der Client gibt eine GET Anforderung auf die Download-URL aus, in Schritt 3 abgerufen wurde, um die Batchergebnisse herunterzuladen.

POST-Text für Batchanforderung

Um die Suchadresse Abfragen zu senden, verwenden Sie eine POST Anforderung, in der der Anforderungstext das batchItems Array im json Format enthält, und der Content-Type Header wird auf application/jsonfestgelegt. Hier ist ein Beispielanforderungstext mit 5 Suchadresse Abfragen:

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Eine Suchadresse Abfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, API-Version und Abonnementschlüssel. Sie kann jede der unterstützten SuchadressenURI-Parameterakzeptieren. Die Zeichenfolgenwerte in der Suchadresse Abfrage müssen ordnungsgemäß escaped sein (z. B. " Zeichen sollte mit \ ) escapet werden und es sollte auch ordnungsgemäß URL-codiert sein.

Mit der asynchronen API können Aufrufer bis zu 10.000 Abfragen und Synchronisierungs-API bis zu 100 Abfragen stapeln, und der Batch sollte mindestens 1 Abfrage enthalten.

Asynchrone Batchergebnisse herunterladen

Um die asynchronen Batchergebnisse herunterzuladen, geben Sie eine GET Anforderung an den Batchdownloadendpunkt aus. Diese Download-URL kann aus dem Location Header einer erfolgreichen POST Batchanforderung abgerufen werden und sieht wie folgt aus:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Dies ist die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:

Client sendet eine GET Anforderung mithilfe der Download-URL.
Der Server antwortet mit einer der folgenden Aktionen:

HTTP-202 Accepted – Batchanforderung wurde akzeptiert, wird aber noch verarbeitet. Versuchen Sie es bitte in irgendeiner Zeit erneut.

HTTP-200 OK – Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.

Batchantwortmodell

Der zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine summary Komponente, die die totalRequests angibt, die Teil der ursprünglichen Batchanforderung waren, und successfulRequestsd. 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 in batchItems enthält statusCode- und response Felder. Jede response in batchItems weist einen der folgenden Typen auf:

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

Hier ist eine Beispielbatchantwort mit 2 erfolgreichen und 1 fehlgeschlagenen Ergebnis:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
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 Microsoft Entra ID-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. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	SearchAddressBatchProcessResult	OKAY
202 Accepted		Wird nur für asynchrone Anforderung unterstützt. Anforderung angenommen: Die Anforderung wurde zur Verarbeitung akzeptiert. Verwenden Sie die URL im Speicherortheader, um die Ergebnisse erneut zu versuchen oder darauf zuzugreifen. Header Location: string
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

SearchAddressBatchProcessResult

OKAY

202 Accepted

Wird nur für asynchrone Anforderung unterstützt. Anforderung angenommen: Die Anforderung wurde zur Verarbeitung akzeptiert. Verwenden Sie die URL im Speicherortheader, um die Ergebnisse erneut zu versuchen oder darauf zuzugreifen.

Header

Location: string

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 Kartenverwaltung API erworben 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

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

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Beispielanforderung

HTTP

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Statuscode:: 202

Operation-Location: URL to download the results of the long-running batch request.

Definitionen

Name	Beschreibung
Address	Die Adresse des Ergebnisses
AddressRanges	Beschreibt den Adressbereich auf beiden Seiten der Straße für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.
BatchRequest	Dieser Typ stellt den Anforderungstext für den Batchdienst dar.
BatchRequestItem	Batchanforderungsobjekt
BoundingBox	Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.
BoundingBoxCompassNotation	Das umgebende Feld der Position.
Brand	Die Marke, die dem POI zugeordnet ist
Classification	Die Klassifizierung für den zurückgegebenen POI
ClassificationName	Name für die Klassifizierung
DataSources	Optionaler Abschnitt. Referenz-IDs für die Verwendung mit der Get Search Polygon API.
Entity	Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.
EntryPoint	Der Einstiegspunkt für den poi, der zurückgegeben wird.
EntryPointType	Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GeographicEntityType	Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
Geometry	Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn Typ == Geografie.
JsonFormat	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
MatchType	Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.
OperatingHours	Öffnungszeiten für einen POI (Interessante Punkte).
OperatingHoursTime	Stellt ein Datum und eine Uhrzeit dar.
OperatingHoursTimeRange	Öffnungszeitbereich für einen Tag
PointOfInterest	Details zu den zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.
PointOfInterestCategorySet	POI-Kategorie
QueryType	Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
Response	Das Ergebnis der Abfrage. SearchAddressResult, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
SearchAddressBatchItem	Ein Element, das vom Suchadressenbatchdienstaufruf zurückgegeben wird.
SearchAddressBatchProcessResult	Dieses Objekt wird von einem erfolgreichen Suchadressenbatchdienstaufruf zurückgegeben.
SearchAddressResultItem	Result-Objekt für eine Such-API-Antwort.
SearchAddressResultType	Enthält einen der folgenden Werte: POI Straße Geografie Punktadresse Adressbereich Querstraße
SearchSummary	Summary-Objekt für eine Such-API-Antwort.
Summary	Zusammenfassung der Ergebnisse für die Batchanforderung

Address

Objekt

Die Adresse des Ergebnisses

Name	Typ	Beschreibung
boundingBox	BoundingBoxCompassNotation	Das umgebende Feld der Position.
buildingNumber	string	Die Gebäudenummer auf der Straße. Verwenden Sie stattdessen "streetNumber" ALS VERALTET.
country	string	Name des Landes/der Region
countryCode	string	Land (Hinweis: Dies ist ein aus zwei Buchstaben bestehender Code, kein Name eines Landes/einer Region.)
countryCodeISO3	string	ISO-Alpha-3-Ländercode
countrySecondarySubdivision	string	Bezirk
countrySubdivision	string	Bundesland oder Provinz
countrySubdivisionCode	string	`countrySubdivisionCode` präfixiert von `countryCode` ( countryCode-countrySubdivisionCode ) und der Bindestrich bildet den ISO 3166-2-Code. Beispiele: TX für Texas, SCT für Schottland und ON für Ontario.
countrySubdivisionName	string	Der vollständige Name einer verwaltungstechnischen Hierarchie der ersten Ebene des Landes/der Region. Dieses Feld wird nur angezeigt, wenn countrySubdivision in einem abgekürzten Formular dargestellt wird. Wird nur für USA, Kanada und Großbritannien unterstützt.
countryTertiarySubdivision	string	Benannter Bereich
crossStreet	string	Der Name der Straße, die durchquert wird.
extendedPostalCode	string	Erweiterte Postleitzahl (Verfügbarkeit hängt von der Region ab).
freeformAddress	string	Eine Adresszeile, die gemäß den Formatierungsregeln des Ursprungslandes/der Herkunftsregion eines Ergebnisses oder im Fall eines Landes/einer Region den vollständigen Namen des Landes/der Region formatiert ist.
localName	string	Eine Adresskomponente, die den Namen eines geografischen Gebiets oder gebietsschemas darstellt, das mehrere adressierbare Objekte zu Adresszwecken gruppiert, ohne eine administrative Einheit zu sein. Dieses Feld wird verwendet, um die `freeformAddress`-Eigenschaft zu erstellen. `localName` stellt die Postgemeinde dar. Je nach Standort ist `localName` der allgemein bekannte Name einer Stadt oder Stadt. Verwenden Sie für den allgemein bekannten Namen einer Stadt oder Stadt `localName` anstelle von `municipality`.
municipality	string	Stadt / Stadt Hinweis: `municipality` stellt die Wohngemeinde dar. Je nach Standort kann sich der `municipality` Wert vom allgemein bekannten Namen einer Stadt oder Stadt unterscheiden. Für den allgemein bekannten Namen der Stadt oder Stadt wird empfohlen, den `localName` Wert anstelle des `municipality` Werts zu verwenden.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Ein Viertel ist ein geografisch lokalisiertes Gebiet innerhalb einer Stadt oder Stadt mit unverwechselbaren Merkmalen und sozialen Interaktionen zwischen Einwohnern.
postalCode	string	Postleitzahl / Postleitzahl
routeNumbers	string[]	Die Codes, die verwendet werden, um die Straße eindeutig zu identifizieren
street	string	Der Straßenname. Verwenden Sie stattdessen "streetName" ALS VERALTET.
streetName	string	Der Straßenname.
streetNameAndNumber	string	Der Straßenname und die Nummer.
streetNumber	string	Die Gebäudenummer auf der Straße.

AddressRanges

Objekt

Beschreibt den Adressbereich auf beiden Seiten der Straße für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.

Name	Typ	Beschreibung
from	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
rangeLeft	string	Adressbereich auf der linken Seite der Straße.
rangeRight	string	Adressbereich auf der rechten Seite der Straße.
to	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.

BatchRequest

Objekt

Dieser Typ stellt den Anforderungstext für den Batchdienst dar.

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

BatchRequestItem

Objekt

Batchanforderungsobjekt

Name	Typ	Beschreibung
query	string	Dieser Parameter enthält eine Abfragezeichenfolge, die zum Ausführen eines unstrukturierten Geocodierungsvorgangs verwendet wird. Die Abfragezeichenfolge wird zur Verarbeitung an die Such-API übergeben.

BoundingBox

Objekt

Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.

Name	Typ	Beschreibung
btmRightPoint	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
topLeftPoint	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.

BoundingBoxCompassNotation

Objekt

Das umgebende Feld der Position.

Name	Typ	Beschreibung
entity	Entity	Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.
northEast	string	North-east latitude,longitude coordinate of the bounding box as comma-separated floats
southWest	string	Süd-West-Breitengrad,Längengradkoordinate des Begrenzungsfelds als kommagetrennte Floats

Brand

Objekt

Die Marke, die dem POI zugeordnet ist

Name	Typ	Beschreibung
name	string	Name der Marke

Classification

Objekt

Die Klassifizierung für den zurückgegebenen POI

Name	Typ	Beschreibung
code	string	Code-Eigenschaft
names	ClassificationName[]	Namensarray

ClassificationName

Objekt

Name für die Klassifizierung

Name	Typ	Beschreibung
name	string	Name-Eigenschaft
nameLocale	string	Name Locale-Eigenschaft

DataSources

Objekt

Optionaler Abschnitt. Referenz-IDs für die Verwendung mit der Get Search Polygon API.

Name	Typ	Beschreibung
geometry	Geometry	Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn Typ == Geografie.

Entity

Enumeration

Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.

Wert	Beschreibung
position	Positionsentität

EntryPoint

Objekt

Der Einstiegspunkt für den poi, der zurückgegeben wird.

Name	Typ	Beschreibung
position	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
type	EntryPointType	Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.

EntryPointType

Enumeration

Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.

Wert	Beschreibung
main
minor

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.

GeographicEntityType

Enumeration

Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.

Wert	Beschreibung
Country	Name des Landes/der Region
CountrySecondarySubdivision	Bezirk
CountrySubdivision	Bundesland oder Provinz
CountryTertiarySubdivision	Benannter Bereich
Municipality	Stadt / Stadt
MunicipalitySubdivision	Sub / Super City
Neighbourhood	Nachbarschaft
PostalCodeArea	Postleitzahl / Postleitzahl

Geometry

Objekt

Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn Typ == Geografie.

Name	Typ	Beschreibung
id	string	Übergeben Sie dies als geometryId an die Get Search Polygon API, um Geometrieinformationen für dieses Ergebnis abzurufen.

JsonFormat

Enumeration

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format

LatLongPairAbbreviated

Objekt

Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.

Name	Typ	Beschreibung
lat	number (double)	Latitude-Eigenschaft
lon	number (double)	Longitude-Eigenschaft

MatchType

Enumeration

Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.

Wert	Beschreibung
AddressPoint
HouseNumberRange
Street

OperatingHours

Objekt

Öffnungszeiten für einen POI (Interessante Punkte).

Name	Typ	Beschreibung
mode	string	In der Anforderung verwendeter Wert: none oder "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Liste der Zeitbereiche für die nächsten 7 Tage

OperatingHoursTime

Objekt

Stellt ein Datum und eine Uhrzeit dar.

Name	Typ	Beschreibung
date	string	Stellt das aktuelle Kalenderdatum in der POI-Zeitzone dar, z. B. "2019-02-07".
hour	integer	Stunden sind im 24-Stunden-Format in der Ortszeit eines POI enthalten; Mögliche Werte sind 0 - 23.
minute	integer	Minuten liegen in der Ortszeit eines POI; Mögliche Werte sind 0 - 59.

OperatingHoursTimeRange

Objekt

Öffnungszeitbereich für einen Tag

Name	Typ	Beschreibung
endTime	OperatingHoursTime	Der Punkt im nächsten 7-Tage-Bereich, an dem ein bestimmter POI geschlossen wird, oder der Anfang des Bereichs, wenn er vor dem Bereich geschlossen wurde.
startTime	OperatingHoursTime	Der Punkt im nächsten 7-Tage-Bereich, an dem ein bestimmter POI geöffnet wird, oder den Anfang des Bereichs, wenn er vor dem Bereich geöffnet wurde.

PointOfInterest

Objekt

Details zu den zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.

Name	Typ	Beschreibung
brands	Brand[]	Markenarray. Der Name der Marke für den POI, der zurückgegeben wird.
categories	string[]	Kategorienarray
categorySet	PointOfInterestCategorySet[]	Die Liste der spezifischsten POI-Kategorien
classifications	Classification[]	Klassifizierungsarray
name	string	Name der POI-Eigenschaft
openingHours	OperatingHours	Öffnungszeiten für einen POI (Interessante Punkte).
phone	string	Telefonnummerneigenschaft
url	string	Website-URL-Eigenschaft

PointOfInterestCategorySet

Objekt

POI-Kategorie

Name	Typ	Beschreibung
id	integer	Kategorie-ID

QueryType

Enumeration

Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.

Wert	Beschreibung
NEARBY	Die Suche wurde um einen bestimmten Breiten- und Längengrad mit einem definierten Radius durchgeführt.
NON_NEAR	Die Suche wurde global durchgeführt, ohne einen bestimmten Breiten- und Längengrad und keinen definierten Radius voreingenommen zu haben.

Response

Objekt

Das Ergebnis der Abfrage. SearchAddressResult, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.
results	SearchAddressResultItem[]	Eine Liste der Suchergebnisse der Such-API.
summary	SearchSummary	Zusammenfassungsobjekt für eine Such-API-Antwort

SearchAddressBatchItem

Objekt

Ein Element, das vom Suchadressenbatchdienstaufruf zurückgegeben wird.

Name	Typ	Beschreibung
response	Response	Das Ergebnis der Abfrage. SearchAddressResult, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
statusCode	integer	HTTP-Anforderungsstatuscode.

SearchAddressBatchProcessResult

Objekt

Dieses Objekt wird von einem erfolgreichen Suchadressenbatchdienstaufruf zurückgegeben.

Name	Typ	Beschreibung
batchItems	SearchAddressBatchItem[]	Array, das die Batchergebnisse enthält.
summary	Summary	Zusammenfassung der Ergebnisse für die Batchanforderung

SearchAddressResultItem

Objekt

Result-Objekt für eine Such-API-Antwort.

Name	Typ	Beschreibung
address	Address	Die Adresse des Ergebnisses
addressRanges	AddressRanges	Beschreibt den Adressbereich auf beiden Seiten der Straße für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.
dataSources	DataSources	Optionaler Abschnitt. Referenzgeometrie-ID für die Verwendung mit der Get Search Polygon API.
detourTime	integer	Umleitungszeit in Sekunden. Wird nur für Aufrufe der Suchrouten-API zurückgegeben.
dist	number (double)	Gerader Zeilenabstand zwischen dem Ergebnis und der Geobia-Position in Metern.
entityType	GeographicEntityType	Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
entryPoints	EntryPoint[]	Array von EntryPoints. Diese beschreiben die Arten von Eingängen, die an der Lage zur Verfügung stehen. Der Typ kann "Haupt" für Haupteingänge wie eine Eingangstür oder eine Lobby und "Minor" für Seiten- und Hintertüren sein.
id	string	ID-Eigenschaft
info	string	Informationen zur ursprünglichen Datenquelle des Ergebnisses. Wird für Supportanfragen verwendet.
matchType	MatchType	Informationen zum Übereinstimmungstyp. Enthält einen der folgenden Werte: AddressPoint HouseNumberRange Straße
poi	PointOfInterest	Details zu den zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.
position	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
score	number (double)	Der Wert innerhalb eines Resultsets, der die relative Übereinstimmungsbewertung zwischen den Ergebnissen angibt. Sie können dies verwenden, um zu bestimmen, dass das Ergebnis x doppelt so relevant ist wie ergebnis y, wenn der Wert von x 2x der Wert von y ist. Die Werte variieren zwischen Abfragen und sind nur als relativer Wert für ein Resultset gedacht.
type	SearchAddressResultType	Enthält einen der folgenden Werte: POI Straße Geografie Punktadresse Adressbereich Querstraße
viewport	BoundingBox	Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.

SearchAddressResultType

Enumeration

Enthält einen der folgenden Werte:

POI
Straße
Geografie
Punktadresse
Adressbereich
Querstraße

Wert	Beschreibung
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchSummary

Objekt

Summary-Objekt für eine Such-API-Antwort.

Name	Typ	Beschreibung
fuzzyLevel	integer	Die maximale Fuzzy-Ebene, die zum Bereitstellen von Ergebnissen erforderlich ist.
geoBias	LatLongPairAbbreviated	Angabe, wenn die interne Suchmaschine einen geospatialen Bias angewendet hat, um die Rangfolge der Ergebnisse zu verbessern. In einigen Methoden kann dies durch Festlegen der Lat- und lon-Parameter beeinflusst werden, sofern verfügbar. In anderen Fällen ist sie rein intern.
limit	integer	Maximale Anzahl von Antworten, die zurückgegeben werden
numResults	integer	Die Anzahl der Ergebnisse in der Antwort.
offset	integer	Der Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets.
query	string	Der Abfrageparameter, der zum Erstellen dieser Suchergebnisse verwendet wurde.
queryTime	integer	Der Zeitaufwand für die Auflösung der Abfrage in Millisekunden.
queryType	QueryType	Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
totalResults	integer	Die Gesamtanzahl der gefundenen Ergebnisse.

Summary

Objekt

Zusammenfassung der Ergebnisse für die Batchanforderung

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

Freigeben über

Search - Post Search Address Batch

Synchrone Batchanforderung übermitteln

Asynchrone Batchanforderung übermitteln

POST-Text für Batchanforderung

Asynchrone Batchergebnisse herunterladen

Batchantwortmodell

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AADToken

Bereiche

subscription-key

SAS Token

Beispiele

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Zusätzliche Ressourcen