Partilhar via

Search - Get Geocoding

Serviço:
Maps
Versão da API:
2025-01-01

Use para obter coordenadas de longitude e latitude de um endereço de rua ou nome de um lugar.

A API Get Geocoding é uma solicitação de GET HTTP que retorna as coordenadas de longitude e latitude do local que está sendo pesquisado.

Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. A pesquisa também pode ser acessada para pesquisa de endereço exclusivamente. A geocodificação é realizada batendo no ponto de extremidade de geocodificação apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para tudo acima dos dados do nível da rua. Nenhum Ponto de Interesse (POIs) será devolvido. Note que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços exatos de ruas ou ruas ou cruzamentos, bem como geografias de nível superior, como centros urbanos, condados e estados. A resposta também retorna propriedades de endereço detalhadas, como rua, código postal, município e informações de país/região.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01
Com parâmetros opcionais: 
GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
 query True

string

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

string

A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. O uso típico deste elemento seria fornecer um endereço ou qualquer endereço oficial.

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
adminDistrict
 query

string

A parte de subdivisão de país de um endereço, como WA.

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
adminDistrict2
 query

string

O condado para o endereço estruturado, como King.

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
adminDistrict3
 query

string

A área nomeada para o endereço estruturado.

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
bbox
 query

number[]

Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de longitude e latitude. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local.

Exemplo: lon1,lat1,lon2,lat2
coordinates
 query

number[]

Um ponto na Terra especificado como longitude e latitude. Quando você especifica esse parâmetro, a localização do usuário é levada em conta e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: &coordinates=lon,lat
countryRegion
 query

string

Sinal para o resultado da geocodificação para uma de código de região/país ISO 3166-1 Alpha-2 de especificada, por exemplo, FR./

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
locality
 query

string

A parte da localidade de um endereço, como Seattle.

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
postalCode
 query

string

A parte do código postal de um endereço.

Este parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.
query
 query

string

Uma cadeia de caracteres que contém informações sobre um local, como um endereço ou nome de ponto de referência.
top
 query

integer (int32)

minimum: 1
maximum: 20

Número máximo de respostas que serão devolvidas. Padrão: 5, mínimo: 1 e máximo: 20.
view
 query

string

Uma cadeia de caracteres que representa um código de região/país ISO 3166-1 Alpha-2 . Isso alterará fronteiras e rótulos disputados geopoliticamente para se alinhar com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Auto", mesmo que você não o tenha definido na solicitação.

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

Cabeçalho do Pedido

Name Necessário Tipo Description
Accept-Language

string

Idioma em que os resultados da pesquisa devem ser retornados.

Consulte de idiomas suportados para obter detalhes.
x-ms-client-id

string

Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Azure AD. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps.

Respostas

Name Tipo Description
200 OK

GeocodingResponse

OK

Media Types: "application/geo+json"

Cabeçalhos

x-ms-request-id: string
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Media Types: "application/geo+json"

Segurança

AADToken

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

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

Observação

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

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

Âmbitos

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

subscription-key

Essa é uma chave compartilhada que é provisionada ao criar um de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

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

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

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

Tipo: apiKey
Em: header

Exemplos

Search detail address 15127 NE 24th Street, Redmond, WA
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Search detail address 15127 NE 24th Street, Redmond, WA by query
Search landmark Empire State Building by query

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

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=15127 NE 24th Street Redmond WA

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=empire state building

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Definições

Name Description
Address

O endereço do resultado
AdminDistricts

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
CalculationMethodEnum

O método que foi usado para calcular o ponto de geocódigo.
ConfidenceEnum

O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência.

A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada.
CountryRegion
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
FeatureCollectionEnum

O tipo de um objeto FeatureCollection deve ser FeatureCollection.
FeaturesItem
FeatureTypeEnum

O tipo de recurso deve ser Recurso.
GeocodePoints

Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido.
GeocodingResponse

Este objeto é retornado de uma chamada de Geocoding bem-sucedida
GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
Intersection

O endereço do resultado.
MatchCodesEnum

Um ou mais valores de código de correspondência que representam o nível de geocodificação para cada local na resposta.

Por exemplo, um local geocodificado com códigos de correspondência de Good e Ambiguous significa que mais de um local de geocódigo foi encontrado para as informações de localização e que o serviço de geocódigo não tinha hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocodificado com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar um local de geocódigo que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar hierarquia superior e encontrar várias correspondências nesse nível. Um exemplo de Ambiguous e UpHierarchy resultado é quando você fornece informações completas de endereço, mas o serviço de geocodificação não consegue localizar uma correspondência para o endereço e, em vez disso, retorna informações para mais de um valor RoadBlock.

Os valores possíveis são:

Good: O local tem apenas uma partida ou todas as partidas retornadas são consideradas partidas fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências Boas.

Ambiguous: A localização faz parte de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher.

UpHierarchy: A localização representa um movimento para cima na hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de local não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se não for possível encontrar uma correspondência para o endereço solicitado, poderá ser devolvido um código de correspondência de UpHierarchy com um tipo de entidade RoadBlock.
Properties
UsageTypeEnum

O melhor uso para o ponto de geocódigo. Cada ponto de geocódigo é definido como um ponto de Route, um ponto de Display ou ambos. Use Route pontos se estiver criando uma rota para o local. Use Display pontos se estiver mostrando a localização em um mapa. Por exemplo, se o local for um parque, um ponto de Route pode especificar uma entrada para o parque onde você pode entrar com um carro, e um ponto de Display pode ser um ponto que especifica o centro do parque.

Address

Object

O endereço do resultado

Name Tipo Description
addressLine

string

AddressLine que inclui o nome e o número da rua
adminDistricts

AdminDistricts[]

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
countryRegion

CountryRegion

formattedAddress

string

Propriedade Endereço formatado
intersection

Intersection

O endereço do resultado.
locality

string

Propriedade de localidade
neighborhood

string

propriedade do bairro
postalCode

string

Propriedade do Código Postal
streetName

string

O nome da rua de formattedAddress
streetNumber

string

O número na rua, se disponível, de formattedAddress

AdminDistricts

Object

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.

Name Tipo Description
name

string

O nome para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome completo do estado, como Washington, Para adminDistrict[1], este poderia ser o nome completo do condado
shortName

string

O nome curto para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome curto do estado, como WA, Para adminDistrict[1], este poderia ser o nome curto do condado

CalculationMethodEnum

Enumeração

O método que foi usado para calcular o ponto de geocódigo.

Valor Description
Interpolation

O ponto de geocódigo foi combinado com um ponto em uma estrada usando interpolação.
InterpolationOffset

O ponto de geocódigo foi combinado com um ponto em uma estrada usando interpolação com um deslocamento adicional para deslocar o ponto para o lado da rua.
Parcel

O ponto de geocódigo foi combinado com o centro de uma parcela.
Rooftop

O ponto de geocódigo foi combinado com o telhado de um edifício.

ConfidenceEnum

Enumeração

O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência.

A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada.

Valor Description
High

Se a confiança estiver definida como High, uma ou mais partidas fortes foram encontradas. As correspondências de confiança múltipla High são classificadas em ordem classificada por importância, quando aplicável. Por exemplo, os pontos de referência têm importância, mas os endereços não.

Se uma solicitação incluir um local ou uma exibição, a classificação pode mudar apropriadamente. Por exemplo, uma consulta de localização para "Paris" retorna "Paris, França" e "Paris, TX" ambos com High confiança. "Paris, França" é sempre classificado em primeiro lugar devido à importância, a menos que uma localização do usuário indique que o usuário está em ou muito perto de Paris, TX ou a visualização do mapa indique que o usuário está pesquisando nessa área.
Medium

Em algumas situações, a correspondência devolvida pode não estar no mesmo nível das informações fornecidas na solicitação. Por exemplo, uma solicitação pode especificar informações de endereço e o serviço de geocodificação só pode corresponder a um código postal. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o código postal corresponde aos dados, a confiança será definida como Medium e o código de correspondência será definido para UpHierarchy especificar que ele não poderia corresponder a todas as informações e teve que pesquisar na hierarquia superior.

Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar os locais (como a localização do usuário ou a importância relativa do local), a confiança será definida como Medium. Por exemplo, uma consulta de localização para "148th Ave, Bellevue" pode retornar "148th Ave SE" e "148th Ave NE" ambos com Medium confiança.

Se as informações de localização na consulta não fornecerem informações suficientes para geocodificar um local específico, um valor de localização menos preciso poderá ser retornado e a confiança será definida como Medium. Por exemplo, se um endereço for fornecido, mas não for encontrada uma correspondência para o número da casa, o resultado do geocódigo com um tipo de entidade Roadblock poderá ser retornado.
Low

CountryRegion

Object
Name Tipo Description
ISO

string

ISO do país/região
name

string

nome do país/região

ErrorAdditionalInfo

Object

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

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

FeatureCollectionEnum

Enumeração

O tipo de um objeto FeatureCollection deve ser FeatureCollection.

Valor Description
FeatureCollection

FeaturesItem

Object
Name Tipo Description
bbox

number[] (double)

Caixa delimitadora. Projeção utilizada - EPSG:3857. Consulte RFC 7946 para obter detalhes.
geometry

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
id

string

ID do recurso retornado
properties

Properties

type

FeatureTypeEnum

O tipo de recurso deve ser Recurso.

FeatureTypeEnum

Enumeração

O tipo de recurso deve ser Recurso.

Valor Description
Feature

GeocodePoints

Object

Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido.

Name Tipo Description
calculationMethod

CalculationMethodEnum

O método que foi usado para calcular o ponto de geocódigo.
geometry

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
usageTypes

UsageTypeEnum[]

O melhor uso para o ponto de geocódigo. Cada ponto de geocódigo é definido como um ponto de Route, um ponto de Display ou ambos. Use Route pontos se estiver criando uma rota para o local. Use Display pontos se estiver mostrando a localização em um mapa. Por exemplo, se o local for um parque, um ponto de Route pode especificar uma entrada para o parque onde você pode entrar com um carro, e um ponto de Display pode ser um ponto que especifica o centro do parque.

GeocodingResponse

Object

Este objeto é retornado de uma chamada de Geocoding bem-sucedida

Name Tipo Description
features

FeaturesItem[]

nextLink

string

O é o link para a próxima página dos recursos retornados. Se for a última página, não há este campo.
type

FeatureCollectionEnum

O tipo de um objeto FeatureCollection deve ser FeatureCollection.

GeoJsonPoint

Object

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Name Tipo Description
bbox

number[] (double)

Caixa delimitadora. Projeção utilizada - EPSG:3857. Consulte RFC 7946 para obter detalhes.
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nesta ordem. de Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

Object

O endereço do resultado.

Name Tipo Description
baseStreet

string

Rua principal para o local.
displayName

string

Nome completo do cruzamento.
intersectionType

string

Tipo de intersecção.
secondaryStreet1

string

A primeira rua que se cruza.
secondaryStreet2

string

Se houver, a segunda rua que se cruza.

MatchCodesEnum

Enumeração

Um ou mais valores de código de correspondência que representam o nível de geocodificação para cada local na resposta.

Por exemplo, um local geocodificado com códigos de correspondência de Good e Ambiguous significa que mais de um local de geocódigo foi encontrado para as informações de localização e que o serviço de geocódigo não tinha hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocodificado com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar um local de geocódigo que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar hierarquia superior e encontrar várias correspondências nesse nível. Um exemplo de Ambiguous e UpHierarchy resultado é quando você fornece informações completas de endereço, mas o serviço de geocodificação não consegue localizar uma correspondência para o endereço e, em vez disso, retorna informações para mais de um valor RoadBlock.

Os valores possíveis são:

Good: O local tem apenas uma partida ou todas as partidas retornadas são consideradas partidas fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências Boas.

Ambiguous: A localização faz parte de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher.

UpHierarchy: A localização representa um movimento para cima na hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de local não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se não for possível encontrar uma correspondência para o endereço solicitado, poderá ser devolvido um código de correspondência de UpHierarchy com um tipo de entidade RoadBlock.

Valor Description
Good
Ambiguous
UpHierarchy

Properties

Object
Name Tipo Description
address

Address

O endereço do resultado
confidence

ConfidenceEnum

O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência.

A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada.
geocodePoints

GeocodePoints[]

Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido.
matchCodes

MatchCodesEnum[]

Um ou mais valores de código de correspondência que representam o nível de geocodificação para cada local na resposta.

Por exemplo, um local geocodificado com códigos de correspondência de Good e Ambiguous significa que mais de um local de geocódigo foi encontrado para as informações de localização e que o serviço de geocódigo não tinha hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocodificado com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar um local de geocódigo que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar hierarquia superior e encontrar várias correspondências nesse nível. Um exemplo de Ambiguous e UpHierarchy resultado é quando você fornece informações completas de endereço, mas o serviço de geocodificação não consegue localizar uma correspondência para o endereço e, em vez disso, retorna informações para mais de um valor RoadBlock.

Os valores possíveis são:

Good: O local tem apenas uma partida ou todas as partidas retornadas são consideradas partidas fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências Boas.

Ambiguous: A localização faz parte de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher.

UpHierarchy: A localização representa um movimento para cima na hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de local não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se não for possível encontrar uma correspondência para o endereço solicitado, poderá ser devolvido um código de correspondência de UpHierarchy com um tipo de entidade RoadBlock.
type

string

Um dos seguintes:

  • Endereço
  • Bloqueio de estrada
  • EstradaIntersecção
  • Bairro
  • PopulatedPlace
  • Código postal1
  • AdminDivision1
  • AdminDivision2
  • País/Região

UsageTypeEnum

Enumeração

O melhor uso para o ponto de geocódigo. Cada ponto de geocódigo é definido como um ponto de Route, um ponto de Display ou ambos. Use Route pontos se estiver criando uma rota para o local. Use Display pontos se estiver mostrando a localização em um mapa. Por exemplo, se o local for um parque, um ponto de Route pode especificar uma entrada para o parque onde você pode entrar com um carro, e um ponto de Display pode ser um ponto que especifica o centro do parque.

Valor Description
Display
Route