SearchGetGeocodingQueryParamProperties interface

Paquete:

@azure-rest/maps-search

Propiedades

addressLine	Línea de calle oficial de una dirección relativa al área, según lo especificado por la localidad, o postalCode, propiedades. El uso típico de este elemento sería proporcionar una dirección postal o cualquier dirección oficial. Si se da una consulta, no debe usar este parámetro.
adminDistrict	Parte de la subdivisión de país de una dirección, como WA. Si se da una consulta, no debe usar este parámetro.
adminDistrict2	El condado para la dirección estructurada, como King. Si se da una consulta, no debe usar este parámetro.
adminDistrict3	Área con nombre para la dirección estructurada. Si se da una consulta, no debe usar este parámetro.
bbox	Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de longitud y latitud. Cuando se especifica este parámetro, se tiene en cuenta el área geográfica al calcular los resultados de una consulta de ubicación. Ejemplo: lon1,lat1,lon2,lat2
coordinates	Punto de la tierra especificado como longitud y latitud. Cuando se especifica este parámetro, se tiene en cuenta la ubicación del usuario y los resultados devueltos pueden ser más relevantes para el usuario. Ejemplo: &coordinates=lon,lat
countryRegion	Restrinja el resultado de la geocodificación a un código de país o región alfa-2 ISO 3166-1 que se especifica, por ejemplo, FR. Esto limitará la búsqueda a la región especificada. Si se da una consulta, no debe usar este parámetro.
locality	La parte de localidad de una dirección, como Seattle. Si se da una consulta, no debe usar este parámetro.
postalCode	Parte del código postal de una dirección. Si se da una consulta, no debe usar este parámetro.
query	Cadena que contiene información sobre una ubicación, como una dirección o un nombre de punto de referencia.
top	Número máximo de respuestas que se devolverán. Valor predeterminado: 5, mínimo: 1 y máximo: 20.
view	Cadena que representa un código de país o región ISO 3166-1 Alfa-2. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. De forma predeterminada, el parámetro View se establece en "Auto", incluso si no lo ha definido en la solicitud. Consulte Vistas admitidas para obtener más información y ver las vistas disponibles.

Detalles de las propiedades

addressLine

Línea de calle oficial de una dirección relativa al área, según lo especificado por la localidad, o postalCode, propiedades. El uso típico de este elemento sería proporcionar una dirección postal o cualquier dirección oficial.

Si se da una consulta, no debe usar este parámetro.

addressLine?: string

Valor de propiedad

string

adminDistrict

Parte de la subdivisión de país de una dirección, como WA.

Si se da una consulta, no debe usar este parámetro.

adminDistrict?: string

Valor de propiedad

string

adminDistrict2

El condado para la dirección estructurada, como King.

Si se da una consulta, no debe usar este parámetro.

adminDistrict2?: string

Valor de propiedad

string

adminDistrict3

Área con nombre para la dirección estructurada.

Si se da una consulta, no debe usar este parámetro.

adminDistrict3?: string

Valor de propiedad

string

bbox

Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de longitud y latitud. Cuando se especifica este parámetro, se tiene en cuenta el área geográfica al calcular los resultados de una consulta de ubicación.

Ejemplo: lon1,lat1,lon2,lat2

bbox?: number[]

Valor de propiedad

number[]

coordinates

Punto de la tierra especificado como longitud y latitud. Cuando se especifica este parámetro, se tiene en cuenta la ubicación del usuario y los resultados devueltos pueden ser más relevantes para el usuario. Ejemplo: &coordinates=lon,lat

coordinates?: number[]

Valor de propiedad

number[]

countryRegion

Restrinja el resultado de la geocodificación a un código de país o región alfa-2 ISO 3166-1 que se especifica, por ejemplo, FR. Esto limitará la búsqueda a la región especificada.

Si se da una consulta, no debe usar este parámetro.

countryRegion?: string

Valor de propiedad

string

locality

La parte de localidad de una dirección, como Seattle.

Si se da una consulta, no debe usar este parámetro.

locality?: string

Valor de propiedad

string

postalCode

Parte del código postal de una dirección.

Si se da una consulta, no debe usar este parámetro.

postalCode?: string

Valor de propiedad

string

query

Cadena que contiene información sobre una ubicación, como una dirección o un nombre de punto de referencia.

query?: string

Valor de propiedad

string

top

Número máximo de respuestas que se devolverán. Valor predeterminado: 5, mínimo: 1 y máximo: 20.

top?: number

Valor de propiedad

number

view

Cadena que representa un código de país o región ISO 3166-1 Alfa-2. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. De forma predeterminada, el parámetro View se establece en "Auto", incluso si no lo ha definido en la solicitud.

Consulte Vistas admitidas para obtener más información y ver las vistas disponibles.

view?: string

Valor de propiedad

string