Search - Post Search Inside Geometry

Verwenden Sie , um Freiformularsuchen innerhalb einer weiteren Geometrie auszuführen.

Die Post Search Inside Geometry API ist und HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a POSTrequest where the request body will contain thegeometryobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON geometrycan be represented as aGeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>TheFeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. TheFeatureCollectioncan contain a max of 50GeoJSON Featureobjects. EachFeatureobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>AFeature Featureobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>AGeoJSONobject for the Circle geometry is composed of a _center_ represented using aPointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sampleFeatureCollectionrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>Thegeometrycan be represented as aGeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeometryCollection GeoJSON Polygon Geometry GeometryCollectioncan contain a max of 50GeoJSON Polygon GeometryCollection GeometryCollection GeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. Theobject can have a max of 50 coordinates. Please see the Examples section below for a sampleobject can have a max of 50 coordinates. Please see the Examples section below for a sampleobjects. Each Geometry Geometryrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>Thecan be represented as aPolygondarstellung.

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays

URI-Parameter

Name In Erforderlich Typ Beschreibung
format
path True

ResponseFormat

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

api-version
query True

string

Versionsnummer der Azure Maps API.

query
query True

string

Der POI-Name, nach dem gesucht werden soll (z. B. "Freiheitsstatue", "Starbucks", "Pizza"). Muss ordnungsgemäß URL-codiert sein.

categorySet
query

integer[]

Eine durch Trennzeichen getrennte Liste von Kategoriegruppen-IDs, die verwendet werden können, um das Ergebnis auf bestimmte Points of Interest-Kategorien zu beschränken. Die ID-Reihenfolge spielt keine Rolle. Die maximale Anzahl von Werten, die categorySet pro Anforderung unterstützt werden, ist 10. Wenn mehrere Kategoriebezeichner bereitgestellt werden, werden nur POIs zurückgegeben, die (mindestens) zu einer der Kategorien aus der angegebenen Liste gehören. Die Liste der unterstützten Kategorien kann mithilfe der POI-Kategorien-API ermittelt werden. Anwendungsbeispiele:

  • categorySet=7315 (Search Points of Interest aus der Kategorie Restaurant)

  • categorySet=7315025,7315017 (Search Points of Interest der Kategorie entweder italienisches oder französisches Restaurant)

extendedPostalCodesFor
query

SearchIndexes[]

Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen.

Verfügbare Indizes sind:

Addr = Adressbereiche

Geo = Geografien

PAD = Punktadressen

POI = Points of Interest

Str = Straßen

XStr = Cross Street (Kreuzungen)

Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein.

Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen.

Anwendungsbeispiele:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.

idxSet
query

SearchIndexes[]

Eine durch Trennzeichen getrennte Liste von Indizes, die für die Suche verwendet werden sollen. Die Reihenfolge der Elemente ist unerheblich. Verfügbare Indizes sind: Addr = Adressbereichsinterpolation, Geo = Geografien, PAD = Punktadressen, POI = Points of Interest, Str = Straßen, Xstr = Cross Streets (Kreuzungen)

language
query

string

Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet.

Weitere Informationen finden Sie unter Unterstützte Sprachen .

limit
query

integer

Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 10, Minimum: 1 und Maximum: 100

openingHours
query

OperatingHoursRange

Betriebsstunden für einen POI (Points of Interest). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden wird, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays

view
query

LocalizedMapView

Mit dem Parameter View (auch als Parameter "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten dieser Regionen, und der Parameter View ermöglicht es Ihrer Anwendung, die für das Land/die Region, das/die/die Ihre Anwendung bereitstellen wird, erforderlich zu erfüllen. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN.

Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

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
geometry GeoJsonObject:
  • GeoJsonFeature
  • GeoJsonFeatureCollection

Ein gültiges GeoJSON-Objekt. Weitere Informationen finden Sie unter RFC 7946 .

Antworten

Name Typ Beschreibung
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung 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

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 21,
    "numResults": 2,
    "offset": 0,
    "totalResults": 4,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "9P2i9inRyndAA-_V40J8oA",
      "score": 2.0041828156,
      "info": "search:ta:840061003419653-US",
      "poi": {
        "name": "Burger Joint",
        "phone": "+1 415-349-4331",
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "categories": [
          "fast food",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "hkr-N07YS6Gv2dOciQ9lwA",
      "score": 2.0041515827,
      "info": "search:ta:840067000526682-US",
      "poi": {
        "name": "Sound of Burgers",
        "categorySet": [
          {
            "id": 7315
          }
        ],
        "categories": [
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 34,
    "numResults": 2,
    "offset": 0,
    "totalResults": 21,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "-UuwTye4GGsea4KmCLvoqQ",
      "score": 2.1455535889,
      "info": "search:ta:840537000108972-US",
      "poi": {
        "name": "Biryani & Pizza House",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15025",
        "streetName": "Northeast 24th Street",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "98052-5531",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
        "localName": "Redmond"
      },
      "position": {
        "lat": 47.630786,
        "lon": -122.139302
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63169,
          "lon": -122.14064
        },
        "btmRightPoint": {
          "lat": 47.62989,
          "lon": -122.13797
        }
      },
      "entryPoints": [
        {
          "type": "minor",
          "position": {
            "lat": 47.63079,
            "lon": -122.13931
          }
        },
        {
          "type": "main",
          "position": {
            "lat": 47.63147,
            "lon": -122.13935
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "7r095LCcCSkdoGoeLcnvsQ",
      "score": 2.1454992294,
      "info": "search:ta:840537000103468-US",
      "poi": {
        "name": "Pagliacci Pizza",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pagliacci.com/",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-20",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-20",
                "hour": 11,
                "minute": 0
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "15238",
        "streetName": "Bel Red Road",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "extendedPostalCode": "98007-3815",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
        "localName": "Bellevue"
      },
      "position": {
        "lat": 47.628008,
        "lon": -122.13646
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62891,
          "lon": -122.13779
        },
        "btmRightPoint": {
          "lat": 47.62711,
          "lon": -122.13513
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6283,
            "lon": -122.13611
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "subs",
    "queryType": "NON_NEAR",
    "queryTime": 42,
    "numResults": 2,
    "offset": 0,
    "totalResults": 5,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "HOIWGiNwVv0z6bF8MO3EbA",
      "score": 2.1455111504,
      "info": "search:ta:840069009512242-US",
      "poi": {
        "name": "Adams Grub Truck",
        "phone": "+1 415-307-8844",
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1465",
        "streetName": "Carroll Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Bayview",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94124",
        "extendedPostalCode": "94124-3604",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.72328,
        "lon": -122.39091
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.72418,
          "lon": -122.39205
        },
        "btmRightPoint": {
          "lat": 37.72238,
          "lon": -122.38977
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72348,
            "lon": -122.39073
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "bXbc0QxTRlkSo8GnU7EU-Q",
      "score": 2.1454677582,
      "info": "search:ta:840061001992959-US",
      "poi": {
        "name": "SUBWAY San Francisco San Francisco",
        "phone": "+1 415-657-9898",
        "brands": [
          {
            "name": "SUBWAY"
          }
        ],
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-13",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-13",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-15",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-15",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-16",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-16",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 8,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 20,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 21,
                "minute": 30
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "2599",
        "streetName": "San Bruno Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Portola",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-1504",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.729004,
        "lon": -122.403956
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.7299,
          "lon": -122.40509
        },
        "btmRightPoint": {
          "lat": 37.7281,
          "lon": -122.40282
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72892,
            "lon": -122.40414
          }
        }
      ]
    }
  ]
}

Definitionen

Name Beschreibung
Address

Die Adresse des Ergebnisses

AddressRanges

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

BoundingBox

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

BoundingBoxCompassNotation

Das umschließende Feld der Position.

Brand

Die Marke, die dem POI zugeordnet ist

Classification

Die Klassifizierung für den zurückgegebenen POI

ClassificationName

Name für die Klassifizierung

DataSources

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

Entity

Entitätstypquelle des Begrenzungsrahmens. Für die Reverse-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 nebenwertig 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.

GeoJsonFeature

Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonFeatureCollection

Ein gültiger GeoJSON FeatureCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonGeometry

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Geometry

Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn der Typ == Geography eingibt.

LatLongPairAbbreviated

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

LocalizedMapView

Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN.

Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

MatchType

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

OperatingHours

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

OperatingHoursRange

Betriebsstunden für einen POI (Points of Interest). Die Verfügbarkeit der Betriebsstunden hängt von den verfügbaren Daten ab. Wenn nicht bestanden, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays

OperatingHoursTime

Stellt ein Datum und eine Uhrzeit dar.

OperatingHoursTimeRange

Offener 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.

ResponseFormat

Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.

SearchAddressResult

Dieses Objekt wird von einer erfolgreichen Search-Aufrufe 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
SearchIndexes

Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollten.

Verfügbare Indizes sind:

Addr = Adressbereiche

Geo = Geographie

PAD = Punktadressen

POI = Points of Interest

Str = Straßen

XStr = Cross Street (Kreuzungen)

Der Wert sollte eine durch Kommage getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein.

Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen.

Anwendungsbeispiele:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.

SearchInsideGeometryRequest

Dieser Typ stellt den Anforderungstext für den Search Inside Geometry-Dienst dar.

SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort.

Address

Die Adresse des Ergebnisses

Name Typ Beschreibung
boundingBox

BoundingBoxCompassNotation

Das umschließende Feld der Position.

buildingNumber

string

Die Gebäudenummer auf der Straße. VERALTET, verwenden Sie stattdessen streetNumber.

country

string

Land-/Regionsname

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 abgekürzter Form dargestellt wird. Nur für DIE 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 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 Gebiets darstellt, der mehrere adressierbare Objekte zu Adressierungszwecken gruppiert, ohne eine Verwaltungseinheit zu sein. Dieses Feld wird verwendet, um die freeformAddress Eigenschaft zu erstellen. localName vertritt die Postgemeinde. Je nach Standort localName ist der allgemein bekannte Name einer Stadt oder Stadt. Verwenden Sie localName für den allgemein bekannten Namen einer Stadt anstelle von municipality.

municipality

string

Stadt / Ort
Hinweis: municipality stellt die Wohngemeinde dar. Je nach Standort kann sich der municipality Wert vom allgemein bekannten Namen einer 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 Einwohnern.

postalCode

string

Postleitzahl / Postleitzahl

routeNumbers

string[]

Die Zur eindeutigen Identifizierung der Straße verwendeten Codes

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

Name Typ Beschreibung
from

LatLongPairAbbreviated

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

rangeLeft

string

Adressbereich auf der linken Straßenseite.

rangeRight

string

Adressbereich auf der rechten Straßenseite.

to

LatLongPairAbbreviated

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

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

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

topLeftPoint

LatLongPairAbbreviated

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

BoundingBoxCompassNotation

Das umschließende Feld der Position.

Name Typ Beschreibung
entity

Entity

Entitätstypquelle des Begrenzungsrahmens. Für die Reverse-Geocodierung ist dies immer gleich der Position.

northEast

string

Nördliche Breite, Längengradkoordinate des Begrenzungsrahmens als kommagetrennte Gleitkomma

southWest

string

Südwestlicher Breitengrad, Längengradkoordinate des Begrenzungsrahmens als kommagetrennte Floats

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 zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn der Typ == Geography eingibt.

Entity

Entitätstypquelle des Begrenzungsrahmens. Für die Reverse-Geocodierung ist dies immer gleich der Position.

Name Typ Beschreibung
position

string

Positionsentität

EntryPoint

Der Einstiegspunkt für den zurückgegebenen POI.

Name Typ Beschreibung
position

LatLongPairAbbreviated

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

type

EntryPointType

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

EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder nebenwertig 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

Stadt / Ort

MunicipalitySubdivision

string

Sub/Super City

Neighbourhood

string

Nachbarschaft

PostalCodeArea

string

Postleitzahl / Postleitzahl

GeoJsonFeature

Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
featureType

string

Der Funktionstyp Der Wert hängt vom Datenmodell ab, in dem sich das aktuelle Feature befindet. Einige Datenmodelle verfügen möglicherweise über einen leeren Wert.

geometry GeoJsonGeometry:
  • GeoJsonGeometryCollection
  • GeoJsonLineString
  • GeoJsonMultiLineString
  • GeoJsonMultiPoint
  • GeoJsonMultiPolygon
  • GeoJsonPoint
  • GeoJsonPolygon

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

id

string

Bezeichner für das Feature.

type string:

Feature

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonFeatureCollection

Ein gültiger GeoJSON FeatureCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
features

GeoJsonFeature[]

Enthält eine Liste gültiger GeoJSON Feature Objekte.

type string:

FeatureCollection

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonGeometry

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
type

GeoJsonObjectType

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
geometries GeoJsonGeometry[]:
  • GeoJsonGeometryCollection[]
  • GeoJsonLineString[]
  • GeoJsonMultiLineString[]
  • GeoJsonMultiPoint[]
  • GeoJsonMultiPolygon[]
  • GeoJsonPoint[]
  • GeoJsonPolygon[]

Enthält eine Liste mit gültigen GeoJSON Geometrieobjekten. Beachten Sie , dass die Koordinaten in GeoJSON in x,y-Reihenfolge (Längengrad, Breitengrad) liegen.

type string:

GeometryCollection

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson LineString Geometrie.

type string:

LineString

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson MultiLineString Geometrie.

type string:

MultiLineString

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson MultiPoint Geometrie.

type string:

MultiPoint

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Enthält eine Liste gültiger GeoJSON Polygon Objekte. Beachten Sie , dass die Koordinaten in GeoJSON in x,y-Reihenfolge (Längengrad, Breitengrad) liegen.

type string:

MultiPolygon

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

A Position ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Altitude/Elevation ist ein optionales drittes Element. Weitere Informationen finden Sie unter RFC 7946 .

type string:

Point

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für den GeoJson Polygon Geometrietyp.

type string:

Polygon

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

Geometry

Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn der Typ == Geography eingibt.

Name Typ Beschreibung
id

string

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

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

LocalizedMapView

Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN.

Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Name Typ Beschreibung
AE

string

Vereinigte Arabische Emirate (arabische Ansicht)

AR

string

Argentinien (argentinische Ansicht)

Auto

string

Gibt die Kartendaten basierend auf der IP-Adresse der Anforderung zurück.

BH

string

Bahrain (arabische Ansicht)

IN

string

Indien (indische Ansicht)

IQ

string

Irak (arabische Ansicht)

JO

string

Jordanien (arabische Ansicht)

KW

string

Kuwait (arabische Ansicht)

LB

string

Libanon (arabische Ansicht)

MA

string

Marokko (marokkanische Ansicht)

OM

string

Oman (arabische Ansicht)

PK

string

Pakistan (pakistanische Ansicht)

PS

string

Palästinensische Autonomiegebiete (arabische Ansicht)

QA

string

Katar (arabische Ansicht)

SA

string

Saudi-Arabien (arabische Ansicht)

SY

string

Syrien (arabische Ansicht)

Unified

string

Einheitliche Ansicht (andere)

YE

string

Jemen (arabische Ansicht)

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 verwendete Wert: none oder "nextSevenDays"

timeRanges

OperatingHoursTimeRange[]

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

OperatingHoursRange

Betriebsstunden für einen POI (Points of Interest). Die Verfügbarkeit der Betriebsstunden hängt von den verfügbaren Daten ab. Wenn nicht bestanden, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays

Name Typ Beschreibung
nextSevenDays

string

Zeigt die Betriebszeiten für die nächste Woche an, beginnend mit dem aktuellen Tag in der Ortszeit des POI.

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 zur Ortszeit eines POI; mögliche Werte sind 0 bis 23.

minute

integer

Minuten liegen in der Ortszeit eines POI; mögliche Werte sind 0 - 59.

OperatingHoursTimeRange

Offener Zeitbereich für einen Tag

Name Typ Beschreibung
endTime

OperatingHoursTime

Der Punkt in den nächsten 7 Tagen, 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

Telefonnummerneigenschaft

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.

ResponseFormat

Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.

Name Typ Beschreibung
json

string

Das Datenaustauschformat der JavaScript-Objektnotation

xml

string

The Extensible Markup Language

SearchAddressResult

Dieses Objekt wird von einer erfolgreichen Search-Aufrufe zurückgegeben.

Name Typ Beschreibung
results

SearchAddressResultItem[]

Eine Liste mit Search API-Ergebnissen.

summary

SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort

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

SearchIndexes

Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollten.

Verfügbare Indizes sind:

Addr = Adressbereiche

Geo = Geographie

PAD = Punktadressen

POI = Points of Interest

Str = Straßen

XStr = Cross Street (Kreuzungen)

Der Wert sollte eine durch Kommage getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein.

Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen.

Anwendungsbeispiele:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.

Name Typ Beschreibung
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchInsideGeometryRequest

Dieser Typ stellt den Anforderungstext für den Search Inside Geometry-Dienst dar.

Name Typ Beschreibung
geometry GeoJsonObject:
  • GeoJsonFeature
  • GeoJsonFeatureCollection

Ein gültiges GeoJSON-Objekt. Weitere Informationen finden Sie unter RFC 7946 .

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.