Search - Get Geocoding Batch

Referência

Serviço:: Maps

Versão da API:: 2023-06-01

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

A Get Geocoding Batch API é uma solicitação HTTP POST que envia lotes de até 100 consultas para a API 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 de 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 as consultas de geocodificação , você usará uma POST solicitação em que o corpo da solicitação conterá a batchItems matriz no json formato e o Content-Type cabeçalho será definido application/jsoncomo . Aqui está um corpo de solicitação de exemplo que contém duas 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 de URI de geocodificação com suporte.

O lote deve conter pelo menos uma consulta.

Modelo de resposta em lote

A resposta em lote contém um summary componente que indica o totalRequests que fazia parte da solicitação em lote original e, por successfulRequests 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 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=2023-06-01

Parâmetros de URI

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

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 usar a segurança do Azure AD no Azure Mapas, confira os artigos a seguir para obter diretrizes .
Accept-Language		string	Idioma no qual os resultados da pesquisa devem ser retornados. Consulte 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 usar a segurança do Azure AD no Azure Mapas, confira os artigos a seguir para obter diretrizes .

Accept-Language

string

Idioma no qual os resultados da pesquisa devem ser retornados.

Consulte 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	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou sub-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 acessar o controle em APIs e escopos específicos.

Observação

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

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

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

Tipo: apiKey
Em: header

SAS Token

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

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

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

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

Resposta de exemplo

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

Nome	Description
Address	O endereço do resultado
AdminDistricts	O nome da subdivisão no país ou região de um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a segunda, terceira ou quarta subdivisão de ordem em um país, dependência ou região.
CalculationMethodEnum	O método que foi usado para calcular o ponto de geocódigo.
ConfidenceEnum	O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use esse valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência. A confiança de uma localização geocódigo baseia-se em muitos fatores, incluindo a importância relativa da localização geocódigo e da localização do usuário, se especificado.
CountryRegion
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
FeatureCollectionEnum	O tipo de um objeto FeatureCollection deve ser FeatureCollection.
FeaturesItem
FeatureTypeEnum	O tipo de um recurso deve ser Recurso.
GeocodePoints	Uma coleção de pontos de geocódigo que diferem 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 Batch Query
GeocodingBatchResponse	Esse objeto é retornado de uma chamada de serviço do Lote 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 de correspondência 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 e `Ambiguous` significa que mais de `Good` um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha pesquisa na hierarquia 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 uma localização de código geográfico que correspondesse a todas as informações de localização fornecidas, portanto, o serviço de geocódigo teve que pesquisar a hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de `Ambiguous` um resultado e é `UpHierarchy` quando você fornece informações de endereço completas, mas o serviço de geocódigo não pode localizar uma correspondência para o endereço de rua e, em vez disso, retorna informações para mais de um valor RoadBlock. Os valores possíveis são: `Good`: o local tem apenas uma correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas. `Ambiguous`: o local é um de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher. `UpHierarchy`: o local representa uma movimentação para cima 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. 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 `Route` ponto, um `Display` ponto ou ambos. Use `Route` pontos se você estiver criando uma rota para o local. Use `Display` pontos se você estiver mostrando o local em um mapa. Por exemplo, se o local for um parque, um `Route` ponto poderá especificar uma entrada para o parque onde você pode entrar com um carro e um `Display` ponto pode ser um ponto que especifica o centro do parque.

Address

O endereço do resultado

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

AdminDistricts

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

Nome	Tipo	Description
name	string	O nome do campo adminDistrict correspondente, Para adminDistrict[0], esse pode ser o nome completo do estado, como Washington, Para adminDistrict[1], esse pode ser o nome completo do município
shortName	string	O nome curto do campo adminDistrict correspondente, Para adminDistrict[0], esse pode ser um nome curto de estado, como WA, Para adminDistrict[1], esse pode ser o nome curto do município

CalculationMethodEnum

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

Nome	Tipo	Description
Interpolation	string	O ponto de código geográfico foi correspondido a um ponto em uma estrada usando interpolação.
InterpolationOffset	string	O ponto de 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	string	O ponto de código geográfico foi correspondido ao centro de uma parcela.
Rooftop	string	O ponto de geocódigo foi correspondido ao telhado de um prédio.

ConfidenceEnum

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

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

Nome Tipo Description

High

Nome	Tipo	Description
High	string	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 classificada por importância quando aplicável. Por exemplo, os pontos de referência têm importância, mas os endereços não. Se uma solicitação incluir um local ou uma exibição, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" retorna "Paris, França" e "Paris, TX" ambos com `High` confiança. "Paris, França" é sempre classificada em primeiro lugar devido à importância, a menos que um local de usuário indique que o usuário está em Paris, TX ou a exibição de mapa indica que o usuário está pesquisando nessa área.
Low	string
Medium	string	Em algumas situações, a correspondência retornada pode não estar no mesmo nível que as informações fornecidas na solicitação. Por exemplo, uma solicitação pode especificar informações de endereço e o serviço de geocódigo só pode corresponder a um código postal. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o cep corresponde aos dados, a confiança será definida `Medium` como e o código de correspondência será definido como `UpHierarchy` para especificar que ele não pôde corresponder a todas as informações e teve que pesquisar na hierarquia. Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar os locais (como o local do usuário ou a importância relativa do local), a confiança será definida `Medium`como . 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 `Medium`como . Por exemplo, se um endereço for fornecido, mas uma correspondência não for encontrada para o número da casa, o resultado do código geográfico com um tipo de entidade de bloqueio poderá ser retornado.

string

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 classificada por importância quando aplicável. Por exemplo, os pontos de referência têm importância, mas os endereços não.

Se uma solicitação incluir um local ou uma exibição, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" retorna "Paris, França" e "Paris, TX" ambos com High confiança. "Paris, França" é sempre classificada em primeiro lugar devido à importância, a menos que um local de usuário indique que o usuário está em Paris, TX ou a exibição de mapa indica que o usuário está pesquisando nessa área.

Low

string

Medium

string

Em algumas situações, a correspondência retornada pode não estar no mesmo nível que as informações fornecidas na solicitação. Por exemplo, uma solicitação pode especificar informações de endereço e o serviço de geocódigo só pode corresponder a um código postal. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o cep corresponde aos dados, a confiança será definida Medium como e o código de correspondência será definido como UpHierarchy para especificar que ele não pôde corresponder a todas as informações e teve que pesquisar na hierarquia.

Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar os locais (como o local do usuário ou a importância relativa do local), a confiança será definida Mediumcomo . Por exemplo, uma consulta de localização para "148th Ave, Bellevue" pode retornar "148th Ave SE" e "148th Ave NE" ambos com Medium confiança.

Se as informações de localização na consulta não fornecerem informações suficientes para geocodificar um local específico, um valor de localização menos preciso poderá ser retornado e a confiança será definida Mediumcomo . Por exemplo, se um endereço for fornecido, mas uma correspondência não for encontrada para o número da casa, o resultado do código geográfico com um tipo de entidade de bloqueio poderá ser retornado.

CountryRegion

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

ErrorAdditionalInfo

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

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

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

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FeatureCollectionEnum

O tipo de um objeto FeatureCollection deve ser FeatureCollection.

Nome	Tipo	Description
FeatureCollection	string

FeaturesItem

Nome	Tipo	Description
bbox	number[]	Caixa delimitadora. Projeção usada – EPSG:3857. Consulte RFC 7946 para obter detalhes.
geometry	GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
id	string	ID do recurso retornado
properties	Properties
type	FeatureTypeEnum	O tipo de um recurso deve ser Recurso.

FeatureTypeEnum

O tipo de um recurso deve ser Recurso.

Nome	Tipo	Description
Feature	string

GeocodePoints

Uma coleção de pontos de geocódigo que diferem 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 geocódigo.
geometry	GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
usageTypes	UsageTypeEnum[]	O melhor uso para o ponto de código geográfico. Cada ponto de código geográfico é definido como um `Route` ponto, um `Display` ponto ou ambos. Use `Route` pontos se você estiver criando uma rota para o local. Use `Display` pontos se você estiver mostrando o local em um mapa. Por exemplo, se o local for um parque, um `Route` ponto poderá especificar uma entrada para o parque onde você pode entrar com um carro e um `Display` ponto pode ser um ponto que especifica o centro do parque.

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.

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

GeocodingBatchRequestItem

Objeto Batch Query

Nome	Tipo	Valor padrão	Description
addressLine	string		A linha de rua oficial de um endereço relativo à área, conforme especificado pelas propriedades localidade, ou postalCode. O uso típico desse elemento seria fornecer um endereço de rua ou qualquer endereço oficial. Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict	string		A parte da subdivisão do país de um endereço, como WA. Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict2	string		O condado para o endereço estruturado, como King. Se a consulta for fornecida, não deverá usar esse parâmetro.
adminDistrict3	string		A área nomeada para o endereço estruturado. Se a consulta for fornecida, não deverá usar esse parâmetro.
bbox	number[]		Uma área retangular na terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de longitude e latitude. 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 localização. Exemplo: [lon1, lat1, lon2, lat2]
coordinates	number[]		Um ponto na terra especificado como longitude e latitude. Quando você especifica esse parâmetro, o local do usuário é levado em conta e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: [lon, lat]
countryRegion	string		Sinal para o resultado da geocodificação para um código de região/país ISO 3166-1 Alfa-2 especificado, por exemplo, FR./ Se a consulta for fornecida, não deverá usar esse parâmetro.
locality	string		A parte de localidade de um endereço, como Seattle. Se a consulta for fornecida, não deverá usar esse parâmetro.
optionalId	string		id da solicitação que seria mostrada em batchItem correspondente
postalCode	string		A parte do cep de um endereço. Se a consulta for fornecida, não deverá usar esse parâmetro.
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	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 um código de região/país ISO 3166-1 Alpha-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem à região de usuário especificada.

GeocodingBatchResponse

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

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

GeoJsonPoint

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

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

Intersection

O endereço do resultado.

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

MatchCodesEnum

Um ou mais valores de código de correspondência que representam o nível de geocodificação para cada local na resposta.

Por exemplo, um local geocodificado com códigos de correspondência de e Ambiguous significa que mais de Good um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha pesquisa na hierarquia 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 uma localização de código geográfico que correspondesse a todas as informações de localização fornecidas, portanto, o serviço de geocódigo teve que pesquisar a hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de Ambiguous um resultado e é UpHierarchy quando você fornece informações de endereço completas, mas o serviço de geocódigo não pode localizar uma correspondência para o endereço de rua e, em vez disso, retorna informações para mais de um valor RoadBlock.

Os valores possíveis são:

Good: o local tem apenas uma correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas.

Ambiguous: o local é um de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher.

UpHierarchy: o local representa uma movimentação para cima 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. 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.

Nome	Tipo	Description
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nome	Tipo	Description
address	Address	O endereço do resultado
confidence	ConfidenceEnum	O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use esse valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência. A confiança de uma localização geocódigo baseia-se em muitos fatores, incluindo a importância relativa da localização geocódigo e da localização do usuário, se especificado.
geocodePoints	GeocodePoints[]	Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido.
matchCodes	MatchCodesEnum[]	Um ou mais valores de código de correspondência que representam o nível de geocodificação para cada local na resposta. Por exemplo, um local geocodificado com códigos de correspondência de e `Ambiguous` significa que mais de `Good` um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha pesquisa na hierarquia 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 uma localização de código geográfico que correspondesse a todas as informações de localização fornecidas, portanto, o serviço de geocódigo teve que pesquisar a hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de `Ambiguous` um resultado e é `UpHierarchy` quando você fornece informações de endereço completas, mas o serviço de geocódigo não pode localizar uma correspondência para o endereço de rua e, em vez disso, retorna informações para mais de um valor RoadBlock. Os valores possíveis são: `Good`: o local tem apenas uma correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas. `Ambiguous`: o local é um de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher. `UpHierarchy`: o local representa uma movimentação para cima 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. 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 CountryRegion

Summary

Resumo da solicitação em lote

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

UsageTypeEnum

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

Nome	Tipo	Description
Display	string
Route	string

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

Recursos adicionais