Search - Get Geocoding Batch

Service:: Maps

Version d’API:: 2026-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={api-version}

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 {endpoint}/geocode:batch?api-version=2026-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Le nom d’hôte du service Azure Maps. Utilisez `https://atlas.microsoft.com` pour le Azure cloud public. Pour cibler une géographie Azure Maps spécifique ou un nuage souverain, voir Azure Maps portée géographique.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Précise quel compte est destiné à être utilisé en conjonction 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é depuis l’API de compte Azure Maps Management Plane. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, voir 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

Précise quel compte est destiné à être utilisé en conjonction 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é depuis l’API de compte Azure Maps Management Plane. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, voir 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[]	Les requêtes de géocodage à traiter dans ce lot. Chaque entrée est une demande de géocodage avant indépendante ; Le service renvoie une entrée correspondante dans `GeocodingBatchResponse.batchItems` par requête, dans le même ordre.

Réponses

Nom	Type	Description
200 OK	GeocodingBatchResponse	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

GeocodingBatchResponse

La demande a réussi.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

AadToken

Ce sont les flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès basé sur Azure par rôle, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès basés sur les rôles Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes ou sous-ressources de ressources Azure Maps. 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 disposent d’URL d’autorisation uniques et de configurations d’identifiants Microsoft Entra ID.
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

subscription-key

Il s’agit d’une clé partagée provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse ê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=2026-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	L’adresse d’un emplacement suggéré par géocodage ou autocomplétion, analysé en champs structurés. La rareté est normale : seuls les champs fournis par l’entité résolue sont peuplés. Par exemple, `streetName` et `streetNumber` apparaissent uniquement pour les adresses au niveau de la rue, et `intersection` apparaissent uniquement pour les résultats d’intersections routières.
AddressAdminDistrictsItem	Un lotissement administratif contenant une adresse. Par exemple, un État, une province ou un comté. Retourné comme une seule entrée dans le tableau parent `Address.adminDistricts` , où les entrées sont ordonnées du plus grossier au plus fin.
AddressCountryRegion	Le pays ou la région contenant l’adresse, identifié par son nom d’affichage et le code pays ISO 3166-1 Alpha-2. L’un ou l’autre champ peut être omis dans une réponse donnée.
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
CalculationMethodEnum	Méthode utilisée pour calculer le point de géocodeur.
ConfidenceEnum	Le niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec les codes de correspondance pour obtenir des informations plus complètes sur la correspondance. La confiance d’un emplacement géocodé dépend de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et la localisation de l’utilisateur, si spécifiée.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
FeatureCollectionEnum	Le type d’objet `GeoJSON` utilisé à la base des réponses réussies issues des opérations de géocodage direct, de géocodage inverse et d’autocomplétion (y compris leurs variantes par lot). La seule valeur est `FeatureCollection`, telle que définie dans la RFC 7946. `Get Polygon` est la seule exception : sa racine de réponse est un `GeoJSON Feature`, voir `FeatureTypeEnum`.
FeaturesItem	Une seule entrée dans le `features` tableau de un `GeocodingResponse`, conforme à la forme de l’objet `GeoJSON Feature` . Représente un emplacement géocodé : données structurées sur `properties`, une coordonnée représentative sur `geometry`, et une boîte englobante optionnelle sur `bbox`.
FeaturesItemProperties	La `properties` charge utile d’une caractéristique dans un `GeocodingResponse`fichier . Contient les indicateurs de type d’entité et de qualité de correspondance pour la localisation géocodée, ses composantes d’adresse analysées, ainsi qu’un ou plusieurs points géocodés qui associent la localisation à des coordonnées spécifiques.
FeatureTypeEnum	Le type d’objet `GeoJSON` pour `Feature` les objets. Étiquete chaque entrée dans le `features` tableau d’une `FeatureCollection` réponse (géocodage, géocodage inverse, autocomplétion) et apparaît à la racine de la `Get Polygon` réponse. La seule valeur est `Feature`, telle que définie dans la RFC 7946.
GeocodePointsItem	Un point de géocodage pour un emplacement : une coordonnée plus des métadonnées décrivant comment le point a été calculé (`calculationMethod`) et à quoi il convient le mieux (`usageTypes`). Une seule fonctionnalité retourne généralement un élément séparé `Display` et `Route` pointe pour que les appelants puissent choisir celle qui convient à la tâche.
GeocodingBatchRequestBody	L’organisme demandeur pour l’opération `Get Geocoding Batch` . Transporte une ou plusieurs requêtes de géocodage individuelles — comprises entre 1 et 100, inclus — que le service traite en un seul appel et renvoie sous forme de tableau parallèle `batchItems` sur `GeocodingBatchResponse`.
GeocodingBatchRequestItem	Une requête de géocodage à l’intérieur d’un `GeocodingBatchRequestBody.batchItems` tableau. Chaque élément est une requête de géocodage avant indépendante équivalente à un seul appel à `Get Geocoding`, exprimée sous forme de champs plutôt que de paramètres de requête URL. La localisation peut être fournie soit sous forme de chaîne libre `query` , soit comme les champs structurés en dessous (`addressLine`, `locality`, `countryRegion`, les `adminDistrict` niveaux, `postalCode`) ; ces deux modes d’entrée sont mutuellement exclusifs — lorsque `query` est défini, les champs structurés sont ignorés.
GeocodingBatchResponse	Le corps de réponse réussi a répondu par `Get Geocoding Batch`. Contient le `summary` nombre de requêtes soumises réussies ainsi qu’un `batchItems` tableau contenant une entrée de réponse par requête dans la requête, dans le même ordre que le tableau de requêtes `batchItems` .
GeocodingBatchResponseItem	Une seule entrée à l’intérieur `GeocodingBatchResponse.batchItems`de , portant le résultat d’une des requêtes de l’entrée correspondante `GeocodingBatchRequestBody.batchItems` . Les requêtes réussies apparaissent leur géocodée `features` ici sous la même forme que `GeocodingResponse`; requêtes échouées présentent des informations de diagnostic via `error` instead. Exactement un de `features` ou `error` est rempli par entrée.
GeocodingBatchResponseSummary	Contient les comptes agrégés pour une `Get Geocoding Batch` réponse : la taille du lot soumis et le nombre de requêtes traitées avec succès. Utilisé comme type de `GeocodingBatchResponse.summary`.
GeoJsonObjectType	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.
GeoJsonPoint	Type de géométrie `GeoJSON Point` valide. Pour plus d’informations, reportez-vous à RFC 7946.
Intersection	Les détails de l’intersection d’une adresse sont définis comme un intersection routière — le coin où deux rues nommées ou plus se rejoignent. Rempli uniquement lorsque l’entité résolue est un `RoadIntersection`; le parent `Address.intersection` est autrement omis.
MatchCodesEnum	Une valeur de code correspondant indiquant comment le service de géocodage a produit un résultat de localisation donné. Le `matchCodes` champ sur une caractéristique est un tableau de ces valeurs ; combinez-les avec `confidence` et `type` pour évaluer la qualité de correspondance.
UsageTypeEnum	L’utilisation prévue d’un point de géocodage. Un point de géocodage retourné par le service porte un ou plusieurs types d’utilisation qui indiquent comment une application cliente doit consommer le point : par exemple, afficher l’emplacement sur une carte versus y acheminer un véhicule.

Address

Objet

L’adresse d’un emplacement suggéré par géocodage ou autocomplétion, analysé en champs structurés. La rareté est normale : seuls les champs fournis par l’entité résolue sont peuplés. Par exemple, streetName et streetNumber apparaissent uniquement pour les adresses au niveau de la rue, et intersection apparaissent uniquement pour les résultats d’intersections routières.

Nom	Type	Description
addressLine	string	La première ligne de l’adresse, généralement le nom et le numéro de la rue. Par exemple : `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	Les subdivisions administratives qui contiennent l’adresse, classées du plus grossier au plus raffiné. La première entrée est généralement la subdivision de premier ordre (comme un État américain ou une province canadienne) ; Les entrées suivantes couvrent les divisions plus fines où le pays, la dépendance ou la région les définit (comme un comté à l’index 1).
countryRegion	AddressCountryRegion	Le pays ou la région contenant l’adresse, avec son nom d’affichage et le code pays ISO 3166-1 Alpha-2.
formattedAddress	string	L’adresse complète est rendue sous forme d’une seule chaîne lisible par l’homme, les composantes étant reliées selon les conventions du pays ou de la région de l’adresse. Exemple : `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	Les détails des rues qui se croisent pour l’adresse, sont remplis lorsque l’entité résolue est un `RoadIntersection` (par exemple le coin de deux rues nommées).
locality	string	La localité dans laquelle se situe l’adresse : généralement une ville, un village ou une ville. Par exemple : `"Redmond"`.
neighborhood	string	Le quartier nommé dans la localité, lorsqu’un est identifié.
postalCode	string	Le code postal de l’adresse, lorsqu’une est définie. Exemple : `"98052"`.
streetName	string	La composante nom de rue de l’adresse, lorsque l’entité résolue est une adresse au niveau de la rue. Exemple : `"NE 24th St"`.
streetNumber	string	Le numéro de maison ou de bâtiment sur la rue, lorsque l’entité résolue est une adresse au niveau de la rue. Exemple : `"15127"`.

AddressAdminDistrictsItem

Objet

Un lotissement administratif contenant une adresse. Par exemple, un État, une province ou un comté. Retourné comme une seule entrée dans le tableau parent Address.adminDistricts , où les entrées sont ordonnées du plus grossier au plus fin.

Nom	Type	Description
name	string	Le nom complet du lotissement. Par exemple, `"Washington"` pour un État américain ou `"King County"` pour un comté.
shortName	string	La forme abrégée ou abrégée du nom de la subdivision, lorsque l’on en définit. Par exemple, `"WA"` pour un État américain. Les subdivisions plus fines n’ont souvent pas de forme courte distincte, auquel `shortName` cas des `name` répétitions (comme `"King County"`).

AddressCountryRegion

Objet

Le pays ou la région contenant l’adresse, identifié par son nom d’affichage et le code pays ISO 3166-1 Alpha-2. L’un ou l’autre champ peut être omis dans une réponse donnée.

Nom	Type	Description
ISO	string	Le code pays ISO 3166-1 Alpha-2 pour le pays ou la région. Par exemple, `"US"` pour les États-Unis, ou `"GB"` pour le Royaume-Uni.
name	string	Le nom affiché du pays ou de la région. Par exemple : `"États-Unis"`.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

CalculationMethodEnum

Énumération

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

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

Le niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec les codes de correspondance pour obtenir des informations plus complètes sur la correspondance.

La confiance d’un emplacement géocodé dépend de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et la localisation de l’utilisateur, si spécifiée.

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 inclut un lieu ou une vue, le classement peut alors changer en conséquence. Par exemple, une requête de localisation pour « Paris » renvoie à la fois « Paris, France » et « Paris, TX » avec `High` assurance. « Paris, France » est toujours classé en premier en raison de son importance, sauf si la localisation de l’utilisateur indique que l’utilisateur se trouve à Paris, TX ou très proche, ou que la vue de la carte indique que l’utilisateur 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 a confiance que le code postal correspond aux données, la confiance est fixée à `Medium` et le code de correspondance est défini pour `UpHierarchy` indiquer que le service ne pouvait pas correspondre à toutes les informations et a dû rechercher en montée hiérarchique. 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 de localisation pour « 148th Ave, Bellevue » peut renvoyer à la fois « 148th Ave SE » et « 148th Ave NE » 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 géocodé avec un `RoadBlock` type d’entité peut être retourné.
Low	Manque de confiance dans le match.

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 inclut un lieu ou une vue, le classement peut alors changer en conséquence. Par exemple, une requête de localisation pour « Paris » renvoie à la fois « Paris, France » et « Paris, TX » avec High assurance. « Paris, France » est toujours classé en premier en raison de son importance, sauf si la localisation de l’utilisateur indique que l’utilisateur se trouve à Paris, TX ou très proche, ou que la vue de la carte indique que l’utilisateur 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 a confiance que le code postal correspond aux données, la confiance est fixée à Medium et le code de correspondance est défini pour UpHierarchy indiquer que le service ne pouvait pas correspondre à toutes les informations et a dû rechercher en montée hiérarchique.

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 de localisation pour « 148th Ave, Bellevue » peut renvoyer à la fois « 148th Ave SE » et « 148th Ave NE » 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 géocodé avec un RoadBlock type d’entité peut être retourné.

Low

Manque de confiance dans le match.

ErrorAdditionalInfo

Objet

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

Objet

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.

FeatureCollectionEnum

Énumération

Le type d’objet GeoJSON utilisé à la base des réponses réussies issues des opérations de géocodage direct, de géocodage inverse et d’autocomplétion (y compris leurs variantes par lot). La seule valeur est FeatureCollection, telle que définie dans la RFC 7946. Get Polygon est la seule exception : sa racine de réponse est un GeoJSON Feature, voir FeatureTypeEnum.

Valeur	Description
FeatureCollection	Le type d’objet `GeoJSON FeatureCollection` . Apparaît comme la racine de tout organisme de réponse réussi en géocodage, géocodage inverse et autocomplétion. `Get Polygon` utilise une `Feature` racine à la place.

FeaturesItem

Objet

Une seule entrée dans le features tableau de un GeocodingResponse, conforme à la forme de l’objet GeoJSON Feature . Représente un emplacement géocodé : données structurées sur properties, une coordonnée représentative sur geometry, et une boîte englobante optionnelle sur bbox.

Nom	Type	Description
bbox	number[] (double)	Le plus petit rectangle aligné sur un axe contenant la géométrie de la structure, dans l’ordre WGS 84 longitude/latitude. Codé selon `[westLon, southLat, eastLon, northLat]`la RFC 7946, Section 5.
geometry	GeoJsonPoint	Le primaire `GeoJSON Point` représente l’emplacement géocodé, avec les coordonnées dans l’ordre de longitude/latitude WGS 84.
id	string	Un identifiant optionnel attribué par le service pour la fonctionnalité, lorsque celui-ci est disponible.
properties	FeaturesItemProperties	Données structurées sur le lieu géocodé, y compris son type d’entité, les indicateurs de qualité de correspondance, les composants d’adresse et un ou plusieurs points de géocodage.
type	FeatureTypeEnum	Le type d’objet `GeoJSON` . Toujours `Feature`, tel que défini dans la RFC 7946.

FeaturesItemProperties

Objet

La properties charge utile d’une caractéristique dans un GeocodingResponsefichier . Contient les indicateurs de type d’entité et de qualité de correspondance pour la localisation géocodée, ses composantes d’adresse analysées, ainsi qu’un ou plusieurs points géocodés qui associent la localisation à des coordonnées spécifiques.

Nom	Type	Description
address	Address	L’adresse du lieu géocodé, analysée en champs structurés tels que localité, code postal, pays/région, et (lorsque disponible) nom et numéro de rue.
confidence	ConfidenceEnum	À quel point la localisation géocodée correspond à la demande. Utilisez cela `matchCodes` pour une vision complète de la qualité du match. Voir `ConfidenceEnum` la liste des valeurs et les facteurs qui influencent la note.
geocodePoints	GeocodePointsItem[]	Un ou plusieurs points de géocodage pour l’emplacement, chacun marqué par la manière dont il a été dérivé (`calculationMethod`) et par ce à quoi il convient le mieux (`usageTypes`). Par exemple, `Display` pour le placement visuel sur une carte, ou `Route` pour une utilisation comme destination de navigation.
matchCodes	MatchCodesEnum[]	Comment le service de géocodage a produit ce résultat par rapport à la requête : une correspondance directe à la spécificité demandée (`Good`), l’un des plusieurs candidats (`Ambiguous`), ou un plan de secours vers un niveau moins précis de la hiérarchie géographique (`UpHierarchy`). Plusieurs valeurs peuvent être présentes. Par exemple, un `Ambiguous` appariement plus `UpHierarchy` indique que le service n’a pas pu correspondre à la spécificité demandée et a trouvé plusieurs correspondances à un niveau plus grossier. Voir `MatchCodesEnum` pour les descriptions par valeur ; combiner avec `confidence` pour une image complète de la qualité des correspondances.
type	string	Le type d’entité auquel la localisation géocodée a été résolue. L’un des suivants : `Address`, `RoadBlock`, `RoadIntersection`, `NeighborhoodPopulatedPlace`, `Postcode1`, `AdminDivision1`, `AdminDivision2`ou `CountryRegion`.

FeatureTypeEnum

Énumération

Le type d’objet GeoJSON pour Feature les objets. Étiquete chaque entrée dans le features tableau d’une FeatureCollection réponse (géocodage, géocodage inverse, autocomplétion) et apparaît à la racine de la Get Polygon réponse. La seule valeur est Feature, telle que définie dans la RFC 7946.

Valeur	Description
Feature	Le type d’objet `GeoJSON Feature` . Apparaît sur chaque fonctionnalité à l’intérieur d’une `FeatureCollection` réponse, et à la racine de celle-ci `Get Polygon` .

GeocodePointsItem

Objet

Un point de géocodage pour un emplacement : une coordonnée plus des métadonnées décrivant comment le point a été calculé (calculationMethod) et à quoi il convient le mieux (usageTypes). Une seule fonctionnalité retourne généralement un élément séparé Display et Route pointe pour que les appelants puissent choisir celle qui convient à la tâche.

Nom	Type	Description
calculationMethod	CalculationMethodEnum	Comment le point a été calculé. Par exemple, fixé sur le toit d’un bâtiment ou interpolé le long d’une ligne centrale de la route. Voir `CalculationMethodEnum` la liste des valeurs.
geometry	GeoJsonPoint	La coordonnée de ce point géocodé est un `GeoJSON Point`, avec des valeurs dans l’ordre de longitude/latitude WGS 84.
usageTypes	UsageTypeEnum[]	À quoi le point de géocodage est le mieux adapté — `Display` pour un placement visuel sur une carte, ou `Route` comme destination de routage. Un point peut valoir les deux. Voir `UsageTypeEnum` les détails par valeur, y compris la façon dont chaque est positionné pour les caractéristiques à étendue non triviale.

GeocodingBatchRequestBody

Objet

L’organisme demandeur pour l’opération Get Geocoding Batch . Transporte une ou plusieurs requêtes de géocodage individuelles — comprises entre 1 et 100, inclus — que le service traite en un seul appel et renvoie sous forme de tableau parallèle batchItems sur GeocodingBatchResponse.

Nom	Type	Description
batchItems	GeocodingBatchRequestItem[]	Les requêtes de géocodage à traiter dans ce lot. Chaque entrée est une demande de géocodage avant indépendante ; Le service renvoie une entrée correspondante dans `GeocodingBatchResponse.batchItems` par requête, dans le même ordre.

GeocodingBatchRequestItem

Objet

Une requête de géocodage à l’intérieur d’un GeocodingBatchRequestBody.batchItems tableau. Chaque élément est une requête de géocodage avant indépendante équivalente à un seul appel à Get Geocoding, exprimée sous forme de champs plutôt que de paramètres de requête URL. La localisation peut être fournie soit sous forme de chaîne libre query , soit comme les champs structurés en dessous (addressLine, locality, countryRegion, les adminDistrict niveaux, postalCode) ; ces deux modes d’entrée sont mutuellement exclusifs — lorsque query est défini, les champs structurés sont ignorés.

Nom	Type	Valeur par défaut	Description
addressLine	string		La ligne de rue de l’adresse, généralement le nom et le numéro de la rue, ou toute autre adresse officielle au niveau de la rue. Ignoré quand `query` c’est réglé.
adminDistrict	string		La subdivision administrative de premier ordre (comme un État ou une province) fournie sous forme de nom ou de code court. Par exemple, `"WA"` pour Washington. Ignoré quand `query` c’est réglé.
adminDistrict2	string		La subdivision administrative de second ordre (comme un comté). Par exemple, `"King"` pour le comté de King. Ignoré quand `query` c’est réglé.
adminDistrict3	string		La subdivision administrative de troisième ordre (comme un district, une paroisse ou une municipalité), où le pays, la dépendance ou la région en définit un. Ignoré quand `query` c’est réglé.
bbox	number[] (double)		Une boîte englobante qui étend la recherche à une zone géographique rectangulaire. Encodés comme `[westLon, southLat, eastLon, northLat]` dans l’ordre de longitude/latitude WGS 84, chaque côté variant d’environ `0.00001` des degrés (~1 mètre) jusqu’à l’étendue globale totale (`-180, -90` à `180, 90`).
coordinates	number[] (double)		Un point sur la Terre, codé selon `[longitude, latitude]` l’ordre WGS 84, servait à biaiser les résultats vers la position de l’utilisateur. Lorsqu’ils sont fournis, les résultats proches de ce point sont généralement plus pertinents pour l’utilisateur.
countryRegion	string		Un code région/pays ISO 3166-1 Alpha-2 qui étend la recherche à un seul pays ou une seule région. Par exemple, `"FR"` pour la France. Ignoré quand `query` c’est réglé.
locality	string		La localité (ville, village ou village) de l’adresse. Par exemple : `"Seattle"`. Ignoré quand `query` c’est réglé.
optionalId	string		Un identifiant optionnel fourni par l’appelant résonnait dans l’entrée correspondante comme `GeocodingBatchResponseItem.optionalId`. Utile pour corréler les réponses aux requêtes par un identifiant stable côté application plutôt que de se fier uniquement à la position du tableau.
postalCode	string		La composante postale de l’adresse. Ignoré quand `query` c’est réglé.
query	string		Une chaîne libre décrivant l’emplacement à géocoder, généralement une adresse ou un nom de point de repère. Une fois défini, les champs de localisation structurés en dessous (`addressLine`, `locality`, `countryRegion`, les `adminDistrict` niveaux, `postalCode`) sont ignorés.
top	integer (int32) minimum: 1 maximum: 20	5	Le nombre maximal de résultats géocodés est retourné pour cette requête. Par défaut à 5 ; Minimum 1, maximum 20.
view	string	auto	Un code région/pays ISO 3166-1 Alpha-2 identifiant la région dont la vision géopolitique doit être appliquée aux frontières contestées et aux labels dans la réponse. Par défaut, `"auto"`, sélectionne la vue en fonction de l’origine de la requête. Voir Vues supportées pour les valeurs disponibles.

GeocodingBatchResponse

Objet

Le corps de réponse réussi a répondu par Get Geocoding Batch. Contient le summary nombre de requêtes soumises réussies ainsi qu’un batchItems tableau contenant une entrée de réponse par requête dans la requête, dans le même ordre que le tableau de requêtes batchItems .

Nom	Type	Description
batchItems	GeocodingBatchResponseItem[]	Les résultats par requête du lot. Chaque entrée correspond positionnellement à l’entrée de requête au même indice de tableau dans `GeocodingBatchRequestBody.batchItems`. Les entrées avec `error` rempli représentent les requêtes qui ont échoué ; les entrées avec `features` rempli représentent les requêtes qui ont réussi.
nextLink	string	Contient l’URL pour récupérer la page suivante de résultats si la réponse est paginanée. Cela est utile lorsque la réponse est trop importante pour être retournée en un seul appel, permettant aux utilisateurs de naviguer à travers plusieurs pages de résultats.
summary	GeocodingBatchResponseSummary	Le nombre total de requêtes pour l’ensemble du lot, le nombre total de requêtes soumises et le nombre d’entre elles accomplies avec succès.

GeocodingBatchResponseItem

Objet

Une seule entrée à l’intérieur GeocodingBatchResponse.batchItemsde , portant le résultat d’une des requêtes de l’entrée correspondante GeocodingBatchRequestBody.batchItems . Les requêtes réussies apparaissent leur géocodée features ici sous la même forme que GeocodingResponse; requêtes échouées présentent des informations de diagnostic via error instead. Exactement un de features ou error est rempli par entrée.

Nom	Type	Description
error	ErrorDetail	Informations de diagnostic pour une requête qui a échoué dans le lot, le chemin d’erreur par entrée complétant le chemin de réussite sur `features`. Rempli seulement lorsque l’entrée échouait ; voir `ErrorDetail` pour la forme par erreur.
features	FeaturesItem[]	Le tableau d’objets `GeoJSON Feature` géocodé pour la requête de cette entrée par lot. Chacune `Feature` représente un emplacement géocodé unique avec des détails exposés via `properties` et sa coordonnée principale via `geometry`. Rempli seulement lorsque l’entrée réussissait.
nextLink	string	Contient l’URL pour récupérer la page suivante de résultats si la réponse est paginanée. Cela est utile lorsque la réponse est trop importante pour être retournée en un seul appel, permettant aux utilisateurs de naviguer à travers plusieurs pages de résultats.
optionalId	string	L’identifiant fourni par l’appelant résonnait depuis le fichier correspondant `GeocodingBatchRequestItem.optionalId`. Rempli uniquement lorsque la demande en fournissait un. Utile pour la corrélation côté application lorsque la position du tableau n’est pas suffisante.
type	FeatureCollectionEnum	Le `GeoJSON` type d’objet du corps de réussite de cette entrée. Toujours `FeatureCollection`, tel que défini dans la RFC 7946. Rempli seulement lorsque l’entrée réussissait.

GeocodingBatchResponseSummary

Objet

Contient les comptes agrégés pour une Get Geocoding Batch réponse : la taille du lot soumis et le nombre de requêtes traitées avec succès. Utilisé comme type de GeocodingBatchResponse.summary.

Nom	Type	Description
successfulRequests	integer (int32)	Le nombre de requêtes dans le lot qui ont été traitées avec succès — celles dont l’entrée de réponse dans `GeocodingBatchResponse.batchItems` contient `features` plutôt que `error`.
totalRequests	integer (int32)	Le nombre total de requêtes soumises dans le lot. Soustrayez `successfulRequests` pour obtenir le nombre de requêtes qui ont échoué.

GeoJsonObjectType

Énumération

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.

Valeur	Description
Point	`GeoJSON Point` géométrie.
MultiPoint	`GeoJSON MultiPoint` géométrie.
LineString	`GeoJSON LineString` géométrie.
MultiLineString	`GeoJSON MultiLineString` géométrie.
Polygon	`GeoJSON Polygon` géométrie.
MultiPolygon	`GeoJSON MultiPolygon` géométrie.
GeometryCollection	`GeoJSON GeometryCollection` géométrie.
Feature	`GeoJSON Feature` objet.
FeatureCollection	`GeoJSON FeatureCollection` objet.

GeoJsonPoint

Objet

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

Objet

Les détails de l’intersection d’une adresse sont définis comme un intersection routière — le coin où deux rues nommées ou plus se rejoignent. Rempli uniquement lorsque l’entité résolue est un RoadIntersection; le parent Address.intersection est autrement omis.

Nom	Type	Description
baseStreet	string	La rue principale de l’intersection — généralement la rue à laquelle le numéro d’adresse fait référence.
displayName	string	Un nom lisible par l’humain pour l’intersection qui combine les rues transversales, comme `"5th Avenue & Main Street"`.
intersectionType	string	Une courte étiquette décrivant la forme de l’intersection. Par exemple, distinguer un carrefour à niveau d’un passage à niveau séparé comme un pont ou un viaduc.
secondaryStreet1	string	La première rue transversale qui se rejoint `baseStreet` à l’intersection.
secondaryStreet2	string	La deuxième rue transversale à l’intersection, quand il y en a une. Habitée uniquement pour les intersections de trois rues ou plus.

MatchCodesEnum

Énumération

Une valeur de code correspondant indiquant comment le service de géocodage a produit un résultat de localisation donné. Le matchCodes champ sur une caractéristique est un tableau de ces valeurs ; combinez-les avec confidence et type pour évaluer la qualité de correspondance.

Valeur	Description
Good	Le service de géocodage a produit ce candidat sans élargir la requête : le résultat correspond à la requête à la spécificité demandée.
Ambiguous	Le lieu fait partie d’un ensemble de correspondances possibles. Par exemple, lors de la requête pour l’adresse « 128 Main St. », la réponse peut retourner deux emplacements pour « 128 North Main St. » et « 128 South Main St. » car il n’y a pas suffisamment d’informations pour déterminer quelle option choisir.
UpHierarchy	La localisation représente une montée dans la hiérarchie géographique. Cela se produit lorsqu’une correspondance pour la demande d’emplacement n’a pas été trouvée. Par conséquent, un résultat moins précis est retourné.

UsageTypeEnum

Énumération

L’utilisation prévue d’un point de géocodage. Un point de géocodage retourné par le service porte un ou plusieurs types d’utilisation qui indiquent comment une application cliente doit consommer le point : par exemple, afficher l’emplacement sur une carte versus y acheminer un véhicule.

Valeur	Description
Display	Le point de géocodage convient à l’affichage de l’emplacement sur une carte. Pour une structure d’étendue non triviale (comme un parc ou un bâtiment), le `Display` point se trouve généralement près du centre visuel de la structure.
Route	Le point de géocodage convient comme destination d’un itinéraire. Pour une structure d’extension non triviale (comme un parc ou un bâtiment), le `Route` point est généralement positionné à une entrée accessible aux véhicules plutôt qu’au centre visuel.