SearchGetSearchAddressStructuredOptionalParams interface

Paket:

azure-maps-rest

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

countrySecondarySubdivision	Der Landkreis für die strukturierte Adresse
countrySubdivision	Der Teil der Ländergliederung einer Adresse
countryTertiarySubdivision	Der benannte Bereich für die strukturierte Adresse
crossStreet	Der Kreuzstraßenname für die strukturierte Adresse
extendedPostalCodesFor	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.
language	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	Maximale Anzahl von Antworten, die zurückgegeben werden
municipality	Der Gemeindeteil einer Adresse
municipalitySubdivision	Die Gemeindeunterteilung (Unter-/Oberstadt) für die strukturierte Adresse
ofs	Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets
postalCode	Der Postleitzahlteil einer Adresse
streetName	Der Straßennamenteil einer Adresse
streetNumber	Der Straßennummernteil einer Adresse
view	Der View-Parameter gibt an, welcher Satz geopolitisch umstrittener Inhalte über Azure Maps-Dienste zurückgegeben wird, einschließlich Rahmen und Bezeichnungen, die auf der Karte angezeigt werden. Der View-Parameter (auch als "Benutzerregion-Parameter" bezeichnet) zeigt die richtigen Zuordnungen für dieses Land/diese Region an. 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, 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 .

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders	{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

countrySecondarySubdivision

Der Landkreis für die strukturierte Adresse

countrySecondarySubdivision?: string

Eigenschaftswert

string

countrySubdivision

Der Teil der Ländergliederung einer Adresse

countrySubdivision?: string

Eigenschaftswert

string

countryTertiarySubdivision

Der benannte Bereich für die strukturierte Adresse

countryTertiarySubdivision?: string

Eigenschaftswert

string

crossStreet

Der Kreuzstraßenname für die strukturierte Adresse

crossStreet?: string

Eigenschaftswert

string

extendedPostalCodesFor

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.

extendedPostalCodesFor?: string

Eigenschaftswert

string

language

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 .

language?: string

Eigenschaftswert

string

limit

Maximale Anzahl von Antworten, die zurückgegeben werden

limit?: number

Eigenschaftswert

number

municipality

Der Gemeindeteil einer Adresse

municipality?: string

Eigenschaftswert

string

municipalitySubdivision

Die Gemeindeunterteilung (Unter-/Oberstadt) für die strukturierte Adresse

municipalitySubdivision?: string

Eigenschaftswert

string

ofs

Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets

ofs?: number

Eigenschaftswert

number

postalCode

Der Postleitzahlteil einer Adresse

postalCode?: string

Eigenschaftswert

string

streetName

Der Straßennamenteil einer Adresse

streetName?: string

Eigenschaftswert

string

streetNumber

Der Straßennummernteil einer Adresse

streetNumber?: string

Eigenschaftswert

string

view

Der View-Parameter gibt an, welcher Satz geopolitisch umstrittener Inhalte über Azure Maps-Dienste zurückgegeben wird, einschließlich Rahmen und Bezeichnungen, die auf der Karte angezeigt werden. Der View-Parameter (auch als "Benutzerregion-Parameter" bezeichnet) zeigt die richtigen Zuordnungen für dieses Land/diese Region an. 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, 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 .

view?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

customHeaders?: [key: string]: string

Eigenschaftswert

[key: string]: string

Geerbt von RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onUploadProgress

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

Geerbt von RequestOptionsBase.timeout