Search - Get Geocoding Batch

Serviço:: Maps

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

Use para enviar um lote de consultas para a API Geocoding em uma única solicitação.

A API é uma solicitação http que envia lotes de até 100 consultas para a API de de Geocodificação em 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/geocode:batch?api-version=2023-06-01

Corpo POST para solicitação em lote

Para enviar a consultas de de geocodificação, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz 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 :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Uma geocodificação objeto batchItem pode aceitar qualquer um dos parâmetros de URI dede geocodificação compatí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 https://atlas.microsoft.com/geocode:batch?api-version=2025-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Número de versão da API do Azure Mapas.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
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 obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no 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 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 obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no 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	GeocodingBatchRequestItem[]	A lista de consultas a serem processadas.

Respostas

Nome	Tipo	Description
200 OK	GeocodingBatchResponse	OKEY
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, 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 controlar o acesso em APIs e escopos específicos.

Observação

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure 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. 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 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	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 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 Geocoding Batch API call containing 2 Geocoding queries

Solicitação de exemplo

HTTP

POST https://atlas.microsoft.com/geocode:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "addressLine": "15127 NE 24th Street, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "query": "Pike Pl",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King County"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
              "streetName": "NE 24th St",
              "streetNumber": "15127",
              "addressLine": "15127 NE 24th St"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.138669,
                    47.630359
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.1387383,
                    47.630563
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.138669,
              47.630359
            ]
          },
          "bbox": [
            -122.14631082421619,
            47.62649628242932,
            -122.1310271757838,
            47.634221717570675
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
      }
    }
  ]
}

Definições

Nome	Description
Address	O endereço do resultado
AdminDistricts	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.
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.
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 objeto FeatureCollection deve ser FeatureCollection.
FeaturesItem
FeatureTypeEnum	O tipo de um recurso deve ser Feature.
GeocodePoints	Uma coleção de pontos de código geográfico que diferem em como eles foram calculados e seu uso sugerido.
GeocodingBatchRequestBody	A lista de consultas/solicitações de geocodificação de endereço a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.
GeocodingBatchRequestItem	Objeto De Consulta em Lote
GeocodingBatchResponse	Esse objeto é retornado de uma chamada de serviço do Lote de Geocodificação bem-sucedida.
GeocodingBatchResponseItem
GeoJsonPoint	Um tipo de geometria de `GeoJSON Point` válido. Consulte RFC 7946 para obter detalhes.
Intersection	O endereço do resultado.
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.
Properties
Summary	Resumo da solicitação em lote
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.

Address

Objeto

O endereço do resultado

Nome	Tipo	Description
addressLine	string	AddressLine que inclui Nome e Número da Rua
adminDistricts	AdminDistricts[]	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	CountryRegion
formattedAddress	string	Propriedade Address formatada
intersection	Intersection	O endereço do resultado.
locality	string	propriedade localidade
neighborhood	string	propriedade neighborhood
postalCode	string	Propriedade Postal Code
streetName	string	O nome da rua de formattedAddress
streetNumber	string	O número na rua, se disponível, de formattedAddress

AdminDistricts

Objeto

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.

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

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

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

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

CountryRegion

Objeto

Nome	Tipo	Description
ISO	string	ISO do país/região
name	string	nome do país/região

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 de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FeatureCollectionEnum

Enumeração

O tipo de objeto FeatureCollection deve ser FeatureCollection.

Valor	Description
FeatureCollection

FeaturesItem

Objeto

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	Properties
type	FeatureTypeEnum	O tipo de um recurso deve ser Feature.

FeatureTypeEnum

Enumeração

O tipo de um recurso deve ser Feature.

Valor	Description
Feature

GeocodePoints

Objeto

Uma coleção de pontos de código geográfico que diferem em como eles foram calculados e seu 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 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.

GeocodingBatchRequestBody

Objeto

A lista de consultas/solicitações de geocodificação de endereço a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.

Nome	Tipo	Description
batchItems	GeocodingBatchRequestItem[]	A lista de consultas a serem processadas.

GeocodingBatchRequestItem

Objeto

Objeto De Consulta em Lote

Nome	Tipo	Valor padrão	Description
addressLine	string		A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. O uso típico desse elemento seria fornecer um endereço de rua ou qualquer endereço oficial. Esse parâmetro não deve ser usado quando o `query` parâmetro é incluído na solicitação.
adminDistrict	string		A parte de 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	string		O condado do endereço estruturado, como King. Esse parâmetro não deve ser usado quando o `query` parâmetro é incluído na solicitação.
adminDistrict3	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	number[] (double)		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. Para obter mais informações, consulte Tipos de Localização e Área. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local. Exemplo: [lon1, lat1, lon2, lat2]
coordinates	number[] (double)		Um ponto na Terra especificado como longitude e latitude. Quando você especifica esse parâmetro, a localização do usuário é levada em conta e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: [lon, lat]
countryRegion	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./ Esse parâmetro não deve ser usado quando o `query` parâmetro é incluído na solicitação.
locality	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.
optionalId	string		ID da solicitação que seria mostrada no batchItem correspondente
postalCode	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	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	integer (int32) minimum: 1 maximum: 20	5	Número máximo de respostas que serão retornadas. Padrão: 5, mínimo: 1 e máximo: 20.
view	string	auto	Uma cadeia de caracteres que especifica uma de código de região/país iso 3166-1 alfa-2 do ISO 3166-1 . Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada.

GeocodingBatchResponse

Objeto

Esse objeto é retornado de uma chamada de serviço do Lote de Geocodificação bem-sucedida.

Nome	Tipo	Description
batchItems	GeocodingBatchResponseItem[]	Matriz que contém os resultados do lote.
nextLink	string	É o link para a próxima página dos recursos retornados. Se for a última página, não este campo.
summary	Summary	Resumo da solicitação em lote

GeocodingBatchResponseItem

Objeto

Nome	Tipo	Description
error	ErrorDetail	O detalhe do erro.
features	FeaturesItem[]
nextLink	string	É o link para a próxima página dos recursos retornados. Se for a última página, não este campo.
optionalId	string	id do batchItem que seria o mesmo que a ID na solicitação
type	FeatureCollectionEnum	O tipo de objeto FeatureCollection deve ser FeatureCollection.

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

Valor	Description
Good
Ambiguous
UpHierarchy

Properties

Objeto

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	GeocodePoints[]	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 destes: Endereço Bloqueio RoadIntersection Vizinhança PopulatedPlace Postcode1 AdminDivision1 AdminDivision2 Região/País

Summary

Objeto

Resumo da solicitação em lote

Nome	Tipo	Description
successfulRequests	integer (int32)	Número de solicitações bem-sucedidas no lote
totalRequests	integer (int32)	Número total de solicitações no lote

UsageTypeEnum

Enumeração

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.

Valor	Description
Display
Route

Compartilhar via

Search - Get Geocoding Batch

Enviar solicitação de lote síncrona

Corpo POST para solicitação em lote

Modelo de resposta em lote

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

AADToken

Escopos

subscription-key

SAS Token

Exemplos

A Geocoding Batch API call containing 2 Geocoding queries

Solicitação de exemplo

Resposta de exemplo

Definições

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum