Classe Geocoder
Classe google.maps.Geocoder
Service permettant de convertir une adresse en LatLng
.
Pour y accéder, appelez const {Geocoder} = await google.maps.importLibrary("geocoding")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
Geocoder |
Geocoder() Paramètres:aucun
Crée une instance de Geocoder qui envoie des requêtes de geocoding 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 geocoding à envoyer à Geocoder
.
Propriétés | |
---|---|
address optional |
Type:
string optional Adresse à géocoder. Vous ne devez fournir qu'un seul élément address , location et placeId . |
bounds optional |
Type:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds dans lesquelles effectuer la recherche. Facultatif. |
componentRestrictions optional |
Type:
GeocoderComponentRestrictions optional Les composants sont utilisés pour limiter les résultats à une zone spécifique. Un filtre est constitué 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. |
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 ne devez fournir qu'un seul élément address , location et placeId . |
placeId optional |
Type:
string optional ID de 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 ne devez fournir qu'un seul élément address , location et placeId . |
region optional |
Type:
string optional Code pays utilisé pour pondérer la recherche, indiqué sous la forme d'un identifiant CLDR ou d'un sous-tag de région Unicode à deux caractères (non numériques). Facultatif. Consultez Détails de la couverture Google Maps Platform pour connaître les régions acceptées. |
Interface GeocoderComponentRestrictions
Interface google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
représente un ensemble de filtres qui se rapportent à une zone spécifique. Pour en savoir plus, consultez l'article Filtrage des composants Geocoding.
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 GeocoderStatus
Constantes google.maps.GeocoderStatus
État renvoyé par Geocoder
à la fin d'un appel à geocode()
. Spécifiez-les à l'aide d'une valeur ou du nom de la constante. Par exemple : 'OK'
ou google.maps.GeocoderStatus.OK
.
Pour y accéder, appelez const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constantes | |
---|---|
ERROR |
Un problème est survenu lors de la communication avec les serveurs Google. |
INVALID_REQUEST |
Cet élément (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 en trop peu de temps. |
REQUEST_DENIED |
La page Web n'est pas autorisée à utiliser le geocoder. |
UNKNOWN_ERROR |
Une requête de geocoding n'a pas pu être traitée en raison d'une erreur de serveur. Si vous essayez à nouveau, la requête pourrait aboutir. |
ZERO_RESULTS |
Aucun résultat n'a été trouvé pour ce GeocoderRequest . |
Interface GeocoderResponse
Interface google.maps.GeocoderResponse
Réponse du geocoder renvoyée par le Geocoder
contenant la liste des GeocoderResult
.
Propriétés | |
---|---|
results |
Type:
Array<GeocoderResult> Liste des GeocoderResult . |
Interface GeocoderResult
Interface google.maps.GeocoderResult
Résultat de geocoder unique récupéré à partir du serveur de geocoding. Une requête de geocoding peut renvoyer plusieurs objets de résultat. Notez que bien que ce résultat soit de type JSON, il ne s'agit pas strictement de JSON, car il inclut indirectement un objet LatLng
.
Propriétés | |
---|---|
address_components |
Tableau de valeurs GeocoderAddressComponent |
formatted_address |
Type:
string Chaîne contenant l'adresse lisible de cet établissement. |
geometry |
Type:
GeocoderGeometry Un objet GeocoderGeometry |
place_id |
Type:
string ID de 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. |
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. Pour une correspondance exacte, la valeur sera undefined . |
plus_code optional |
Type:
PlacePlusCode optional Plus code associé à l'établissement. |
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 GeocoderAddressComponent
Interface google.maps.GeocoderAddressComponent
Un composant d'adresse unique dans un élément 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 court et 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 géométriques sur ce GeocoderResult
Propriétés | |
---|---|
location |
Type:
LatLng Coordonnées de latitude/longitude de ce résultat |
location_type |
Type:
GeocoderLocationType Type d'établissement renvoyé dans location |
viewport |
Type:
LatLngBounds Limites de la fenêtre d'affichage recommandée pour l'affichage de ce GeocoderResult |
bounds optional |
Type:
LatLngBounds optional Les limites précises de ce GeocoderResult , le cas échéant |
Constantes GeocoderLocationType
Constantes google.maps.GeocoderLocationType
Décrit le type de lieu renvoyé par un geocode. Spécifiez-les à l'aide d'une valeur ou du nom de la constante. Par exemple, 'ROOFTOP'
ou google.maps.GeocoderLocationType.ROOFTOP
.
Pour y accéder, appelez const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
. Consultez Bibliothèques dans 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 tel qu'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. |