SearchGetGeocodingQueryParamProperties interface

Pacote:

@azure-rest/maps-search

Propriedades

addressLine	A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. O uso típico desse elemento seria fornecer um endereço de rua ou qualquer endereço oficial. Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict	A parte de subdivisão do país de um endereço, como WA. Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict2	O condado do endereço estruturado, como King. Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict3	A área nomeada para o endereço estruturado. Se a consulta for fornecida, não deverá usar esse parâmetro.
bbox	Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de longitude e latitude. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local. Exemplo: lon1,lat1,lon2,lat2
coordinates	Um ponto na Terra especificado como longitude e latitude. Quando você especifica esse parâmetro, a localização do usuário é levada em conta e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: &coordinates=lon,lat
countryRegion	Sinal para o resultado da geocodificação para um código de região/país ISO 3166-1 Alpha-2 especificado, por exemplo, FR./ Se a consulta for fornecida, não deverá usar esse parâmetro.
locality	A parte da localidade de um endereço, como Seattle. Se a consulta for fornecida, não deverá usar esse parâmetro.
postalCode	A parte do código postal de um endereço. Se a consulta for fornecida, não deverá usar esse parâmetro.
query	Uma cadeia de caracteres que contém informações sobre um local, como um endereço ou nome de ponto de referência.
top	Número máximo de respostas que serão retornadas. Padrão: 5, mínimo: 1 e máximo: 20.
view	Uma cadeia de caracteres que representa uma de código de região/país iso 3166-1 do ISO 3166-1 alfa-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Automático", mesmo que você não o tenha definido na solicitação. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

Detalhes da propriedade

addressLine

A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. O uso típico desse elemento seria fornecer um endereço de rua ou qualquer endereço oficial.

Se a consulta for fornecida, não deverá usar esse parâmetro.

addressLine?: string

Valor da propriedade

string

adminDistrict

A parte de subdivisão do país de um endereço, como WA.

Se a consulta for fornecida, não deverá usar esse parâmetro.

adminDistrict?: string

Valor da propriedade

string

adminDistrict2

O condado do endereço estruturado, como King.

Se a consulta for fornecida, não deverá usar esse parâmetro.

adminDistrict2?: string

Valor da propriedade

string

adminDistrict3

A área nomeada para o endereço estruturado.

Se a consulta for fornecida, não deverá usar esse parâmetro.

adminDistrict3?: string

Valor da propriedade

string

bbox

Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de longitude e latitude. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local.

Exemplo: lon1,lat1,lon2,lat2

bbox?: number[]

Valor da propriedade

number[]

coordinates

Um ponto na Terra especificado como longitude e latitude. Quando você especifica esse parâmetro, a localização do usuário é levada em conta e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: &coordinates=lon,lat

coordinates?: number[]

Valor da propriedade

number[]

countryRegion

Sinal para o resultado da geocodificação para um código de região/país ISO 3166-1 Alpha-2 especificado, por exemplo, FR./

Se a consulta for fornecida, não deverá usar esse parâmetro.

countryRegion?: string

Valor da propriedade

string

locality

A parte da localidade de um endereço, como Seattle.

Se a consulta for fornecida, não deverá usar esse parâmetro.

locality?: string

Valor da propriedade

string

postalCode

A parte do código postal de um endereço.

Se a consulta for fornecida, não deverá usar esse parâmetro.

postalCode?: string

Valor da propriedade

string

query

Uma cadeia de caracteres que contém informações sobre um local, como um endereço ou nome de ponto de referência.

query?: string

Valor da propriedade

string

top

Número máximo de respostas que serão retornadas. Padrão: 5, mínimo: 1 e máximo: 20.

top?: number

Valor da propriedade

number

view

Uma cadeia de caracteres que representa uma de código de região/país iso 3166-1 do ISO 3166-1 alfa-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Automático", mesmo que você não o tenha definido na solicitação.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

view?: string

Valor da propriedade

string