Geocoder

Classe Geocoder

Classe google.maps.Geocoder
library "geocoding"

Service permettant de convertir une adresse en LatLng et inversement.

const {Geocoder} = await google.maps.importLibrary("geocoding");
Geocoder
Geocoder()
Paramètres : aucun
Crée une instance de Geocoder qui envoie des requêtes de géocodage aux serveurs Google.
geocode
geocode(request[, callback])
Paramètres :
Valeur renvoyée : Promise<GeocoderResponse>
Géocoder une requête.

Interface GeocoderRequest

google.maps.GeocoderRequest interface

Spécification d'une requête de géocodage à envoyer à Geocoder.
address
facultatif
Type : string optional
Adresse à géocoder. Vous devez indiquer un seul des champs suivants : address, location ou placeId.
bounds
facultatif
LatLngBounds dans lequel effectuer la recherche. Facultatif.
componentRestrictions
facultatif
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.
BetaextraComputations
facultatif
Type : Array<ExtraGeocodeComputation> optional
Liste des calculs supplémentaires pouvant être utilisés pour répondre à la requête. Remarque : Ces calculs supplémentaires peuvent renvoyer des champs supplémentaires dans la réponse.
fulfillOnZeroResults
facultatif
Type : boolean optional
Répondez à la promesse avec l'état ZERO_RESULT dans la réponse. Cela peut être souhaitable, car même si aucun résultat de géocodage n'est renvoyé, des champs supplémentaires peuvent être renvoyés au niveau de la réponse.
language
facultatif
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
facultatif
Type : LatLng|LatLngLiteral optional
LatLng (ou LatLngLiteral) à rechercher. Le geocoder effectue un geocoding inversé. Pour en savoir plus, consultez Geocoding inversé. Vous devez indiquer un seul des champs suivants : address, location ou placeId.
placeId
facultatif
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 devez indiquer un seul des champs address, location et placeId.
region
facultatif
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)/identifiant CLDR. Facultatif. Consultez Détails de la couverture Google Maps Platform pour obtenir une liste des régions prises en charge.

Interface GeocoderComponentRestrictions

google.maps.GeocoderComponentRestrictions interface

GeocoderComponentRestrictions représente un ensemble de filtres qui se résolvent en une zone spécifique. Pour en savoir plus sur le fonctionnement de cette fonctionnalité, consultez Filtrage des composants de géocodage.
administrativeArea
facultatif
Type : string optional
Correspond à tous les administrative_area levels. Facultatif.
country
facultatif
Type : string optional
Correspond à un nom de pays ou à un code pays ISO 3166-1 à deux lettres. Facultatif.
locality
facultatif
Type : string optional
Correspond à la fois aux types locality et sublocality. Facultatif.
postalCode
facultatif
Type : string optional
Correspond à postal_code et postal_code_prefix. Facultatif.
route
facultatif
Type : string optional
Correspond au nom long ou court d'un route. Facultatif.

ExtraGeocodeComputation constantes

google.maps.ExtraGeocodeComputation Bibliothèque de constantes
"geocoding"

Calculs supplémentaires à effectuer lors d'une requête de géocodage.

Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type ExtraGeocodeComputationString.

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");
ADDRESS_DESCRIPTORS Générez un descripteur d'adresse.

Constantes GeocoderStatus

google.maps.GeocoderStatus Bibliothèque de constantes
"geocoding"

É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.

Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type GeocoderStatusString.

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");
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é 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 "GeocoderRequest".

Interface GeocoderResponse

google.maps.GeocoderResponse interface

Réponse du geocoder renvoyée par Geocoder contenant la liste des GeocoderResult.
results
Liste des GeocoderResult.
Betaaddress_descriptor
facultatif
Type : AddressDescriptor optional
Description relationnelle d'un lieu. Inclut un ensemble classé de points de repère à proximité et les zones contenant l'emplacement cible. Il n'est renseigné que pour les requêtes de géocodage inversé et uniquement lorsque ExtraGeocodeComputation.ADDRESS_DESCRIPTORS est activé.
plus_code
facultatif
Type : PlacePlusCode optional
Plus Code associé à l'établissement.

Interface GeocoderResult

google.maps.GeocoderResult interface

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.
address_components
Un tableau de GeocoderAddressComponent
formatted_address
Type : string
Chaîne contenant l'adresse lisible par l'humain de ce lieu.
geometry
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.
Betaaddress_descriptor
facultatif
Type : AddressDescriptor optional
Description relationnelle de l'emplacement associé à ce geocode. Inclut un ensemble classé de points de repère à proximité et les zones contenant l'emplacement cible. Ce champ n'est 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 seulement pour certains lieux localisés.
partial_match
facultatif
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 s'agit d'une correspondance exacte, la valeur sera undefined.
plus_code
facultatif
Type : PlacePlusCode optional
Plus Code associé à l'établissement.
postcode_localities
facultatif
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

google.maps.AddressDescriptor interface

Description relationnelle d'un lieu. Inclut un ensemble classé de points de repère à proximité et les zones contenant l'emplacement cible.
areas
Type : Array<Area>
Liste classée des zones contenantes ou adjacentes. Les zones les plus utiles (reconnaissables et précises) sont classées en premier.
landmarks
Type : Array<Landmark>
Une liste classée des points de repère à proximité. Les repères les plus utiles (reconnaissables et à proximité) sont classés en premier.

Interface GeocoderAddressComponent

google.maps.GeocoderAddressComponent interface

Composant d'adresse unique dans un GeocoderResult. Une adresse complète peut être composée de plusieurs composants d'adresse.
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

google.maps.GeocoderGeometry interface

Informations géométriques sur ce GeocoderResult
location
Type : LatLng
Coordonnées de latitude/longitude de ce résultat
location_type
Type de lieu renvoyé dans location
viewport
Type : LatLngBounds
Limites de la fenêtre d'affichage recommandée pour afficher ce GeocoderResult
bounds
facultatif
Type : LatLngBounds optional
Les limites précises de ce GeocoderResult, le cas échéant

GeocoderLocationType

google.maps.GeocoderLocationType Bibliothèque de constantes
"geocoding"

Décrit le type d'emplacement 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.

Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type GeocoderLocationTypeString.

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");
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 Landmark

google.maps.Landmark interface

Lieu qui représente un point de référence pour l'adresse.
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 de lieu de l'établissement sous-jacent servant de repère. Peut être utilisé pour obtenir plus d'informations sur le point de repère via Place Details ou la recherche d'ID de lieu.
spatial_relationship
Définit la relation spatiale entre l'emplacement cible et le point de repère.
straight_line_distance_meters
Type : number
Distance en ligne droite entre l'emplacement 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
facultatif
Type : number optional
Distance de trajet sur le réseau routier entre l'emplacement cible et le point de repère. Ce champ peut être vide si le repère est déconnecté de la partie du réseau routier la plus proche de la cible OU si la zone géographique ciblée n'a pas été considérée comme faisant partie du réseau routier.

Interface Area

google.maps.Area interface

Lieu correspondant à une petite région, comme un quartier, une sous-localité ou un grand complexe contenant la zone géographique ciblée.
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 de lieu de la zone sous-jacente. Peut être utilisé pour obtenir plus d'informations sur la zone via Place Details ou la recherche d'ID de lieu.

Constantes de structuration

google.maps.Containment Bibliothèque de constantes
"geocoding"

Énumération représentant la relation spatiale entre la zone et l'emplacement cible.

Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type ContainmentString.

const {Containment} = await google.maps.importLibrary("geocoding");
NEAR La zone géographique ciblée se trouve en dehors de la région, mais à proximité.
OUTSKIRTS La zone géographique ciblée se trouve dans la région, près de la frontière.
WITHIN La zone géographique ciblée se trouve dans la région, près du centre.

Constantes SpatialRelationship

google.maps.SpatialRelationship Bibliothèque de constantes
"geocoding"

Énumération représentant la relation dans l'espace entre le repère et la cible.

Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type SpatialRelationshipString.

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");
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 repère, mais à un seul virage.
BEHIND Proche de la structure du point de repère, mais plus éloigné de son point d'accès.
BESIDE La cible est directement adjacente au point de repère.
DOWN_THE_ROAD Sur la même route que le repère, mais pas à côté ni en face.
NEAR Il s'agit de la relation par défaut lorsqu'aucune des relations plus spécifiques 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.