Search - Get Geocoding Batch

Service:: Maps

Version d'API:: 2025-01-01

Permet d’envoyer un lot de requêtes à l’API de géocodage en une seule requête.

L’API Get Geocoding Batch est une requête HTTP POST qui envoie des lots de 100 requêtes maximum à l’API de géocodage en une seule requête.

Envoyer une demande de traitement par lots synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

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

Corps POST pour la requête Batch

Pour envoyer les requêtes de géocodage , vous utiliserez une POST requête dont le corps de la requête contiendra le batchItems tableau au json format et dont l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 2 requêtes de géocodage :

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

Un objet batchItem de géocodage peut accepter n’importe quel paramètre d’URI de géocodage pris en charge.

Le lot doit contenir au moins 1 requête.

Modèle de réponse par lot

La réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequests c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément est de l’un des types suivants :

GeocodingResponse : si la requête s’est terminée correctement.
Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Numéro de version de l’API Azure Maps.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.
Accept-Language		string	Langue dans laquelle les résultats de recherche doivent être retournés. Pour plus d’informations, consultez langues prises en charge.

Nom

Obligatoire

Type

Description

x-ms-client-id

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

Accept-Language

string

Langue dans laquelle les résultats de recherche doivent être retournés.

Pour plus d’informations, consultez langues prises en charge.

Corps de la demande

Nom	Type	Description
batchItems	GeocodingBatchRequestItem[]	Liste des requêtes à traiter.

Réponses

Nom	Type	Description
200 OK	GeocodingBatchResponse	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Note

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.
La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

A Geocoding Batch API call containing 2 Geocoding queries

Exemple de requête

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
    }
  ]
}

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
Address	Adresse du résultat
AdminDistricts	Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.
CalculationMethodEnum	Méthode utilisée pour calculer le point de géocodage.
ConfidenceEnum	Niveau de confiance selon lequel le résultat de l’emplacement géocodé correspond. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance. La fiabilité d’un emplacement géocodé dépend de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et l’emplacement de l’utilisateur, le cas échéant.
CountryRegion
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
FeatureCollectionEnum	Le type d’un objet FeatureCollection doit être FeatureCollection.
FeaturesItem
FeatureTypeEnum	Le type d’une fonction doit être Fonctionnalité.
GeocodePoints	Collection de points de géocodage qui diffèrent par la façon dont ils ont été calculés et leur utilisation suggérée.
GeocodingBatchRequestBody	La liste des requêtes/demandes de géocodage d’adresses à traiter. La liste peut contenir un maximum de 100 requêtes et doit contenir au moins 1 requête.
GeocodingBatchRequestItem	Objet Batch Query
GeocodingBatchResponse	Cet objet est renvoyé à partir d’un appel de service Geocoding Batch réussi.
GeocodingBatchResponseItem
GeoJsonPoint	Type de géométrie `GeoJSON Point` valide. Pour plus d’informations, reportez-vous à RFC 7946.
Intersection	L’adresse du résultat.
MatchCodesEnum	Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage de chaque emplacement dans la réponse. Par exemple, un emplacement géocodé avec les codes de correspondance de `Good` et `Ambiguous` signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations de localisation et que le service de géocodage n’a pas eu de hiérarchie de recherche pour trouver une correspondance. De même, un emplacement géocodé avec des codes de correspondance de et `Ambiguous` implique qu’il n’a pas été possible de `UpHierarchy` trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocodage a dû effectuer une recherche dans la hiérarchie ascendante et trouver plusieurs correspondances à ce niveau. Par exemple, lorsque vous fournissez des `AmbiguousUpHierarchy` informations d’adresse complètes, mais que le service de géocodage ne peut pas trouver de correspondance pour l’adresse postale et renvoie à la place des informations pour plusieurs valeurs RoadBlock. Les valeurs possibles sont les suivantes : `Good`: L’emplacement n’a qu’une seule correspondance ou toutes les correspondances renvoyées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York renvoie plusieurs correspondances Bonnes. `Ambiguous`: L’emplacement fait partie d’un ensemble de correspondances possibles. Par exemple, lorsque vous recherchez l’adresse postale 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St., car il n’y a pas assez d’informations pour déterminer l’option à choisir. `UpHierarchy`: L’emplacement représente une progression dans la hiérarchie géographique. Cela se produit lorsqu’aucune correspondance n’a été trouvée pour la demande d’emplacement, de sorte qu’un résultat moins précis est renvoyé. Par exemple, si une correspondance pour l’adresse demandée ne peut pas être trouvée, un code de correspondance avec un type d’entité `UpHierarchy` RoadBlock peut être renvoyé.
Properties
Summary	Résumé de la demande de traitement par lots
UsageTypeEnum	Meilleure utilisation du point de géocodage. Chaque point de géocodage est défini comme un `Route` point, un `Display` point ou les deux. Utilisez des `Route` points si vous créez un itinéraire vers l’emplacement. Utilisez des `Display` points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un `Route` point peut spécifier une entrée du parc où vous pouvez entrer avec une voiture, et un `Display` point peut être un point qui spécifie le centre du parc.

Address

Object

Adresse du résultat

Nom	Type	Description
addressLine	string	AddressLine qui comprend le nom et le numéro de la rue
adminDistricts	AdminDistricts[]	Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.
countryRegion	CountryRegion
formattedAddress	string	Propriété Formatted Address
intersection	Intersection	L’adresse du résultat.
locality	string	localité propriété
neighborhood	string	Propriété de quartier
postalCode	string	Propriété Code postal
streetName	string	Le nom de la rue à partir de formattedAddress
streetNumber	string	Le numéro dans la rue, le cas échéant, à partir de formattedAddress

AdminDistricts

Object

Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.

Nom	Type	Description
name	string	Le nom du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom complet de l’État tel que Washington, Pour adminDistrict[1], il peut s’agir du nom complet du comté
shortName	string	Le nom abrégé du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom abrégé de l’État tel que WA, Pour adminDistrict[1], il peut s’agir du nom abrégé du comté

CalculationMethodEnum

Énumération

Méthode utilisée pour calculer le point de géocodage.

Valeur	Description
Interpolation	Le point de géocodage a été apparié à un point sur une route à l’aide de l’interpolation.
InterpolationOffset	Le point de géocodage a été apparié à un point sur une route à l’aide d’une interpolation avec un décalage supplémentaire pour déplacer le point sur le côté de la rue.
Parcel	Le point de géocodage a été apparié au centre d’une parcelle.
Rooftop	Le point de géocodage a été apparié au toit d’un bâtiment.

ConfidenceEnum

Énumération

Niveau de confiance selon lequel le résultat de l’emplacement géocodé correspond. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance.

La fiabilité d’un emplacement géocodé dépend de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et l’emplacement de l’utilisateur, le cas échéant.

Valeur Description

High

Valeur	Description
High	Si le niveau de confiance est défini sur `High`, une ou plusieurs correspondances fortes ont été trouvées. Les correspondances de confiance multiples `High` sont classées par ordre d’importance, le cas échéant. Par exemple, les points de repère ont de l’importance, mais les adresses n’en ont pas. Si une demande comprend un lieu ou une vue, le classement peut changer en conséquence. Par exemple, une requête d’emplacement pour « Paris » renvoie « Paris, France » et « Paris, TX » tous deux avec `High` confiance. « Paris, France » est toujours classé en premier en raison de son importance, sauf si l’emplacement de l’utilisateur indique que l’utilisateur se trouve à Paris, TX ou très proche de Paris, TX ou que la vue de la carte indique que l’utilisateur effectue une recherche dans cette zone.
Medium	Dans certaines situations, la correspondance renvoyée peut ne pas être au même niveau que les informations fournies dans la demande. Par exemple, une demande peut spécifier des informations d’adresse et le service de géocodage peut uniquement correspondre à un code postal. Dans ce cas, si le service de géocodage est sûr que le code postal correspond aux données, la confiance est définie sur `Medium` et le code de correspondance est défini sur `UpHierarchy` pour spécifier qu’il n’a pas pu correspondre à toutes les informations et qu’il a dû effectuer une recherche dans la hiérarchie ascendante. Si les informations d’emplacement de la requête sont ambiguës et qu’il n’existe pas d’informations supplémentaires pour classer les emplacements (telles que l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), le niveau de confiance est défini sur `Medium`. Par exemple, une requête d’emplacement pour « 148th Ave, Bellevue » peut renvoyer « 148th Ave SE » et « 148th Ave NE », tous deux avec `Medium` confiance. Si les informations d’emplacement de la requête ne fournissent pas suffisamment d’informations pour géocoder un emplacement spécifique, une valeur d’emplacement moins précise peut être renvoyée et le niveau de confiance est défini sur `Medium`. Par exemple, si une adresse est fournie, mais qu’aucune correspondance n’est trouvée pour le numéro de maison, le résultat du géocodage avec un type d’entité Roadblock peut être renvoyé.
Low

Si le niveau de confiance est défini sur High, une ou plusieurs correspondances fortes ont été trouvées. Les correspondances de confiance multiples High sont classées par ordre d’importance, le cas échéant. Par exemple, les points de repère ont de l’importance, mais les adresses n’en ont pas.

Si une demande comprend un lieu ou une vue, le classement peut changer en conséquence. Par exemple, une requête d’emplacement pour « Paris » renvoie « Paris, France » et « Paris, TX » tous deux avec High confiance. « Paris, France » est toujours classé en premier en raison de son importance, sauf si l’emplacement de l’utilisateur indique que l’utilisateur se trouve à Paris, TX ou très proche de Paris, TX ou que la vue de la carte indique que l’utilisateur effectue une recherche dans cette zone.

Medium

Dans certaines situations, la correspondance renvoyée peut ne pas être au même niveau que les informations fournies dans la demande. Par exemple, une demande peut spécifier des informations d’adresse et le service de géocodage peut uniquement correspondre à un code postal. Dans ce cas, si le service de géocodage est sûr que le code postal correspond aux données, la confiance est définie sur Medium et le code de correspondance est défini sur UpHierarchy pour spécifier qu’il n’a pas pu correspondre à toutes les informations et qu’il a dû effectuer une recherche dans la hiérarchie ascendante.

Si les informations d’emplacement de la requête sont ambiguës et qu’il n’existe pas d’informations supplémentaires pour classer les emplacements (telles que l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), le niveau de confiance est défini sur Medium. Par exemple, une requête d’emplacement pour « 148th Ave, Bellevue » peut renvoyer « 148th Ave SE » et « 148th Ave NE », tous deux avec Medium confiance.

Si les informations d’emplacement de la requête ne fournissent pas suffisamment d’informations pour géocoder un emplacement spécifique, une valeur d’emplacement moins précise peut être renvoyée et le niveau de confiance est défini sur Medium. Par exemple, si une adresse est fournie, mais qu’aucune correspondance n’est trouvée pour le numéro de maison, le résultat du géocodage avec un type d’entité Roadblock peut être renvoyé.

Low

CountryRegion

Object

Nom	Type	Description
ISO	string	ISO du pays/de la région
name	string	nom du pays/de la région

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

FeatureCollectionEnum

Énumération

Le type d’un objet FeatureCollection doit être FeatureCollection.

Valeur	Description
FeatureCollection

FeaturesItem

Object

Nom	Type	Description
bbox	number[] (double)	Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946.
geometry	GeoJsonPoint	Type de géométrie `GeoJSON Point` valide. Pour plus d’informations, reportez-vous à RFC 7946.
id	string	ID de la fonctionnalité renvoyée
properties	Properties
type	FeatureTypeEnum	Le type d’une fonction doit être Fonctionnalité.

FeatureTypeEnum

Énumération

Le type d’une fonction doit être Fonctionnalité.

Valeur	Description
Feature

GeocodePoints

Object

Collection de points de géocodage qui diffèrent par la façon dont ils ont été calculés et leur utilisation suggérée.

Nom	Type	Description
calculationMethod	CalculationMethodEnum	Méthode utilisée pour calculer le point de géocodage.
geometry	GeoJsonPoint	Type de géométrie `GeoJSON Point` valide. Pour plus d’informations, reportez-vous à RFC 7946.
usageTypes	UsageTypeEnum[]	Meilleure utilisation du point de géocodage. Chaque point de géocodage est défini comme un `Route` point, un `Display` point ou les deux. Utilisez des `Route` points si vous créez un itinéraire vers l’emplacement. Utilisez des `Display` points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un `Route` point peut spécifier une entrée du parc où vous pouvez entrer avec une voiture, et un `Display` point peut être un point qui spécifie le centre du parc.

GeocodingBatchRequestBody

Object

La liste des requêtes/demandes de géocodage d’adresses à traiter. La liste peut contenir un maximum de 100 requêtes et doit contenir au moins 1 requête.

Nom	Type	Description
batchItems	GeocodingBatchRequestItem[]	Liste des requêtes à traiter.

GeocodingBatchRequestItem

Object

Objet Batch Query

Nom	Type	Valeur par défaut	Description
addressLine	string		Ligne de rue officielle d’une adresse par rapport à la zone, telle que spécifiée par les propriétés de la localité ou du code postal. L’utilisation typique de cet élément serait de fournir une adresse municipale ou une adresse officielle. Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
adminDistrict	string		La partie subdivision de pays d’une adresse, telle que WA. Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
adminDistrict2	string		Le comté pour l’adresse structurée, comme King. Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
adminDistrict3	string		Zone nommée pour l’adresse structurée. Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
bbox	number[] (double)		Une zone rectangulaire sur la terre définie comme un objet de cadre englobant. Les côtés des rectangles sont définis par des valeurs de longitude et de latitude. Pour plus d’informations, reportez-vous à la rubrique Types d’emplacement et de zone. Lorsque vous spécifiez ce paramètre, la zone géographique est prise en compte lors du calcul des résultats d’une requête de localisation. Exemple : [lon1, lat1, lon2, lat2]
coordinates	number[] (double)		Un point sur la terre spécifié par une longitude et une latitude. Lorsque vous spécifiez ce paramètre, la localisation de l’utilisateur est prise en compte et les résultats renvoyés peuvent être plus pertinents pour l’utilisateur. Exemple : [lon, lat]
countryRegion	string		Signal pour le résultat du géocodage selon un code de région/pays ISO 3166-1 Alpha-2 spécifié, par exemple FR./ Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
locality	string		La partie locale d’une adresse, telle que Seattle. Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
optionalId	string		id de la requête qui s’afficherait dans batchItem correspondant
postalCode	string		La partie code postal d’une adresse. Ce paramètre ne doit pas être utilisé lorsqu’il `query` est inclus dans la demande.
query	string		Chaîne qui contient des informations sur un emplacement, telles qu’une adresse ou un nom de point de repère.
top	integer (int32) minimum: 1 maximum: 20	5	Nombre maximal de réponses qui seront retournées. Par défaut : 5, minimum : 1 et maximum : 20.
view	string	auto	Chaîne qui spécifie un code de région/pays ISO 3166-1 Alpha-2. Cela modifiera les frontières et les étiquettes géopolitiques contestées pour s’aligner sur la région d’utilisateur spécifiée.

GeocodingBatchResponse

Object

Cet objet est renvoyé à partir d’un appel de service Geocoding Batch réussi.

Nom	Type	Description
batchItems	GeocodingBatchResponseItem[]	Tableau contenant les résultats du lot.
nextLink	string	Il s’agit du lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, aucun champ n’est présent.
summary	Summary	Résumé de la demande de traitement par lots

GeocodingBatchResponseItem

Object

Nom	Type	Description
error	ErrorDetail	Détail de l’erreur.
features	FeaturesItem[]
nextLink	string	Il s’agit du lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, aucun champ n’est présent.
optionalId	string	id du batchItem qui serait le même que l’id dans la requête
type	FeatureCollectionEnum	Le type d’un objet FeatureCollection doit être FeatureCollection.

GeoJsonPoint

Object

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.

Nom	Type	Description
bbox	number[] (double)	Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946.
coordinates	number[] (double)	Un `Position` est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont longitude et latitude, précisément dans cet ordre. altitude/élévation est un troisième élément facultatif. Pour plus d’informations, reportez-vous à RFC 7946.
type	string: Point	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

Intersection

Object

L’adresse du résultat.

Nom	Type	Description
baseStreet	string	Rue principale pour l’emplacement.
displayName	string	Nom complet de l’intersection.
intersectionType	string	Type d’intersection.
secondaryStreet1	string	La première rue qui se croise.
secondaryStreet2	string	Le cas échéant, la deuxième rue qui se croise.

MatchCodesEnum

Énumération

Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage de chaque emplacement dans la réponse.

Par exemple, un emplacement géocodé avec les codes de correspondance de Good et Ambiguous signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations de localisation et que le service de géocodage n’a pas eu de hiérarchie de recherche pour trouver une correspondance.

De même, un emplacement géocodé avec des codes de correspondance de et Ambiguous implique qu’il n’a pas été possible de UpHierarchy trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocodage a dû effectuer une recherche dans la hiérarchie ascendante et trouver plusieurs correspondances à ce niveau. Par exemple, lorsque vous fournissez des AmbiguousUpHierarchy informations d’adresse complètes, mais que le service de géocodage ne peut pas trouver de correspondance pour l’adresse postale et renvoie à la place des informations pour plusieurs valeurs RoadBlock.

Les valeurs possibles sont les suivantes :

Good: L’emplacement n’a qu’une seule correspondance ou toutes les correspondances renvoyées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York renvoie plusieurs correspondances Bonnes.

Ambiguous: L’emplacement fait partie d’un ensemble de correspondances possibles. Par exemple, lorsque vous recherchez l’adresse postale 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St., car il n’y a pas assez d’informations pour déterminer l’option à choisir.

UpHierarchy: L’emplacement représente une progression dans la hiérarchie géographique. Cela se produit lorsqu’aucune correspondance n’a été trouvée pour la demande d’emplacement, de sorte qu’un résultat moins précis est renvoyé. Par exemple, si une correspondance pour l’adresse demandée ne peut pas être trouvée, un code de correspondance avec un type d’entité UpHierarchy RoadBlock peut être renvoyé.

Valeur	Description
Good
Ambiguous
UpHierarchy

Properties

Object

Nom	Type	Description
address	Address	Adresse du résultat
confidence	ConfidenceEnum	Niveau de confiance selon lequel le résultat de l’emplacement géocodé correspond. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance. La fiabilité d’un emplacement géocodé dépend de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et l’emplacement de l’utilisateur, le cas échéant.
geocodePoints	GeocodePoints[]	Collection de points de géocodage qui diffèrent par la façon dont ils ont été calculés et leur utilisation suggérée.
matchCodes	MatchCodesEnum[]	Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage de chaque emplacement dans la réponse. Par exemple, un emplacement géocodé avec les codes de correspondance de `Good` et `Ambiguous` signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations de localisation et que le service de géocodage n’a pas eu de hiérarchie de recherche pour trouver une correspondance. De même, un emplacement géocodé avec des codes de correspondance de et `Ambiguous` implique qu’il n’a pas été possible de `UpHierarchy` trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocodage a dû effectuer une recherche dans la hiérarchie ascendante et trouver plusieurs correspondances à ce niveau. Par exemple, lorsque vous fournissez des `AmbiguousUpHierarchy` informations d’adresse complètes, mais que le service de géocodage ne peut pas trouver de correspondance pour l’adresse postale et renvoie à la place des informations pour plusieurs valeurs RoadBlock. Les valeurs possibles sont les suivantes : `Good`: L’emplacement n’a qu’une seule correspondance ou toutes les correspondances renvoyées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York renvoie plusieurs correspondances Bonnes. `Ambiguous`: L’emplacement fait partie d’un ensemble de correspondances possibles. Par exemple, lorsque vous recherchez l’adresse postale 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St., car il n’y a pas assez d’informations pour déterminer l’option à choisir. `UpHierarchy`: L’emplacement représente une progression dans la hiérarchie géographique. Cela se produit lorsqu’aucune correspondance n’a été trouvée pour la demande d’emplacement, de sorte qu’un résultat moins précis est renvoyé. Par exemple, si une correspondance pour l’adresse demandée ne peut pas être trouvée, un code de correspondance avec un type d’entité `UpHierarchy` RoadBlock peut être renvoyé.
type	string	Un parmi : Adresse Barrage routier Intersection routière Quartier PeupleLieuPeuplé Code postal1 AdminDivision1 AdminDivision2 CountryRegion

Summary

Object

Résumé de la demande de traitement par lots

Nom	Type	Description
successfulRequests	integer (int32)	Nombre de requêtes réussies dans le lot
totalRequests	integer (int32)	Nombre total de requêtes dans le lot

UsageTypeEnum

Énumération

Meilleure utilisation du point de géocodage. Chaque point de géocodage est défini comme un Route point, un Display point ou les deux. Utilisez des Route points si vous créez un itinéraire vers l’emplacement. Utilisez des Display points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un Route point peut spécifier une entrée du parc où vous pouvez entrer avec une voiture, et un Display point peut être un point qui spécifie le centre du parc.

Valeur	Description
Display
Route

Partager via

Search - Get Geocoding Batch

Envoyer une demande de traitement par lots synchrone

Corps POST pour la requête Batch

Modèle de réponse par lot

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AADToken

Étendues

subscription-key

SAS Token

Exemples

A Geocoding Batch API call containing 2 Geocoding queries

Exemple de requête

Exemple de réponse

Définitions

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum