Search - Get Search Address

Serviço:: Maps

Versão da API:: 1.0

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

A API Get Search Address é uma solicitação HTTP GET retorna as coordenadas de latitude e longitude quando passadas em um endereço ou nome de um lugar como critério de pesquisa.

Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. A pesquisa também pode ser acessada para pesquisa de endereço exclusivamente. A geocodificação é realizada batendo no ponto final do geocódigo apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para tudo acima dos dados do nível da rua. Nenhum POI será devolvido. Note que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços exatos de ruas ou ruas ou cruzamentos, bem como geografias de nível superior, como centros de cidades, condados, estados, etc.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}

Com parâmetros opcionais:

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 desejado da resposta. O valor pode ser json ou xml.
api-version	query	True	string	Número da versão da API do Azure Maps.
query	query	True	string	O endereço a ser pesquisado (por exemplo, "1 Microsoft way, Redmond, WA") deve ser codificado corretamente por URL.
btmRight	query		string	Posição inferior direita da caixa delimitadora. Por exemplo, 37.553,-122.453
countrySet	query		string[]	Cadeia de códigos de país/região separada por vírgula, por exemplo, FR,ES. Isso limitará a pesquisa aos países/regiões especificados
entityType	query		GeographicEntityType	Especifica o nível de filtragem executado em geografias. Reduz a pesquisa de tipos de entidades geográficas especificadas, por exemplo, retornar apenas município. A resposta resultante conterá o ID geográfico, bem como o tipo de entidade correspondente. Se você fornecer mais de uma entidade como uma lista separada por vírgula, o ponto de extremidade retornará a 'menor entidade disponível'. A ID de geometria retornada pode ser usada para obter a geometria dessa geografia por meio da API Obter Polígono de Pesquisa. Os seguintes parâmetros são ignorados quando entityType é definido: cabeçalho número regressoUtilização da estrada returnSpeedLimit utilização da estrada 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 Pontos POI = Pontos de Interesse Str = Ruas XStr = Ruas transversais (cruzamentos) O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice. Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas alargadas de códigos postais para geografias podem ser bastante longas, pelo que têm de ser explicitamente solicitadas quando necessário. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=Nenhum O código postal estendido é devolvido como um código postal estendido propriedade de um endereço. A disponibilidade depende da região.
language	query		string	Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte de idiomas suportados para obter detalhes.
lat	query		number (double)	Latitude onde os resultados devem ser tendenciosos. Por exemplo, 37.337
limit	query		integer minimum: 1 maximum: 100	Número máximo de respostas que serão devolvidas. Padrão: 10, mínimo: 1 e máximo: 100
lon	query		number (double)	Longitude onde os resultados devem ser tendenciosos. Por exemplo, -121,89
ofs	query		integer minimum: 0 maximum: 1900	Deslocamento inicial dos resultados retornados dentro do conjunto completo de resultados. Padrão: 0
radius	query		integer	O raio em metros para que os resultados sejam restringidos à á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 View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps.

Respostas

Name	Tipo	Description
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observação

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.
O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra.
O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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 um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.
BoundingBox	O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
BoundingBoxCompassNotation	A caixa delimitadora do local.
Brand	A marca associada ao POI
Classification	A classificação para o POI que está sendo devolvido
ClassificationName	Nome para a classificação
DataSources	Secção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.
Entity	Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição.
EntryPoint	O ponto de entrada para o POI que está sendo retornado.
EntryPointType	O tipo de ponto de entrada. O valor pode ser principal ou menor.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GeographicEntityType	Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível.
Geometry	Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.
LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
LocalizedMapView	O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.
MatchType	Tipos de correspondência para uma operação de pesquisa de endereço reverso.
OperatingHours	Horário de funcionamento de um POI (Pontos de Interesse).
OperatingHoursTime	Representa uma data e hora
OperatingHoursTimeRange	Intervalo de tempo aberto por um dia
PointOfInterest	Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
PointOfInterestCategorySet	Categoria POI
QueryType	O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR.
ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
SearchAddressResult	Este objeto é retornado de uma chamada de Pesquisa bem-sucedida.
SearchAddressResultItem	Objeto de resultado para uma resposta da API de pesquisa.
SearchAddressResultType	Um dos seguintes: POI Rua Geografia Endereço do ponto Intervalo de endereços Rua Cross
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 Pontos POI = Pontos de Interesse Str = Ruas XStr = Ruas transversais (cruzamentos) O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice. Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas alargadas de códigos postais para geografias podem ser bastante longas, pelo que têm de ser explicitamente solicitadas quando necessário. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=Nenhum O código postal estendido é devolvido como um código postal estendido propriedade de um endereço. A disponibilidade depende da região.
SearchSummary	Objeto de resumo para uma resposta da API de pesquisa.

Address

Object

O endereço do resultado

Name	Tipo	Description
boundingBox	BoundingBoxCompassNotation	A caixa delimitadora do local.
buildingNumber	string	O número do edifício na rua. DEPRECATED, use 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 ISO alpha-3 do país
countrySecondarySubdivision	string	Condado
countrySubdivision	string	Distrito
countrySubdivisionCode	string	`countrySubdivisionCode` prefixada por `countryCode` ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para o 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 aparece apenas no caso de paísSubdivisão ser apresentado de forma abreviada. Apenas suportado para EUA, Canadá e Reino Unido.
countryTertiarySubdivision	string	Área nomeada
crossStreet	string	O nome da rua que está sendo atravessada.
extendedPostalCode	string	Código postal estendido (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 é usado para construir a propriedade `freeformAddress`. `localName` representa o município postal. Dependendo da localização, `localName` é o nome comumente conhecido de uma cidade ou vila. Para o nome comumente conhecido de uma cidade ou vila, use `localName` em vez de `municipality`.
municipality	string	Cidade Nota: `municipality` representa o município residencial. Dependendo da localização, o valor `municipality` pode diferir do nome comumente conhecido de uma cidade ou vila. Para o nome comumente conhecido da cidade ou vila, sugere-se que o valor `localName` seja usado em vez do valor `municipality`.
municipalitySubdivision	string	Sub / Super Cidade
neighbourhood	string	Um Bairro é uma área geograficamente localizada dentro de uma cidade ou vila, com características distintas e interações sociais entre os habitantes.
postalCode	string	Código Postal / Código Postal
routeNumbers	string[]	Os códigos utilizados para identificar inequivocamente a rua
street	string	O nome da rua. DEPRECATED, use 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

Object

Descreve o intervalo de endereços em ambos os lados da rua para um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.

Name	Tipo	Description
from	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando 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	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.

BoundingBox

Object

O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

Name	Tipo	Description
btmRightPoint	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.

BoundingBoxCompassNotation

Object

A caixa delimitadora do local.

Name	Tipo	Description
entity	Entity	Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição.
northEast	string	latitude nordeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas
southWest	string	latitude sudoeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas

Brand

Object

A marca associada ao POI

Name	Tipo	Description
name	string	Nome da marca

Classification

Object

A classificação para o POI que está sendo devolvido

Name	Tipo	Description
code	string	Propriedade de Código
names	ClassificationName[]	Matriz de nomes

ClassificationName

Object

Nome para a classificação

Name	Tipo	Description
name	string	Propriedade Name
nameLocale	string	Propriedade Name Locale

DataSources

Object

Secção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.

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

Entity

Enumeração

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição.

Valor	Description
position	Entidade de posição

EntryPoint

Object

O ponto de entrada para o POI que está sendo retornado.

Name	Tipo	Description
position	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
type	EntryPointType	O tipo de ponto de entrada. O valor pode ser principal ou menor.

EntryPointType

Enumeração

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

Valor	Description
main
minor

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeographicEntityType

Enumeração

Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível.

Valor	Description
Country	Nome do país/região
CountrySubdivision	Distrito
CountrySecondarySubdivision	Condado
CountryTertiarySubdivision	Área nomeada
Municipality	Cidade
MunicipalitySubdivision	Sub / Super Cidade
Neighbourhood	Bairro
PostalCodeArea	Código Postal / Código Postal

Geometry

Object

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

Name	Tipo	Description
id	string	Passe isso como geometryId para o Get Search Polygon API para buscar informações de geometria para esse resultado.

LatLongPairAbbreviated

Object

Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.

Name	Tipo	Description
lat	number (double)	Propriedade Latitude
lon	number (double)	Propriedade Longitude

LocalizedMapView

Enumeração

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

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

Valor	Description
AE	Emirados Árabes Unidos (Vista árabe)
AR	Argentina (Vista Argentina)
BH	Bahrein (Vista árabe)
IN	Índia (Vista indiana)
IQ	Iraque (Vista árabe)
JO	Jordânia (Vista árabe)
KW	Kuwait (Vista árabe)
LB	Líbano (Vista árabe)
MA	Marrocos (Vista Marroquina)
OM	Omã (Vista árabe)
PK	Paquistão (Vista paquistanesa)
PS	Autoridade Palestiniana (Vista árabe)
QA	Qatar (Vista árabe)
SA	Arábia Saudita (Vista árabe)
SY	Síria (Vista árabe)
US	Estados Unidos da América
YE	Iémen (Vista árabe)
Auto	Retornar os dados do mapa com base no endereço IP da solicitação.
Unified	Modo de Exibição Unificado (Outros)

MatchType

Enumeração

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

Valor	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

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

Name	Tipo	Description
mode	string	Valor usado na solicitação: none ou "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista de intervalos de tempo para os próximos 7 dias

OperatingHoursTime

Object

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 no horário 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

Object

Intervalo de tempo aberto por um dia

Name	Tipo	Description
endTime	OperatingHoursTime	O ponto no próximo intervalo de 7 dias quando um determinado POI está sendo fechado, ou o início do intervalo se ele foi fechado antes do intervalo.
startTime	OperatingHoursTime	O ponto no intervalo de 7 dias seguintes quando um determinado POI está sendo aberto, ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

Object

Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.

Name	Tipo	Description
brands	Brand[]	Matriz de marcas. O nome da marca para o POI sendo devolvido.
categories	string[]	Matriz de categorias
categorySet	PointOfInterestCategorySet[]	A lista das categorias de 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 do número de telefone
url	string	Propriedade URL do site

PointOfInterestCategorySet

Object

Categoria POI

Name	Tipo	Description
id	integer	ID da categoria

QueryType

Enumeração

O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR.

Valor	Description
NEARBY	A pesquisa foi realizada em torno de uma determinada latitude e longitude com um raio definido
NON_NEAR	A pesquisa foi realizada globalmente, sem polarização para uma determinada latitude e longitude, e sem raio definido

ResponseFormat

Enumeração

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

Valor	Description
json	O formato de intercâmbio de dados de notação de objeto JavaScript
xml	A linguagem de marcação extensível

SearchAddressResult

Object

Este objeto é retornado de uma chamada de Pesquisa bem-sucedida.

Name	Tipo	Description
results	SearchAddressResultItem[]	Uma lista de resultados da API de pesquisa.
summary	SearchSummary	Objeto de resumo para uma resposta da API de Pesquisa

SearchAddressResultItem

Object

Objeto de resultado para uma resposta da API de 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 um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.
dataSources	DataSources	Secção opcional. ID de geometria de referência para uso com a API Obter Polígono de Pesquisa.
detourTime	integer	Tempo de desvio em segundos. Retornado somente para chamadas para a API Pesquisar ao longo da rota.
dist	number (double)	Distância em linha reta entre o resultado e a localização geográfica em metros.
entityType	GeographicEntityType	Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível.
entryPoints	EntryPoint[]	Matriz de EntryPoints. Estes descrevem os tipos de entradas disponíveis no local. 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 fonte de dados original do Resultado. Usado para solicitações de suporte.
matchType	MatchType	Informações sobre o tipo de correspondência. Um dos seguintes: Ponto de endereço CasaNúmeroGama Rua
poi	PointOfInterest	Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
position	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
score	number (double)	O valor dentro de um conjunto de resultados para indicar a pontuação correspondente relativa entre os resultados. Você pode usar isso para determinar que o resultado x tem duas vezes mais probabilidade de ser tão relevante quanto o resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e são apenas um valor relativo para um conjunto de resultados.
type	SearchAddressResultType	Um dos seguintes: POI Rua Geografia Endereço do ponto Intervalo de endereços Rua Cross
viewport	BoundingBox	O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

SearchAddressResultType

Enumeração

Um dos seguintes:

POI
Rua
Geografia
Endereço do ponto
Intervalo de endereços
Rua Cross

Valor	Description
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchIndexes

Enumeração

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 Pontos

POI = Pontos de Interesse

Str = Ruas

XStr = Ruas transversais (cruzamentos)

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

Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas alargadas de códigos postais para geografias podem ser bastante longas, pelo que têm de ser explicitamente solicitadas quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Nenhum

O código postal estendido é devolvido como um código postal estendido propriedade de um endereço. A disponibilidade depende da região.

Valor	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Object

Objeto de resumo para uma resposta da API de pesquisa.

Name	Tipo	Description
fuzzyLevel	integer	O nível máximo difuso necessário para fornecer Resultados.
geoBias	LatLongPairAbbreviated	Indicação de quando o motor de busca interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado pela definição dos parâmetros lat e lon, quando disponíveis. Noutros casos, é puramente interna.
limit	integer	Número máximo de respostas que serão devolvidas
numResults	integer	Número de resultados na resposta.
offset	integer	O deslocamento inicial dos Resultados retornados dentro do conjunto completo de Resultados.
query	string	O parâmetro de consulta que foi usado para produzir esses resultados de pesquisa.
queryTime	integer	Tempo gasto na resolução da consulta, em milissegundos.
queryType	QueryType	O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR.
totalResults	integer	O número total de Resultados encontrados.

Partilhar via

Search - Get Search Address

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Âmbitos

subscription-key

SAS Token

Exemplos

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

Pedido de amostra

Resposta da amostra

Definições

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary