Search - Get Reverse Geocoding Batch

Serviço:: Maps

Versão da API:: 2026-01-01

Use para enviar um lote de consultas para a API de geocodificação reversa em uma única solicitação.
A API Get Reverse Geocoding Batch é uma solicitação http POST que envia lotes de até 100 consultas para API de geocodificação reversa usando uma única solicitação.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version={api-version}

Corpo POST para solicitação em lote

Para enviar o consultas de de geocodificação reversa, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 2 consultas de de geocodificação reversa:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Uma geocodificação reversa objeto batchItem pode aceitar qualquer um dos parâmetros de URI de de geocodificação reversacompatíveis.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

GeocodingResponse - Se a consulta foi concluída com êxito.
Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.

POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	O nome de host do serviço Azure Mapas. Use `https://atlas.microsoft.com` para a Azure nuvem pública. Para direcionar uma geografia Azure Mapas específica ou uma nuvem soberana, veja Azure Mapas escopo geográfico.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
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.
Accept-Language		string	Idioma no qual os resultados da pesquisa devem ser retornados. Consulte de idiomas com suporte para obter detalhes.

Nome

Obrigatório

Tipo

Description

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.

Accept-Language

string

Idioma no qual os resultados da pesquisa devem ser retornados.

Consulte de idiomas com suporte para obter detalhes.

Corpo da solicitação

Nome	Tipo	Description
batchItems	ReverseGeocodingBatchRequestItem[]	As consultas de geocodificação reversa para processar neste lote. Cada entrada é uma requisição independente de geocodificação reversa; o serviço retorna uma entrada correspondente em `GeocodingBatchResponse.batchItems` por consulta, na mesma ordem.

Respostas

Nome	Tipo	Description
200 OK	GeocodingBatchResponse	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

GeocodingBatchResponse

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

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 entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

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

Note

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

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

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

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

Tipo: apiKey
Em: header

Exemplos

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Solicitação de exemplo

HTTP

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2026-01-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.138681,
        47.630358
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        47.630358,
        -122.138681
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "Medium",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "name": "Washington",
                  "shortName": "WA"
                },
                {
                  "name": "King County",
                  "shortName": "King Co."
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
              "streetName": "152nd Ave NE",
              "streetNumber": "2267",
              "addressLine": "2267 152nd Ave NE"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "error": {
        "code": "Bad Request",
        "message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
      },
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Definições

Nome	Description
Address	O endereço de um local sugerido por geocodificação ou autocompletamento, analisado em campos estruturados. A escassez é normal: apenas os campos que a entidade resolvida fornece são preenchidos. Por exemplo, `streetName` e `streetNumber` aparece apenas para endereços no nível da rua, e `intersection` aparece apenas para resultados de interseções rodoviárias.
AddressAdminDistrictsItem	Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no arranjo pai `Address.adminDistricts` , onde as entradas são ordenadas do mais grosseiro para o mais fino.
AddressCountryRegion	O país ou região que contém o endereço, identificado pelo nome de exibição e código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido em uma determinada resposta.
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 junto com os códigos de correspondência para obter informações mais completas sobre a combinação. A confiança de uma localização geocodificada é baseada em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do usuário, se especificada.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
FeatureCollectionEnum	O `GeoJSON` tipo de objeto usado na raiz das respostas bem-sucedidas das operações de geocodificação direta, geocodificação reversa e autocompletar (incluindo suas variantes em lote). O único valor é `FeatureCollection`, conforme definido no RFC 7946. `Get Polygon` é a única exceção: sua raiz de resposta é um `GeoJSON Feature`, veja `FeatureTypeEnum`.
FeaturesItem	Uma única entrada no `features` array de um `GeocodingResponse`, conforme a forma do `GeoJSON Feature` objeto. Representa uma localização geocodificada: dados estruturados em `properties`, uma coordenada representativa em `geometry`, e uma caixa delimitadora opcional em `bbox`.
FeaturesItemProperties	A `properties` carga útil de uma característica em um `GeocodingResponse`. Carrega os indicadores de tipo de entidade e qualidade de correspondência para a localização geocodificada, seus componentes de endereço analisados e um ou mais pontos de geocódigo que atribuem a localização a coordenadas específicas.
FeatureTypeEnum	O `GeoJSON` tipo de objeto para `Feature` objetos. Etiqueta cada entrada dentro do `features` array de uma `FeatureCollection` resposta (geocodificação, geocodificação reversa, autocompletamento) e aparece na raiz da `Get Polygon` resposta. O único valor é `Feature`, conforme definido no RFC 7946.
GeocodePointsItem	Um ponto de geocodificação para uma localização: uma coordenada mais metadados que descrevem como o ponto foi calculado (`calculationMethod`) e para que ele é mais adequado (`usageTypes`). Um único recurso normalmente retorna separados `Display` e `Route` aponta para que os chamadores possam escolher o que se encaixa na tarefa.
GeocodingBatchResponse	O corpo de resposta bem-sucedida retornou por `Get Geocoding Batch`. Carrega uma `summary` indicação de quantas consultas enviadas foram bem-sucedidas, além de um `batchItems` array contendo uma entrada de resposta por consulta na solicitação, na mesma ordem do array de requisições `batchItems` .
GeocodingBatchResponseItem	Uma única entrada dentro `GeocodingBatchResponse.batchItems`de , carregando o resultado de uma das consultas da entrada correspondente `GeocodingBatchRequestBody.batchItems` . Consultas bem-sucedidas surgem geocodificadas `features` aqui na mesma forma que `GeocodingResponse`; consultas falhadas apresentam informações diagnósticas via `error` instead. Exatamente um de `features` ou `error` é preenchido por entrada.
GeocodingBatchResponseSummary	Carrega contagens agregadas para uma `Get Geocoding Batch` resposta: o tamanho do lote enviado e quantas de suas consultas foram processadas com sucesso. Usado como o tipo de `GeocodingBatchResponse.summary`.
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	Detalhes do cruzamento para um endereço resolvidos como um cruzamento de estrada — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um `RoadIntersection`; o pai `Address.intersection` é omitido.
MatchCodesEnum	Um valor de código de correspondência indicando como o serviço de geocodificação produziu um determinado resultado de localização. O `matchCodes` campo em uma característica é um array desses valores; combine-os com `confidence` e `type` para avaliar a qualidade da correspondência.
ResultTypeEnum	Um tipo de entidade retornado pela `Get Reverse Geocoding Batch` operação. Fornecido como um ou mais valores no campo por item `resultTypes` por lote para restringir a resposta daquele item a tipos específicos de localizações; quando o campo é omitido, todos os tipos de entidade são elegíveis. Quando entidades de mais de um tipo correspondem a uma coordenada, apenas a mais específica é retornada. Listado do mais específico ao menos específico: `Address`, `Neighborhood`, `PopulatedPlace`, `Postcode1AdminDivision1`, , `AdminDivision2`, , . `CountryRegion`
ReverseGeocodingBatchRequestBody	O órgão de solicitação da `Get Reverse Geocoding Batch` operação. Carrega uma ou mais consultas individuais de geocodificação reversa — entre 1 e 100, inclusive — que o serviço processa como uma única chamada e retorna como um array paralelo `batchItems` em `GeocodingBatchResponse`.
ReverseGeocodingBatchRequestItem	Uma consulta de geocodificação reversa dentro de um `ReverseGeocodingBatchRequestBody.batchItems` array. Cada item é uma requisição independente de geocodificação reversa equivalente a uma única chamada para `Get Reverse Geocoding`, expressa como campos em vez de parâmetros de consulta URL. Especifique a localização a ser reverse-geocodificada via `coordinates`; opcionalmente restringir os tipos de entidade via `resultTypes` e a visão geopolítica via `view`.
UsageTypeEnum	O uso pretendido para um ponto de geocódigo. Um ponto de geocódigo retornado pelo serviço carrega um ou mais tipos de uso que indicam como um aplicativo cliente deve consumir o ponto: por exemplo, exibindo a localização em um mapa versus rotear um veículo para ele.

Address

Objeto

O endereço de um local sugerido por geocodificação ou autocompletamento, analisado em campos estruturados. A escassez é normal: apenas os campos que a entidade resolvida fornece são preenchidos. Por exemplo, streetName e streetNumber aparece apenas para endereços no nível da rua, e intersection aparece apenas para resultados de interseções rodoviárias.

Nome	Tipo	Description
addressLine	string	A primeira linha do endereço, normalmente o nome e número da rua. Por exemplo, `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	As subdivisões administrativas que contêm o endereço, ordenadas do mais grosseiro ao mais refinado. A primeira entrada é tipicamente a subdivisão de primeira ordem (como um estado dos EUA ou uma província canadense); Entradas subsequentes cobrem divisões mais detalhadas onde o país, dependência ou região as define (como um condado no índice 1).
countryRegion	AddressCountryRegion	O país ou região que contém o endereço, com seu nome de exibição e o código de país ISO 3166-1 Alpha-2.
formattedAddress	string	O endereço completo é apresentado como uma única string legível por humanos, com os componentes unidos de acordo com as convenções do país ou região do endereço. Exemplo: `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	Os detalhes das ruas que se cruzam para o endereço, preenchidos quando a entidade resolvida é um `RoadIntersection` (como a esquina de duas ruas nomeadas).
locality	string	A localidade onde o endereço se encontra: geralmente uma cidade, vila ou vila. Por exemplo: `"Redmond"`.
neighborhood	string	O bairro nomeado dentro da localidade, quando um é identificado.
postalCode	string	O código postal do endereço, quando um é definido. Exemplo: `"98052"`.
streetName	string	O componente de nome de rua do endereço, quando a entidade resolvida é um endereço de nível de rua. Exemplo: `"NE 24th St"`.
streetNumber	string	O número da casa ou prédio na rua, quando a entidade resolvida é um endereço no nível da rua. Exemplo: `"15127"`.

AddressAdminDistrictsItem

Objeto

Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no arranjo pai Address.adminDistricts , onde as entradas são ordenadas do mais grosseiro para o mais fino.

Nome	Tipo	Description
name	string	O nome completo do loteamento. Por exemplo, `"Washington"` para um estado dos EUA, ou `"King County"` para um condado.
shortName	string	A forma curta ou abreviada do nome da subdivisão, quando definido um. Por exemplo, `"WA"` para um estado dos EUA. Subdivisões mais finas frequentemente não possuem forma curta distinta, caso em `shortName` que se `name` repete (como `"King County"`).

AddressCountryRegion

Objeto

O país ou região que contém o endereço, identificado pelo nome de exibição e código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido em uma determinada resposta.

Nome	Tipo	Description
ISO	string	O código de país ISO 3166-1 Alpha-2 para o país ou região. Por exemplo, `"US"` para os Estados Unidos, ou `"GB"` para o Reino Unido.
name	string	O nome de exibição do país ou região. Por exemplo, `"Estados Unidos"`.

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 junto com os códigos de correspondência para obter informações mais completas sobre a combinação.

A confiança de uma localização geocodificada é baseada em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do usuário, se especificada.

Valor Description

High

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 um pedido incluir uma localização ou uma visualização, a classificação pode mudar de acordo. Por exemplo, uma consulta de localização para "Paris" retorna tanto "Paris, França" quanto "Paris, TX" 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 Paris, TX, ou muito próximo dela, ou a visualização do mapa indique que o usuário está buscando naquela á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 tem confiança de que o código postal corresponde aos dados, a confiança é definida como `Medium` e o código de correspondência é definido para `UpHierarchy` indicar que o serviço não pôde corresponder a todas as informações e teve que buscar na hierarquia superior. 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 tanto "148th Ave SE" quanto "148th Ave NE" 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 correspondência para o número da casa, o resultado do geocódigo com um `RoadBlock` tipo de entidade pode ser retornado.
Low	Baixa confiança na partida.

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 um pedido incluir uma localização ou uma visualização, a classificação pode mudar de acordo. Por exemplo, uma consulta de localização para "Paris" retorna tanto "Paris, França" quanto "Paris, TX" 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 Paris, TX, ou muito próximo dela, ou a visualização do mapa indique que o usuário está buscando naquela á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 tem confiança de que o código postal corresponde aos dados, a confiança é definida como Medium e o código de correspondência é definido para UpHierarchy indicar que o serviço não pôde corresponder a todas as informações e teve que buscar na hierarquia superior.

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 tanto "148th Ave SE" quanto "148th Ave NE" 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 correspondência para o número da casa, o resultado do geocódigo com um RoadBlock tipo de entidade pode ser retornado.

Low

Baixa confiança na partida.

ErrorAdditionalInfo

Objeto

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

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código do erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

FeatureCollectionEnum

Enumeração

O GeoJSON tipo de objeto usado na raiz das respostas bem-sucedidas das operações de geocodificação direta, geocodificação reversa e autocompletar (incluindo suas variantes em lote). O único valor é FeatureCollection, conforme definido no RFC 7946. Get Polygon é a única exceção: sua raiz de resposta é um GeoJSON Feature, veja FeatureTypeEnum.

Valor	Description
FeatureCollection	O tipo de `GeoJSON FeatureCollection` objeto. Aparece como a raiz de todo corpo de resposta bem-sucedido em geocodificação, geocodificação reversa e autocompletamento. `Get Polygon` usa uma `Feature` raiz em vez disso.

FeaturesItem

Objeto

Uma única entrada no features array de um GeocodingResponse, conforme a forma do GeoJSON Feature objeto. Representa uma localização geocodificada: dados estruturados em properties, uma coordenada representativa em geometry, e uma caixa delimitadora opcional em bbox.

Nome	Tipo	Description
bbox	number[] (double)	O menor retângulo alinhado ao eixo que contém a geometria da estrutura, na ordem WGS 84 de longitude/latitude. Codificado conforme `[westLon, southLat, eastLon, northLat]`o RFC 7946, Seção 5.
geometry	GeoJsonPoint	O primário `GeoJSON Point` representa a localização geocodificada, com coordenadas na ordem WGS 84 longitude/latitude.
id	string	Um identificador opcional atribuído pelo serviço para o recurso, quando um estiver disponível.
properties	FeaturesItemProperties	Dados estruturados sobre a localização geocodificada, incluindo seu tipo de entidade, indicadores de qualidade de correspondência, componentes de endereço e um ou mais pontos de geocodificação.
type	FeatureTypeEnum	O tipo de `GeoJSON` objeto. Sempre `Feature`, conforme definido no RFC 7946.

FeaturesItemProperties

Objeto

A properties carga útil de uma característica em um GeocodingResponse. Carrega os indicadores de tipo de entidade e qualidade de correspondência para a localização geocodificada, seus componentes de endereço analisados e um ou mais pontos de geocódigo que atribuem a localização a coordenadas específicas.

Nome	Tipo	Description
address	Address	O endereço da localização geocodificada, dividido em campos estruturados como localidade, CEIP, país/região e (quando disponível) nome e número da rua.
confidence	ConfidenceEnum	Quão fortemente a localização geocodificada corresponde ao pedido. Use junto `matchCodes` com para ter uma visão completa da qualidade do jogo. Veja `ConfidenceEnum` a lista de valores e os fatores que influenciam a avaliação.
geocodePoints	GeocodePointsItem[]	Um ou mais pontos de geocódigo para o local, cada um marcado com como foi derivado (`calculationMethod`) e para o que é mais adequado (`usageTypes`). Por exemplo, `Display` para posicionamento visual em um mapa, ou `Route` para uso como destino de navegação.
matchCodes	MatchCodesEnum[]	Como o serviço de geocodificação produziu esse resultado em relação à consulta: uma correspondência direta na especificidade solicitada (`Good`), um entre vários candidatos (`Ambiguous`), ou um recurso para um nível menos preciso da hierarquia geográfica (`UpHierarchy`). Múltiplos valores podem estar presentes. Por exemplo, um `Ambiguous` pareamento plus `UpHierarchy` indica que o serviço não conseguiu corresponder à especificidade solicitada e encontrou múltiplas correspondências em um nível mais grosseiro. Veja `MatchCodesEnum` para descrições por valor; combine com `confidence` para uma visão completa da qualidade da correspondência.
type	string	O tipo de entidade para o qual a localização geocodificada foi resolvida. Um de: , , , , , , , , `AdminDivision2`, ou `CountryRegion`. `Postcode1AdminDivision1PopulatedPlaceNeighborhoodRoadIntersectionRoadBlockAddress`

FeatureTypeEnum

Enumeração

O GeoJSON tipo de objeto para Feature objetos. Etiqueta cada entrada dentro do features array de uma FeatureCollection resposta (geocodificação, geocodificação reversa, autocompletamento) e aparece na raiz da Get Polygon resposta. O único valor é Feature, conforme definido no RFC 7946.

Valor	Description
Feature	O tipo de `GeoJSON Feature` objeto. Aparece em cada Recurso dentro de uma `FeatureCollection` resposta e na raiz da resposta `Get Polygon` .

GeocodePointsItem

Objeto

Um ponto de geocodificação para uma localização: uma coordenada mais metadados que descrevem como o ponto foi calculado (calculationMethod) e para que ele é mais adequado (usageTypes). Um único recurso normalmente retorna separados Display e Route aponta para que os chamadores possam escolher o que se encaixa na tarefa.

Nome	Tipo	Description
calculationMethod	CalculationMethodEnum	Como o ponto foi calculado. Por exemplo, se encaixar no telhado de um prédio ou interpolar ao longo da linha central de uma estrada. Veja `CalculationMethodEnum` a lista de valores.
geometry	GeoJsonPoint	A coordenada desse ponto de geocódigo é um `GeoJSON Point`, com valores na ordem de longitude/latitude WGS 84.
usageTypes	UsageTypeEnum[]	Para que o ponto de geocódigo é mais adequado — `Display` para posicionamento visual em um mapa ou `Route` como destino de roteamento. Um ponto pode valer ambos. Veja `UsageTypeEnum` os detalhes por valor, incluindo como cada um é posicionado para características com extensão não trivial.

GeocodingBatchResponse

Objeto

O corpo de resposta bem-sucedida retornou por Get Geocoding Batch. Carrega uma summary indicação de quantas consultas enviadas foram bem-sucedidas, além de um batchItems array contendo uma entrada de resposta por consulta na solicitação, na mesma ordem do array de requisições batchItems .

Nome	Tipo	Description
batchItems	GeocodingBatchResponseItem[]	Os resultados por consulta do lote. Cada entrada corresponde posicionalmente à entrada da solicitação no mesmo índice do array em `GeocodingBatchRequestBody.batchItems`. Entradas com `error` preenchidas representam consultas que falharam; entradas com `features` preenchidas representam consultas que tiveram sucesso.
nextLink	string	Contém a URL para buscar a próxima página de resultados caso a resposta seja paginada. Isso é útil quando a resposta é grande demais para ser retornada em uma única chamada, permitindo que os usuários naveguem por várias páginas de resultados.
summary	GeocodingBatchResponseSummary	O agregado conta para o lote como um todo, o total de consultas enviadas e quantas delas foram concluídas com sucesso.

GeocodingBatchResponseItem

Objeto

Uma única entrada dentro GeocodingBatchResponse.batchItemsde , carregando o resultado de uma das consultas da entrada correspondente GeocodingBatchRequestBody.batchItems . Consultas bem-sucedidas surgem geocodificadas features aqui na mesma forma que GeocodingResponse; consultas falhadas apresentam informações diagnósticas via error instead. Exatamente um de features ou error é preenchido por entrada.

Nome	Tipo	Description
error	ErrorDetail	Informações de diagnóstico para uma consulta que falhou dentro do lote, o caminho de erro por entrada complementando o caminho de sucesso em `features`. Preenchidos apenas quando a entrada falhava; veja `ErrorDetail` para a forma por erro.
features	FeaturesItem[]	O array de `GeoJSON Feature` objetos geocodificados para a consulta desta entrada em lote. Cada um `Feature` representa uma única localização geocodificada com detalhes expostos via `properties` e sua coordenada primária via `geometry`. Povoado apenas quando a entrada foi bem-sucedida.
nextLink	string	Contém a URL para buscar a próxima página de resultados caso a resposta seja paginada. Isso é útil quando a resposta é grande demais para ser retornada em uma única chamada, permitindo que os usuários naveguem por várias páginas de resultados.
optionalId	string	O identificador fornecido pelo chamador ecoava de volta do correspondente `GeocodingBatchRequestItem.optionalId`. Preenchido apenas quando a entrada do pedido fornecia um. Útil para correlação do lado da aplicação quando a posição do array não é suficiente.
type	FeatureCollectionEnum	O `GeoJSON` tipo de objeto do corpo de sucesso desta entrada. Sempre `FeatureCollection`, conforme definido no RFC 7946. Povoado apenas quando a entrada foi bem-sucedida.

GeocodingBatchResponseSummary

Objeto

Carrega contagens agregadas para uma Get Geocoding Batch resposta: o tamanho do lote enviado e quantas de suas consultas foram processadas com sucesso. Usado como o tipo de GeocodingBatchResponse.summary.

Nome	Tipo	Description
successfulRequests	integer (int32)	O número de consultas no lote que foram processadas com sucesso — aquelas cuja entrada de resposta em `GeocodingBatchResponse.batchItems` contém `features` em vez de `error`.
totalRequests	integer (int32)	O número total de consultas enviadas no lote. Subtrai `successfulRequests` para derivar o número de consultas que falharam.

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

Detalhes do cruzamento para um endereço resolvidos como um cruzamento de estrada — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um RoadIntersection; o pai Address.intersection é omitido.

Nome	Tipo	Description
baseStreet	string	A rua principal do cruzamento — normalmente a rua que o número do endereço menciona.
displayName	string	Um nome legível para o cruzamento que combina as ruas transversais, como `"5th Avenue & Main Street"`.
intersectionType	string	Um pequeno rótulo descrevendo a forma da interseção. Por exemplo, distinguir um cruzamento em nível de um cruzamento em nível, como uma ponte ou viaduta.
secondaryStreet1	string	A primeira rua transversal que se encontra `baseStreet` no cruzamento.
secondaryStreet2	string	A segunda rua transversal no cruzamento, quando há uma. Habitado apenas para cruzamentos de três ou mais ruas.

MatchCodesEnum

Enumeração

Um valor de código de correspondência indicando como o serviço de geocodificação produziu um determinado resultado de localização. O matchCodes campo em uma característica é um array desses valores; combine-os com confidence e type para avaliar a qualidade da correspondência.

Valor	Description
Good	O serviço de geocodificação produziu esse candidato sem ampliar a consulta: o resultado corresponde à consulta na especificidade solicitada.
Ambiguous	O local é um de um conjunto de possíveis correspondências. Por exemplo, ao consultar 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 uma subida 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.

ResultTypeEnum

Enumeração

Um tipo de entidade retornado pela Get Reverse Geocoding Batch operação. Fornecido como um ou mais valores no campo por item resultTypes por lote para restringir a resposta daquele item a tipos específicos de localizações; quando o campo é omitido, todos os tipos de entidade são elegíveis. Quando entidades de mais de um tipo correspondem a uma coordenada, apenas a mais específica é retornada. Listado do mais específico ao menos específico: Address, Neighborhood, PopulatedPlace, Postcode1AdminDivision1, , AdminDivision2, , . CountryRegion

Valor	Description
Address	Um endereço específico.
Neighborhood	Uma área reconhecida localmente dentro de um local povoado, frequentemente com limites informais ou culturalmente definidos.
PopulatedPlace	Uma área concentrada de assentamento humano, como uma cidade, vila ou vila.
Postcode1	A menor categoria de código postal, como um CEP.
AdminDivision1	Primeiro nível administrativo dentro do país/região, como um estado ou província.
AdminDivision2	Segundo nível administrativo dentro do país/região, como um condado.
CountryRegion	Um país ou região.

ReverseGeocodingBatchRequestBody

Objeto

O órgão de solicitação da Get Reverse Geocoding Batch operação. Carrega uma ou mais consultas individuais de geocodificação reversa — entre 1 e 100, inclusive — que o serviço processa como uma única chamada e retorna como um array paralelo batchItems em GeocodingBatchResponse.

Nome	Tipo	Description
batchItems	ReverseGeocodingBatchRequestItem[]	As consultas de geocodificação reversa para processar neste lote. Cada entrada é uma requisição independente de geocodificação reversa; o serviço retorna uma entrada correspondente em `GeocodingBatchResponse.batchItems` por consulta, na mesma ordem.

ReverseGeocodingBatchRequestItem

Objeto

Uma consulta de geocodificação reversa dentro de um ReverseGeocodingBatchRequestBody.batchItems array. Cada item é uma requisição independente de geocodificação reversa equivalente a uma única chamada para Get Reverse Geocoding, expressa como campos em vez de parâmetros de consulta URL. Especifique a localização a ser reverse-geocodificada via coordinates; opcionalmente restringir os tipos de entidade via resultTypes e a visão geopolítica via view.

Nome	Tipo	Description
coordinates	number[] (double)	O local para geocodificar reversamente, codificado conforme `[longitude, latitude]` a ordem WGS 84. Por exemplo, `[-122.138681, 47.630358]` para um ponto em Redmond, Washington.
optionalId	string	Um identificador opcional fornecido pelo chamador ecoava de volta na entrada correspondente como `GeocodingBatchResponseItem.optionalId`. Útil para correlacionar respostas a solicitações por um identificador estável do lado da aplicação, em vez de depender apenas da posição do array.
resultTypes	ResultTypeEnum[]	Restringe a resposta a tipos específicos de locais. Quando omitidos, todos os tipos de entidade são elegíveis. Veja `ResultTypeEnum` a lista de valores e o comportamento de seleção de vitórias mais específicas quando entidades de múltiplos tipos coincidem.
view	string	Um código de região/país ISO 3166-1 Alpha-2 identificando a região cuja visão geopolítica deve ser aplicada a fronteiras e rótulos disputados na resposta. Veja Visualizações Suportadas para os valores disponíveis.

UsageTypeEnum

Enumeração

O uso pretendido para um ponto de geocódigo. Um ponto de geocódigo retornado pelo serviço carrega um ou mais tipos de uso que indicam como um aplicativo cliente deve consumir o ponto: por exemplo, exibindo a localização em um mapa versus rotear um veículo para ele.

Valor	Description
Display	O ponto de geocódigo é adequado para exibir a localização em um mapa. Para uma característica com extensão não trivial (como um parque ou edifício), o `Display` ponto está tipicamente próximo ao centro visual da característica.
Route	O ponto de geocódigo é adequado como destino de uma rota. Para uma característica com extensão não trivial (como um parque ou edifício), o `Route` ponto normalmente está posicionado em uma entrada acessível por veículos, em vez do centro visual.