Partilhar via


Search - Get Search POI

Utilize para procurar pontos de interesse por nome.

A Points of Interest (POI) Search API é um pedido HTTP GET que lhe permite pedir os resultados do POI por nome. Também suporta parâmetros de consulta adicionais, como linguagem e filtragem de resultados por área de interesse condicionada por país/região ou caixa delimitadora. O Ponto Final devolverá apenas resultados POI correspondentes à cadeia de consulta. A resposta inclui detalhes do POI, como endereço, localização coordenada e categoria.

GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{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}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

Parâmetros do URI

Name Em Necessário Tipo Description
format
path True

ResponseFormat

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

api-version
query True

string

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

query
query True

string

O nome POI a procurar (por exemplo, "estátua da liberdade", "starbucks"), tem de estar devidamente codificado com URL.

brandSet
query

string[]

Uma lista separada por vírgulas de nomes de marcas que poderiam ser utilizadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando forem fornecidas várias marcas, apenas serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas. As marcas que contêm uma "" no respetivo nome devem ser colocadas em aspas.

Exemplos de utilização:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Vírgula",Barra

btmRight
query

string

Posição inferior direita da caixa delimitadora. Por exemplo, 37.553,-122.453

categorySet
query

integer[]

Uma lista separada por vírgulas de IDs de conjuntos de categorias que podem ser utilizados para restringir o resultado a categorias específicas de Pontos de Interesse. A encomenda de ID não importa. O número máximo de categorySet valores suportados por pedido é 10. Quando forem fornecidos vários identificadores de categoria, apenas serão devolvidas POIs que pertençam (pelo menos) a uma das categorias da lista fornecida. A lista de categorias suportadas pode ser detetada com a API de Categorias POI . Exemplos de utilização:

  • categorySet=7315 (Pesquisa Pontos de Interesse da categoria Restaurante)

  • categorySet=7315025,7315017 (Pesquisa Pontos de Interesse da categoria, seja italiano ou francês)

connectorSet
query

ElectricVehicleConnector[]

Uma lista separada por vírgulas de tipos de conectores que podem ser utilizados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem do item não importa. Quando são fornecidos vários tipos de conector, apenas serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas.

Os tipos de conector disponíveis são:

  • StandardHouseholdCountrySpecific - Estes são os conectores domésticos padrão para uma determinada região. São todas uma fase única de AC e a Tensão padrão e o Amperage padrão. Veja também: Plug & socket types - World Standards ( Padrões Mundiais).
  • IEC62196Type1 - Escreva 1 conector conforme definido na norma IEC 62196-2. Também chamado Yazaki em homenagem ao fabricante original ou SAE J1772 após a norma que a publicou pela primeira vez. Utilizado principalmente em combinação com uma fase única de 120V ou até 240V de infraestrutura de fase única.
  • IEC62196Type1CCS - Escreva um conector de combinação baseado, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 1 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type2CableAttached - Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um cabo e uma ficha ligadas ao ponto de carregamento.
  • IEC62196Type2Outlet - Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um conjunto de sockets no ponto de carregamento.
  • IEC62196Type2CCS - Escreva conector de combinação baseado em 2 conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 2 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Escreva 3 conector conforme definido na norma IEC 62196-2. Também denominado Scame em homenagem ao fabricante original. Utilizado principalmente em combinação com uma única fase de até 240V ou até 420V infraestrutura de três fases.
  • Chademo - Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e pelos parceiros industriais. Por este motivo, também é conhecido como o conector do TEPCO. Suporta carregamentos DC rápidos.
  • IEC60309AC1PhaseBlue - O conector Azul Industrial é um conector definido na norma IEC 60309. Por vezes, é referido como por alguma combinação do padrão, a cor e o facto de ser um conector de fase única. Normalmente, o conector tem a configuração "P+N+E, 6h".
  • IEC60309DCWhite - O conector Industrial White é um conector DC definido na norma IEC 60309.
  • Tesla - O conector Tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, por vezes referido como Porta Tesla maioritariamente limitado a América do Norte ou ao Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de utilização:

connectorSet=IEC62196Type2Cable ConnectorAttachedSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

countrySet
query

string[]

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

extendedPostalCodesFor
query

PointOfInterestExtendedPostalCodes[]

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

Os índices disponíveis são:

POI = Pontos de Interesse

O valor deve ser POI ou Nenhum para desativar códigos postais expandidos.

Por predefinição, estão incluídos códigos postais expandidos.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

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

language
query

string

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

Consulte idiomas suportados para obter detalhes.

lat
query

number

double

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

limit
query

integer

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

lon
query

number

double

Longitude onde os resultados devem ser tendenciosos. Por exemplo, -121,89

ofs
query

integer

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

openingHours
query

OperatingHoursRange

Horas de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horas de operação irá variar consoante os dados disponíveis. Se não for transmitido, não serão devolvidas informações sobre o horário de funcionamento. Valor suportado: nextSevenDays

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

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

Cabeçalho do Pedido

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

string

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

Respostas

Name Tipo Description
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

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

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

Nota

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

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 partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

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

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

Tipo: apiKey
Em: query

SAS Token

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

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

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

Tipo: apiKey
Em: header

Exemplos

Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results

Pedido de amostra

GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays

Resposta da amostra

{
  "summary": {
    "query": "juice bars",
    "queryType": "NON_NEAR",
    "queryTime": 36,
    "numResults": 5,
    "offset": 0,
    "totalResults": 12,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.606038,
      "lon": -122.333345
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/9223158",
      "score": 5.664,
      "dist": 667.2710170950347,
      "info": "search:ta:840539001755244-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-6240804",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "400",
        "streetName": "Pine St",
        "municipalitySubdivision": "Seattle, Central Business District",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98101",
        "extendedPostalCode": "981011628",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "400 Pine St, Seattle, WA 98101",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61138,
        "lon": -122.3374
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61228,
          "lon": -122.33873
        },
        "btmRightPoint": {
          "lat": 47.61048,
          "lon": -122.33607
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61134,
            "lon": -122.33737
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9222534",
      "score": 5.663,
      "dist": 1101.6849025777728,
      "info": "search:ta:840539001760125-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-4533785",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "315",
        "streetName": "E Pine St",
        "municipalitySubdivision": "Seattle, Broadway",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98122",
        "extendedPostalCode": "9812200",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "315 E Pine St, Seattle, WA 98122",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61518,
        "lon": -122.32768
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61608,
          "lon": -122.32901
        },
        "btmRightPoint": {
          "lat": 47.61428,
          "lon": -122.32635
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61523,
            "lon": -122.32768
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9133689",
      "score": 5.659,
      "dist": 2649.8700791555398,
      "info": "search:ta:840539001339220-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-2820651",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "604",
        "streetName": "1st Ave N",
        "municipalitySubdivision": "Seattle, Lower Queen Anne",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98109",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "604 1st Ave N, Seattle, WA 98109",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6247,
        "lon": -122.35533
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6256,
          "lon": -122.35666
        },
        "btmRightPoint": {
          "lat": 47.6238,
          "lon": -122.354
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6247,
            "lon": -122.3554
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9131285",
      "score": 5.646,
      "dist": 5097.757019046541,
      "info": "search:ta:840539001743255-US",
      "poi": {
        "name": "Custom Smoothie & Sports Nutrition",
        "phone": "+(1)-(206)-5475522",
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.customsmoothie.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "462",
        "streetName": "N 34th St",
        "municipalitySubdivision": "Seattle, Fremont",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981038600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "462 N 34th St, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.65016,
        "lon": -122.35182
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.65106,
          "lon": -122.35315
        },
        "btmRightPoint": {
          "lat": 47.64926,
          "lon": -122.35049
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.64991,
            "lon": -122.3519
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9228250",
      "score": 5.637,
      "dist": 6235.798481758295,
      "info": "search:ta:840531000416784-US",
      "poi": {
        "name": "Jamba Juice",
        "phone": "+(1)-(206)-6322060",
        "brands": [
          {
            "name": "Jamba Juice"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.jambajuice.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "4555",
        "streetName": "Stone Way N",
        "municipalitySubdivision": "Wallingford, Seattle",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981036600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.66179,
        "lon": -122.34233
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.66269,
          "lon": -122.34367
        },
        "btmRightPoint": {
          "lat": 47.66089,
          "lon": -122.34099
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.66188,
            "lon": -122.34211
          }
        }
      ]
    }
  ]
}

Definições

Name Description
Address

O endereço do resultado

AddressRanges

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

BoundingBox

A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport.

BoundingBoxCompassNotation

A caixa delimitadora da localização.

Brand

A marca associada ao POI

Classification

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

ClassificationName

Nome da classificação

DataSources

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

ElectricVehicleConnector

Uma lista separada por vírgulas de tipos de conectores que podem ser utilizados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem do item não importa. Quando são fornecidos vários tipos de conector, apenas serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas.

Os tipos de conector disponíveis são:

  • StandardHouseholdCountrySpecific - Estes são os conectores domésticos padrão para uma determinada região. São todas uma fase única de AC e a Tensão padrão e o Amperage padrão. Veja também: Plug & socket types - World Standards ( Padrões Mundiais).
  • IEC62196Type1 - Escreva 1 conector conforme definido na norma IEC 62196-2. Também chamado Yazaki em homenagem ao fabricante original ou SAE J1772 após a norma que a publicou pela primeira vez. Utilizado principalmente em combinação com uma fase única de 120V ou até 240V de infraestrutura de fase única.
  • IEC62196Type1CCS - Escreva um conector de combinação baseado, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 1 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type2CableAttached - Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um cabo e uma ficha ligadas ao ponto de carregamento.
  • IEC62196Type2Outlet - Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um conjunto de sockets no ponto de carregamento.
  • IEC62196Type2CCS - Escreva conector de combinação baseado em 2 conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 2 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Escreva 3 conector conforme definido na norma IEC 62196-2. Também denominado Scame em homenagem ao fabricante original. Utilizado principalmente em combinação com uma única fase de até 240V ou até 420V infraestrutura de três fases.
  • Chademo - Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e pelos parceiros industriais. Por este motivo, também é conhecido como o conector do TEPCO. Suporta carregamentos DC rápidos.
  • IEC60309AC1PhaseBlue - O conector Azul Industrial é um conector definido na norma IEC 60309. Por vezes, é referido como por alguma combinação do padrão, a cor e o facto de ser um conector de fase única. Normalmente, o conector tem a configuração "P+N+E, 6h".
  • IEC60309DCWhite - O conector Industrial White é um conector DC definido na norma IEC 60309.
  • Tesla - O conector Tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, por vezes referido como Porta Tesla maioritariamente limitado a América do Norte ou ao Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de utilização:

connectorSet=IEC62196Type2Cable ConnectorAttachedSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Entity

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

EntryPoint

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

EntryPointType

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

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

GeographicEntityType

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

Geometry

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

LatLongPairAbbreviated

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

LocalizedMapView

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

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

MatchType

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

OperatingHours

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

OperatingHoursRange

Horas de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horas de operação irá variar consoante os dados disponíveis. Se não for transmitido, não serão devolvidas informações sobre o horário de funcionamento. Valor suportado: nextSevenDays

OperatingHoursTime

Representa uma data e hora

OperatingHoursTimeRange

Intervalo de tempo de abertura de um dia

PointOfInterest

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

PointOfInterestCategorySet

Categoria POI

PointOfInterestExtendedPostalCodes

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

Os índices disponíveis são:

POI = Pontos de Interesse

O valor deve ser POI ou Nenhum para desativar códigos postais expandidos.

Por predefinição, estão incluídos códigos postais expandidos.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

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

QueryType

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

ResponseFormat

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

SearchAddressResult

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

SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.

SearchAddressResultType

Um dos seguintes:

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

Objeto de resumo para uma resposta da API Pesquisa.

Address

O endereço do resultado

Name Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora da localização.

buildingNumber

string

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

country

string

nome do país/região

countryCode

string

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

countryCodeISO3

string

Código de país iso alfa-3

countrySecondarySubdivision

string

Concelho

countrySubdivision

string

Distrito

countrySubdivisionCode

string

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

countrySubdivisionName

string

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

countryTertiarySubdivision

string

Área Nomeada

crossStreet

string

O nome da rua a ser atravessada.

extendedPostalCode

string

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

freeformAddress

string

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

localName

string

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

municipality

string

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

municipalitySubdivision

string

Sub/Super City

neighbourhood

string

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

postalCode

string

Código Postal/Código Postal

routeNumbers

string[]

Os códigos utilizados para identificar inequívocamente a rua

street

string

O nome da rua. PRETERIDO, utilize streetName como alternativa.

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. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços.

Name Tipo Description
from

LatLongPairAbbreviated

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

rangeLeft

string

Intervalo de endereços no lado esquerdo da rua.

rangeRight

string

Intervalo de endereços no lado direito da rua.

to

LatLongPairAbbreviated

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

BoundingBox

A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport.

Name Tipo Description
btmRightPoint

LatLongPairAbbreviated

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

topLeftPoint

LatLongPairAbbreviated

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

BoundingBoxCompassNotation

A caixa delimitadora da localização.

Name Tipo Description
entity

Entity

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

northEast

string

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

southWest

string

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

Brand

A marca associada ao POI

Name Tipo Description
name

string

Nome da marca

Classification

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

Name Tipo Description
code

string

Propriedade do código

names

ClassificationName[]

Matriz de nomes

ClassificationName

Nome da classificação

Name Tipo Description
name

string

Propriedade Nome

nameLocale

string

Propriedade Região do Nome

DataSources

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

Name Tipo Description
geometry

Geometry

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

ElectricVehicleConnector

Uma lista separada por vírgulas de tipos de conectores que podem ser utilizados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem do item não importa. Quando são fornecidos vários tipos de conector, apenas serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas.

Os tipos de conector disponíveis são:

  • StandardHouseholdCountrySpecific - Estes são os conectores domésticos padrão para uma determinada região. São todas uma fase única de AC e a Tensão padrão e o Amperage padrão. Veja também: Plug & socket types - World Standards ( Padrões Mundiais).
  • IEC62196Type1 - Escreva 1 conector conforme definido na norma IEC 62196-2. Também chamado Yazaki em homenagem ao fabricante original ou SAE J1772 após a norma que a publicou pela primeira vez. Utilizado principalmente em combinação com uma fase única de 120V ou até 240V de infraestrutura de fase única.
  • IEC62196Type1CCS - Escreva um conector de combinação baseado, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 1 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type2CableAttached - Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um cabo e uma ficha ligadas ao ponto de carregamento.
  • IEC62196Type2Outlet - Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um conjunto de sockets no ponto de carregamento.
  • IEC62196Type2CCS - Escreva conector de combinação baseado em 2 conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 2 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Escreva 3 conector conforme definido na norma IEC 62196-2. Também denominado Scame em homenagem ao fabricante original. Utilizado principalmente em combinação com uma única fase de até 240V ou até 420V infraestrutura de três fases.
  • Chademo - Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e pelos parceiros industriais. Por este motivo, também é conhecido como o conector do TEPCO. Suporta carregamentos DC rápidos.
  • IEC60309AC1PhaseBlue - O conector Azul Industrial é um conector definido na norma IEC 60309. Por vezes, é referido como por alguma combinação do padrão, a cor e o facto de ser um conector de fase única. Normalmente, o conector tem a configuração "P+N+E, 6h".
  • IEC60309DCWhite - O conector Industrial White é um conector DC definido na norma IEC 60309.
  • Tesla - O conector Tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, por vezes referido como Porta Tesla maioritariamente limitado a América do Norte ou ao Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de utilização:

connectorSet=IEC62196Type2Cable ConnectorAttachedSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Name Tipo Description
Chademo

string

Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por este motivo, também é conhecido como o conector do TEPCO. Suporta carregamentos DC rápidos.

IEC60309AC1PhaseBlue

string

O conector Azul Industrial é um conector definido na norma IEC 60309. Por vezes, é referido como por alguma combinação do padrão, a cor e o facto de ser um conector de fase única. Normalmente, o conector tem a configuração "P+N+E, 6h".

IEC60309DCWhite

string

O conector Industrial White é um conector DC definido na norma IEC 60309.

IEC62196Type1

string

Conector tipo 1 conforme definido na norma IEC 62196-2. Também chamado Yazaki em homenagem ao fabricante original ou SAE J1772 após a norma que a publicou pela primeira vez. Utilizado principalmente em combinação com uma fase única de 120V ou até 240V de infraestrutura de fase única.

IEC62196Type1CCS

string

Escreva um conector de combinação baseado em 1, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 1 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.

IEC62196Type2CCS

string

Escreva um conector de combinação baseado em 2, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 2 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.

IEC62196Type2CableAttached

string

Conector tipo 2 conforme definido na norma IEC 62196-2. Fornecido como um cabo e uma ficha ligadas ao ponto de carregamento

IEC62196Type2Outlet

string

Conector tipo 2 conforme definido na norma IEC 62196-2. Fornecido como um conjunto de sockets no ponto de carregamento.

IEC62196Type3

string

Conector tipo 3 conforme definido na norma IEC 62196-2. Também denominado Scame em homenagem ao fabricante original. Utilizado principalmente em combinação com uma única fase de até 240V ou até 420V infraestrutura de três fases.

StandardHouseholdCountrySpecific

string

Estes são os conectores domésticos padrão para uma determinada região. São todas uma fase única de AC e a Tensão padrão e o Amperage padrão.

Veja também: Plug & socket types - World Standards

Tesla

string

O conector Tesla é o conector tesla supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, por vezes referido como Porta Tesla maioritariamente limitado a América do Norte ou ao Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Entity

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

Name Tipo Description
position

string

Entidade de posição

EntryPoint

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

Name Tipo Description
position

LatLongPairAbbreviated

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

type

EntryPointType

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

EntryPointType

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

Name Tipo Description
main

string

minor

string

ErrorAdditionalInfo

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

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

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

Name Tipo Description
Country

string

nome do país/região

CountrySecondarySubdivision

string

Concelho

CountrySubdivision

string

Distrito

CountryTertiarySubdivision

string

Área Nomeada

Municipality

string

Cidade/Cidade

MunicipalitySubdivision

string

Sub/Super Cidade

Neighbourhood

string

Bairro

PostalCodeArea

string

Código Postal/Código Postal

Geometry

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

Name Tipo Description
id

string

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

LatLongPairAbbreviated

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

Name Tipo Description
lat

number

Propriedade Latitude

lon

number

Propriedade Longitude

LocalizedMapView

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

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

Name Tipo Description
AE

string

Emirados Árabes Unidos (Vista Árabe)

AR

string

Argentina (Vista Argentina)

Auto

string

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

BH

string

Bahrein (Vista Árabe)

IN

string

Índia (Vista Indiana)

IQ

string

Iraque (Vista Árabe)

JO

string

Jordânia (Vista Árabe)

KW

string

Kuwait (Vista Árabe)

LB

string

Líbano (Vista Árabe)

MA

string

Marrocos (Vista Marroquina)

OM

string

Omã (Vista Árabe)

PK

string

Paquistão (Vista Paquistanesa)

PS

string

Autoridade Palestiniana (Vista Árabe)

QA

string

Qatar (Vista Árabe)

SA

string

Arábia Saudita (Vista Árabe)

SY

string

Síria (Vista Árabe)

Unified

string

Vista Unificada (Outros)

YE

string

Iémen (Vista Árabe)

MatchType

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

Name Tipo Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

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

Name Tipo Description
mode

string

Valor utilizado no pedido: nenhum ou "nextSevenDays"

timeRanges

OperatingHoursTimeRange[]

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

OperatingHoursRange

Horas de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horas de operação irá variar consoante os dados disponíveis. Se não for transmitido, não serão devolvidas informações sobre o horário de funcionamento. Valor suportado: nextSevenDays

Name Tipo Description
nextSevenDays

string

Mostra as horas de funcionamento da próxima semana, começando com o dia atual na hora local do POI.

OperatingHoursTime

Representa uma data e hora

Name Tipo Description
date

string

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

hour

integer

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

minute

integer

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

OperatingHoursTimeRange

Intervalo de tempo de abertura de um dia

Name Tipo Description
endTime

OperatingHoursTime

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

startTime

OperatingHoursTime

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

PointOfInterest

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

Name Tipo Description
brands

Brand[]

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

categories

string[]

Matriz de categorias

categorySet

PointOfInterestCategorySet[]

A lista das categorias POI mais específicas

classifications

Classification[]

Matriz de classificação

name

string

Nome da propriedade POI

openingHours

OperatingHours

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

phone

string

Propriedade número de telefone

url

string

Propriedade URL do Site

PointOfInterestCategorySet

Categoria POI

Name Tipo Description
id

integer

ID da Categoria

PointOfInterestExtendedPostalCodes

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

Os índices disponíveis são:

POI = Pontos de Interesse

O valor deve ser POI ou Nenhum para desativar códigos postais expandidos.

Por predefinição, estão incluídos códigos postais expandidos.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

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

Name Tipo Description
None

string

POI

string

QueryType

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

Name Tipo Description
NEARBY

string

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

NON_NEAR

string

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

ResponseFormat

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

Name Tipo Description
json

string

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

xml

string

O Idioma de Marcação Extensível

SearchAddressResult

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

Name Tipo Description
results

SearchAddressResultItem[]

Uma lista de resultados da API Pesquisa.

summary

SearchSummary

Objeto de resumo para uma resposta da API Pesquisa

SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.

Name Tipo Description
address

Address

O endereço do resultado

addressRanges

AddressRanges

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

dataSources

DataSources

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

detourTime

integer

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

dist

number

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

entityType

GeographicEntityType

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

entryPoints

EntryPoint[]

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

id

string

Propriedade ID

info

string

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

matchType

MatchType

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

Um dos seguintes:

  • AddressPoint
  • HouseNumberRange
  • Rua
poi

PointOfInterest

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

position

LatLongPairAbbreviated

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

score

number

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

type

SearchAddressResultType

Um dos seguintes:

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

BoundingBox

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

SearchAddressResultType

Um dos seguintes:

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

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchSummary

Objeto de resumo para uma resposta da API Pesquisa.

Name Tipo Description
fuzzyLevel

integer

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

geoBias

LatLongPairAbbreviated

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

limit

integer

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

numResults

integer

Número de resultados na resposta.

offset

integer

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

query

string

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

queryTime

integer

Tempo gasto a resolver a consulta, em milissegundos.

queryType

QueryType

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

totalResults

integer

O número total de Resultados encontrados.