SearchGetGeocodingQueryParamProperties interface

Paket:

@azure-rest/maps-search

Eigenschaften

addressLine	Die offizielle Straßenzeile einer Adresse relativ zum Gebiet, wie durch die Eigenschaften "locality" oder "postalCode" angegeben. In der Regel wird dieses Element verwendet, um eine Adresse oder eine offizielle Adresse anzugeben. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict	Der Teil der Länderunterteilung einer Adresse, z. B. WA. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict2	Der Landkreis für die strukturierte Adresse, z. B. King. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
adminDistrict3	Der benannte Bereich für die strukturierte Adresse. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
bbox	Ein rechteckiger Bereich auf der Erde, der als Begrenzungsrahmenobjekt definiert ist. Die Seiten des Rechtecks werden durch Längen- und Breitengradwerte definiert. Wenn Sie diesen Parameter angeben, wird der geografische Bereich beim Berechnen der Ergebnisse einer Standortabfrage berücksichtigt. Beispiel: lon1,lat1,lon2,lat2
coordinates	Ein Punkt auf der Erde, der als Längen- und Breitengrad angegeben ist. Wenn Sie diesen Parameter angeben, wird der Standort des Benutzers berücksichtigt, und die zurückgegebenen Ergebnisse können für den Benutzer relevanter sein. Beispiel: &coordinates=lon,lat
countryRegion	Beschränken Sie das Geocodierungsergebnis auf einen iso 3166-1 Alpha-2-Regions-/Ländercode , der angegeben wird, z. B. FR. Dadurch wird die Suche auf die angegebene Region beschränkt. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
locality	Der Lokale Teil einer Adresse, z. B. Seattle. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
postalCode	Der Postleitzahlteil einer Adresse. Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.
query	Eine Zeichenfolge, die Informationen zu einem Speicherort enthält, z. B. einen Adress- oder Wahrzeichennamen.
top	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 5, Minimum: 1 und Maximum: 20.
view	Eine Zeichenfolge, die einen Iso 3166-1 Alpha-2-Regions-/Ländercode darstellt. Dadurch werden die geopolitisch umstrittenen Grenzen und Bezeichnungen so geändert, dass sie der angegebenen Benutzerregion entsprechen. Standardmäßig ist der View-Parameter auf "Auto" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Details zur Eigenschaft

addressLine

Die offizielle Straßenzeile einer Adresse relativ zum Gebiet, wie durch die Eigenschaften "locality" oder "postalCode" angegeben. In der Regel wird dieses Element verwendet, um eine Adresse oder eine offizielle Adresse anzugeben.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

addressLine?: string

Eigenschaftswert

string

adminDistrict

Der Teil der Länderunterteilung einer Adresse, z. B. WA.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

adminDistrict?: string

Eigenschaftswert

string

adminDistrict2

Der Landkreis für die strukturierte Adresse, z. B. King.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

adminDistrict2?: string

Eigenschaftswert

string

adminDistrict3

Der benannte Bereich für die strukturierte Adresse.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

adminDistrict3?: string

Eigenschaftswert

string

bbox

Ein rechteckiger Bereich auf der Erde, der als Begrenzungsrahmenobjekt definiert ist. Die Seiten des Rechtecks werden durch Längen- und Breitengradwerte definiert. Wenn Sie diesen Parameter angeben, wird der geografische Bereich beim Berechnen der Ergebnisse einer Standortabfrage berücksichtigt.

Beispiel: lon1,lat1,lon2,lat2

bbox?: number[]

Eigenschaftswert

number[]

coordinates

Ein Punkt auf der Erde, der als Längen- und Breitengrad angegeben ist. Wenn Sie diesen Parameter angeben, wird der Standort des Benutzers berücksichtigt, und die zurückgegebenen Ergebnisse können für den Benutzer relevanter sein. Beispiel: &coordinates=lon,lat

coordinates?: number[]

Eigenschaftswert

number[]

countryRegion

Beschränken Sie das Geocodierungsergebnis auf einen iso 3166-1 Alpha-2-Regions-/Ländercode , der angegeben wird, z. B. FR. Dadurch wird die Suche auf die angegebene Region beschränkt.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

countryRegion?: string

Eigenschaftswert

string

locality

Der Lokale Teil einer Adresse, z. B. Seattle.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

locality?: string

Eigenschaftswert

string

postalCode

Der Postleitzahlteil einer Adresse.

Wenn eine Abfrage angegeben ist, sollte dieser Parameter nicht verwendet werden.

postalCode?: string

Eigenschaftswert

string

query

Eine Zeichenfolge, die Informationen zu einem Speicherort enthält, z. B. einen Adress- oder Wahrzeichennamen.

query?: string

Eigenschaftswert

string

top

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

top?: number

Eigenschaftswert

number

view

Eine Zeichenfolge, die einen Iso 3166-1 Alpha-2-Regions-/Ländercode darstellt. Dadurch werden die geopolitisch umstrittenen Grenzen und Bezeichnungen so geändert, dass sie der angegebenen Benutzerregion entsprechen. Standardmäßig ist der View-Parameter auf "Auto" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben.

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

view?: string

Eigenschaftswert

string