Géocodage par lots (Outils de géocodage)

Résumé

Permet de géocoder une table ou un fichier .csv d’adresses ou de lieux de grande taille de manière asynchrone à l’aide de l’API REST batchGeocode. Les résultats géocodés sont renvoyés sous forme de classe d’entités et ArcGIS Pro n’est pas requis pour diviser la requête en lots de plus petite taille.

Avec cet outil, le géocodage peut être isolé et mis à l’échelle sur le serveur, indépendamment d’autres processus. Par exemple, lorsqu’une tâche est soumise à ArcGIS World Geocoding Service, un matériel dédié est attribué pour traiter le fichier, ce qui accélère le temps de réponse. Vous pouvez sélectionner au choix ArcGIS World Geocoding Service ou un service hébergé dans ArcGIS Enterprise on Kubernetes 11.5 ou version ultérieure avec votre cluster Kubernetes configuré.

Remarque :

Pour réaliser des opérations de géocodage à l’aide d’ArcGIS World Geocoding Service, vous avez besoin d’un compte d’organisation ArcGIS et de crédits. Le compte d’organisation doit disposer de suffisamment de crédits pour satisfaire à la totalité de la demande de géocodage.

L’estimation des crédits est affichée en haut de l’outil, dans la fenêtre Geoprocessing (Géotraitement) si le portail actif est ArcGIS Online.

Utilisation

Si vous utilisez ArcGIS World Geocoding Service comme valeur de paramètre Input Batch Service (Service de géocodage par lots en entrée), la table ou le fichier en entrée doit contenir au moins 100 000 enregistrements.
Si vous utilisez ArcGIS World Geocoding Service comme valeur de paramètre Input Batch Service (Service de géocodage par lots en entrée), la valeur du paramètre Input Table (Table en entrée) est stockée temporairement sur votre portail ArcGIS Online jusqu’à ce que la tâche soit terminée. Une fois la tâche terminée, le fichier temporaire est supprimé du portail.
Cet outil prend en charge un nombre maximal d’enregistrements de 50 millions. Si la table contient plus de 50 millions d’enregistrements, divisez-la en plusieurs tables contenant chacune 50 millions d’enregistrements au maximum. Si l’entrée est un fichier .csv, il doit utiliser le codage UTF-8 avec un indicateur d’ordre des octets (BOM).

Remarque :

Vous pouvez utiliser une application tierce comme Microsoft Excel ou Notepad++ pour ajouter un paramètre BOM UTF-8 au fichier .csv.
La première ligne du fichier .csv en entrée est utilisée comme noms de champ pour la classe d’entités en sortie, en plus des champs ajoutés à partir du localisateur. Les noms de champs ne peuvent pas contenir d’espaces ou de caractères spéciaux autres qu’un tiret bas.

Remarque :

Si vous utilisez l’outil dans Python, les champs de la valeur du paramètre table_field_name doivent être écrits dans la même casse que ceux de la valeur du paramètre input_address_field pour apparier les champs à l’aide du paramètre address_fields.
Si le localisateur est publié dans ArcGIS Enterprise on Kubernetes et que la fonctionnalité Batch Geocode (Géocodage par lots) est activée, deux services sont créés : un service de serveur de géocodage et un service GPServer. Si vous utilisez l’outil dans Python, la valeur du paramètre in_batch_service doit être le service GPServer (par exemple, https://machinename.domain.com/server/rest/services/service_name/GPServer).
Les résultats de géocodage sont enregistrés dans la même référence spatiale que le service. Vous pouvez modifier la référence spatiale de la sortie en définissant l’environnement Output Coordinate System (Système de coordonnées en sortie).
Les résultats du géocodage contiendront toutes les informations de géocodage pertinentes, notamment le score, le statut et l’adresse appariée de chaque enregistrement, ainsi que les valeurs de la table ou du fichier en entrée d’origine. Les résultats du géocodage produits par cet outil comprennent un instantané de la table en entrée d’origine. Par conséquent, l’ajout ou la mise à jour de valeurs dans la table d’origine n’implique pas la mise à jour des résultats dans la classe d’entités en sortie. Réexécutez l’outil pour créer une classe d’entités en sortie contenant ces modifications.
Les paramètres suivants ne sont pas pris en charge pour tous les services par lots utilisés par la valeur du paramètre Input Batch Service (Service de géocodage par lots en entrée) : Country or Region (Pays ou région), Preferred Location Type (Type de localisation privilégié) et Category (Catégorie).
Cet outil ne prend pas en charge les sélections. Pour géocoder une portion de table, exportez la partie concernée et exécutez l’outil sur cette nouvelle table plus petite.

Etiqueter	Explication	Type de données
Input Table (Table en entrée)	Table ou fichier `.csv` d’adresses ou de lieux à géocoder.	Table View
Service de géocodage par lots en entrée	Service de géocodage du portail avec prise en charge du géocodage par lots à utiliser pour géocoder la table d’adresses et de lieux. Remarque : Si le service est un localisateur personnalisé ou un localisateur ArcGIS StreetMap Premium, il doit être publié dans ArcGIS Enterprise on Kubernetes 11.5 ou version ultérieure avec la fonctionnalité Batch Geocode (Géocodage par lots) activée.	String
Appariement des champs d’adresse	Appariement des champs d’adresse utilisés par le localisateur aux champs de la table ou du fichier d’adresses en entrée. Précisez Single Field (Champ unique) si l’adresse complète est stockée dans un champ du fichier ou de la table en entrée (par exemple, 303 Peachtree St NE, Atlanta, GA 30308). Spécifiez Multiple Fields (Champs multiples) si les adresses en entrée sont divisées en plusieurs champs, tels que `Address`, `City`, `State` et `ZIP` dans le cas d’une adresse générale aux États-Unis. Spécifiez Single Field and Country Field (Champ unique et Champ de pays) si l’adresse complète et le pays sont répartis sur des champs distincts, tels que `Address` (303 Peachtree St NE, Atlanta, GA 30308) et `Country` (USA). Certains localisateurs prennent en charge plusieurs adresses en entrée telles que `Address`, `Address2` et `Address3`. Dans ce cas, le composant d’adresse peut être divisé en plusieurs champs et les champs d’adresse seront concaténés au moment du géocodage. Par exemple, 100, Main St et Apt 140 en trois champs ou 100 Main St et Apt 140 en deux champs deviennent 100 Main St Apt 140 lors du géocodage. Si vous n’appariez pas un champ d’adresse en entrée facultatif utilisé par le localisateur d’adresses à un champ de la table ou du fichier d’adresses en entrée, indiquez qu’il n’existe pas d’appariement en utilisant <None> au lieu d’un nom de champ.	Field Info
Classe d’entités en sortie	Classe d’entités géocodées en sortie. Remarque : L’enregistrement de la sortie au format shapefile n’est pas pris en charge en raison de limitations liées aux shapefiles.	Feature Class
Pays ou région	Pays auxquels se limite la recherche des adresses géocodées. Dans la plupart des cas, la spécification d’un pays contribue à accroître la précision du géocodage. Si aucun pays n’est spécifié, le géocodage est effectué en utilisant tous les pays pris en charge sur le localisateur. Si vous spécifiez Single Field and Country Field (Champ unique et champ de pays) dans le paramètre Adress Field Mapping (Appariement de champs d’adresse), la valeur de ce paramètre est remplacée.	String
Type d’emplacement préféré (Facultatif)	Spécifie la géométrie en sortie privilégiée qui est renvoyée pour les correspondances `PointAddress`. Si l’emplacement préféré n’existe pas dans les données, l’emplacement par défaut est renvoyé. Consultez l’aide Web d’ArcGIS REST API pour en savoir plus sur le paramètre `locationType` dans le cadre de l’opération `geocodeAddresses`. Emplacement d’adresse—La géométrie des résultats de géocodage qui représentent une localisation d’adresse, comme le toit, le centroïde de la parcelle ou la porte principale, est renvoyée. Il s’agit de l’option par défaut. Emplacement d’itinéraire—La géométrie des résultats de géocodage représentant un emplacement proche du côté de la rue qui peut servir dans le cadre du calcul d’itinéraire est renvoyé.	String
Catégorie (Facultatif)	Restreint les types de lieux que le localisateur recherche. Cela permet d’éliminer les faux positifs ainsi que les correspondances d’adresses non souhaitées, et de distinguer les recherches de coordonnées. Ce paramètre peut accélérer le processus de recherche. Si aucune catégorie n’est utilisée, le géocodage est effectué à l’aide de toutes les catégories prises en charge. Toutes les valeurs de catégories ne sont pas prises en charge pour tous les emplacements et pays. Pour en savoir plus sur le filtrage des catégories, reportez-vous à l’aide Web d’ArcGIS REST API.	String
Champs en sortie (Facultatif)	Spécifie les champs de localisateur en sortie qui sont renvoyés dans les résultats de géocodage. Les noms de champ d’origine indiqués dans le paramètre Input Table (Table en entrée) sont conservés si l’option Location Only (Localisation uniquement), Minimal ou Minimal and User Fields (Champs minimaux et d’utilisateur) est spécifiée. Tous—Inclut tous les champs de localisateur en sortie disponibles dans les résultats de géocodage. Il s’agit de l’option par défaut. Emplacement uniquement—Stocke le champ `Shape` dans les résultats de géocodage. Minimale—Ajoute les champs suivants qui décrivent l’emplacement et son niveau d’appariement avec les informations du localisateur dans les résultats de géocodage : `Shape`, `Status`, `Score`, `Match_type`, `Match_addr` et `Addr_type`. Champs minimaux et d’utilisateur—Les champs `MINIMAL`, ainsi que les éventuels champs en sortie personnalisés définis par l’utilisateur, sont ajoutés et renvoyés dans les résultats du géocodage.	String
Match Narrative (Détails de l’appariement) (Facultatif)	Indique la manière dont les détails de l’appariement sont renvoyés dans la classe d’entités géocodées en sortie. Si aucune valeur de paramètre n’est indiquée, le paramètre de la propriété du localisateur Include match narrative (Inclure les détails de l’appariement) est utilisé. Ce paramètre contribue à mieux comprendre la manière dont les adresses ont été appariées dans la classe d’entités géocodées. Add match narrative to output (Ajouter les détails de l’appariement à la sortie)—Un champ nommé `MatchNarrative` est ajouté à la classe d’entités géocodées. Ce champ contient le texte des détails de l’appariement pour chaque adresse appariée. Split match narrative into fields (Fractionner les détails de l’appariement dans des champs)—Les détails de l’appariement du champ unique sont extraits de l’objet JSON. Le texte des détails de l’appariement est analysé, fractionné en plusieurs champs et ajouté à la classe d’entités géocodées.	String

arcpy.geocoding.BatchGeocode(in_table, in_batch_service, address_fields, out_feature_class, country, {location_type}, {category}, {output_fields}, {match_narrative})

Nom	Explication	Type de données
in_table	Table ou fichier `.csv` d’adresses ou de lieux à géocoder.	Table View
in_batch_service	Service de géocodage du portail avec prise en charge du géocodage par lots à utiliser pour géocoder la table d’adresses et de lieux. Remarque : Si le service est un localisateur personnalisé ou un localisateur ArcGIS StreetMap Premium, il doit être publié dans ArcGIS Enterprise on Kubernetes 11.5 ou version ultérieure avec la fonctionnalité Batch Geocode (Géocodage par lots) activée.	String
address_fields	Chaque appariement de champs dans ce paramètre est au format `input_address_field, table_field_name`, où `input_address_field` est le nom du champ d’adresse en entrée spécifié par le localisateur et `table_field_name` est le nom du champ correspondant dans la table ou le fichier d’adresses à géocoder. Spécifiez un champ d’entrée unique si l’adresse complète est stockée dans un seul champ de la valeur `in_table` (par exemple, 303 Peachtree St NE, Atlanta, GA 30308). Vous pouvez également spécifier plusieurs champs si les adresses en entrée sont décomposées dans plusieurs champs, tels que `Address`, `City`, `State` et `ZIP` dans le cas d’une adresse générale aux États-Unis. Vous pouvez également spécifier un seul champ en entrée qui contient l’adresse complète (par exemple, 303 Peachtree St NE, Atlanta, GA 30308) et un champ qui stocke le pays associé à l’adresse (par exemple, USA). Certains localisateurs prennent en charge plusieurs champs d’adresse en entrée (par exemple, `Address`, `Address2` et `Address3`). Dans ce cas, le composant d’adresse peut être divisé en plusieurs champs et les champs d’adresse seront concaténés au moment du géocodage. Par exemple, 100, Main St et Apt 140 en trois champs ou 100 Main St et Apt 140 en deux champs deviennent 100 Main St Apt 140 lors du géocodage. Si vous n’appariez pas un champ d’adresse facultatif en entrée utilisé par le localisateur d’adresses à un champ dans la table ou le fichier d’adresses en entrée, précisez qu’il n’y a pas d’appariement en utilisant `<None>` au lieu du nom d’un champ.	Field Info
out_feature_class	Classe d’entités géocodées en sortie. Remarque : L’enregistrement de la sortie au format shapefile n’est pas pris en charge en raison de limitations liées aux shapefiles.	Feature Class
country [country,...]	Pays auxquels se limite la recherche des adresses géocodées. Dans la plupart des cas, la spécification d’un pays contribue à accroître la précision du géocodage. Si aucun pays n’est spécifié, le géocodage est effectué pour tous les pays pris en charge par le localisateur. Lorsqu’un champ de la valeur du paramètre `in_table` est apparié au champ `Country` dans le paramètre `address_fields`, la valeur de ce paramètre est remplacée. Spécifiez la valeur en tant que code pays à deux ou trois caractères dans une liste de valeurs séparées par des virgules. Reportez-vous à la rubrique Colonne des codes de pays pris en charge pour connaître la valeur en entrée à utiliser.	String
location_type (Facultatif)	Spécifie la géométrie en sortie privilégiée qui est renvoyée pour les correspondances `PointAddress`. Si la localisation privilégiée n’existe pas dans les données, la localisation par défaut de `ADDRESS_LOCATION` est renvoyée. Consultez l’aide Web d’ArcGIS REST API pour en savoir plus sur le paramètre `locationType` dans le cadre de l’opération `geocodeAddresses`. `ADDRESS_LOCATION`—La géométrie des résultats de géocodage qui représentent une localisation d’adresse, comme le toit, le centroïde de la parcelle ou la porte principale, est renvoyée. Il s’agit de l’option par défaut. `ROUTING_LOCATION`—La géométrie des résultats de géocodage représentant un emplacement proche du côté de la rue qui peut servir dans le cadre du calcul d’itinéraire est renvoyé.	String
category [category,...] (Facultatif)	Restreint les types de lieux que le localisateur recherche. Cela permet d’éliminer les faux positifs ainsi que les correspondances d’adresses non souhaitées, et de distinguer les recherches de coordonnées. Ce paramètre peut accélérer le processus de recherche. Si aucune catégorie n’est utilisée, le géocodage est effectué à l’aide de toutes les catégories prises en charge. Toutes les valeurs de catégories ne sont pas prises en charge pour tous les emplacements et pays. Pour en savoir plus sur le filtrage des catégories, reportez-vous à l’aide Web d’ArcGIS REST API.	String
output_fields (Facultatif)	Spécifie les champs de localisateur en sortie qui sont renvoyés dans les résultats de géocodage. Les noms de champ d’origine indiqués dans le paramètre `in_table` sont conservés si l’option `LOCATION_ONLY`, `MINIMAL` ou `MINIMAL_AND_USER` est spécifiée. `ALL`—Inclut tous les champs de localisateur en sortie disponibles dans les résultats de géocodage. Il s’agit de l’option par défaut. `LOCATION_ONLY`—Stocke le champ `Shape` dans les résultats de géocodage. `MINIMAL`—Ajoute les champs suivants qui décrivent l’emplacement et son niveau d’appariement avec les informations du localisateur dans les résultats de géocodage : `Shape`, `Status`, `Score`, `Match_type`, `Match_addr` et `Addr_type`. `MINIMAL_AND_USER`—Les champs `MINIMAL`, ainsi que les éventuels champs en sortie personnalisés définis par l’utilisateur, sont ajoutés et renvoyés dans les résultats du géocodage.	String
match_narrative [match_narrative,...] (Facultatif)	Indique la manière dont les détails de l’appariement sont renvoyés dans la classe d’entités géocodées en sortie. Si aucune valeur de paramètre n’est indiquée, le paramètre de la propriété du localisateur Include match narrative (Inclure les détails de l’appariement) est utilisé. Ce paramètre contribue à mieux comprendre la manière dont les adresses ont été appariées dans la classe d’entités géocodées. `ADD_MATCH_NARRATIVE`—Un champ nommé `MatchNarrative` est ajouté à la classe d’entités géocodées. Ce champ contient le texte des détails de l’appariement pour chaque adresse appariée. `SPLIT_MATCH_NARRATIVE`—Les détails de l’appariement du champ unique sont extraits de l’objet JSON. Le texte des détails de l’appariement est analysé, fractionné en plusieurs champs et ajouté à la classe d’entités géocodées.	String

Exemple de code

Exemple 1 d’utilisation de la fonction BatchGeocode (script autonome)

Le script ci-après montre comment utiliser la fonction BatchGeocode pour géocoder un fichier .csv avec ArcGIS World Geocoding Service et renvoyer les MINIMAL output_fields dans le résultat du géocodage.

Remarque :

Si vous utilisez des localisateurs sur votre portail, assurez-vous d’être connecté à celui-ci et de l’avoir défini comme portail actif dans ArcGIS Pro. Pour accéder à un localisateur situé sur un portail qui n’est pas le portail actif, authentifiez-vous à l’aide de la fonction SignInToPortal.

Remarque :

Lors de l’utilisation d’ArcGIS World Geocoding Service, cette opération peut consommer des crédits.

import arcpy

# Set local variables

# Input is a local file
in_table = r"C:\data\customers.csv"

# Sign in to Portal
#arcpy.SignInToPortal("https://www.arcgis.com.", "MyUsername", "MyPassword")

in_batch_service = "https://geocode.arcgis.com/arcgis/rest/services/World/GPServer/BatchGeocode/"

# One way to generate the value for the field mapping parameter is to first run the tool in ArcGIS
# Pro and right-click the green success ribbon and click "Copy Python command"
# The table_field_name fields must be in the same case as the input_address_field fields.

address_fields = """'Address or Place' Address VISIBLE NONE;Address2 <None> VISIBLE NONE;Address3 <None> VISIBLE NONE;
Neighborhood <None> VISIBLE NONE;City City VISIBLE NONE;County <None> VISIBLE NONE;State State VISIBLE NONE;
ZIP ZIPCODE VISIBLE NONE;ZIP4 <None> VISIBLE NONE;Country <None> VISIBLE NONE"""

geocode_result = r"C:\Mydata\results.gdb\geocode_results"

# Optional geocoding parameters. Only some are supported depending on the in_batch_service that you use.
country = USA
location_type = "ADDRESS_LOCATION"
category = "'Point Address'"
output_fields = "MINIMAL"

arcpy.geocoding.BatchGeocode(in_table, in_batch_service, address_fields, geocode_result,
                             country, location_type, category, output_fields)

Exemple 2 d’utilisation de la fonction BatchGeocode (script autonome)

Le script ci-après illustre l’utilisation de la fonction BatchGeocode pour géocoder une table avec un service de géocodage par lots du portail avec les output_fields par défaut dans le résultat du géocodage.

Remarque :

import arcpy

# Set local variables

# Input is a local file
in_table = r"C:\data\mytables.gdb\restaurants"

in_batch_service = "https://machinename.domain.com/server/rest/services/service_name/GPServer/"

# One way to generate the value for the field mapping parameter is to first run the tool in ArcGIS
# Pro and right-click the green success ribbon and click "Copy Python command"
# The table_field_name fields must be in the same case as the input_address_field fields.

address_fields = """'Address or Place' Address VISIBLE NONE;Address2 <None> VISIBLE NONE;Address3 <None> VISIBLE NONE;
Neighborhood <None> VISIBLE NONE;City City VISIBLE NONE;County <None> VISIBLE NONE;State State VISIBLE NONE;
ZIP ZIPCODE VISIBLE NONE;ZIP4 <None> VISIBLE NONE;Country <None> VISIBLE NONE"""

geocode_result = r"C:\My_Output.gdb\geocode_result"

# Optional geocoding parameters. Only some are supported depending on the in_batch_service that you use.
country = USA
location_type = "ROUTING_LOCATION"
category = "'Point Address'"
output_fields = "ALL"

arcpy.geocoding.BatchGeocode(in_table, in_batch_service, address_fields, geocode_result,
                             country, location_type, category, output_fields)

Environnements

Système de coordonnées en sortie

Informations de licence

Basic: Votre compte dans ArcGIS Enterprise doit bénéficier du privilège Perform Analysis (Effectuer des analyses)
Standard: Votre compte dans ArcGIS Enterprise doit bénéficier du privilège Perform Analysis (Effectuer des analyses)
Advanced: Votre compte dans ArcGIS Enterprise doit bénéficier du privilège Perform Analysis (Effectuer des analyses)

Géocodage par lots (Outils de géocodage)

Résumé

Remarque :

Utilisation

Remarque :

Remarque :

Paramètres

Remarque :

Remarque :

Environnements

Informations de licence

Rubriques connexes