Search - Get Geocoding Batch

Referência

Service:: Maps

API Version:: 2024-04-01-preview

API do Batch de Geocodificação

Aplica-se a: veja escalões de preço.

A API do Batch de Geocodificação envia lotes de consultas para a API de Geocodificação com apenas uma única chamada à API. A API permite que o autor da chamada crie um lote de até 100 consultas.

Submeter Pedido do Batch Síncrono

A API Síncrona é recomendada para pedidos em lote simples. Quando o serviço receber um pedido, este responderá assim que os itens do lote forem calculados e não haverá possibilidade de obter os resultados mais tarde. A API Síncrona devolverá um erro de tempo limite (uma resposta 408) se o pedido demorar mais de 60 segundos. O número de itens de lote está limitado a 100 para esta API.

POST https://atlas.microsoft.com/geocode:batch

CORPO POST para Pedido do Batch

Para enviar as consultas de geocodificação , irá utilizar um POST pedido no qual o corpo do pedido irá conter a batchItems matriz no json formato e o Content-Type cabeçalho será definido como application/json. Eis um corpo de pedido de exemplo que contém 2 consultas de geocodificação :

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

Um objeto batchItem de geocodificação pode aceitar qualquer um dos parâmetros URI de geocodificação suportados.

O lote deve conter, pelo menos, 1 consulta.

Modelo de Resposta do Batch

A resposta em lote contém um summary componente que indica o totalRequests que fazia parte do pedido de lote original e successfulRequests , por exemplo, consultas que foram executadas com êxito. A resposta em lote também inclui uma batchItems matriz que contém uma resposta para cada consulta no pedido batch. O batchItems irá conter os resultados na mesma ordem em que as consultas originais foram enviadas no pedido batch. Cada item é de um dos seguintes tipos:

GeocodingResponse - Se a consulta tiver sido concluída com êxito.
Error - Se a consulta tiver falhado. A resposta conterá um code e um message neste caso.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	Número da versão da API Azure Maps.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Azure AD. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Azure AD segurança no Azure Maps consulte os seguintes artigos para obter orientações.
Accept-Language		string	Idioma no qual os resultados da pesquisa devem ser devolvidos. Consulte idiomas suportados para obter detalhes.

Name

Necessário

Tipo

Description

x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Azure AD. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Azure AD segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Accept-Language

string

Idioma no qual os resultados da pesquisa devem ser devolvidos.

Consulte idiomas suportados para obter detalhes.

Corpo do Pedido

Name	Tipo	Description
batchItems	GeocodingBatchRequestItem[]	A lista de consultas a processar.

Respostas

Name	Tipo	Description
200 OK	GeocodingBatchResponse	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado. Headers x-ms-error-code: string

Name

Tipo

Description

200 OK

GeocodingBatchResponse

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Headers

x-ms-error-code: string

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Nota

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.
O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID.
O controlo de acesso baseado em funções do Azure é configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

A Geocoding Batch API call containing 2 Geocoding queries

Sample Request

HTTP

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

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

Sample Response

Status code:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "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
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' was passed"
      }
    }
  ]
}

Definições

Name	Description
Address	O endereço do resultado
AdminDistricts	O nome da subdivisão no país ou região de um endereço. Normalmente, este elemento é tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão da segunda, terceira ou quarta ordem num país, dependência ou região.
CalculationMethodEnum	O método que foi utilizado para calcular o ponto de geocódigo.
ConfidenceEnum	O nível de confiança de que o resultado da localização geocodificada corresponde. Utilize este valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência. A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificado.
CountryRegion
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
FeatureCollectionEnum	O tipo de objeto FeatureCollection tem de ser FeatureCollection.
FeaturesItem
FeatureTypeEnum	O tipo de funcionalidade tem de ser Funcionalidade.
GeocodePoints	Uma coleção de pontos geocódigo que diferem na forma como foram calculados e na respetiva utilização sugerida.
GeocodingBatchRequestBody	A lista de consultas/pedidos de geocodificação de endereços a processar. A lista pode conter um máximo de 100 consultas e tem de conter, pelo menos, 1 consulta.
GeocodingBatchRequestItem	Objeto Batch Query
GeocodingBatchResponse	Este objeto é devolvido de uma chamada de serviço do Batch de Geocodificação bem-sucedida.
GeocodingBatchResponseItem
GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
Intersection	O endereço do resultado.
MatchCodesEnum	Um ou mais valores de código correspondem ao nível de geocodificação para cada localização na resposta. Por exemplo, uma localização geocodificada com códigos de correspondência de `Good` e `Ambiguous` significa que foi encontrada mais do que uma localização de geocódigo para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência. Da mesma forma, uma localização geocodificada com códigos de correspondência de `Ambiguous` e `UpHierarchy` implica que não foi possível localizar uma localização de geocódigo que corresponda a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um `AmbiguousUpHierarchy` resultado e é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço da rua e, em vez disso, devolve informações para mais do que um valor RoadBlock. Os valores possíveis são: `Good`: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas. `Ambiguous`: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher. `UpHierarchy`: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de `UpHierarchy` entidade RoadBlock.
Properties
Summary	Resumo do pedido de lote
UsageTypeEnum	A melhor utilização para o ponto de geocódigo. Cada ponto de geocódigo é definido como um `Route` ponto, um `Display` ponto ou ambos. Utilize `Route` pontos se estiver a criar uma rota para a localização. Utilize `Display` pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um `Route` ponto pode especificar uma entrada para o parque onde pode entrar com um carro, e um `Display` ponto pode ser um ponto que especifica o centro do parque.

Address

O endereço do resultado

Name	Tipo	Description
addressLine	string	AddressLine que inclui Nome da Rua e Número
adminDistricts	AdminDistricts[]	O nome da subdivisão no país ou região de um endereço. Normalmente, este elemento é tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão da segunda, terceira ou quarta ordem num país, dependência ou região.
countryRegion	CountryRegion
formattedAddress	string	Propriedade Endereço Formatado
intersection	Intersection	O endereço do resultado.
locality	string	propriedade de localidade
neighborhood	string	propriedade de bairro
postalCode	string	Propriedade Código Postal

AdminDistricts

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

Name	Tipo	Description
name	string	O nome do campo adminDistrict correspondente, Para adminDistrict[0], pode ser o nome completo do estado, como Washington, Para adminDistrict[1], este pode ser o nome completo do condado
shortName	string	O nome abreviado do campo adminDistrict correspondente, Para adminDistrict[0], este pode ser um nome abreviado de estado, como WA, Para adminDistrict[1], este pode ser o nome abreviado do concelho

CalculationMethodEnum

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

Name	Tipo	Description
Interpolation	string	O ponto de geocódigo foi correspondido a um ponto numa estrada através da interpolação.
InterpolationOffset	string	O ponto geocódigo foi correspondido a um ponto numa estrada usando interpolação com um desvio adicional para deslocar o ponto para o lado da rua.
Parcel	string	O ponto geocódigo foi correspondido ao centro de uma parcela.
Rooftop	string	O ponto geocódigo foi correspondido ao telhado de um edifício.

ConfidenceEnum

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

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

Name Tipo Description

High

Name	Tipo	Description
High	string	Se a confiança estiver definida como `High`, foi encontrada uma ou mais correspondências fortes. Várias `High` correspondências de confiança são ordenadas por ordem classificada por importância quando aplicável. Por exemplo, os marcos têm importância, mas os endereços não. Se um pedido incluir uma localização ou uma vista, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" devolve "Paris, França" e "Paris, TX" ambos com `High` confiança. "Paris, França" é sempre classificado em primeiro lugar devido a importância, a menos que uma localização de utilizador indique que o utilizador está dentro ou muito perto de Paris, TX ou a vista de mapa indica que o utilizador está a procurar nessa área.
Low	string
Medium	string	Em algumas situações, a correspondência devolvida pode não estar no mesmo nível que as informações fornecidas no pedido. Por exemplo, um pedido pode especificar informações de endereço e o serviço de geocódigo só poderá corresponder a um código postal. Neste caso, se o serviço de geocódigo tiver a confiança de que o código postal corresponde aos dados, a confiança é definida como `Medium` e o código de correspondência está definido para `UpHierarchy` especificar que não conseguiu corresponder a todas as informações e teve de procurar na hierarquia. Se as informações de localização na consulta forem ambíguas e não existirem 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 está definida como `Medium`. Por exemplo, uma consulta de localização para "148th Ave, Bellevue" pode devolver "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 uma localização específica, poderá ser devolvido um valor de localização menos preciso e a confiança está definida como `Medium`. Por exemplo, se for fornecido um endereço, mas não for encontrada uma correspondência para o número da casa, o resultado de geocódigo com um tipo de entidade Bloqueio de estrada poderá ser devolvido.

string

Se a confiança estiver definida como High, foi encontrada uma ou mais correspondências fortes. Várias High correspondências de confiança são ordenadas por ordem classificada por importância quando aplicável. Por exemplo, os marcos têm importância, mas os endereços não.

Se um pedido incluir uma localização ou uma vista, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" devolve "Paris, França" e "Paris, TX" ambos com High confiança. "Paris, França" é sempre classificado em primeiro lugar devido a importância, a menos que uma localização de utilizador indique que o utilizador está dentro ou muito perto de Paris, TX ou a vista de mapa indica que o utilizador está a procurar nessa área.

Low

string

Medium

string

Em algumas situações, a correspondência devolvida pode não estar no mesmo nível que as informações fornecidas no pedido. Por exemplo, um pedido pode especificar informações de endereço e o serviço de geocódigo só poderá corresponder a um código postal. Neste caso, se o serviço de geocódigo tiver a confiança de que o código postal corresponde aos dados, a confiança é definida como Medium e o código de correspondência está definido para UpHierarchy especificar que não conseguiu corresponder a todas as informações e teve de procurar na hierarquia.

Se as informações de localização na consulta forem ambíguas e não existirem 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 está definida como Medium. Por exemplo, uma consulta de localização para "148th Ave, Bellevue" pode devolver "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 uma localização específica, poderá ser devolvido um valor de localização menos preciso e a confiança está definida como Medium. Por exemplo, se for fornecido um endereço, mas não for encontrada uma correspondência para o número da casa, o resultado de geocódigo com um tipo de entidade Bloqueio de estrada poderá ser devolvido.

CountryRegion

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

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

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

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FeatureCollectionEnum

O tipo de objeto FeatureCollection tem de ser FeatureCollection.

Name	Tipo	Description
FeatureCollection	string

FeaturesItem

Name	Tipo	Description
bbox	number[]	Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes.
geometry	GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
id	string	ID da funcionalidade devolvida
properties	Properties
type	FeatureTypeEnum	O tipo de funcionalidade tem de ser Funcionalidade.

FeatureTypeEnum

O tipo de funcionalidade tem de ser Funcionalidade.

Name	Tipo	Description
Feature	string

GeocodePoints

Uma coleção de pontos geocódigo que diferem na forma como foram calculados e na respetiva utilização sugerida.

Name	Tipo	Description
calculationMethod	CalculationMethodEnum	O método que foi utilizado para calcular o ponto de geocódigo.
geometry	GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
usageTypes	UsageTypeEnum[]	A melhor utilização para o ponto de geocódigo. Cada ponto de geocódigo é definido como um `Route` ponto, um `Display` ponto ou ambos. Utilize `Route` pontos se estiver a criar uma rota para a localização. Utilize `Display` pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um `Route` ponto pode especificar uma entrada para o parque onde pode entrar com um carro, e um `Display` ponto pode ser um ponto que especifica o centro do parque.

GeocodingBatchRequestBody

A lista de consultas/pedidos de geocodificação de endereços a processar. A lista pode conter um máximo de 100 consultas e tem de conter, pelo menos, 1 consulta.

Name	Tipo	Description
batchItems	GeocodingBatchRequestItem[]	A lista de consultas a processar.

GeocodingBatchRequestItem

Objeto Batch Query

Name	Tipo	Valor Predefinido	Description
addressLine	string		A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. A utilização típica deste elemento seria fornecer um endereço de rua ou qualquer endereço oficial. Se for fornecida uma consulta, não deve utilizar este parâmetro.
adminDistrict	string		A parte da subdivisão do país de um endereço, como WA. Se for fornecida uma consulta, não deve utilizar este parâmetro.
adminDistrict2	string		O condado para o endereço estruturado, como King. Se for fornecida uma consulta, não deve utilizar este parâmetro.
adminDistrict3	string		A área nomeada para o endereço estruturado. Se for fornecida uma consulta, não deve utilizar este parâmetro.
bbox	number[]		Uma área retangular na terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos pelos valores de longitude e latitude. Para obter mais informações, veja Localização e Tipos de Área. Quando especificar este parâmetro, a área geográfica é tida em conta ao calcular os resultados de uma consulta de localização. Exemplo: [lon1, lat1, lon2, lat2]
coordinates	number[]		Um ponto na terra especificado como uma longitude e latitude. Quando especificar este parâmetro, a localização do utilizador é tida em conta e os resultados devolvidos podem ser mais relevantes para o utilizador. Exemplo: [lon, lat]
countryRegion	string		Restringir o resultado da geocodificação a um código de região/país ISO 3166-1 Alpha-2 especificado, por exemplo, FR. Isto irá limitar a pesquisa à região especificada. Se for fornecida uma consulta, não deve utilizar este parâmetro.
locality	string		A parte local de um endereço, como Seattle. Se for fornecida uma consulta, não deve utilizar este parâmetro.
optionalId	string		ID do pedido que seria apresentado no batchItem correspondente
postalCode	string		A parte do código postal de um endereço. Se for fornecida uma consulta, não deve utilizar este parâmetro.
query	string		Uma cadeia que contém informações sobre uma localização, como um endereço ou nome de marco.
top	integer	5	Número máximo de respostas que serão devolvidas. Predefinição: 5, mínimo: 1 e máximo: 20.
view	string	auto	Uma cadeia que especifica um código de região/país ISO 3166-1 Alpha-2. Isto irá alterar os limites e etiquetas geopolíticos contestados para se alinharem com a região de utilizador especificada.

GeocodingBatchResponse

Este objeto é devolvido de uma chamada de serviço do Batch de Geocodificação bem-sucedida.

Name	Tipo	Description
batchItems	GeocodingBatchResponseItem[]	Matriz que contém os resultados do lote.
nextLink	string	É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
summary	Summary	Resumo do pedido de lote

GeocodingBatchResponseItem

Name	Tipo	Description
error	ErrorDetail	O detalhe do erro.
features	FeaturesItem[]
nextLink	string	É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
optionalId	string	ID do batchItem que seria igual ao ID no pedido
type	FeatureCollectionEnum	O tipo de objeto FeatureCollection tem de ser FeatureCollection.

GeoJsonPoint

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

Name	Tipo	Description
bbox	number[]	Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes.
coordinates	number[]	A `Position` é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type	string: Point	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

O endereço do resultado.

Name	Tipo	Description
baseStreet	string	Rua principal para a localização.
displayName	string	Nome completo da interseção.
intersectionType	string	Tipo de interseção.
secondaryStreet1	string	A primeira rua interseccionada.
secondaryStreet2	string	Se houver, a segunda rua interseccionada.

MatchCodesEnum

Um ou mais valores de código correspondem ao nível de geocodificação para cada localização na resposta.

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

Da mesma forma, uma localização geocodificada com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível localizar uma localização de geocódigo que corresponda a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um AmbiguousUpHierarchy resultado e é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço da rua e, em vez disso, devolve informações para mais do que um valor RoadBlock.

Os valores possíveis são:

Good: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas.

Ambiguous: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher.

UpHierarchy: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock.

Name	Tipo	Description
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Name	Tipo	Description
address	Address	O endereço do resultado
confidence	ConfidenceEnum	O nível de confiança de que o resultado da localização geocodificada corresponde. Utilize este valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência. A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificado.
geocodePoints	GeocodePoints[]	Uma coleção de pontos geocódigo que diferem na forma como foram calculados e na respetiva utilização sugerida.
matchCodes	MatchCodesEnum[]	Um ou mais valores de código correspondem ao nível de geocodificação para cada localização na resposta. Por exemplo, uma localização geocodificada com códigos de correspondência de `Good` e `Ambiguous` significa que foi encontrada mais do que uma localização de geocódigo para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência. Da mesma forma, uma localização geocodificada com códigos de correspondência de `Ambiguous` e `UpHierarchy` implica que não foi possível localizar uma localização de geocódigo que corresponda a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um `AmbiguousUpHierarchy` resultado e é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço da rua e, em vez disso, devolve informações para mais do que um valor RoadBlock. Os valores possíveis são: `Good`: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas. `Ambiguous`: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher. `UpHierarchy`: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de `UpHierarchy` entidade RoadBlock.
type	string	Um dos seguintes: Endereço RoadBlock RoadIntersection Bairro PopulatedPlace Código postal1 AdminDivision1 AdminDivision2 RegiãoDoPaís

Summary

Resumo do pedido de lote

Name	Tipo	Description
successfulRequests	integer	Número de pedidos bem-sucedidos no lote
totalRequests	integer	Número total de pedidos no lote

UsageTypeEnum

A melhor utilização para o ponto de geocódigo. Cada ponto de geocódigo é definido como um Route ponto, um Display ponto ou ambos. Utilize Route pontos se estiver a criar uma rota para a localização. Utilize Display pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um Route ponto pode especificar uma entrada para o parque onde pode entrar com um carro, e um Display ponto pode ser um ponto que especifica o centro do parque.

Name	Tipo	Description
Display	string
Route	string

Search - Get Geocoding Batch

Submeter Pedido do Batch Síncrono

CORPO POST para Pedido do Batch

Modelo de Resposta do Batch

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

AADToken

Scopes

subscription-key

SAS Token

Exemplos

A Geocoding Batch API call containing 2 Geocoding queries

Sample Request

Sample Response

Definições

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum

Recursos adicionais