Classe Geocoder
Classe google.maps.Geocoder
Service permettant de convertir une adresse en LatLng
.
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éocoder une requête |
Interface GeocoderRequest
google.maps.GeocoderRequest
interface
Spécification pour une requête de geocoding à envoyer à Geocoder
.
Propriétés | |
---|---|
address optional |
Type :
string optional Adresse à géocoder. Vous devez fournir un seul des champs 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 comprend un ou 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 :
string optional Identifiant de la langue dans laquelle les résultats doivent être renvoyés, lorsque cela est possible. Consultez la liste des langues disponibles. |
location optional |
Type:
LatLng|LatLngLiteral optional LatLng (ou LatLngLiteral ) pour lequel effectuer la recherche. Le géocodeur effectue un géocodage inversé. Pour en savoir plus, consultez Geocoding inversé. Vous devez fournir un seul des champs 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 géocodeur effectue un géocodage inversé. Pour en savoir plus, consultez Geocoding inversé. Vous devez fournir un seul des champs address , location et placeId . |
region optional |
Type :
string optional Code de pays utilisé pour pondérer la recherche, spécifié comme sous-tag de région à deux caractères (non numérique)/identifiant CLDR. Facultatif. Consultez Détails de la couverture Google Maps Platform pour connaître les régions compatibles. |
Interface GeocoderComponentRestrictions
google.maps.GeocoderComponentRestrictions
interface
GeocoderComponentRestrictions
représente un ensemble de filtres qui s'appliquent à une zone spécifique. Pour en savoir plus sur ce fonctionnement, consultez Filtrage des composants de 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'une valeur route . Facultatif. |
Constantes GeocoderStatus
constantes google.maps.GeocoderStatus
État renvoyé par Geocoder
à la fin d'un appel à geocode()
. Spécifiez ces valeurs par valeur ou en utilisant le nom de la constante. Par exemple, 'OK'
ou google.maps.GeocoderStatus.OK
.
Constantes | |
---|---|
ERROR |
Un problème est survenu lors de la communication avec les serveurs Google. |
INVALID_REQUEST |
Ce GeocoderRequest n'était pas valide. |
OK |
La réponse contient un GeocoderResponse valide. |
OVER_QUERY_LIMIT |
La page Web a dépassé le nombre maximal de requêtes trop rapidement. |
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 du serveur. Si vous essayez à nouveau, la requête pourrait aboutir. |
ZERO_RESULTS |
Aucun résultat trouvé pour ce GeocoderRequest . |
Interface GeocoderResponse
google.maps.GeocoderResponse
interface
Une réponse Geocoder renvoyée par Geocoder
contenant la liste de GeocoderResult
.
Propriétés | |
---|---|
results |
Type :
Array<GeocoderResult> Liste de GeocoderResult . |
Interface GeocoderResult
google.maps.GeocoderResult
interface
Résultat de géocode unique extrait du serveur de géocodes. Une requête de geocoding peut renvoyer plusieurs objets de résultat. Notez que même si ce résultat est de type JSON, il n'est pas strictement 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 cet emplacement. |
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. S'il correspond, 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
google.maps.GeocoderAddressComponent
interface
Composant d'adresse unique dans un élément GeocoderResult
. Une adresse complète peut être composée de plusieurs éléments d'adresse.
Propriétés | |
---|---|
long_name |
Type :
string Texte complet du composant d'adresse |
short_name |
Type :
string Le 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
google.maps.GeocoderGeometry
interface
Informations sur la géométrie pour cet élément GeocoderResult
Propriétés | |
---|---|
location |
Type :
LatLng Coordonnées de latitude/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 l'affichage de ce 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 de position renvoyé par un geocode. Spécifiez ces valeurs par valeur ou en utilisant le nom de la constante. Exemples : 'ROOFTOP'
ou google.maps.GeocoderLocationType.ROOFTOP
.
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 (une rue, par exemple) ou un polygone (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 géocode précis. |