Search - Post Search Fuzzy Batch

Such-Fuzzy-Batch-API

Gilt für: Siehe Preisstufen.

Die Suchadressenbatch-API sendet Batches von Abfragen an die Such-Fuzzy-API mithilfe eines einzigen API-Aufrufs. Sie können die Suchadresse fuzzy Batch-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 batchieren.

Synchrone Batchanforderung übermitteln

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet es, sobald die Batchelemente berechnet werden und es keine Möglichkeit gibt, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine Antwort 408) 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/fuzzy/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 den Abruf 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 ausgeführt wird.
  • 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 von 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 Antwort von 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

Bitte beachten Sie, dass asynchrone Batchanforderung eine lang ausgeführte Anforderung ist. Nachfolgend finden Sie eine typische Sequenz von Vorgängen:

  1. Client sendet eine Suchadressenbatchanforderung POST an Azure Maps

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted - Batchanforderung wurde akzeptiert.

    HTTP Error - Es gab einen Fehler bei der Verarbeitung Ihrer Batchanforderung. Dies kann entweder ein oder ein 400 Bad Request anderer Error Statuscode sein.

  3. Wenn die Batchanforderung erfolgreich akzeptiert wurde, enthält die Location Kopfzeile in der Antwort die URL, um die Ergebnisse der Batchanforderung herunterzuladen. Dieser Status-URI sieht wie folgt aus:

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Client stellt eine GET Anforderung an die download-URL aus, die in Schritt 3 abgerufen wurde, um die Batchergebnisse herunterzuladen.

POST-Text für Batchanforderung

Um die Suchfuzzyabfragen zu senden, verwenden Sie eine POST Anforderung, in der der Anforderungstext das batchItems Array im json Format enthält, und die Content-Type Kopfzeile wird auf application/jsonfestgelegt. Nachfolgend finden Sie einen Beispielanforderungstext mit 5 Such-Fuzzyabfragen :

{
    "batchItems": [
        {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
        {"query": "?query=Statue Of Liberty&limit=2"},
        {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
        {"query": "?query=Space Needle"},
        {"query": "?query=pizza&limit=10"}
    ]
}

Eine Such-Fuzzy-Abfrage in einem Batch ist nur eine Teil-URL ohne Protokoll, Basis-URL, Pfad, API-Version und Abonnementschlüssel. Sie kann alle unterstützten Such-Fuzzy-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Such-Fuzzy-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 batchieren, und der Batch sollte mindestens 1 Abfrage enthalten.

Herunterladen asynchroner Batchergebnisse

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

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

Hier sehen Sie die typische Reihenfolge der Vorgänge zum Herunterladen der Batchergebnisse:

  1. 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 jedoch weiterhin verarbeitet. Versuchen Sie es in einigen Zeit erneut.

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

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt asynchronen und Synchronisierungsanforderungen. Wenn sie die Ergebnisse einer asynchronen Batchanforderung herunterladen, wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext die Batchantwort. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass sie Teil der ursprünglichen Batchanforderung waren und successfulRequestsd. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein Array, das eine batchItems Antwort für jede und jede Abfrage in der Batchanforderung enthält. Die batchItems Ergebnisse enthalten die Ergebnisse in der genauen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält und response feldern.statusCode Jedes response In besteht aus batchItems einem der folgenden Typen:

  • SearchAddressResponse - Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error - Wenn die Abfrage fehlgeschlagen ist. Die Antwort enthält eine und eine codemessage in diesem Fall.

Nachfolgend finden Sie eine Beispiel-Batchantwort mit 2 erfolgreichen und 1 fehlgeschlagenen Ergebnissen:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "atm"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "ATM at Wells Fargo"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "statue of liberty"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "Statue of Liberty"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "New York, NY 10004"
                        }
                    }
                ]
            }
        },
        {
            "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/fuzzy/batch/json?api-version=1.0

URI-Parameter

Name In Required Type Description
format
path True

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

api-version
query True
  • string

Versionsnummer der Azure Maps API.

Anforderungsheader

Name Required Type Description
x-ms-client-id
  • string

Gibt an, welches Konto in Verbindung mit dem Azure AD-Sicherheitsmodell für die Verwendung vorgesehen ist. Es 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 Azure AD-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln zur Anleitung.

Anforderungstext

Name Type Description
batchItems

Die Liste der zu verarbeitenden Abfragen.

Antworten

Name Type Description
200 OK

OK

202 Accepted

Nur für asynchrone Anforderung unterstützt. Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Speicherortheader, um die Ergebnisse erneut zu wiederholen oder auf die Ergebnisse zuzugreifen.

Headers

  • Location: string
Other Status Codes

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flusse . Wenn sie mit azure-rollenbasierter Zugriffssteuerung gekoppelt sind, kann er verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerelemente werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jeder Benutzer-, Gruppen- oder 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.

Um Szenarien zu implementieren, empfehlen wir das Anzeigen von Authentifizierungskonzepten. In der Zusammenfassung stellt diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte bereit, die Zugriffssteuerungen für bestimmte APIs und Bereiche ermöglichen.

Notizen

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, welche Azure Maps Ressource die Anwendung anfordert. Dies kann über die Kartenverwaltungs-API erworben werden.

Dies Authorization URL ist speziell für die Azure-öffentliche Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die azure-rollenbasierte Zugriffssteuerung wird über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs aus der Azure-Verwaltungsebene konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

  • Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Gäste, aber keine persönlichen Konten.

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

Scopes

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

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

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den vertraulichen Clientanwendungen-Ansatz zum 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 freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung berechtigt, auf azure rollenbasierte Zugriffssteuerelemente und Feinkornsteuerelemente auf den Ablauf, die Rate und die Region(n) der Verwendung für das bestimmte Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen den Zugriff auf eine sicherere Weise als den freigegebenen Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge in der Kartenkontoressource zu konfigurieren, um das Rendern von Missbrauch zu beschränken und das SAS-Token regelmäßig zu verlängern.

Type: apiKey
In: header

Beispiele

A Search Fuzzy Batch API call containing 5 Search Fuzzy API queries

Sample Request

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

{
  "batchItems": [
    {
      "query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"
    },
    {
      "query": "?query=Statue Of Liberty&limit=2"
    },
    {
      "query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"
    }
  ]
}

Sample Response

{
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "atm",
          "queryType": "NON_NEAR",
          "queryTime": 5,
          "numResults": 5,
          "offset": 0,
          "totalResults": 262,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/3656546",
            "score": 2.671,
            "dist": 1336.1815386162032,
            "info": "search:ta:840539002005905-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "14808",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63229,
              "lon": -122.14232
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63319,
                "lon": -122.14365
              },
              "btmRightPoint": {
                "lat": 47.63139,
                "lon": -122.14099
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63154,
                  "lon": -122.1423
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/8673325",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840539002022072-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "Northeast 24Th Street",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736315",
            "score": 2.671,
            "dist": 864.7591776519859,
            "info": "search:ta:840539002187855-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15521",
              "streetName": "Bel Red Rd",
              "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
              "municipality": "Redmond, Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525501",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63259,
              "lon": -122.1328
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63349,
                "lon": -122.13413
              },
              "btmRightPoint": {
                "lat": 47.63169,
                "lon": -122.13147
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63255,
                  "lon": -122.13275
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/3656412",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001998867-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736876",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001396789-US",
            "poi": {
              "name": "US Bank ATM",
              "phone": "+(1)-(800)-8722657",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "url": "www.usbank.com",
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "statue of liberty",
          "queryType": "NON_NEAR",
          "queryTime": 37,
          "numResults": 2,
          "offset": 0,
          "totalResults": 18,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/9189660",
            "score": 6.942,
            "info": "search:ta:840369001174316-US",
            "poi": {
              "name": "Statue of Liberty",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "monument"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "municipalitySubdivision": "New York",
              "municipality": "New York",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivision": "NY",
              "postalCode": "10004",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "New York, NY 10004",
              "localName": "New York",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.68955,
              "lon": -74.04483
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.69045,
                "lon": -74.04602
              },
              "btmRightPoint": {
                "lat": 40.68865,
                "lon": -74.04364
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.69001,
                  "lon": -74.04683
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/3264566",
            "score": 6.942,
            "info": "search:ta:840019000670588-US",
            "poi": {
              "name": "Statue of Liberty",
              "phone": "+(1)-(205)-9700251",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "url": "www.1bsa.org",
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "516",
              "streetName": "Liberty Pkwy",
              "municipalitySubdivision": "Vestavia Hills",
              "municipality": "Vestavia Hills, Birmingham",
              "countrySecondarySubdivision": "Jefferson",
              "countryTertiarySubdivision": "Leeds",
              "countrySubdivision": "AL",
              "postalCode": "35242",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
              "localName": "Vestavia Hills",
              "countrySubdivisionName": "Alabama"
            },
            "position": {
              "lat": 33.48234,
              "lon": -86.70719
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 33.48324,
                "lon": -86.70827
              },
              "btmRightPoint": {
                "lat": 33.48144,
                "lon": -86.70611
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 33.48129,
                  "lon": -86.7065
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "starbucks",
          "queryType": "NON_NEAR",
          "queryTime": 35,
          "numResults": 10,
          "offset": 0,
          "totalResults": 17,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/153678",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840531000006554-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8695816",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152316",
            "score": 2.67,
            "dist": 2315.294397491255,
            "info": "search:ta:840539000484552-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-6436471",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15097",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15600",
              "streetName": "NE 8th St",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98008",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61896,
              "lon": -122.12945
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61986,
                "lon": -122.13078
              },
              "btmRightPoint": {
                "lat": 47.61806,
                "lon": -122.12812
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.619,
                  "lon": -122.12945
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167545",
            "score": 2.67,
            "dist": 1979.2222952267998,
            "info": "search:ta:840539001950429-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-7470690",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1350",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62212,
              "lon": -122.13179
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62302,
                "lon": -122.13312
              },
              "btmRightPoint": {
                "lat": 47.62122,
                "lon": -122.13046
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62213,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168519",
            "score": 2.67,
            "dist": 2490.3337046455963,
            "info": "search:ta:840539001015090-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-4556500",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "https://www.starbucks.com/store-locator/store/15901",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1645",
              "streetName": "140th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98005",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62626,
              "lon": -122.15487
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62716,
                "lon": -122.1562
              },
              "btmRightPoint": {
                "lat": 47.62536,
                "lon": -122.15354
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62645,
                  "lon": -122.15446
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.62579,
                  "lon": -122.15377
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152428",
            "score": 2.668,
            "dist": 3529.7080738812224,
            "info": "search:ta:840539001033722-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-3789496",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "180",
              "streetName": "148th Ave SE",
              "municipalitySubdivision": "West Lake Hills, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.60901,
              "lon": -122.14
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.60991,
                "lon": -122.14133
              },
              "btmRightPoint": {
                "lat": 47.60811,
                "lon": -122.13867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.60901,
                  "lon": -122.14008
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167147",
            "score": 2.668,
            "dist": 3479.393294615887,
            "info": "search:ta:840539000326896-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8619198",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7425",
              "streetName": "166th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526288",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67055,
              "lon": -122.12001
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67145,
                "lon": -122.12135
              },
              "btmRightPoint": {
                "lat": 47.66965,
                "lon": -122.11867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67069,
                  "lon": -122.11889
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153695",
            "score": 2.667,
            "dist": 3622.441074618729,
            "info": "search:ta:840531000006551-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8822881",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15022",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7625",
              "streetName": "170th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980520910",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67086,
              "lon": -122.11392
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67176,
                "lon": -122.11526
              },
              "btmRightPoint": {
                "lat": 47.66996,
                "lon": -122.11258
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67073,
                  "lon": -122.1135
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167420",
            "score": 2.667,
            "dist": 3818.293513029088,
            "info": "search:ta:840539000640782-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8853323",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "17246",
              "streetName": "Redmond Way",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980524403",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67174,
              "lon": -122.10976
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67264,
                "lon": -122.1111
              },
              "btmRightPoint": {
                "lat": 47.67084,
                "lon": -122.10842
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.6706,
                  "lon": -122.11026
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153686",
            "score": 2.666,
            "dist": 4009.922205147074,
            "info": "search:ta:840531000006548-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8859590",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15738",
              "streetName": "Redmond Way Pad 3 Redmond Center",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980523873",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67583,
              "lon": -122.12877
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67673,
                "lon": -122.13011
              },
              "btmRightPoint": {
                "lat": 47.67493,
                "lon": -122.12743
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.67456,
                  "lon": -122.12887
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.67668,
                  "lon": -122.12829
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168511",
            "score": 2.666,
            "dist": 3987.80992387863,
            "info": "search:ta:840531000006669-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8818265",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "6617",
              "streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
              "municipalitySubdivision": "Kirkland, Bridle Trails",
              "municipality": "Kirkland",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98033",
              "extendedPostalCode": "980338234",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
              "localName": "Kirkland",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.66514,
              "lon": -122.16599
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.66604,
                "lon": -122.16733
              },
              "btmRightPoint": {
                "lat": 47.66424,
                "lon": -122.16465
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.666,
                  "lon": -122.16669
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.66553,
                  "lon": -122.16405
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  }
}
Location: URL to download the results of the long-running batch request.

Definitionen

Address

Die Adresse des Ergebnisses

AddressRanges

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

BatchRequest

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

BatchRequestItem

Batchanforderungsobjekt

BoundingBox

Der Viewport, der das Ergebnis umfasst, das durch die oberen linken und unteren rechten Koordinaten des Viewports dargestellt wird.

BoundingBoxCompassNotation

Das Begrenzungsfeld des Speicherorts.

Brand

Die Marke, die dem POI zugeordnet ist

Classification

Die Klassifizierung für die zurückgegebene 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 Begrenzungsfelds. Bei umgekehrter Geocodierung entspricht dies immer der Position.

EntryPoint

Der Einstiegspunkt für die zurückgegebene POI.

EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt - oder Nebenwert sein.

ErrorAdditionalInfo

Fehler bei der Ressourcenverwaltung.

ErrorDetail

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 der Typ ==Geografie ist.

JsonFormat

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

LatLongPairAbbreviated

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

MatchType

Typen der Übereinstimmung für einen Umgekehrt-Adresssuchevorgang.

OperatingHours

Öffnungszeiten für einen POI (Interessenspunkte).

OperatingHoursTime

Stellt ein Datum und eine Uhrzeit dar.

OperatingHoursTimeRange

Geöffneter Zeitbereich für einen Tag

PointOfInterest

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

PointOfInterestCategorySet

POI-Kategorie

QueryType

Der Typ der zurückgegebenen Abfrage: IN DER NÄHE oder NON_NEAR.

Response

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

SearchAddressBatchItem

Ein Element, das vom Aufruf des Suchadressenbatchdiensts 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

Zusammenfassungsobjekt für eine Such-API-Antwort.

Summary

Zusammenfassung der Ergebnisse für die Batchanforderung

Address

Die Adresse des Ergebnisses

Name Type Description
boundingBox

Das Begrenzungsfeld des Speicherorts.

buildingNumber
  • string

Die Gebäudenummer auf der Straße. Verwenden Sie stattdessen streetNumber.

country
  • string

Name des Lands

countryCode
  • string

Land (Hinweis: Dies ist ein Zwei-Buchstaben-Code, kein Landname.)

countryCodeISO3
  • string

ISO-Alpha-3-Ländercode

countrySecondarySubdivision
  • string

County

countrySubdivision
  • string

Bundesland oder Kanton

countrySubdivisionName
  • string

Der vollständige Name einer ersten Ebene der Verwaltungshierarchie des Landes. Dieses Feld wird nur angezeigt, wenn countrySubdivision in einem abgekürzten Formular angezeigt wird. Nur für USA, Kanada und Vereinigtes Königreich unterstützt.

countryTertiarySubdivision
  • string

Benannter Bereich

crossStreet
  • string

Der Name der Straße, die gekreuzt wird.

extendedPostalCode
  • string

Erweiterte Postleitzahl (Verfügbarkeit ist abhängig von der Region).

freeformAddress
  • string

Eine Adresszeile, die gemäß den Formatierungsregeln des Ursprungslandes eines Ergebnisses oder im Falle eines Landes, dessen vollständiger Landesname formatiert ist.

localName
  • string

Eine Adresskomponente, die den Namen eines geografischen Bereichs oder gebietsschemas darstellt, das eine Reihe adressierbarer Objekte für Adressierungszwecke gruppiert, ohne eine Verwaltungseinheit zu sein. Dieses Feld wird verwendet, um die freeformAddress Eigenschaft zu erstellen.

municipality
  • string

Stadt / Stadt

municipalitySubdivision
  • string

Sub / Super City

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.

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 Seiten der Straße für ein Suchergebnis. Koordinaten für die Start- und Endspeicherorte des Adressbereichs sind enthalten.

Name Type Description
from

Eine Position, die 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

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

BatchRequest

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

Name Type Description
batchItems

Die Liste der zu verarbeitenden Abfragen.

BatchRequestItem

Batchanforderungsobjekt

Name Type Description
query
  • string

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

BoundingBox

Der Viewport, der das Ergebnis umfasst, das durch die oberen linken und unteren rechten Koordinaten des Viewports dargestellt wird.

Name Type Description
btmRightPoint

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

topLeftPoint

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

BoundingBoxCompassNotation

Das Begrenzungsfeld des Speicherorts.

Name Type Description
entity

Entitätstypquelle des Begrenzungsfelds. Bei umgekehrter Geocodierung entspricht dies immer der Position.

northEast
  • string

Nord-ost-Breite,Längengradkoordinate des Begrenzungsfelds als kommatrennte Floats

southWest
  • string

Süd-West-Breite,Längengradkoordinate des Begrenzungsfelds als kommatrennte Floats

Brand

Die Marke, die dem POI zugeordnet ist

Name Type Description
name
  • string

Name der Marke

Classification

Die Klassifizierung für die zurückgegebene POI

Name Type Description
code
  • string

Eigenschaft „code“

names

Namenarray

ClassificationName

Name für die Klassifizierung

Name Type Description
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 Type Description
geometry

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

Entity

Entitätstypquelle des Begrenzungsfelds. Bei umgekehrter Geocodierung entspricht dies immer der Position.

Name Type Description
position
  • string

Positionsentität

EntryPoint

Der Einstiegspunkt für die zurückgegebene POI.

Name Type Description
position

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

type

Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt - oder Nebenwert sein.

EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt - oder Nebenwert sein.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

Fehler bei der Ressourcenverwaltung.

Name Type Description
info
  • object

Die zusätzlichen Informationen.

type
  • string

Der zusätzliche Infotyp.

ErrorDetail

Fehlerdetails.

Name Type Description
additionalInfo

Der Fehler zusätzliche Informationen.

code
  • string

Der Fehlercode.

details

Die Fehlerdetails.

message
  • string

Die Fehlermeldung.

target
  • string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Type Description
error

Das Fehlerobjekt.

GeographicEntityType

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

Name Type Description
Country
  • string

Name des Lands

CountrySecondarySubdivision
  • string

County

CountrySubdivision
  • string

Bundesland oder Kanton

CountryTertiarySubdivision
  • string

Benannter Bereich

Municipality
  • string

Stadt / Stadt

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

Nachbarschaft

PostalCodeArea
  • string

Postleitzahl / Postleitzahl

Geometry

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

Name Type Description
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 Type Description
json
  • string

Das JavaScript-Objektnotation-Datentyp

LatLongPairAbbreviated

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

Name Type Description
lat
  • number

Latitude-Eigenschaft

lon
  • number

Longitude-Eigenschaft

MatchType

Typen der Übereinstimmung für einen Umgekehrt-Adresssuchevorgang.

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Öffnungszeiten für einen POI (Interessenspunkte).

Name Type Description
mode
  • string

Wert, der in der Anforderung verwendet wird: keine oder "nextSevenDays"

timeRanges

Liste der Zeitbereiche für die nächsten 7 Tage

OperatingHoursTime

Stellt ein Datum und eine Uhrzeit dar.

Name Type Description
date
  • string

Stellt das aktuelle Kalenderdatum in der POI-Zeitzone dar, z. B. "2019-02-07".

hour
  • integer

Stunden befinden sich im 24-Stunden-Format in der lokalen Uhrzeit eines POI; Mögliche Werte sind 0 - 23.

minute
  • integer

Minuten befinden sich in der lokalen Zeit eines POI; Mögliche Werte sind 0 - 59.

OperatingHoursTimeRange

Geöffneter Zeitbereich für einen Tag

Name Type Description
endTime

Der Punkt im nächsten 7-Tage-Bereich, wenn ein bestimmtes POI geschlossen wird, oder den Anfang des Bereichs, wenn er vor dem Bereich geschlossen wurde.

startTime

Der Punkt im nächsten 7-Tage-Bereich, an dem ein bestimmtes POI geöffnet wird, oder den Anfang des Bereichs, wenn er vor dem Bereich geöffnet wurde.

PointOfInterest

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

Name Type Description
brands

Markenarray. Der Name der Marke für die ZURÜCKGEGEBENe POI.

categories
  • string[]

Kategorienarray

categorySet

Die Liste der spezifischsten POI-Kategorien

classifications

Klassifizierungsarray

name
  • string

Name der POI-Eigenschaft

openingHours

Öffnungszeiten für einen POI (Interessenspunkte).

phone
  • string

Telefonnummerneigenschaft

url
  • string

Website-URL-Eigenschaft

PointOfInterestCategorySet

POI-Kategorie

Name Type Description
id
  • integer

Kategorie-ID

QueryType

Der Typ der zurückgegebenen Abfrage: IN DER NÄHE oder NON_NEAR.

Name Type Description
NEARBY
  • string

Die Suche wurde um einen bestimmten Breiten- und Längengrad mit einem definierten Radius durchgeführt.

NON_NEAR
  • string

Die Suche wurde global ausgeführt, ohne sich auf einen bestimmten Breiten- und Längengrad und keinen definierten Radius zu richten.

Response

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

Name Type Description
error

Das Fehlerobjekt.

results

Eine Liste der Suchergebnisse der Such-API.

summary

Zusammenfassungsobjekt für eine Such-API-Antwort

SearchAddressBatchItem

Ein Element, das vom Aufruf des Suchadressenbatchdiensts zurückgegeben wird.

Name Type Description
response

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

statusCode
  • integer

HTTP-Anforderungsstatuscode.

SearchAddressBatchProcessResult

Dieses Objekt wird von einem erfolgreichen Suchadressenbatchdienstaufruf zurückgegeben.

Name Type Description
batchItems

Array, das die Batchergebnisse enthält.

summary

Zusammenfassung der Ergebnisse für die Batchanforderung

SearchAddressResultItem

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

Name Type Description
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.

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

Gerader Linienabstand zwischen dem Ergebnis und geobias Standort in Metern.

entityType

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

entryPoints

Array von EntryPoints. Diese beschreiben die Arten von Eingangstypen, die an der Position verfügbar sind. Der Typ kann "Main" für Haupteingänge wie eine Fronttür oder einen Wartebereich und "Neben" 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

Informationen zum Übereinstimmungstyp.

Enthält einen der folgenden Werte:

  • AddressPoint
  • HouseNumberRange
  • Straße
poi

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

position

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

score
  • number

Der Wert in einem Resultset, um die relative Übereinstimmungsbewertung zwischen Ergebnissen anzugeben. Sie können dies verwenden, um zu bestimmen, dass ergebnis x doppelt so relevant ist wie Ergebnis y, wenn der Wert von x 2x der Wert y ist. Die Werte variieren zwischen Abfragen und sind nur als relativer Wert für einen Resultset gedacht.

type

Enthält einen der folgenden Werte:

  • POI
  • Straße
  • Geografie
  • Punktadresse
  • Adressbereich
  • Querstraße
viewport

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

SearchAddressResultType

Enthält einen der folgenden Werte:

  • POI
  • Straße
  • Geografie
  • Punktadresse
  • Adressbereich
  • Querstraße
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Zusammenfassungsobjekt für eine Such-API-Antwort.

Name Type Description
fuzzyLevel
  • integer

Die maximale Fuzzy-Ebene, die zum Bereitstellen von Ergebnissen erforderlich ist.

geoBias

Hinweis, wenn die interne Suchmaschine einen Geospatial-Bias angewendet hat, um die Rangfolge der Ergebnisse zu verbessern. In einigen Methoden kann dies durch Festlegen der Lat- und lon-Parameter, sofern verfügbar, beeinflusst werden. 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 Startversatz 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 die Auflösung der Abfrage in Millisekunden.

queryType

Der Typ der zurückgegebenen Abfrage: IN DER NÄHE oder NON_NEAR.

totalResults
  • integer

Die Gesamtzahl der gefundenen Ergebnisse.

Summary

Zusammenfassung der Ergebnisse für die Batchanforderung

Name Type Description
successfulRequests
  • integer

Anzahl der erfolgreichen Anforderungen im Batch

totalRequests
  • integer

Gesamtanzahl der Anforderungen im Batch