Search - Get Search Fuzzy
Use quando precisar de uma solicitação de pesquisa que possa lidar com combinações de endereços e tokens POI.
A API Get Search Fuzzy (Pesquisa de Formulário Livre), uma solicitação http GET que lida perfeitamente com uma combinação de de pesquisa de POI e de geocodificação. É uma API de Pesquisa de Formulário Livre que lida com entradas difusas que contêm qualquer combinação de tokens de endereço ou POI como uma "pesquisa de linha única" canônica. Ele também pode ser ponderado com uma posição contextual (par lat/lon) ou totalmente restringido por uma coordenada e raio, ou pode ser executado de forma mais geral sem qualquer ponto de âncora de viés geográfico.
Recomendamos que você use o parâmetro 'countrySet' para especificar apenas os países/regiões para os quais seu aplicativo precisa de cobertura, pois o comportamento padrão será pesquisar o mundo inteiro, potencialmente retornando resultados desnecessários.
Por exemplo: countrySet=US,FR
Consulte de Cobertura de Pesquisa para obter uma lista completa de todos os países/regiões com suporte.
A maioria das consultas de Pesquisa usa como padrão maxFuzzyLevel=2 para obter desempenho e também reduzir resultados incomuns. Esse novo padrão pode ser substituído conforme necessário por solicitação passando o parâmetro de consulta maxFuzzyLevel=3 ou 4.
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&view={view}&openingHours=nextSevenDays
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
format
|
path | True |
Formato desejado da resposta. O valor pode ser json ou xml. |
|
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. |
|
query
|
query | True |
string |
A cadeia de caracteres de consulta aplicável (por exemplo, "seattle", "pizza"). Pode também ser especificada como uma cadeia de caracteres separada por vírgula composta por latitude seguida de longitude (por exemplo, "47,641268, -122,125679"). Deve ser codificado corretamente na URL. |
|
brand
|
query |
string[] |
Uma lista separada por vírgulas de marcas que podem ser usadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando várias marcas forem fornecidas, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. As marcas que contêm um "," em seu nome devem ser colocadas entre aspas. Exemplos de uso: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,Vírgula C",Barra |
|
|
btm
|
query |
string |
Posição inferior direita da caixa delimitadora. Por exemplo, 37.553,-122,453 |
|
|
category
|
query |
integer[] |
Uma lista separada por vírgulas de IDs de conjunto de categorias que pode ser usada para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de ID não importa. O número máximo de valores de
|
|
|
connector
|
query |
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Os tipos de conector disponíveis são:
Exemplos de uso: conjunto de conectores=IEC62196Tipo2CaboConector anexadoSet=IEC62196Tipo2Tomada,IEC62196Tipo2CaboAnexado |
||
|
country
|
query |
string[] |
Cadeia de caracteres separada por vírgulas de códigos de país/região, por exemplo, FR, ES. Isso limitará a pesquisa aos países/regiões especificados |
|
|
entity
|
query |
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 Polígono de Pesquisa. Os seguintes parâmetros são ignorados quando entityType é definido:
|
||
|
extended
|
query |
Í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 de 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, códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de códigos postais estendidas para geografias podem ser bastante 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. |
||
|
idx
|
query |
Uma lista separada por vírgulas de índices que devem ser utilizados para a pesquisa. A ordem do item não importa. Os índices disponíveis são: Addr = Interpolação de intervalo de endereços, Geo = Geografias, PAD = Endereços de Ponto, POI = Pontos de interesse, Str = Ruas, Xstr = Cross Streets (interseções) |
||
|
language
|
query |
string |
Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem 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. |
|
|
lat
|
query |
number (double) |
Latitude em que os resultados devem ser tendenciosos. Por exemplo, 37.337 |
|
|
limit
|
query |
integer minimum: 1maximum: 100 |
Número máximo de respostas que serão retornadas. Padrã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 |
|
|
max
|
query |
integer minimum: 1maximum: 4 |
Nível máximo de fuzziness a ser usado. Padrão: 2, mínimo: 1 e máximo: 4
O mecanismo de pesquisa começará a procurar uma correspondência no nível definido por minFuzzyLevel e interromperá a pesquisa no nível especificado por maxFuzzyLevel. |
|
|
min
|
query |
integer minimum: 1maximum: 4 |
Nível mínimo de difusa a ser usado. Padrão: 1, mínimo: 1 e máximo: 4
O mecanismo de pesquisa começará a procurar uma correspondência no nível definido por minFuzzyLevel e interromperá a pesquisa no nível especificado por maxFuzzyLevel. |
|
|
ofs
|
query |
integer minimum: 0maximum: 1900 |
Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. Padrão: 0 |
|
|
opening
|
query |
Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays |
||
|
radius
|
query |
integer |
O raio em metros para que os resultados sejam restritos à área definida |
|
|
top
|
query |
string |
Posição superior esquerda da caixa delimitadora. Por exemplo, 37.553,-122,453 |
|
|
typeahead
|
query |
boolean |
Se a flag de typeahead for ativada, a consulta será interpretada como uma entrada parcial e a busca entrará em modo preditivo. |
|
|
view
|
query |
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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 atenderá. 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 de seus 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 Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OKEY |
|
| Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.
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 controlar o acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas. - O
Authorization URLé específico para a instância de nuvem pública do Azure. 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 do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- O uso do SDK da Web do do 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 a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
query
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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 expiração, taxa e região(s) 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 protegida 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 de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Search City Seattle
Solicitação de exemplo
GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays
Resposta de exemplo
{
"summary": {
"query": "seattle",
"queryType": "NON_NEAR",
"queryTime": 66,
"numResults": 10,
"offset": 0,
"totalResults": 3720,
"fuzzyLevel": 1
},
"results": [
{
"type": "Geography",
"id": "US/GEO/p0/188055",
"score": 2.531,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60323,
"lon": -122.33028
},
"viewport": {
"topLeftPoint": {
"lat": 47.7344,
"lon": -122.4594
},
"btmRightPoint": {
"lat": 47.48106,
"lon": -122.22497
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-0000596ae8ed"
}
}
},
{
"type": "Geography",
"id": "US/GEO/p0/183911",
"score": 2.382,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.55342,
"lon": -122.25007
},
"viewport": {
"topLeftPoint": {
"lat": 47.58995,
"lon": -122.26723
},
"btmRightPoint": {
"lat": 47.5169,
"lon": -122.23291
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-00006553f33d"
}
}
},
{
"type": "POI",
"id": "ZA/POI/p0/449288",
"score": 2.226,
"info": "search:ta:710009004165863-ZA",
"poi": {
"name": "Seattle Coffee Co - Groote Kerk Sentrum",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Kloof Street",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "8001",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
"localName": "Gardens"
},
"position": {
"lat": -33.92917,
"lon": 18.41178
},
"viewport": {
"topLeftPoint": {
"lat": -33.92827,
"lon": 18.4107
},
"btmRightPoint": {
"lat": -33.93007,
"lon": 18.41286
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.92907,
"lon": 18.41162
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/449396",
"score": 2.226,
"info": "search:ta:710009004163591-ZA",
"poi": {
"name": "Seattle Coffee Co - Pietermaritzburg",
"phone": "+(27)-(33)-3458486",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "9",
"streetName": "Armitage Road",
"municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
"municipality": "Pietermaritzburg",
"countrySecondarySubdivision": "The Msunduzi",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "3201",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
"localName": "Athlone"
},
"position": {
"lat": -29.58611,
"lon": 30.37508
},
"viewport": {
"topLeftPoint": {
"lat": -29.58521,
"lon": 30.37405
},
"btmRightPoint": {
"lat": -29.58701,
"lon": 30.37611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -29.58668,
"lon": 30.37531
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/451868",
"score": 2.226,
"info": "search:ta:710009002195538-ZA",
"poi": {
"name": "Seattle Coffee Co - Bedford Village",
"phone": "+(27)-(84)-5451111",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Van Buuren Road",
"municipalitySubdivision": "Bedfordview",
"municipality": "Germiston",
"countrySecondarySubdivision": "Ekurhuleni",
"countrySubdivisionCode": "Gauteng",
"postalCode": "2007",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
"localName": "Bedfordview"
},
"position": {
"lat": -26.18009,
"lon": 28.13544
},
"viewport": {
"topLeftPoint": {
"lat": -26.17919,
"lon": 28.13444
},
"btmRightPoint": {
"lat": -26.18099,
"lon": 28.13644
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -26.18006,
"lon": 28.13636
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/488888",
"score": 2.226,
"info": "search:ta:710009002102639-ZA",
"poi": {
"name": "Seattle Coffee Co - Caltex Starstop Milly's",
"phone": "+(27)-(13)-2560340",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipality": "Wonderfontein",
"countrySecondarySubdivision": "Emakhazeni",
"countrySubdivisionCode": "Mpumalanga",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
},
"position": {
"lat": -25.68842,
"lon": 30.21291
},
"viewport": {
"topLeftPoint": {
"lat": -25.68752,
"lon": 30.21191
},
"btmRightPoint": {
"lat": -25.68932,
"lon": 30.21391
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -25.68913,
"lon": 30.21343
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489433",
"score": 2.226,
"info": "search:ta:710009002184068-ZA",
"poi": {
"name": "Seattle Coffee Co - Southcoast Mall",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79937,
"lon": 30.40569
},
"viewport": {
"topLeftPoint": {
"lat": -30.79847,
"lon": 30.40464
},
"btmRightPoint": {
"lat": -30.80027,
"lon": 30.40674
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.7994,
"lon": 30.40618
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489976",
"score": 2.226,
"info": "search:ta:710009004261897-ZA",
"poi": {
"name": "Seattle Cofee Co",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79801,
"lon": 30.40557
},
"viewport": {
"topLeftPoint": {
"lat": -30.79711,
"lon": 30.40452
},
"btmRightPoint": {
"lat": -30.79891,
"lon": 30.40662
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.79784,
"lon": 30.40523
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/490056",
"score": 2.226,
"info": "search:ta:710009004149612-ZA",
"poi": {
"name": "Seattle Coffee Co - Constantia Village",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Constantia Main Road",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7708",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
"localName": "Constantia"
},
"position": {
"lat": -34.02087,
"lon": 18.44503
},
"viewport": {
"topLeftPoint": {
"lat": -34.01997,
"lon": 18.44394
},
"btmRightPoint": {
"lat": -34.02177,
"lon": 18.44612
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -34.02017,
"lon": 18.44476
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/494340",
"score": 2.226,
"info": "search:ta:710009004152570-ZA",
"poi": {
"name": "Seattle Coffee Co - Canal Walk Shopping Centre",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Century Boulevard",
"municipalitySubdivision": "Milnerton",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7441",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
"localName": "Century City"
},
"position": {
"lat": -33.89348,
"lon": 18.5122
},
"viewport": {
"topLeftPoint": {
"lat": -33.89258,
"lon": 18.51112
},
"btmRightPoint": {
"lat": -33.89438,
"lon": 18.51328
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.8943,
"lon": 18.51328
}
}
]
}
]
}
Definições
| Nome | Description |
|---|---|
| Address |
O endereço do resultado. |
|
Address |
Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas. |
|
Bounding |
O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor. |
|
Bounding |
A caixa delimitadora do local. |
| Brand |
A marca associada à POI |
| Classification |
A classificação para a POI que está sendo retornada |
|
Classification |
Nome da classificação |
|
Data |
Seção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa. |
|
Electric |
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Os tipos de conector disponíveis são:
Exemplos de uso: conjunto de conectores=IEC62196Tipo2CaboConector anexadoSet=IEC62196Tipo2Tomada,IEC62196Tipo2CaboAnexado |
| Entity |
Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição. |
|
Entry |
O ponto de entrada para a POI que está sendo retornada. |
|
Entry |
O tipo de ponto de entrada. O valor pode ser principal ou secundária. |
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Geographic |
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 == Geografia. |
|
Lat |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
Localized |
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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 atenderá. 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 de seus 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 Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
|
Match |
Tipos de correspondência para uma operação de pesquisa de endereço reverso. |
|
Operating |
Horário de funcionamento para uma POI (Pontos de Interesse). |
|
Operating |
Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays |
|
Operating |
Representa uma data e hora |
|
Operating |
Abrir intervalo de tempo por um dia |
|
Point |
Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações. |
|
Point |
Categoria poi |
|
Query |
O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR. Importante: Esta propriedade está obsoleta e pode ser omitida na resposta. |
|
Response |
Formato desejado da resposta. O valor pode ser json ou xml. |
|
Search |
Esse objeto é retornado de chamadas de pesquisa bem-sucedidas. |
|
Search |
Objeto de resultado para uma resposta da API de Pesquisa. |
|
Search |
Um destes:
|
|
Search |
Í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 de 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, códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de códigos postais estendidas para geografias podem ser bastante 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. |
|
Search |
Objeto resumo de uma resposta da API de Pesquisa. |
Address
O endereço do resultado.
| Nome | Tipo | Description |
|---|---|---|
| boundingBox |
Define a caixa delimitadora do local. Essa propriedade só é retornada pelas APIs reversas de endereço de pesquisa. Todas as outras APIs de Pesquisa retornam a |
|
| buildingNumber |
string |
O número do prédio na rua.
Importante: Essa propriedade foi descontinuada. Use |
| country |
string |
O nome do país/região. |
| countryCode |
string |
Um código alfabético de duas letras definido pela norma ISO 3166-1 Alpha-2 para representar um país/região e territórios dependentes. |
| countryCodeISO3 |
string |
Um código alfabético de três letras definido pela norma ISO 3166-1 Alpha-3 para representar um país/região e territórios dependentes. |
| countrySecondarySubdivision |
string |
A divisão administrativa de segundo nível dentro de um país/região. Identifica uma subdivisão que está abaixo da subdivisão principal, como estado ou província, mas acima de unidades menores, como municípios ou bairros. Exemplos incluem County nos Estados Unidos e District no Reino Unido. |
| countrySubdivision |
string |
A principal divisão administrativa dentro de um país, como um estado, província. Ele é usado para representar a subdivisão de primeiro nível abaixo do nível nacional. |
| countrySubdivisionCode |
string |
Essa propriedade não está disponível na |
| countrySubdivisionName |
string |
Representa o nome completo da divisão administrativa de primeiro nível (como estado, província ou região) dentro de um país ou região. Essa propriedade é incluída apenas quando o |
| countryTertiarySubdivision |
string |
A divisão administrativa de terceiro nível dentro de um país/região. Ele oferece uma granularidade ainda mais fina do que a subdivisão secundária (como condado ou distrito). Exemplos incluem municípios como cidade, vila, vila, vila ou município e bairros de uma área geográfica menor e informal dentro de um município, como Capitol Hill, Green Lake e Wallingford em Seattle. |
| crossStreet |
string |
O nome da rua que está sendo atravessada. Essa propriedade está disponível apenas na |
| extendedPostalCode |
string |
Um código postal estendido refere-se a um formato de código postal que vai além do conjunto padrão de dígitos para fornecer maior precisão de localização. É comumente usado em sistemas como o código U.S. ZIP+4 ou formatos estendidos similares em outros países/regiões. A disponibilidade depende da região. Não disponível na |
| freeformAddress |
string |
Uma linha de endereço formatada de acordo com as regras de formatação do país/região de origem do resultado, ou, no caso de um país/região, seu 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. Esse campo é usado para criar a propriedade |
| municipality |
string |
Cidade/Cidade |
| municipalitySubdivision |
string |
Uma subdivisão dentro de um município. Representa uma unidade administrativa ou geográfica menor dentro de uma cidade, vila ou outra entidade municipal. |
| 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 |
Uma série de números ou letras (ou ambos) adicionados a um endereço para ajudar a identificar uma área geográfica específica. Um CEP é a versão dos EUA de um CEP; outros países/regiões usam outros formatos como CEP, PIN e PLZ. |
| routeNumbers |
string[] |
Os códigos usados para identificar a rua de forma inequívoca. Disponível apenas para as APIs de Reversão de Endereço de Pesquisa. |
| street |
string |
O nome da rua.
Importante: Essa propriedade foi descontinuada. Use |
| streetName |
string |
O nome da rua. |
| streetNameAndNumber |
string |
O nome e o número da rua. Disponível apenas para as APIs de Reversão de Endereço de Pesquisa. |
| streetNumber |
string |
O número do prédio na rua. Não disponível na |
AddressRanges
Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas.
| Nome | Tipo | Description |
|---|---|---|
| from |
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 |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
BoundingBox
O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
| Nome | Tipo | Description |
|---|---|---|
| btmRightPoint |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
| topLeftPoint |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
BoundingBoxCompassNotation
A caixa delimitadora do local.
| Nome | Tipo | Description |
|---|---|---|
| entity |
Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição. |
|
| northEast |
string |
Latitude nordeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas |
| southWest |
string |
Latitude sudoeste, coordenada 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 Code |
| names |
Matriz de nomes |
ClassificationName
Nome da classificação
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
Propriedade Name |
| nameLocale |
string |
Propriedade Name Locale |
DataSources
Seção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.
| Nome | Tipo | Description |
|---|---|---|
| geometry |
Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia. |
ElectricVehicleConnector
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados.
Os tipos de conector disponíveis são:
-
StandardHouseholdCountrySpecific- Estes são os conectores domésticos padrão para uma determinada região. Todas elas são uma única fase ac e a tensão padrão e o amperamento padrão. Veja também: tipos de soquete & plug – Padrões Mundiais. -
IEC62196Type1- Conector tipo 1 conforme definido no padrão IEC 62196-2. Também chamado yazaki após o fabricante original ou SAE J1772 após o padrão que o publicou pela primeira vez. Usado principalmente em combinação com a fase única de 120V ou até 240V de infraestrutura de fase única. -
IEC62196Type1CCS- Conector de combinação baseado no tipo 1, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 1, conforme definido no padrão IEC 62196-2, com dois contatos dc (corrente direta) adicionais para permitir o carregamento rápido de DC. -
IEC62196Type2CableAttached- Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plug anexado ao ponto de carregamento. -
IEC62196Type2Outlet- Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento. -
IEC62196Type2CCS- Conector de combinação baseado no tipo 2, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 2, conforme definido no padrão IEC 62196-2, com dois contatos atuais diretos adicionais (DC) para permitir o carregamento rápido de DC. -
IEC62196Type3- Conector tipo 3 conforme definido no padrão IEC 62196-2. Também chamado de Scame após o fabricante original. Usado principalmente em combinação com até 240V de fase única ou até 420V de infraestrutura de três fases. -
Chademo- Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por isso também é conhecido como conector do TEPCO. Ele dá suporte a carregamento rápido de DC. -
IEC60309AC1PhaseBlue– O conector Azul Industrial é um conector definido no padrão IEC 60309. Em algum momento, ele é conhecido como por alguma combinação do padrão, da cor e do fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h". -
IEC60309DCWhite– O conector Branco Industrial é um conector dc definido no padrão IEC 60309. -
Tesla- O conector tesla é o conector do Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes conhecido como Tesla Port, limitado principalmente à América do Norte ou o modificado Tipo 2 (DC sobre o Tipo 2) na Europa.
Exemplos de uso:
conjunto de conectores=IEC62196Tipo2CaboConector anexadoSet=IEC62196Tipo2Tomada,IEC62196Tipo2CaboAnexado
| Valor | Description |
|---|---|
| StandardHouseholdCountrySpecific |
Estes são os conectores domésticos padrão para uma determinada região. Todas elas são uma única fase ac e a tensão padrão e o amperamento padrão. Veja também: tipos de soquete Plug & – World Standards |
| IEC62196Type1 |
Conector tipo 1 conforme definido no padrão IEC 62196-2. Também chamado yazaki após o fabricante original ou SAE J1772 após o padrão que o publicou pela primeira vez. Usado principalmente em combinação com a fase única de 120V ou até 240V de infraestrutura de fase única. |
| IEC62196Type1CCS |
Conector de combinação baseado no tipo 1, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 1, conforme definido no padrão IEC 62196-2, com dois contatos dc (corrente direta) adicionais para permitir o carregamento rápido de DC. |
| IEC62196Type2CableAttached |
Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plug anexado ao ponto de carregamento |
| IEC62196Type2Outlet |
Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento. |
| IEC62196Type2CCS |
Conector de combinação baseado no tipo 2, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 2, conforme definido no padrão IEC 62196-2, com dois contatos atuais diretos adicionais (DC) para permitir o carregamento rápido de DC. |
| IEC62196Type3 |
Conector tipo 3 conforme definido no padrão IEC 62196-2. Também chamado de Scame após o fabricante original. Usado principalmente em combinação com até 240V de fase única ou até 420V de infraestrutura de três fases. |
| Chademo |
Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por isso também é conhecido como conector do TEPCO. Ele dá suporte a carregamento rápido de DC. |
| IEC60309AC1PhaseBlue |
O conector Azul Industrial é um conector definido no padrão IEC 60309. Em algum momento, ele é conhecido como por alguma combinação do padrão, da cor e do fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h". |
| IEC60309DCWhite |
O conector Branco Industrial é um conector dc definido no padrão IEC 60309. |
| Tesla |
O conector tesla é o conector do Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes conhecido como Tesla Port, limitado principalmente à América do Norte ou o modificado Tipo 2 (DC sobre o Tipo 2) na Europa. |
Entity
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
O ponto de entrada para a POI que está sendo retornada.
| Nome | Tipo | Description |
|---|---|---|
| position |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
| type |
O tipo de ponto de entrada. O valor pode ser principal ou secundária. |
EntryPointType
O tipo de ponto de entrada. O valor pode ser principal ou secundária.
| Valor | Description |
|---|---|
| main | |
| minor |
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 |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
GeographicEntityType
Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.
| Valor | Description |
|---|---|
| Country |
nome do país/região |
| CountrySubdivision |
Estado ou Província |
| CountrySecondarySubdivision |
Município |
| CountryTertiarySubdivision |
Área Nomeada |
| Municipality |
Cidade/Cidade |
| MunicipalitySubdivision |
Sub/Super City |
| Neighbourhood |
Vizinhança |
| PostalCodeArea |
Cep/Cep |
Geometry
Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia.
| Nome | Tipo | Description |
|---|---|---|
| id |
string |
Passe isso como geometryId para a API Obter Polígono de Pesquisa 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 (double) |
Propriedade Latitude |
| lon |
number (double) |
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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 atenderá. 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 de seus 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 Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN.
Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.
| Valor | Description |
|---|---|
| AE |
Emirados Árabes Unidos (Exibição árabe) |
| AR |
Argentina (Exibição argentina) |
| BH |
Bahrein (exibição árabe) |
| IN |
Índia (Modo de Exibição Indiano) |
| IQ |
Iraque (exibição árabe) |
| JO |
Jordânia (exibição árabe) |
| KW |
Kuwait (exibição árabe) |
| LB |
Líbano (exibição árabe) |
| MA |
Marrocos (Vista Marroquina) |
| OM |
Omã (exibição árabe) |
| PK |
Paquistão (Exibição paquistanesa) |
| PS |
Autoridade Palestina (Exibição Árabe) |
| QA |
Catar (exibição árabe) |
| SA |
Arábia Saudita (exibição árabe) |
| SY |
Síria (Exibição árabe) |
| US |
Estados Unidos da América |
| YE |
Iêmen (exibição árabe) |
| Auto |
Retorne os dados do mapa com base no endereço IP da solicitação. |
| Unified |
Exibição unificada (outros) |
MatchType
Tipos de correspondência para uma operação de pesquisa de endereço reverso.
| Valor | Description |
|---|---|
| AddressPoint | |
| HouseNumberRange | |
| Street |
OperatingHours
Horário de funcionamento para uma POI (Pontos de Interesse).
| Nome | Tipo | Description |
|---|---|---|
| mode |
string |
Valor usado na solicitação: nenhum ou "nextSevenDays" |
| timeRanges |
Lista de intervalos de tempo para os próximos 7 dias |
OperatingHoursRange
Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays
| Valor | Description |
|---|---|
| nextSevenDays |
Mostra as horas de operação para a próxima semana, começando com o dia atual no horário local da POI. |
OperatingHoursTime
Representa uma data e hora
| Nome | Tipo | Description |
|---|---|---|
| date |
string |
Representa a data do calendário atual no fuso horário da POI, por exemplo, "2019-02-07". |
| hour |
integer |
As horas estão no formato de 24 horas no horário 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 |
O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo. |
|
| startTime |
O ponto nos próximos 7 dias intervalo 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 |
A lista das categorias de POI mais específicas |
|
| classifications |
Matriz de classificação |
|
| name |
string |
Nome da propriedade POI |
| openingHours |
Horário de funcionamento para 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 retornada: NEARBY ou NON_NEAR.
Importante: Esta propriedade está obsoleta e pode ser omitida na resposta.
| Valor | Description |
|---|---|
| NEARBY |
A busca era realizada ao redor de uma certa latitude e longitude com um raio definido. |
| NON_NEAR |
A pesquisa foi realizada globalmente, sem ser tendenciosa para uma determinada latitude e longitude, e nenhum raio definido |
ResponseFormat
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 |
SearchAddressResult
Esse objeto é retornado de chamadas de pesquisa bem-sucedidas.
| Nome | Tipo | Description |
|---|---|---|
| results |
Uma lista de resultados da API de Pesquisa. |
|
| summary |
Objeto resumo de uma resposta à API de Pesquisa |
SearchAddressResultItem
Objeto de resultado para uma resposta da API de Pesquisa.
| Nome | Tipo | 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. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas. |
|
| dataSources |
Seçã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 apenas para chamadas para a API pesquisar ao longo da rota. |
| dist |
number (double) |
Distância de linha reta entre o resultado e a localização geográfica em metros. |
| entityType |
Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível. |
|
| entryPoints |
Matriz de EntryPoints. Eles 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 |
Informações sobre o tipo de correspondência. Um destes:
|
|
| poi |
Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações. |
|
| position |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
| score |
number (double) |
O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usá-lo 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. Importante: Esta propriedade está obsoleta e pode ser omitida na resposta. |
| type |
Um destes:
|
|
| viewport |
O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor. |
SearchAddressResultType
Um destes:
- POI
- Rua
- Geografia
- Endereço de ponto
- Intervalo de endereços
- Cruzamento
| Valor | Description |
|---|---|
| POI | |
| Street | |
| Geography | |
| Point Address | |
| Address Range | |
| Cross Street |
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
de 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, códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de códigos postais estendidas para geografias podem ser bastante 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.
| Valor | Description |
|---|---|
| Addr | |
| Geo | |
| PAD | |
| POI | |
| Str | |
| Xstr |
SearchSummary
Objeto resumo de uma resposta da API de Pesquisa.
| Nome | Tipo | Description |
|---|---|---|
| fuzzyLevel |
integer |
O nível difuso máximo necessário para fornecer Resultados. |
| geoBias |
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 usado para produzir esses resultados da pesquisa. |
| queryTime |
integer |
Tempo gasto resolvendo a consulta, em milissegundos. |
| queryType |
O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR. Importante: Esta propriedade está obsoleta e pode ser omitida na resposta. |
|
| totalResults |
integer |
O número total de resultados encontrados. |