Classe Geocoder
Classe google.maps.Geocoder
Service permettant de convertir une adresse en LatLng
.
Accédez-y en appelant const {Geocoder} = await google.maps.importLibrary("geocoding")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
Geocoder |
Geocoder() Paramètres:aucun
Crée une instance d'un 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éocodez une demande. |
Interface GeocoderRequest
Interface google.maps.GeocoderRequest
Spécification d'une requête de géocodage à envoyer à la Geocoder
.
Propriétés | |
---|---|
address optional |
Type:
string optional Adresse à géocoder. Vous devez fournir un seul élément parmi address , location et placeId . |
bounds optional |
Type:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds dans lequel effectuer une recherche. Facultatif. |
componentRestrictions optional |
Type:
GeocoderComponentRestrictions optional Les composants permettent de limiter les résultats à une zone spécifique. Un filtre se compose d'au moins une des valeurs suivantes: route , locality , administrativeArea , postalCode ou 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. |
extraComputations optional |
Type:
Array<ExtraGeocodeComputation> optional Liste des calculs supplémentaires pouvant être utilisés pour traiter la requête. Remarque: Ces calculs supplémentaires peuvent renvoyer des champs supplémentaires dans la réponse. |
fulfillOnZeroResults optional |
Type:
boolean optional Tenez la promesse avec un état ZERO_RESULT dans la réponse. Cela peut être utile, car même si aucun résultat de géocodage n'est renvoyé, 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 un seul élément address , location ou 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 lieu, 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 un seul élément address , location ou placeId . |
region optional |
Type:
string optional Code pays utilisé pour biaiser la recherche, spécifié sous forme de sous-tag de région Unicode à deux caractères (non numériques)/identifiant CLDR. Facultatif. Consultez Détails de la couverture Google Maps Platform pour obtenir une liste des régions compatibles. |
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
Constantes google.maps.ExtraGeocodeComputation
Calculs supplémentaires à effectuer lors de l'exécution d'une requête de géocodage.
Accédez-y en appelant const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
ADDRESS_DESCRIPTORS |
Générez un descripteur d'adresse. |
Constantes GeocoderStatus
Constantes google.maps.GeocoderStatus
É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 const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
ERROR |
Un problème est survenu lors de la communication avec les serveurs Google. |
INVALID_REQUEST |
La syntaxe de cet élément GeocoderRequest est incorrecte. |
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 géocodeur. |
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 n'a été trouvé pour cette GeocoderRequest . |
Interface GeocoderResponse
Interface google.maps.GeocoderResponse
Réponse du géocodeur renvoyée par le Geocoder
contenant la liste des GeocoderResult
.
Propriétés | |
---|---|
results |
Type:
Array<GeocoderResult> Liste des GeocoderResult . |
address_descriptor optional |
Type:
AddressDescriptor optional Description relationnelle d'un emplacement. Inclut un ensemble classé de repères à proximité et les zones contenant l'emplacement cible. Il n'est renseigné que pour les requêtes de géocodage inverse 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
Un seul résultat de 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 "semblable à du JSON", il ne s'agit pas strictement de JSON, car il inclut indirectement un objet LatLng
.
Propriétés | |
---|---|
address_components |
Tableau de GeocoderAddressComponent |
formatted_address |
Type:
string Chaîne contenant l'adresse lisible de cet emplacement. |
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 lieu, 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. |
address_descriptor optional |
Type:
AddressDescriptor optional Description relationnelle du lieu associé à ce code géographique. Inclut un ensemble classé de repères à proximité et les zones contenant l'emplacement 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 géocodeur 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. En cas de correspondance exacte, la valeur est 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 emplacement. Inclut un ensemble classé de repères à proximité et les zones contenant l'emplacement 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 d'intérêt à proximité. Les repères les plus utiles (reconnaissables et à proximité) 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.
Propriétés | |
---|---|
long_name |
Type:
string Texte complet du composant d'adresse |
short_name |
Type:
string Texte court 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 appareil GeocoderResult
Propriétés | |
---|---|
location |
Type:
LatLng Coordonnées de latitude/longitude de ce résultat |
location_type |
Type:
GeocoderLocationType Type d'emplacement renvoyé dans location |
viewport |
Type:
LatLngBounds Limites de la fenêtre d'affichage recommandée pour afficher cette GeocoderResult |
bounds optional |
Type:
LatLngBounds optional Limites précises de cette GeocoderResult , le cas échéant |
Constantes GeocoderLocationType
Constantes google.maps.GeocoderLocationType
Décrit le type d'emplacement renvoyé par une géolocalisation. 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 const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
. Consultez la section 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 repère. |
place_id |
Type:
string ID du lieu de l'établissement sous-jacent servant de repère. Permet d'obtenir plus d'informations sur le point d'intérêt via "Place Details" ou "Place ID Lookup". |
spatial_relationship |
Type:
SpatialRelationship Définit la relation spatiale entre l'emplacement cible et le repère. |
straight_line_distance_meters |
Type:
number Distance en ligne droite entre l'emplacement cible et le repère. |
types |
Type:
Array<string> Une ou plusieurs valeurs indiquant le type du résultat renvoyé. Pour en savoir plus, consultez la section Types . |
travel_distance_meters optional |
Type:
number optional Distance parcourue sur le réseau routier entre l'emplacement cible et le repère. Ce champ peut être vide si le repère est déconnecté de la partie du réseau routier à laquelle la cible est la plus proche OU si l'emplacement cible n'était pas considéré comme faisant partie du réseau routier. |
Interface Area (Zone)
Interface google.maps.Area
Lieu qui correspond à une petite région, comme un quartier, une sous-localité ou un grand complexe qui contient l'emplacement cible.
Propriétés | |
---|---|
containment |
Type:
Containment Définit la relation spatiale entre l'emplacement 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. Vous pouvez l'utiliser pour obtenir plus d'informations sur la zone via "Détails sur le lieu" ou "Recherche d'ID de lieu". |
Constantes de structuration
Constantes google.maps.Containment
Enumération représentant la relation spatiale entre la zone et l'emplacement cible.
Accédez-y en appelant const {Containment} = await google.maps.importLibrary("geocoding")
. Consultez la section 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 zone, près du bord. |
WITHIN |
L'emplacement cible se trouve dans la zone, près du centre. |
Constantes SpatialRelationship
Constantes google.maps.SpatialRelationship
Enumération représentant la relation spatiale entre le repère et la cible.
Accédez-y en appelant const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
ACROSS_THE_ROAD |
La cible se trouve directement en face du repère, de l'autre côté de la route. |
AROUND_THE_CORNER |
Ne se trouve pas sur le même itinéraire que le repère, mais à un seul virage de distance. |
BEHIND |
Près de la structure du point de repère, mais plus éloigné de son point d'accès |
BESIDE |
La cible est directement adjacente au repère. |
DOWN_THE_ROAD |
Sur le même itinéraire que le repère, mais pas à côté ni en face. |
NEAR |
Il s'agit de la relation par défaut lorsque rien de plus spécifique ci-dessous ne s'applique. |
WITHIN |
Le repère possède une géométrie spatiale et la cible se trouve dans ses limites. |