Classe Geocoder
Classe google.maps.Geocoder
Service permettant de convertir une adresse en LatLng
et inversement.
Accédez-y en appelant le const {Geocoder} = await google.maps.importLibrary("geocoding")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
Geocoder |
Geocoder() Paramètres : aucun
Crée une instance de Geocoder qui envoie des requêtes de géocodage aux serveurs Google. |
Méthodes | |
---|---|
geocode |
geocode(request[, callback]) Paramètres :
Valeur renvoyée :
Promise<GeocoderResponse> Géocode une requête. |
Interface GeocoderRequest
Interface google.maps.GeocoderRequest
Spécification d'une requête de géocodage à envoyer à Geocoder
.
Propriétés | |
---|---|
address optional |
Type :
string optional Adresse à géocoder. Vous devez fournir une seule valeur parmi address , location et placeId . |
bounds optional |
Type :
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds dans lequel effectuer la recherche. Facultatif. |
componentRestrictions optional |
Type :
GeocoderComponentRestrictions optional Les composants permettent de limiter les résultats à une zone spécifique. Un filtre se compose d'un ou de plusieurs des éléments suivants : route , locality , administrativeArea , postalCode , country . Seuls les résultats correspondant à tous les filtres sont renvoyés. Les valeurs de filtre prennent en charge les mêmes méthodes de correction orthographique et de correspondance partielle que les autres requêtes de géocodage. Facultatif. |
|
Type :
Array<ExtraGeocodeComputation> optional Liste des calculs supplémentaires pouvant être utilisés pour traiter la demande. Remarque : Ces calculs supplémentaires peuvent renvoyer des champs supplémentaires dans la réponse. |
fulfillOnZeroResults optional |
Type :
boolean optional Respectez la promesse d'un état ZERO_RESULT dans la réponse. Cela peut être souhaitable, car même en l'absence de résultats de géocodage, des champs supplémentaires au niveau de la réponse peuvent toujours être renvoyés. |
language optional |
Type :
string optional Identifiant de la langue dans laquelle les résultats doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
location optional |
Type :
LatLng|LatLngLiteral optional LatLng (ou LatLngLiteral ) à rechercher. Le geocoder effectue un geocoding inversé. Pour en savoir plus, consultez Geocoding inversé. Vous devez fournir une seule valeur parmi address , location et placeId . |
placeId optional |
Type :
string optional ID du lieu associé à l'établissement. Les ID de lieu identifient de façon unique un lieu dans la base de données Google Places et sur Google Maps. Pour en savoir plus sur les ID de lieux, consultez le guide du développeur de l'API Places. Le geocoder effectue un geocoding inversé. Pour en savoir plus, consultez Geocoding inversé. Vous devez fournir une seule valeur parmi address , location et placeId . |
region optional |
Type :
string optional Code pays utilisé pour orienter la recherche, spécifié sous forme de sous-tag de région Unicode à deux caractères (non numériques) ou d'identifiant CLDR. Facultatif. Consultez Détails de la couverture Google Maps Platform pour obtenir la liste des régions acceptées. |
Interface GeocoderComponentRestrictions
Interface google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
représente un ensemble de filtres qui correspondent à une zone spécifique. Pour en savoir plus sur son fonctionnement, consultez Filtrage des composants de géocodage.
Propriétés | |
---|---|
administrativeArea optional |
Type :
string optional Correspond à tous les administrative_area levels . Facultatif. |
country optional |
Type :
string optional Correspond à un nom de pays ou à un code pays ISO 3166-1 à deux lettres. Facultatif. |
locality optional |
Type :
string optional Correspond aux types locality et sublocality . Facultatif. |
postalCode optional |
Type :
string optional Correspond à postal_code et postal_code_prefix . Facultatif. |
route optional |
Type :
string optional Correspond au nom long ou court d'un route . Facultatif. |
Constantes ExtraGeocodeComputation
google.maps.ExtraGeocodeComputation
constantes
Calculs supplémentaires à effectuer lors du traitement d'une demande de géocodage.
Accédez-y en appelant le const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
ADDRESS_DESCRIPTORS |
Générez un descripteur d'adresse. |
Constantes GeocoderStatus
google.maps.GeocoderStatus
constantes
État renvoyé par Geocoder
à la fin d'un appel à geocode()
. Spécifiez-les par valeur ou en utilisant le nom de la constante. Par exemple : 'OK'
ou google.maps.GeocoderStatus.OK
.
Accédez-y en appelant le const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
ERROR |
Un problème est survenu lors de la communication avec les serveurs Google. |
INVALID_REQUEST |
Ce GeocoderRequest n'est pas valide. |
OK |
La réponse contient un GeocoderResponse valide. |
OVER_QUERY_LIMIT |
La page Web a dépassé la limite de requêtes sur une période trop courte. |
REQUEST_DENIED |
La page Web n'est pas autorisée à utiliser le geocoder. |
UNKNOWN_ERROR |
Une requête de géocodage n'a pas pu être traitée en raison d'une erreur du serveur. Si vous essayez à nouveau, la requête pourrait aboutir. |
ZERO_RESULTS |
Aucun résultat trouvé pour cette GeocoderRequest . |
Interface GeocoderResponse
Interface google.maps.GeocoderResponse
Réponse du géocodeur renvoyée par Geocoder
contenant la liste des GeocoderResult
.
Propriétés | |
---|---|
results |
Type :
Array<GeocoderResult> Liste des GeocoderResult . |
|
Type :
AddressDescriptor optional Description relationnelle d'un lieu. Inclut un ensemble classé de points de repère à proximité et les zones contenant le lieu cible. Il n'est renseigné que pour les demandes de géocodage inversé et uniquement lorsque ExtraGeocodeComputation.ADDRESS_DESCRIPTORS est activé. |
plus_code optional |
Type :
PlacePlusCode optional Plus Code associé au lieu. |
Interface GeocoderResult
Interface google.maps.GeocoderResult
Résultat unique du geocoder récupéré à partir du serveur de géocodage. Une requête de géocodage peut renvoyer plusieurs objets de résultat. Notez que, bien que ce résultat soit "de type JSON", il n'est pas strictement au format JSON, car il inclut indirectement un objet LatLng
.
Propriétés | |
---|---|
address_components |
Type :
Array<GeocoderAddressComponent> Tableau de GeocoderAddressComponent |
formatted_address |
Type :
string Chaîne contenant l'adresse lisible de ce lieu. |
geometry |
Type :
GeocoderGeometry Un objet GeocoderGeometry |
place_id |
Type :
string ID du lieu associé à l'établissement. Les ID de lieu identifient de façon unique un lieu dans la base de données Google Places et sur Google Maps. Pour en savoir plus sur les ID de lieux, consultez le guide du développeur de l'API Places. |
types |
Type :
Array<string> Tableau de chaînes indiquant le type de l'élément géocodé renvoyé. Pour obtenir la liste des chaînes possibles, consultez la section Types de composants d'adresse du guide du développeur. |
|
Type :
AddressDescriptor optional Description relationnelle du lieu associé à ce code géographique. Inclut un ensemble classé de points de repère à proximité et les zones contenant le lieu cible. Ce champ ne sera renseigné que pour les requêtes de géocodage direct et de recherche d'ID de lieu, uniquement lorsque ExtraGeocodeComputation.ADDRESS_DESCRIPTORS est activé et uniquement pour certains lieux localisés. |
partial_match optional |
Type :
boolean optional Indique si le geocoder n'a pas renvoyé de correspondance exacte pour la requête d'origine, bien qu'il ait pu trouver une partie de l'adresse demandée. Si la correspondance est exacte, la valeur sera undefined . |
plus_code optional |
Type :
PlacePlusCode optional Plus Code associé au lieu. |
postcode_localities optional |
Type :
Array<string> optional Tableau de chaînes indiquant toutes les localités contenues dans un code postal. Ce composant est présent uniquement lorsque le résultat correspond à un code postal regroupant plusieurs localités. |
Interface AddressDescriptor
Interface google.maps.AddressDescriptor
Description relationnelle d'un lieu. Inclut un ensemble classé de points de repère à proximité et les zones contenant le lieu cible.
Propriétés | |
---|---|
areas |
Liste classée des zones contenant ou adjacentes. Les zones les plus utiles (reconnaissables et précises) sont classées en premier. |
landmarks |
Liste classée des points de repère à proximité. Les points de repère les plus utiles (reconnaissables et proches) sont classés en premier. |
Interface GeocoderAddressComponent
Interface google.maps.GeocoderAddressComponent
Composant d'adresse unique dans un GeocoderResult
. Une adresse complète peut comporter plusieurs composants d'adresse.
Propriétés | |
---|---|
long_name |
Type :
string Texte complet du composant d'adresse |
short_name |
Type :
string Texte abrégé du composant d'adresse donné |
types |
Type :
Array<string> Tableau de chaînes indiquant le type de ce composant d'adresse. Pour consulter la liste des types valides, cliquez ici. |
Interface GeocoderGeometry
Interface google.maps.GeocoderGeometry
Informations sur la géométrie de cet GeocoderResult
Propriétés | |
---|---|
location |
Type :
LatLng Coordonnées de latitude et de longitude de ce résultat |
location_type |
Type :
GeocoderLocationType Type de lieu renvoyé dans location |
viewport |
Type :
LatLngBounds Limites de la fenêtre d'affichage recommandée pour afficher ce GeocoderResult |
bounds optional |
Type :
LatLngBounds optional Limites précises de ce GeocoderResult , le cas échéant |
Constantes GeocoderLocationType
google.maps.GeocoderLocationType
constantes
Décrit le type de lieu renvoyé par un géocode. Spécifiez-les par valeur ou en utilisant le nom de la constante. Par exemple, 'ROOFTOP'
ou google.maps.GeocoderLocationType.ROOFTOP
.
Accédez-y en appelant le const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
APPROXIMATE |
Le résultat renvoyé est approximatif. |
GEOMETRIC_CENTER |
Le résultat renvoyé est le centre géométrique d'un résultat, comme une ligne (par exemple, une rue) ou un polygone (une région). |
RANGE_INTERPOLATED |
Le résultat renvoyé reflète une approximation (généralement sur une route) interpolée entre deux points précis (des intersections, par exemple). Les résultats interpolés sont généralement renvoyés lorsque le géocodage rooftop est indisponible pour une adresse postale. |
ROOFTOP |
Le résultat renvoyé reflète un geocode précis. |
Interface Point de repère
Interface google.maps.Landmark
Lieu qui sert de point de référence pour l'adresse.
Propriétés | |
---|---|
display_name |
Type :
string Nom du repère. |
display_name_language_code |
Type :
string Langue du nom du point de repère. |
place_id |
Type :
string ID du lieu de l'établissement sous-jacent servant de point de repère. Peut être utilisé pour obtenir plus d'informations sur le point de repère grâce à Place Details ou Place Id Lookup. |
spatial_relationship |
Type :
SpatialRelationship Définit la relation spatiale entre le lieu cible et le point de repère. |
straight_line_distance_meters |
Type :
number Distance en ligne droite entre le lieu cible et le point de repère. |
types |
Type :
Array<string> Une ou plusieurs valeurs indiquant le type du résultat renvoyé. Pour en savoir plus, consultez Types . |
travel_distance_meters optional |
Type :
number optional Distance à parcourir sur le réseau routier entre le lieu cible et le point de repère. Ce champ peut être vide si le point de repère est déconnecté de la partie du réseau routier la plus proche de la cible OU si l'emplacement cible n'a pas été considéré comme faisant partie du réseau routier. |
Interface Aires
Interface google.maps.Area
Lieu qui correspond à une petite région, comme un quartier, une sous-localité ou un grand complexe contenant l'emplacement cible.
Propriétés | |
---|---|
containment |
Type :
Containment Définit la relation spatiale entre le lieu cible et la zone. |
display_name |
Type :
string Nom de la zone. |
display_name_language_code |
Type :
string Langue du nom de la zone. |
place_id |
Type :
string ID du lieu de la zone sous-jacente. Peut être utilisé pour obtenir plus d'informations sur la zone grâce à Place Details ou Place ID Lookup. |
Constantes Containment
google.maps.Containment
constantes
Énumération représentant la relation spatiale entre la zone et le lieu cible.
Accédez-y en appelant le const {Containment} = await google.maps.importLibrary("geocoding")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
NEAR |
L'emplacement cible se trouve en dehors de la zone, mais à proximité. |
OUTSKIRTS |
L'emplacement cible se trouve dans la région de la zone, près du bord. |
WITHIN |
L'emplacement cible se trouve dans la région de la zone, près du centre. |
Constantes SpatialRelationship
google.maps.SpatialRelationship
constantes
Énumération représentant la relation spatiale entre le repère et la cible.
Accédez-y en appelant le const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
ACROSS_THE_ROAD |
La cible se trouve directement en face du point de repère, de l'autre côté de la route. |
AROUND_THE_CORNER |
Pas sur le même itinéraire que le point de repère, mais à un seul embranchement. |
BEHIND |
Près de la structure du point de repère, mais plus loin de son point d'accès. |
BESIDE |
La cible est directement adjacente au point de repère. |
DOWN_THE_ROAD |
Sur le même itinéraire que le point de repère, mais pas à côté ni en face. |
NEAR |
Il s'agit de la relation par défaut lorsqu'aucune relation plus spécifique ci-dessous ne s'applique. |
WITHIN |
Le point de repère a une géométrie spatiale et la cible se trouve dans ses limites. |