Compartilhar via

Search - Get Geocoding

  • Referência
Serviço:
Maps
Versão da API:
2023-06-01

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

A Get Geocoding API é uma solicitação HTTP GET 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 é executada atingindo o ponto de extremidade de geocodificação apenas com o endereço ou o endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para obter tudo acima dos dados de nível de rua. Nenhum POIs (Ponto de Interesse) será retornado. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível mais alto, como centros urbanos, condados e estados. A resposta também retorna propriedades de endereço detalhadas, como informações de rua, cep, município e país/região.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01
Com parâmetros opcionais: 
GET https://atlas.microsoft.com/geocode?api-version=2023-06-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 de URI

Nome Em Obrigatório Tipo Description
api-version
 query True

string

Número de versão da API de Mapas Azure.
addressLine
 query

string

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

Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict
 query

string

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

Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict2
 query

string

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

Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict3
 query

string

A área nomeada para o endereço estruturado.

Se a consulta for fornecida, não deverá usar esse parâmetro.
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 localização.

Exemplo: lon1,lat1,lon2,lat2
coordinates
 query

number[]

Um ponto na terra especificado como longitude e latitude. Quando você especifica esse parâmetro, o local do usuário é levado 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 um código de região/país ISO 3166-1 Alpha-2 especificado, por exemplo, FR./

Se a consulta for fornecida, não deverá usar esse parâmetro.
locality
 query

string

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

Se a consulta for fornecida, não deverá usar esse parâmetro.
postalCode
 query

string

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

Se a consulta for fornecida, não deverá usar esse parâmetro.
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

Número máximo de respostas que serão retornadas. 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á as bordas e rótulos geopolíticos disputados para se alinharem à região de usuário especificada. Por padrão, o parâmetro View é definido como "Automático", mesmo que você não o tenha definido na solicitação.

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

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Accept-Language

string

Idioma no qual os resultados da pesquisa devem ser retornados.

Consulte Idiomas com suporte para obter detalhes.
x-ms-client-id

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança do Azure AD. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança do Azure AD no Azure Mapas, confira os artigos a seguir para obter diretrizes .

Respostas

Nome Tipo Description
200 OK

GeocodingResponse

OK

Media Types: "application/geo+json"

Cabeçalhos

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

ErrorResponse

Erro inesperado.

Media Types: "application/geo+json"

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , ele pode ser usado para controlar o acesso à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 acessar o controle em APIs e escopos específicos.

Observação

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra.
  • O controle de acesso baseado em função do Azure é configurado no 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 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 ao criar um 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 essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

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

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar 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 à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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",
          "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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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",
          "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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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",
          "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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Nome Description
Address

O endereço do resultado
AdminDistricts

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

O método que foi usado para calcular o ponto de código geográfico.
ConfidenceEnum

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

A confiança de um local geocódigo baseia-se em muitos fatores, incluindo a importância relativa da localização geocódigo e a localização do usuário, se especificado.
CountryRegion
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
FeatureCollectionEnum

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

O tipo de um recurso deve ser Recurso.
GeocodePoints

Uma coleção de pontos de geocódigo que diferem na forma como foram calculados e no uso sugerido.
GeocodingResponse

Esse objeto é retornado de uma chamada de Geocodificação bem-sucedida
GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . 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 geocódigo com códigos de correspondência de e Ambiguous significa que mais de Good um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocódigo com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar uma localização de código geográfico que correspondesse a todas as informações de localização fornecidas, portanto, o serviço de geocódigo teve que pesquisar a hierarquia e encontrou várias correspondências nesse nível. Um exemplo de Ambiguous um resultado e UpHierarchy é quando você fornece informações de endereço completas, mas o serviço de geocódigo não pode localizar uma correspondência para o endereço de rua 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 correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas.

Ambiguous: o local é um de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 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: o local representa um movimento para cima da hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de localização não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se uma correspondência para o endereço solicitado não puder ser encontrada, um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock poderá ser retornado.
Properties
UsageTypeEnum

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

Address

O endereço do resultado

Nome Tipo Description
addressLine

string

AddressLine que inclui Nome da Rua e Número
adminDistricts

AdminDistricts[]

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

CountryRegion

formattedAddress

string

Propriedade Address formatada
intersection

Intersection

O endereço do resultado.
locality

string

propriedade locality
neighborhood

string

propriedade neighborhood
postalCode

string

Propriedade Postal Code

AdminDistricts

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

Nome Tipo Description
name

string

O nome do campo adminDistrict correspondente, For adminDistrict[0], pode ser o nome completo do estado, como Washington, For adminDistrict[1], esse pode ser o nome completo do município
shortName

string

O nome curto do campo adminDistrict correspondente, For adminDistrict[0], pode ser um nome curto de estado, como WA, For adminDistrict[1], esse pode ser o nome curto do município

CalculationMethodEnum

O método que foi usado para calcular o ponto de código geográfico.

Nome Tipo Description
Interpolation

string

O ponto de código geográfico foi correspondido a um ponto em uma estrada usando interpolação.
InterpolationOffset

string

O ponto de código geográfico foi correspondido a um ponto em uma estrada usando interpolação com um deslocamento adicional para deslocar o ponto para o lado da rua.
Parcel

string

O ponto de código geográfico foi correspondido ao centro de uma parcela.
Rooftop

string

O ponto de código geográfico foi correspondido ao telhado de um prédio.

ConfidenceEnum

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

A confiança de um local geocódigo baseia-se em muitos fatores, incluindo a importância relativa da localização geocódigo e a localização do usuário, se especificado.

Nome Tipo Description
High

string

Se a confiança for definida como High, uma ou mais correspondências fortes foram encontradas. Várias High correspondências de confiança 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 poderá ser alterada adequadamente. 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 classificada em primeiro lugar devido à importância, a menos que um local de usuário indique que o usuário está em Paris, TX ou a exibição de mapa indica que o usuário está pesquisando nessa área.
Low

string

Medium

string

Em algumas situações, a correspondência retornada 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 geocódigo 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 Medium como e o código de correspondência será definido como UpHierarchy para especificar que ele não pôde corresponder a todas as informações e teve que pesquisar a hierarquia.

Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar os locais (como o local do usuário ou a importância relativa do local), a confiança será definida Mediumcomo . 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 codificar geografiamente 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 uma correspondência não for encontrada para o número da casa, o resultado do código geográfico com um tipo de entidade de bloqueio poderá ser retornado.

CountryRegion

Nome Tipo Description
ISO

string

ISO do país/região
name

string

nome do país/região

ErrorAdditionalInfo

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

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

FeatureCollectionEnum

O tipo de um objeto FeatureCollection deve ser FeatureCollection.

Nome Tipo Description
FeatureCollection

string

FeaturesItem

Nome Tipo Description
bbox

number[]

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

GeoJsonPoint

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

string

ID do recurso retornado
properties

Properties

type

FeatureTypeEnum

O tipo de um recurso deve ser Recurso.

FeatureTypeEnum

O tipo de um recurso deve ser Recurso.

Nome Tipo Description
Feature

string

GeocodePoints

Uma coleção de pontos de geocódigo que diferem na forma como foram calculados e no uso sugerido.

Nome Tipo Description
calculationMethod

CalculationMethodEnum

O método que foi usado para calcular o ponto de código geográfico.
geometry

GeoJsonPoint

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

UsageTypeEnum[]

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

GeocodingResponse

Esse objeto é retornado de uma chamada de Geocodificação bem-sucedida

Nome 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 este campo.
type

FeatureCollectionEnum

O tipo de um objeto FeatureCollection deve ser FeatureCollection.

GeoJsonPoint

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

Nome Tipo Description
bbox

number[]

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

number[]

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nessa ordem. 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

O endereço do resultado.

Nome Tipo Description
baseStreet

string

Rua primária para o local.
displayName

string

Nome completo da interseção.
intersectionType

string

Tipo de interseção.
secondaryStreet1

string

A primeira rua intersecciona.
secondaryStreet2

string

Se houver, a segunda rua interseccionando.

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 geocódigo com códigos de correspondência de e Ambiguous significa que mais de Good um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocódigo com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar uma localização de código geográfico que correspondesse a todas as informações de localização fornecidas, portanto, o serviço de geocódigo teve que pesquisar a hierarquia e encontrou várias correspondências nesse nível. Um exemplo de Ambiguous um resultado e UpHierarchy é quando você fornece informações de endereço completas, mas o serviço de geocódigo não pode localizar uma correspondência para o endereço de rua 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 correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas.

Ambiguous: o local é um de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 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: o local representa um movimento para cima da hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de localização não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se uma correspondência para o endereço solicitado não puder ser encontrada, um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock poderá ser retornado.

Nome Tipo Description
Ambiguous

string

Good

string

UpHierarchy

string

Properties

Nome Tipo Description
address

Address

O endereço do resultado
confidence

ConfidenceEnum

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

A confiança de um local geocódigo baseia-se em muitos fatores, incluindo a importância relativa da localização geocódigo e a localização do usuário, se especificado.
geocodePoints

GeocodePoints[]

Uma coleção de pontos de geocódigo que diferem na forma como foram calculados e no 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 geocódigo com códigos de correspondência de e Ambiguous significa que mais de Good um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocódigo com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar uma localização de código geográfico que correspondesse a todas as informações de localização fornecidas, portanto, o serviço de geocódigo teve que pesquisar a hierarquia e encontrou várias correspondências nesse nível. Um exemplo de Ambiguous um resultado e UpHierarchy é quando você fornece informações de endereço completas, mas o serviço de geocódigo não pode localizar uma correspondência para o endereço de rua 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 correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas.

Ambiguous: o local é um de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 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: o local representa um movimento para cima da hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de localização não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se uma correspondência para o endereço solicitado não puder ser encontrada, um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock poderá ser retornado.
type

string

Um destes:

  • Endereço
  • Bloqueio
  • RoadIntersection
  • Vizinhança
  • PopulatedPlace
  • Postcode1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

UsageTypeEnum

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

Nome Tipo Description
Display

string

Route

string