Share via

Search - Get Search Address

  • Referência
Service:
Maps
API Version:
1.0

Utilizado para obter coordenadas de latitude e longitude de um endereço de rua num formato de entrada não estruturado ou de consulta.

A Get Search Address API é um pedido HTTP GET que devolve as coordenadas de latitude e longitude quando transmitidas num endereço de rua ou nome de um local como critérios de pesquisa.

Em muitos casos, o serviço de pesquisa completo pode ser demasiado, por exemplo, se apenas estiver interessado na geocodificação tradicional. Pesquisa também pode ser acedido para pesquisa exclusiva de endereços. A geocodificação é efetuada ao atingir o ponto final de geocódigo apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado relativamente a tudo o que estiver acima dos dados de nível de rua. Não serão devolvidas poIs. Tenha em atenção que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Também tratará de tudo, desde ruas ou cruzamentos exatos, bem como geografias de nível superior, como centros da cidade, concelhos, estados, etc.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
With optional parameters: 
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parâmetros do URI

Name Em Necessário Tipo Description
format
 path True

ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.
api-version
 query True

string

Número da versão da API Azure Maps.
query
 query True

string

O endereço a procurar (por exemplo, "1 microsoft way, Redmond, WA"), tem de estar codificado corretamente com URL.
btmRight
 query

string

Posição inferior direita da caixa delimitadora. Por exemplo, 37,553,-122,453
countrySet
 query

string[]

Cadeia separada por vírgulas de códigos de país/região, por exemplo FR, ES. Isto irá limitar a pesquisa aos países/regiões especificados
entityType
 query

GeographicEntityType

Especifica o nível de filtragem efetuado em geografias. Limita a pesquisa de tipos de entidades geográficas especificados, por exemplo, devolver apenas o município. A resposta resultante conterá o ID geográfico, bem como o tipo de entidade correspondente. Se fornecer mais do que uma entidade como uma lista separada por vírgulas, o ponto final devolverá a "entidade mais pequena disponível". O ID de Geometria devolvido pode ser utilizado para obter a geometria dessa geografia através da API Get Pesquisa Polygon. Os seguintes parâmetros são ignorados quando entityType é definido:

  • cabeçalho
  • número
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
 query

SearchIndexes[]

Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Ponto

POI = Pontos de Interesse

Str = Streets

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (por qualquer ordem) ou Nenhum para nenhum índice.

Por predefinição, os códigos postais expandidos estão incluídos para todos os índices, exceto Geo. As listas de códigos postais alargados para geografias podem ser bastante longas, pelo que têm de ser explicitamente pedidas quando necessário.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal alargado é devolvido como uma propriedade extendedPostalCode de um endereço. A disponibilidade é dependente da região.
language
 query

string

Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido.

Consulte idiomas suportados para obter detalhes.
lat
 query

number

double

Latitude em que os resultados devem ser tendenciosos. Por exemplo, 37.337
limit
 query

integer

Número máximo de respostas que serão devolvidas. Predefinição: 10, mínimo: 1 e máximo: 100
lon
 query

number

double

Longitude em que os resultados devem ser tendenciosos. Por exemplo, -121,89
ofs
 query

integer

A iniciar o desvio dos resultados devolvidos no conjunto de resultados completo. Predefinição: 0
radius
 query

integer

O raio em metros para para que os resultados sejam restritos à área definida
topLeft
 query

string

Posição superior esquerda da caixa delimitadora. Por exemplo, 37,553,-122,453
typeahead
 query

boolean

Booleano. Se o sinalizador typeahead estiver definido, a consulta será interpretada como uma entrada parcial e a pesquisa entrará no modo preditivo
view
 query

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

SearchAddressResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Nota

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .
  • O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID.
  • O controlo de acesso baseado em funções do Azure é configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
  • Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Sample Request

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Sample Response

Status code:
200 
{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definições

Name Description
Address

O endereço do resultado
AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços.
BoundingBox

O viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport.
BoundingBoxCompassNotation

A caixa delimitadora da localização.
Brand

A marca associada ao POI
Classification

A classificação do POI que está a ser devolvido
ClassificationName

Nome da classificação
DataSources

Secção opcional. IDs de referência para utilização com a API Get Pesquisa Polygon.
Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.
EntryPoint

O ponto de entrada para o POI que está a ser devolvido.
EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
GeographicEntityType

Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.
Geometry

Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.
LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.
MatchType

Tipos de correspondência para uma operação de pesquisa de endereços inversos.
OperatingHours

Horário de abertura de um POI (Pontos de Interesse).
OperatingHoursTime

Representa uma data e hora
OperatingHoursTimeRange

Intervalo de tempo de abertura de um dia
PointOfInterest

Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações.
PointOfInterestCategorySet

Categoria POI
QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.
ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.
SearchAddressResult

Este objeto é devolvido a partir de uma Pesquisa chamadas com êxito.
SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.
SearchAddressResultType

Um dos seguintes:

  • POI
  • Rua
  • Geografia
  • Endereço de Ponto
  • Intervalo de Endereços
  • Cross Street
SearchIndexes

Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Ponto

POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (por qualquer ordem) ou Nenhum para nenhum índice.

Por predefinição, os códigos postais expandidos estão incluídos para todos os índices, exceto Geo. As listas de códigos postais alargados para geografias podem ser bastante longas, pelo que têm de ser explicitamente pedidas quando necessário.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal alargado é devolvido como uma propriedade extendedPostalCode de um endereço. A disponibilidade é dependente da região.
SearchSummary

Objeto de resumo para uma resposta da API Pesquisa.

Address

O endereço do resultado

Name Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora da localização.
buildingNumber

string

O número do edifício na rua. PRETERIDO, utilize streetNumber em vez disso.
country

string

nome do país/região
countryCode

string

País (Nota: este é um código de duas letras, não um nome de país/região.)
countryCodeISO3

string

Código de país alfa-3 ISO
countrySecondarySubdivision

string

Concelho
countrySubdivision

string

Distrito
countrySubdivisionCode

string

countrySubdivisionCode prefixado por countryCode ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para Texas, SCT para a Escócia e ON para Ontário.
countrySubdivisionName

string

O nome completo de um primeiro nível de hierarquia administrativa de país/região. Este campo só aparece no caso de countrySubdivision ser apresentado num formulário abreviado. Apenas suportado pelos EUA, Canadá e Reino Unido.
countryTertiarySubdivision

string

Área Nomeada
crossStreet

string

O nome da rua a ser atravessada.
extendedPostalCode

string

Código postal alargado (a disponibilidade depende da região).
freeformAddress

string

Uma linha de endereço formatada de acordo com as regras de formatação do país/região de origem de um Resultado ou, no caso de um país/região, o nome completo do país/região.
localName

string

Um componente de endereço que representa o nome de uma área geográfica ou localidade que agrupa vários objetos endereçáveis para fins de endereçamento, sem ser uma unidade administrativa. Este campo é utilizado para criar a freeformAddress propriedade. localName representa o município postal. Consoante a localização, localName é o nome mais conhecido de uma cidade ou cidade. Para o nome mais conhecido de uma cidade ou cidade, utilize localName em vez de municipality.
municipality

string

Cidade/Cidade
Nota: municipality representa o município residencial. Consoante a localização, o municipality valor pode diferir do nome mais conhecido de uma cidade ou cidade. Para o nome mais conhecido da cidade ou cidade, sugere-se que o localName valor seja utilizado em vez do municipality valor.
municipalitySubdivision

string

Sub/Super Cidade
neighbourhood

string

Um Bairro é uma área geograficamente localizada dentro de uma cidade ou cidade com características distintas e interações sociais entre habitantes.
postalCode

string

Código Postal/Código Postal
routeNumbers

string[]

Os códigos utilizados para identificar de forma inequívoca a rua
street

string

O nome da rua. Preterido, utilize streetName em vez disso.
streetName

string

O nome da rua.
streetNameAndNumber

string

O nome e o número da rua.
streetNumber

string

O número do edifício na rua.

AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços.

Name Tipo Description
from

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
rangeLeft

string

Intervalo de endereços no lado esquerdo da rua.
rangeRight

string

Intervalo de endereços no lado direito da rua.
to

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".

BoundingBox

O viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport.

Name Tipo Description
btmRightPoint

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".

BoundingBoxCompassNotation

A caixa delimitadora da localização.

Name Tipo Description
entity

Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.
northEast

string

Latitude nordeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas
southWest

string

Latitude sudoeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas

Brand

A marca associada ao POI

Name Tipo Description
name

string

Nome da marca

Classification

A classificação do POI que está a ser devolvido

Name Tipo Description
code

string

Propriedade de código
names

ClassificationName[]

Matriz de nomes

ClassificationName

Nome da classificação

Name Tipo Description
name

string

Propriedade Nome
nameLocale

string

Propriedade Região do Nome

DataSources

Secção opcional. IDs de referência para utilização com a API Get Pesquisa Polygon.

Name Tipo Description
geometry

Geometry

Informações sobre a forma geométrica do resultado. Apenas presente se o tipo == Geografia.

Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.

Name Tipo Description
position

string

Entidade de posição

EntryPoint

O ponto de entrada para o POI que está a ser devolvido.

Name Tipo Description
position

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
type

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.

Name Tipo Description
main

string

minor

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.

Name Tipo Description
Country

string

nome do país/região
CountrySecondarySubdivision

string

Concelho
CountrySubdivision

string

Distrito
CountryTertiarySubdivision

string

Área Nomeada
Municipality

string

Cidade/Cidade
MunicipalitySubdivision

string

Sub/Super Cidade
Neighbourhood

string

Bairro
PostalCodeArea

string

Código Postal/Código Postal

Geometry

Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.

Name Tipo Description
id

string

Transmita-o como geometryId à API Get Pesquisa Polygon para obter informações de geometria para este resultado.

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".

Name Tipo Description
lat

number

Propriedade Latitude
lon

number

Propriedade Longitude

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

Name Tipo Description
AE

string

Emirados Árabes Unidos (Vista Árabe)
AR

string

Argentina (Vista Argentina)
Auto

string

Devolva os dados do mapa com base no endereço IP do pedido.
BH

string

Bahrein (Vista Árabe)
IN

string

Índia (Vista Indiana)
IQ

string

Iraque (Vista Árabe)
JO

string

Jordânia (Vista Árabe)
KW

string

Kuwait (Vista Árabe)
LB

string

Líbano (Vista Árabe)
MA

string

Marrocos (Vista Marroquina)
OM

string

Omã (Vista Árabe)
PK

string

Paquistão (Vista Paquistanesa)
PS

string

Autoridade Palestiniana (Vista Árabe)
QA

string

Qatar (Vista Árabe)
SA

string

Arábia Saudita (Vista Árabe)
SY

string

Síria (Vista Árabe)
Unified

string

Vista Unificada (Outros)
YE

string

Iémen (Vista Árabe)

MatchType

Tipos de correspondência para uma operação de pesquisa de endereços inversos.

Name Tipo Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Horário de abertura de um POI (Pontos de Interesse).

Name Tipo Description
mode

string

Valor utilizado no pedido: nenhum ou "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Lista de intervalos de tempo para os próximos 7 dias

OperatingHoursTime

Representa uma data e hora

Name Tipo Description
date

string

Representa a data atual do calendário no fuso horário POI, por exemplo, "2019-02-07".
hour

integer

As horas estão no formato de 24 horas na hora local de um POI; os valores possíveis são 0 - 23.
minute

integer

Os minutos estão na hora local de um POI; os valores possíveis são 0 - 59.

OperatingHoursTimeRange

Intervalo de tempo de abertura de um dia

Name Tipo Description
endTime

OperatingHoursTime

O ponto no intervalo de 7 dias seguintes quando um determinado POI está a ser fechado ou o início do intervalo se tiver sido fechado antes do intervalo.
startTime

OperatingHoursTime

O ponto no intervalo de 7 dias seguintes quando um determinado POI está a ser aberto ou o início do intervalo, se tiver sido aberto antes do intervalo.

PointOfInterest

Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações.

Name Tipo Description
brands

Brand[]

Matriz de marcas. O nome da marca para o POI que está a ser devolvido.
categories

string[]

Matriz de categorias
categorySet

PointOfInterestCategorySet[]

A lista das categorias POI mais específicas
classifications

Classification[]

Matriz de classificação
name

string

Nome da propriedade POI
openingHours

OperatingHours

Horário de funcionamento de um POI (Pontos de Interesse).
phone

string

Propriedade número de telefone
url

string

Propriedade URL do Site

PointOfInterestCategorySet

Categoria POI

Name Tipo Description
id

integer

ID da Categoria

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

Name Tipo Description
NEARBY

string

Pesquisa foi realizada em torno de uma determinada latitude e longitude com um raio definido
NON_NEAR

string

Pesquisa foi realizada globalmente, sem distorção para uma determinada latitude e longitude, e nenhum raio definido

ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.

Name Tipo Description
json

string

O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript
xml

string

O Idioma de Marcação Extensível

SearchAddressResult

Este objeto é devolvido a partir de uma Pesquisa chamadas com êxito.

Name Tipo Description
results

SearchAddressResultItem[]

Uma lista de resultados da API Pesquisa.
summary

SearchSummary

Objeto de resumo para uma resposta da API Pesquisa

SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.

Name Tipo Description
address

Address

O endereço do resultado
addressRanges

AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços.
dataSources

DataSources

Secção opcional. ID de geometria de referência para utilização com a API Get Pesquisa Polygon.
detourTime

integer

Tempo de desvio em segundos. Apenas devolvidas para chamadas à API de Pesquisa Ao Longo da Rota.
dist

number

Distância de linha reta entre o resultado e a localização geobias em metros.
entityType

GeographicEntityType

Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.
entryPoints

EntryPoint[]

Matriz de EntryPoints. Estes descrevem os tipos de entradas disponíveis na localização. O tipo pode ser "principal" para entradas principais, como uma porta da frente, ou um lobby, e "menor", para portas laterais e traseiras.
id

string

Propriedade ID
info

string

Informações sobre a origem de dados original do Resultado. Utilizado para pedidos de suporte.
matchType

MatchType

Informações sobre o tipo de correspondência.

Um dos seguintes:

  • AddressPoint
  • HouseNumberRange
  • Rua
poi

PointOfInterest

Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações.
position

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
score

number

O valor dentro de um conjunto de resultados para indicar a classificação correspondente relativa entre os resultados. Pode utilizá-lo para determinar que o resultado x tem duas vezes mais probabilidades de ser tão relevante como o resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e destinam-se apenas a um valor relativo para um conjunto de resultados.
type

SearchAddressResultType

Um dos seguintes:

  • POI
  • Rua
  • Geografia
  • Endereço de Ponto
  • Intervalo de Endereços
  • Cross Street
viewport

BoundingBox

O viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport.

SearchAddressResultType

Um dos seguintes:

  • POI
  • Rua
  • Geografia
  • Endereço de Ponto
  • Intervalo de Endereços
  • Cross Street
Name Tipo Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Ponto

POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (por qualquer ordem) ou Nenhum para nenhum índice.

Por predefinição, os códigos postais expandidos estão incluídos para todos os índices, exceto Geo. As listas de códigos postais alargados para geografias podem ser bastante longas, pelo que têm de ser explicitamente pedidas quando necessário.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal alargado é devolvido como uma propriedade extendedPostalCode de um endereço. A disponibilidade é dependente da região.

Name Tipo Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Objeto de resumo para uma resposta da API Pesquisa.

Name Tipo Description
fuzzyLevel

integer

O nível máximo difuso necessário para fornecer Resultados.
geoBias

LatLongPairAbbreviated

Indicação quando o motor de busca interno aplicou um desvio geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isto pode ser afetado ao definir os parâmetros lat e lon sempre que disponíveis. Noutros casos, é puramente interno.
limit

integer

Número máximo de respostas que serão devolvidas
numResults

integer

Número de resultados na resposta.
offset

integer

O desvio inicial dos Resultados devolvidos no conjunto de Resultados completo.
query

string

O parâmetro de consulta que foi utilizado para produzir estes resultados de pesquisa.
queryTime

integer

Tempo gasto a resolver a consulta, em milissegundos.
queryType

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.
totalResults

integer

O número total de Resultados encontrados.