Search - Get Search Address Structured

Referência

Service:: Maps

API Version:: 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 Get Search Address Structured API (Geocodificação de Endereço Estruturado) é uma solicitação HTTP GET que retorna coordenadas de latitude e longitude de um endereço de rua em um formato de entrada não estruturado ou de consulta.

O índice de pesquisa de geocodificação será consultado para obter tudo acima dos dados de nível de rua. Nenhuma POIs será retornada. Observe que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível mais alto, como centros municipais, condados, estados etc.

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

With optional parameters:

GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parâmetros de URI

Nome	Em	Obrigató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 de versão da API de Mapas Azure.
countryCode	query	True	string	A parte de código de 2 ou 3 letras ISO3166-1 país/região de um endereço. Por exemplo, EUA.
countrySecondarySubdivision	query		string	O país/região para o endereço estruturado
countrySubdivision	query		string	A parte da subdivisão de país/região de um endereço
countryTertiarySubdivision	query		string	A área nomeada para o endereço estruturado
crossStreet	query		string	O nome da rua cruzada para o endereço estruturado
entityType	query		GeographicEntityType	Especifica o nível de filtragem executado em geografias. Restringe a pesquisa de tipos de entidade geography especificados, por exemplo, retornar somente município. A resposta resultante conterá a ID de geografia, bem como o tipo de entidade correspondente. Se você fornecer mais de uma entidade como uma lista separada por vírgulas, 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 Pesquisa Polígono. Os seguintes parâmetros são ignorados quando entityType é definido: Indo número returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Índices para os quais os códigos postais estendidos 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 (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 de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de 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 Idiomas com suporte para obter detalhes.
limit	query		integer	Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100
municipality	query		string	A parte do município de um endereço
municipalitySubdivision	query		string	A subdivisão do município (sub/super cidade) para o endereço estruturado
ofs	query		integer	Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. Padrão: 0
postalCode	query		string	A parte do cep de um endereço
streetName	query		string	A parte do nome da rua de um endereço
streetNumber	query		string	A parte do número da rua de um endereço
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 geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo fornecerá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. 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 View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.

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

Observação

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas .
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 Microsoft Entra ID.
O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

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

Scopes

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

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

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

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiõ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 maneira mais segura do que a chave compartilhada.

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

Type: apiKey
In: header

Exemplos

Search address in Redmond, WA in structured form

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052

Sample Response

Status code:: 200

{
  "summary": {
    "query": "15127 98052 ne redmond wa",
    "queryType": "NON_NEAR",
    "queryTime": 57,
    "numResults": 1,
    "offset": 0,
    "totalResults": 34,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.30129317913035,
      "lon": -120.88247999999997
    }
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/37974392",
      "score": 8.074,
      "dist": 101274.64693865852,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
        "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 98052",
        "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

Nome	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. As coordenadas para os locais de início e término do intervalo de endereços estão incluídas.
BoundingBox	O visor que aborda o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
BoundingBoxCompassNotation	A caixa delimitadora do local.
Brand	A marca associada à POI
Classification	A classificação para a POI que está sendo retornada
ClassificationName	Nome da classificação
DataSources	Seção opcional. IDs de referência para uso com a API Obter Pesquisa Polígono.
Entity	Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, 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 main ou secundário.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GeographicEntityType	Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.
Geometry	Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geography.
LatLongPairAbbreviated	Um local representado como 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 geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo fornecerá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. 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 View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.
MatchType	Tipos de correspondência para uma operação de pesquisa de endereço reverso.
OperatingHours	Horário de funcionamento de uma POI (Pontos de Interesse).
OperatingHoursTime	Representa uma data e hora
OperatingHoursTimeRange	Abrir intervalo de tempo por um dia
PointOfInterest	Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.
PointOfInterestCategorySet	Categoria POI
QueryType	O tipo de consulta que está sendo retornado: NEARBY ou NON_NEAR.
ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
SearchAddressResult	Esse objeto é retornado de um Pesquisa chamadas bem-sucedidas.
SearchAddressResultItem	Objeto de resultado para uma resposta da API Pesquisa.
SearchAddressResultType	Um destes: POI Street Geografia Endereço de ponto Intervalo de Endereços Cruzamento
SearchIndexes	Índices para os quais os códigos postais estendidos 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 (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 de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
SearchSummary	Objeto summary para uma resposta da API Pesquisa.

Address

O endereço do resultado

Nome	Tipo	Description
boundingBox	BoundingBoxCompassNotation	A caixa delimitadora do local.
buildingNumber	string	O número do prédio na rua. PRETERIDO, use streetNumber em vez disso.
country	string	nome do país/região
countryCode	string	País (Observação: este é um código de duas letras, não um nome de país/região.)
countryCodeISO3	string	Código do país ISO alfa-3
countrySecondarySubdivision	string	Município
countrySubdivision	string	Estado ou Província
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 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. Esse campo aparece somente no caso de countrySubdivision ser apresentado em uma forma abreviada. Só há suporte 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, seu nome completo de 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. Esse campo é usado para compilar a `freeformAddress` propriedade . `localName` representa o município postal. Dependendo do local, `localName` é o nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido de uma cidade ou cidade, use `localName` em vez de `municipality`.
municipality	string	Cidade/Cidade Observação: `municipality` representa o município residencial. Dependendo do local, o `municipality` valor pode ser diferente do nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido da cidade ou cidade, é sugerido que o `localName` valor seja usado 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 os habitantes.
postalCode	string	Cep/Cep
routeNumbers	string[]	Os códigos usados para identificar de forma inequívoca a rua
street	string	O nome da rua. PRETERIDO, use streetName.
streetName	string	O nome da rua.
streetNameAndNumber	string	O nome e o número da rua.
streetNumber	string	O número do prédio na rua.

AddressRanges

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

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

BoundingBox

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

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

BoundingBoxCompassNotation

A caixa delimitadora do local.

Nome	Tipo	Description
entity	Entity	Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.
northEast	string	Latitude do Nordeste, coordenada de longitude da caixa delimitadora como floats separados por vírgulas
southWest	string	Latitude sudoeste, coordenada de longitude da caixa delimitadora como floats separados por vírgulas

Brand

A marca associada à POI

Nome	Tipo	Description
name	string	Nome da marca

Classification

A classificação para a POI que está sendo retornada

Nome	Tipo	Description
code	string	Propriedade do código
names	ClassificationName[]	Matriz de nomes

ClassificationName

Nome da classificação

Nome	Tipo	Description
name	string	Propriedade Name
nameLocale	string	Propriedade Localidade do Nome

DataSources

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

Nome	Tipo	Description
geometry	Geometry	Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geography.

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.

Nome	Tipo	Description
position	string	Posicionar entidade

EntryPoint

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

Nome	Tipo	Description
position	LatLongPairAbbreviated	Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
type	EntryPointType	O tipo de ponto de entrada. O valor pode ser main ou secundário.

EntryPointType

O tipo de ponto de entrada. O valor pode ser main ou secundário.

Nome	Tipo	Description
main	string
minor	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeographicEntityType

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

Nome	Tipo	Description
Country	string	nome do país/região
CountrySecondarySubdivision	string	Município
CountrySubdivision	string	Estado ou Província
CountryTertiarySubdivision	string	Área Nomeada
Municipality	string	Cidade/Cidade
MunicipalitySubdivision	string	Sub/Super Cidade
Neighbourhood	string	Bairro
PostalCodeArea	string	Cep/CEP

Geometry

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

Nome	Tipo	Description
id	string	Passe isso como geometryId para a API Get Pesquisa Polygon para buscar informações de geometria para esse resultado.

LatLongPairAbbreviated

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

Nome	Tipo	Description
lat	number	Propriedade Latitude
lon	number	Propriedade Longitude

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 geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo fornecerá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. 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 View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

Nome	Tipo	Description
AE	string	Emirados Árabes Unidos (Exibição Árabe)
AR	string	Argentina (Exibição Argentina)
Auto	string	Retornar os dados do mapa com base no endereço IP da solicitação.
BH	string	Bahrein (Exibição Árabe)
IN	string	Índia (Exibição Indiana)
IQ	string	Iraque (Exibição Árabe)
JO	string	Jordânia (Exibição Árabe)
KW	string	Kuwait (Exibição Árabe)
LB	string	Líbano (Exibição Árabe)
MA	string	Marrocos (Exibição Marroquina)
OM	string	Omã (Exibição Árabe)
PK	string	Paquistão (Exibição Paquistanesa)
PS	string	Autoridade Palestina (Exibição Árabe)
QA	string	Qatar (Exibição Árabe)
SA	string	Arábia Saudita (Exibição Árabe)
SY	string	Síria (Exibição Árabe)
Unified	string	Exibição Unificada (Outras)
YE	string	Iêmen (Exibição Árabe)

MatchType

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

Nome	Tipo	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

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

Nome	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

Representa uma data e hora

Nome	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 uma POI; os valores possíveis são 0 a 23.
minute	integer	Os minutos estão no horário local de uma POI; os valores possíveis são 0 a 59.

OperatingHoursTimeRange

Abrir intervalo de tempo por um dia

Nome	Tipo	Description
endTime	OperatingHoursTime	O ponto no intervalo de 7 dias seguinte quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo.
startTime	OperatingHoursTime	O ponto no intervalo de 7 dias seguinte quando uma determinada POI está sendo aberta ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

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

Nome	Tipo	Description
brands	Brand[]	Matriz de marcas. O nome da marca para a POI que está sendo retornada.
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 uma POI (Pontos de Interesse).
phone	string	Propriedade número de telefone
url	string	Propriedade URL do Site

PointOfInterestCategorySet

Categoria POI

Nome	Tipo	Description
id	integer	ID da categoria

QueryType

O tipo de consulta que está sendo retornado: NEARBY ou NON_NEAR.

Nome	Tipo	Description
NEARBY	string	Pesquisa foi executado em torno de uma certa latitude e longitude com um raio definido
NON_NEAR	string	Pesquisa foi executado globalmente, sem preconceitos para uma certa latitude e longitude, e nenhum raio definido

ResponseFormat

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

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

SearchAddressResult

Esse objeto é retornado de um Pesquisa chamadas bem-sucedidas.

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

SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.

Nome	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. As coordenadas para os locais de início e término do intervalo de endereços estão incluídas.
dataSources	DataSources	Seção opcional. ID de geometria de referência para uso com a API Obter Pesquisa Polígono.
detourTime	integer	Tempo de desvio em segundos. Retornado apenas para chamadas para a API 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 geography. Presente somente quando entityType foi solicitado e está disponível.
entryPoints	EntryPoint[]	Matriz de EntryPoints. Eles descrevem os tipos de entradas disponíveis no local. O tipo pode ser "main" para entradas main, 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 destes: AddressPoint HouseNumberRange Street
poi	PointOfInterest	Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.
position	LatLongPairAbbreviated	Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
score	number	O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usar isso para determinar que o resultado x tem duas vezes mais chances 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 destinados apenas como um valor relativo para um conjunto de resultados.
type	SearchAddressResultType	Um destes: POI Street Geografia Endereço de ponto Intervalo de Endereços Cruzamento
viewport	BoundingBox	O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

SearchAddressResultType

Um destes:

POI
Street
Geografia
Endereço de ponto
Intervalo de Endereços
Cruzamento

Nome	Tipo	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchIndexes

Índices para os quais os códigos postais estendidos 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 (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 de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

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

Nome	Tipo	Description
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	string

SearchSummary

Objeto summary para uma resposta da API Pesquisa.

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

Compartilhar via