Compartilhar via

Search - Get Geocoding

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

Use para obter coordenadas de longitude e latitude de um endereço ou nome de um lugar.
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 é realizada atingindo o endpoint de geocodificação apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado sobre tudo acima dos dados de nível de rua. Nenhum ponto de interesse (POIs) será devolvido. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços exatos 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 {endpoint}/geocode?api-version=2026-01-01
Com parâmetros opcionais: 
GET {endpoint}/geocode?api-version=2026-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 de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
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 ou qualquer endereço oficial.

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

string

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

Esse 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.

Esse 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.

Esse 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 do retângulo 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.

Tamanho mínimo: aproximadamente 0,00001 graus (~0,01 metros).

Tamanho máximo: até a extensão global total (-180,-90 a 180,90)
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 consideração e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: &coordinates=lon,lat
countryRegion
 query

string

Sinalize o resultado da geocodificação para um código de região/país ISO 3166-1 Alfa-2 especificado, por exemplo, FR.

Esse 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.

Esse 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.

Esse 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 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 Alfa-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a 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 exibições com suporte para obter detalhes e 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 de idiomas com suporte 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 um ID único para a conta do Azure Mapas e pode ser recuperado na API de Contas do plano de gerenciamento do Azure Mapas. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Mapas, veja Gerencie autenticação em Azure Mapas.

Respostas

Nome Tipo Description
200 OK

GeocodingResponse

A solicitação foi bem-sucedida.

Media Types: "application/geo+json", "application/json"
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Media Types: "application/geo+json", "application/json"

Cabeçalhos

x-ms-error-code: string

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. Qualquer usuário, grupo ou principal de serviço pode receber acesso via um papel embutido ou um papel personalizado composto por uma ou mais permissões para Azure Mapas APIs REST.\n\nPara implementar cenários, recomendamos visualizar conceitos autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicações(ões) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige o uso do cabeçalho x-ms-client-id para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento Maps.\n* \nO Authorization URL é específico para a instância Azure nuvem pública. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controle de acesso baseado em função Azure é configurado a partir do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUso do Azure Mapas Web SDK permite a configuração de uma aplicação baseada em configuração para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidade da Microsoft, veja plataforma de identidade da Microsoft visão geral.

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

Escopos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta Azure Mapas no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que são emitidas.\n\n Para aplicações publicamente expostas, nossa recomendação é usar a abordagem confidenciais de aplicativos clientes para acessar APIs REST Azure Mapas e assim sua chave possa 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 List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicativo está autorizado a acessar com Azure controles de acesso baseados em funções e controle detalhado da expiração, taxa e região(s) de uso do token específico. Em outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave compartilhada.\n\n Para aplicações publicamente expostas, nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos 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 {endpoint}/geocode?api-version=2026-01-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",
          "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

Solicitação de exemplo

GET {endpoint}/geocode?api-version=2026-01-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",
          "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

Solicitação de exemplo

GET {endpoint}/geocode?api-version=2026-01-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",
          "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

Solicitação de exemplo

GET {endpoint}/geocode?api-version=2026-01-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
AddressAdminDistrictsItem

O nome da subdivisão no país ou região para um endereço.
AddressCountryRegion

País ou região com seu nome e código ISO.
Azure.Core.Foundations.Error

O objeto de erro.
Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
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 do local geocodificado é 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 um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado.
FeatureCollectionEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.
FeaturesItem

Um objeto de destaque.
FeaturesItemProperties

Propriedades da característica.
FeatureTypeEnum

O tipo de um recurso deve ser Feature.
GeocodePointsItem

Um ponto de geocódigo.
GeocodingResponse

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

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.
GeoJsonPoint

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

O endereço do resultado.
MatchCodesEnum

Um enum representando o código de correspondência.
UsageTypeEnum

Um enum representando o tipo de uso.

Address

Objeto

O endereço do resultado

Nome Tipo Description
addressLine

string

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

AddressAdminDistrictsItem[]

O nome da subdivisão no país ou região para um endereço. Esse 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

AddressCountryRegion

País ou região com seu nome e código ISO.
formattedAddress

string

Propriedade de endereço formatado
intersection

Intersection

O endereço do resultado.
locality

string

Propriedade de localidade
neighborhood

string

Propriedade do bairro
postalCode

string

Propriedade do CEP
streetName

string

O nome da rua de formattedAddress
streetNumber

string

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

AddressAdminDistrictsItem

Objeto

O nome da subdivisão no país ou região para um endereç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], este pode ser o nome completo do condado
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

AddressCountryRegion

Objeto

País ou região com seu nome e código ISO.

Nome Tipo Description
ISO

string

ISO do país/região
name

string

nome do país/região

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
details

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível pelo ser humano do erro.
target

string

O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome Tipo Description
error

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
innererror

Azure.Core.Foundations.InnerError

Erro interno.

CalculationMethodEnum

Enumeração

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

Valor Description
Interpolation

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

O ponto de geocódigo 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

O ponto de geocódigo foi correspondido ao centro de um lote.
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 do local geocodificado é 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 um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado.

Valor Description
High

Se a confiança estiver definida como High, uma ou mais correspondências fortes foram encontradas. Várias High correspondências de confiança são classificadas em ordem de classificação 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 vista, 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 classificado em primeiro lugar devido à importância, a menos que a 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 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 pode corresponder apenas a um código postal. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o CEP corresponde aos dados, a confiança será definida como Medium 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 ascendente.

Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar as localizações (como a localização do utilizador ou a importância relativa da localização), 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 uma correspondência não for encontrada para o número da casa, o resultado do geocódigo com um tipo de entidade Roadblock poderá ser retornado.
Low

Baixo

FeatureCollectionEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

Valor Description
FeatureCollection

Especifica o tipo de objeto GeoJSONFeatureCollection.

FeaturesItem

Objeto

Um objeto de destaque.

Nome Tipo Description
bbox

number[] (double)

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

GeoJsonPoint

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

string

ID do recurso retornado
properties

FeaturesItemProperties

Propriedades da característica.
type

FeatureTypeEnum

O tipo de um recurso deve ser Feature.

FeaturesItemProperties

Objeto

Propriedades da característica.

Nome Tipo Description
address

Address

O endereço do resultado
confidence

ConfidenceEnum

O nível de confiança de que o resultado do local geocodificado é 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 um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado.
geocodePoints

GeocodePointsItem[]

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

MatchCodesEnum[]

Um ou mais valores de código correspondentes 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 código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha uma 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 código geográfico que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar a hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um resultado Ambiguous e UpHierarchy é quando você fornece informações de endereço completas, mas o serviço de geocodificação 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 é uma 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 local 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 UpHierarchy com um tipo de entidade RoadBlock poderá ser retornado.
type

string

Um dos: * Endereço * BloqueioEstrada * InterseçãoEstrada * Bairro * Lugar Povoado * CEP1 * DivisãoAdministrativa1 * DivisãoAdministrativa2 * PaísRegião

FeatureTypeEnum

Enumeração

O tipo de um recurso deve ser Feature.

Valor Description
Feature

Especifica o tipo de objeto GeoJSON Feature.

GeocodePointsItem

Objeto

Um ponto de geocódigo.

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 de GeoJSON Point válido. 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 ponto de Route, um ponto Display ou ambos. Use Route pontos se estiver criando uma rota para o local. Use Display pontos se estiver mostrando o local em um mapa. Por exemplo, se o local for um parque, um ponto Route poderá especificar uma entrada para o parque em que você pode entrar com um carro e um ponto Display pode ser um ponto que especifica o centro do parque.

GeocodingResponse

Objeto

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

Nome Tipo Description
features

FeaturesItem[]

Uma série de recursos retornados da consulta.
nextLink

string

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

FeatureCollectionEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

GeoJsonObjectType

Enumeração

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.

Valor Description
Point

GeoJSON Point geometria.
MultiPoint

GeoJSON MultiPoint geometria.
LineString

GeoJSON LineString geometria.
MultiLineString

GeoJSON MultiLineString geometria.
Polygon

GeoJSON Polygon geometria.
MultiPolygon

GeoJSON MultiPolygon geometria.
GeometryCollection

GeoJSON GeometryCollection geometria.
Feature

GeoJSON Feature objeto.
FeatureCollection

GeoJSON FeatureCollection objeto.

GeoJsonPoint

Objeto

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

Nome Tipo Description
bbox

number[] (double)

Caixa delimitadora. Projeção usada – 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 de longitude e de 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

Objeto

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 de interseção.
secondaryStreet2

string

Se houver, a segunda rua de interseção.

MatchCodesEnum

Enumeração

Um enum representando o código de correspondência.

Valor Description
Good

Bom
Ambiguous

Ambíguo
UpHierarchy

UpHierarchy

UsageTypeEnum

Enumeração

Um enum representando o tipo de uso.

Valor Description
Display

Display
Route

Route