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 deste elemento seria fornecer um endereço ou qualquer endereço oficial. Se a consulta for fornecida, não deve usar este parâmetro.
adminDistrict	A parte de subdivisão de país de um endereço, como WA. Se a consulta for fornecida, não deve usar este parâmetro.
adminDistrict2	O condado para o endereço estruturado, como King. Se a consulta for fornecida, não deve usar este parâmetro.
adminDistrict3	A área nomeada para o endereço estruturado. Se a consulta for fornecida, não deve usar este 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 uma de código de região/país ISO 3166-1 Alpha-2 de especificada, por exemplo, FR./ Se a consulta for fornecida, não deve usar este parâmetro.
locality	A parte da localidade de um endereço, como Seattle. Se a consulta for fornecida, não deve usar este parâmetro.
postalCode	A parte do código postal de um endereço. Se a consulta for fornecida, não deve usar este 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 devolvidas. Padrão: 5, mínimo: 1 e máximo: 20.
view	Uma cadeia de caracteres que representa um código de região/país ISO 3166-1 Alpha-2 . Isso alterará fronteiras e rótulos disputados geopoliticamente para se alinhar com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Auto", mesmo que você não o tenha definido na solicitação. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Detalhes de Propriedade

addressLine

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

Se a consulta for fornecida, não deve usar este parâmetro.

addressLine?: string

Valor de Propriedade

string

adminDistrict

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

Se a consulta for fornecida, não deve usar este parâmetro.

adminDistrict?: string

Valor de Propriedade

string

adminDistrict2

O condado para o endereço estruturado, como King.

Se a consulta for fornecida, não deve usar este parâmetro.

adminDistrict2?: string

Valor de Propriedade

string

adminDistrict3

A área nomeada para o endereço estruturado.

Se a consulta for fornecida, não deve usar este parâmetro.

adminDistrict3?: string

Valor de 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 de 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 de Propriedade

number[]

countryRegion

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

Se a consulta for fornecida, não deve usar este parâmetro.

countryRegion?: string

Valor de Propriedade

string

locality

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

Se a consulta for fornecida, não deve usar este parâmetro.

locality?: string

Valor de Propriedade

string

postalCode

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

Se a consulta for fornecida, não deve usar este parâmetro.

postalCode?: string

Valor de 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 de Propriedade

string

top

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

top?: number

Valor de Propriedade

number

view

Uma cadeia de caracteres que representa um código de região/país ISO 3166-1 Alpha-2 . Isso alterará fronteiras e rótulos disputados geopoliticamente para se alinhar com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Auto", mesmo que você não o tenha definido na solicitação.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

view?: string

Valor de Propriedade

string