Search - Post Search Address Batch

Service:

Maps

API Version:

1.0

Verwenden Sie , um einen Batch von Abfragen an die Search-Adress-API in einer einzigen asynchronen Anforderung zu senden.
Die Post Search Address Batch API ist eine HTTP-AnforderungPOST, die Batches von Abfragen an Search Adress-API in einem einzelnen synchronen API-Aufruf sendet. Sie können Search Adressbatch-API aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht aufrufer das Batchen von bis zu 10.000 Abfragen und die Synchronisierungs-API bis zu 100 Abfragen.

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

Übermitteln einer asynchronen Batchanforderung

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 die Zuverlässigkeit optimiert und es wird nicht erwartet, dass ein Timeout auftritt.
• Die Anzahl der Batchelemente ist für diese API auf 10.000 beschränkt.

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

Beachten Sie, dass es sich bei der asynchronen Batchanforderung um einen zeitintensiven Vorgang handelt. Dies ist eine typische Abfolge von Vorgängen:

1. Der Client sendet eine Search Address Batch-Anforderung POST an Azure Maps.

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

2. Der Server antwortet mit einer der folgenden Aktionen:

   HTTP 202 Accepted : Batchanforderung wurde akzeptiert.

   HTTP Error : Fehler bei der Verarbeitung Ihrer Batch-Anforderung. Dies kann entweder ein oder ein 400 Bad Request anderer Error status Code sein.

3. 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}

4. Der Client stellt eine GET Anforderung an die In Schritt 3 abgerufene Download-URL , um die Batchergebnisse herunterzuladen.

POST-Text für Batchanforderung

Zum Senden der Suchadressenabfragen 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 ein Beispiel für den Anforderungstext, der fünf Suchadressenabfragen enthält:

{
    "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 Suchadressenabfrage in einem Batch ist nur eine Teil-URL ohne Protokoll, Basis-URL, Pfad, API-Version und Abonnementschlüssel. Er kann jeden der unterstützten Suchadress-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Suchadressenabfrage müssen ordnungsgemäß mit Escapezeichen versehen sein (z. B. " zeichen sollte mit \ ) versehen werden, und es sollte auch ordnungsgemäß URL-codiert sein.

Die asynchrone API ermöglicht aufrufer das Batchen von bis zu 10.000 Abfragen und die Synchronisierungs-API bis zu 100 Abfragen, und der Batch sollte mindestens eine Abfrage enthalten.

Herunterladen von asynchronen Batchergebnissen

Um die asynchronen Batchergebnisse herunterzuladen, senden Sie eine GET Anforderung an den Batchdownloadendpunkt. 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:

1. Der Client sendet eine GET Anforderung mithilfe der Download-URL.

2. Der Server antwortet mit einer der folgenden Aktionen:

   HTTP 202 Accepted : Batchanforderung wurde akzeptiert, wird aber noch verarbeitet. Bitte versuchen Sie es in einiger 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 die Verarbeitung des Batches abgeschlossen ist, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , die Teil der ursprünglichen Batchanforderung waren, und successfulRequestsabfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede einzelne Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode Felder und response . Jedes response in batchItems hat einen der folgenden Typen:

• SearchAddressResult – Wenn die Abfrage erfolgreich abgeschlossen wurde.

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

Hier sehen Sie ein Beispiel für eine Batchantwort mit 2 erfolgreichen und 1 fehlgeschlagenen Ergebnissen:

{
    "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	Das gewünschte Format der Antwort. Nur das 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 verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Wird nur für asynchrone Anforderungen unterstützt. Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Location Header, um einen Wiederholungsversuch zu versuchen oder auf die Ergebnisse zuzugreifen. Headers Location: string
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 in 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 Ressourcenkonto 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-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
• Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
• Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
• Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Beispiele

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

Sample Request

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"
    }
  ]
}

Sample Response

Status code:

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

Status code:

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 Straßenseiten für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.
BatchRequest	Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar.
BatchRequestItem	Batch-Anforderungsobjekt
BoundingBox	Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.
BoundingBoxCompassNotation	Das begrenzungsfeld 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 Begrenzungsrahmens. Bei umgekehrter Geocodierung ist dies immer gleich der Position.
EntryPoint	Der Einstiegspunkt für den zurückgegebenen POI.
EntryPointType	Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder Nebenwert sein.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GeographicEntityType	Geography-Entitätstyp. Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
Geometry	Informationen über die geometrische Form des Ergebnisses. Nur vorhanden, wenn typ == Geography.
JsonFormat	Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.
LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
MatchType	Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.
OperatingHours	Öffnungszeiten für einen POI (Points of Interest).
OperatingHoursTime	Stellt ein Datum und eine Uhrzeit dar.
OperatingHoursTimeRange	Geöffneter Zeitbereich für einen Tag
PointOfInterest	Details des 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 von Search Address Batch-Dienstaufruf zurückgegeben wird.
SearchAddressBatchProcessResult	Dieses Objekt wird von einem erfolgreichen Search Address Batch-Dienstaufruf zurückgegeben.
SearchAddressResultItem	Ergebnisobjekt für eine Search API-Antwort.
SearchAddressResultType	Enthält einen der folgenden Werte: POI Straße Gebiet Punktadresse Adressbereich Querstraße
SearchSummary	Zusammenfassungsobjekt für eine Search-API-Antwort.
Summary	Zusammenfassung der Ergebnisse für die Batchanforderung

Address

Die Adresse des Ergebnisses

Name	Typ	Beschreibung
boundingBox	BoundingBoxCompassNotation	Das begrenzungsfeld der Position.
buildingNumber	string	Die Gebäudenummer auf der Straße. VERALTET, verwenden Sie stattdessen streetNumber.
country	string	Name des Landes/der Region
countryCode	string	Land (Hinweis: Dies ist ein code aus zwei Buchstaben, kein Name des Landes/der Region.)
countryCodeISO3	string	ISO-Alpha-3-Ländercode
countrySecondarySubdivision	string	County
countrySubdivision	string	Bundesland oder Kanton
countrySubdivisionCode	string	countrySubdivisionCode präfixiert durch 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 ersten Ebene der Verwaltungshierarchie für Land/Region. Dieses Feld wird nur angezeigt, wenn countrySubdivision in einer gekürzten Form dargestellt wird. Wird nur für die USA, Kanada und Das Vereinigte Königreich unterstützt.
countryTertiarySubdivision	string	Benannter Bereich
crossStreet	string	Der Name der Straße, die gekreuzt wird.
extendedPostalCode	string	Erweiterte Postleitzahl (Verfügbarkeit hängt von der Region ab).
freeformAddress	string	Eine Adresszeile, die gemäß den Formatierungsregeln des Ursprungslandes/der Region 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 Bereichs oder Orts darstellt, der mehrere adressierbare Objekte zu Adressierungszwecken gruppiert, ohne eine Verwaltungseinheit zu sein. Dieses Feld wird verwendet, um die freeformAddress -Eigenschaft zu erstellen. localName stellt die Postgemeinde dar. Je nach Standort localName ist der allgemein bekannte Name einer Stadt oder Stadt. Verwenden Sie localName für den allgemein bekannten Namen einer Stadt oder Stadt anstelle von municipality.
municipality	string	Ort/ Ort 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 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 charakteristischen Merkmalen und sozialen Interaktionen zwischen den Bewohnern.
postalCode	string	Postleitzahl / Postleitzahl
routeNumbers	string[]	Die Codes, die verwendet werden, um die Straße eindeutig zu identifizieren
street	string	Der Straßenname. VERALTET, verwenden Sie stattdessen streetName.
streetName	string	Der Straßenname.
streetNameAndNumber	string	Der Straßenname und die Nummer.
streetNumber	string	Die Gebäudenummer auf der Straße.

AddressRanges

Beschreibt den Adressbereich auf beiden Straßenseiten 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 dem Kurznamen "lat" & "lon" dargestellt wird.
rangeLeft	string	Adressbereich auf der linken Straßenseite.
rangeRight	string	Adressbereich auf der rechten Straßenseite.
to	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

BatchRequest

Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar.

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

BatchRequestItem

Batch-Anforderungsobjekt

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 wortwörtlich an die Such-API übergeben.

BoundingBox

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 dem Kurznamen "lat" & "lon" dargestellt wird.
topLeftPoint	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

BoundingBoxCompassNotation

Das begrenzungsfeld der Position.

Name	Typ	Beschreibung
entity	Entity	Entitätstypquelle des Begrenzungsrahmens. Bei umgekehrter Geocodierung ist dies immer gleich der Position.
northEast	string	Nord-Ost-Breitengrad, Längengradkoordinate des Begrenzungsrahmens als durch Trennzeichen getrennte Gleitkomma
southWest	string	Südwestlicher Breitengrad, Längengradkoordinate des Begrenzungsrahmens als durch Trennzeichen getrennte Gleitkomma

Brand

Die Marke, die dem POI zugeordnet ist

Name	Typ	Beschreibung
name	string	Name der Marke

Classification

Die Klassifizierung für den zurückgegebenen POI

Name	Typ	Beschreibung
code	string	Eigenschaft „code“
names	ClassificationName[]	Namensarray

ClassificationName

Name für die Klassifizierung

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

DataSources

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

Name	Typ	Beschreibung
geometry	Geometry	Informationen über die geometrische Form des Ergebnisses. Nur vorhanden, wenn typ == Geography.

Entity

Entitätstypquelle des Begrenzungsrahmens. Bei umgekehrter Geocodierung ist dies immer gleich der Position.

Name	Typ	Beschreibung
position	string	Position der Entität

EntryPoint

Der Einstiegspunkt für den zurückgegebenen POI.

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

EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder Nebenwert sein.

Name	Typ	Beschreibung
main	string
minor	string

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.

GeographicEntityType

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

Name	Typ	Beschreibung
Country	string	Land-/Regionsname
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Bundesland oder Kanton
CountryTertiarySubdivision	string	Benannter Bereich
Municipality	string	Ort/ Ort
MunicipalitySubdivision	string	Sub/ Super City
Neighbourhood	string	Nachbarschaft
PostalCodeArea	string	Postleitzahl / Postleitzahl

Geometry

Informationen über die geometrische Form des Ergebnisses. Nur vorhanden, wenn typ == Geography.

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

JsonFormat

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

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

LatLongPairAbbreviated

Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.

Name	Typ	Beschreibung
lat	number	Latitude-Eigenschaft
lon	number	Längengradeigenschaft

MatchType

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

Name	Typ	Beschreibung
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Öffnungszeiten für einen POI (Points of Interest).

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

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; mögliche Werte sind 0 bis 23.
minute	integer	Die Minuten liegen in der Ortszeit eines POI; mögliche Werte sind 0 bis 59.

OperatingHoursTimeRange

Geöffneter Zeitbereich für einen Tag

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

PointOfInterest

Details des 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 zurückgegebenen POI.
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 (Points of Interest).
phone	string	Telefonnummern-Eigenschaft
url	string	Website-URL-Eigenschaft

PointOfInterestCategorySet

POI-Kategorie

Name	Typ	Beschreibung
id	integer	Kategorie-ID

QueryType

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

Name	Typ	Beschreibung
NEARBY	string	Search wurde um einen bestimmten Breiten- und Längengrad mit einem definierten Radius durchgeführt.
NON_NEAR	string	Search wurde global durchgeführt, ohne eine Verzerrung auf einen bestimmten Breiten- und Längengrad und keinen definierten Radius zu haben.

Response

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

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

SearchAddressBatchItem

Ein Element, das von Search Address Batch-Dienstaufruf zurückgegeben wird.

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

SearchAddressBatchProcessResult

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

Name	Typ	Beschreibung
batchItems	SearchAddressBatchItem[]	Array mit den Batchergebnissen.
summary	Summary	Zusammenfassung der Ergebnisse für die Batchanforderung

SearchAddressResultItem

Ergebnisobjekt für eine Search 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 Start- und Endpositionen des Adressbereichs sind enthalten.
dataSources	DataSources	Optionaler Abschnitt Referenzgeometrie-ID zur Verwendung mit der Get Search Polygon-API.
detourTime	integer	Umleitungszeit in Sekunden. Wird nur für Aufrufe der Search-API für entlang der Route zurückgegeben.
dist	number	Gerader Abstand zwischen dem Ergebnis und der Geobias-Position in Metern.
entityType	GeographicEntityType	Geography-Entitätstyp. Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
entryPoints	EntryPoint[]	Array von EntryPoints. Diese beschreiben die Arten von Eingängen, die am Standort verfügbar sind. Der Typ kann "Standard" für Standard Eingä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 Typ der Übereinstimmung. Enthält einen der folgenden Werte: AddressPoint HouseNumberRange Straße
poi	PointOfInterest	Details des zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.
position	LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
score	number	Der Wert innerhalb eines Resultsets, um die relative Übereinstimmungsbewertung zwischen den Ergebnissen anzugeben. Mit dieser Option können Sie bestimmen, dass ergebnis x doppelt so wahrscheinlich ist, dass es so relevant ist wie das 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 gemeint.
type	SearchAddressResultType	Enthält einen der folgenden Werte: POI Straße Gebiet 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

Enthält einen der folgenden Werte:

• POI
• Straße
• Gebiet
• Punktadresse
• Adressbereich
• Querstraße

Name	Typ	Beschreibung
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort.

Name	Typ	Beschreibung
fuzzyLevel	integer	Die maximale Fuzzy-Ebene, die für die Bereitstellung von Ergebnissen erforderlich ist.
geoBias	LatLongPairAbbreviated	Hinweis, wenn die interne Suchmaschine eine geografische Verzerrung angewendet hat, um das Ranking 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 es rein intern.
limit	integer	Maximale Anzahl von Antworten, die zurückgegeben werden
numResults	integer	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	Zeitaufwand für das Auflösen der Abfrage in Millisekunden.
queryType	QueryType	Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
totalResults	integer	Die Gesamtzahl der gefundenen Ergebnisse.

Summary

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