Classe DistanceMatrixService
Classe google.maps.DistanceMatrixService
Service permettant de calculer les distances entre plusieurs points de départ et destinations.
Accédez-y en appelant le const {DistanceMatrixService} = await google.maps.importLibrary("routes").
Consultez Bibliothèques de l'API Maps JavaScript.
Constructeur | |
|---|---|
DistanceMatrixService |
DistanceMatrixService()Paramètres : aucun
Crée une instance de DistanceMatrixService qui envoie des requêtes Distance Matrix aux serveurs Google. |
Méthodes | |
|---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback])Paramètres :
Valeur renvoyée :
Promise<DistanceMatrixResponse>Émet une requête Distance Matrix. |
Interface DistanceMatrixRequest
Interface google.maps.DistanceMatrixRequest
Requête Distance Matrix envoyée par DistanceMatrixService, contenant des tableaux de lieux de départ et de destination, ainsi que diverses options pour calculer les métriques.
Propriétés | |
|---|---|
destinations |
Type :
Array<string|LatLng|LatLngLiteral|Place>Tableau contenant des chaînes d'adresse de destination, ou des objets LatLng ou Place, à utiliser comme destinations pour calculer des distances et des durées. Obligatoire. |
origins |
Type :
Array<string|LatLng|LatLngLiteral|Place>Tableau contenant des chaînes d'adresse d'origine, des objets LatLng ou des objets Place à partir desquels calculer la distance et la durée. Obligatoire. |
travelMode |
Type :
TravelModeType de routage demandé. Obligatoire. |
avoidFerries optional |
Type :
boolean optionalSi la valeur est true, le service Distance Matrix est invité à éviter les ferries dans la mesure du possible. Facultatif. |
avoidHighways optional |
Type :
boolean optionalSi la valeur est true, le service Distance Matrix est invité à éviter les autoroutes dans la mesure du possible. Facultatif. |
avoidTolls optional |
Type :
boolean optionalSi la valeur est true, le service Distance Matrix est invité à éviter les routes à péage dans la mesure du possible. Facultatif. |
drivingOptions optional |
Type :
DrivingOptions optionalParamètres qui ne s'appliquent qu'aux requêtes où travelMode est défini sur DRIVING. Cet objet n'aura aucun effet pour les autres modes de déplacement. |
language optional |
Type :
string optionalIdentifiant de la langue dans laquelle les résultats doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
region optional |
Type :
string optionalCode de région utilisé comme biais pour les demandes de géocodage. Le code régional accepte une valeur ccTLD ("domaine de premier niveau") à deux caractères. La plupart des codes ccTLD sont identiques aux codes ISO 3166-1, à quelques exceptions près. Par exemple, le ccTLD du Royaume-Uni est "uk" ( .co.uk), tandis que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord"). |
transitOptions optional |
Type :
TransitOptions optionalParamètres qui s'appliquent uniquement aux requêtes où travelMode est TRANSIT. Cet objet n'aura aucun effet pour les autres modes de déplacement. |
unitSystem optional |
Type :
UnitSystem optionalSystème d'unités préféré à utiliser pour afficher les distances. Facultatif ; la valeur par défaut est "metric". |
Interface DistanceMatrixResponse
Interface google.maps.DistanceMatrixResponse
Réponse à une requête DistanceMatrixService, composée des adresses de départ et de destination mises en forme, et d'une séquence de DistanceMatrixResponseRow, une pour chaque adresse de départ correspondante.
Propriétés | |
|---|---|
destinationAddresses |
Type :
Array<string>Adresses de destination mises en forme. |
originAddresses |
Type :
Array<string>Adresses d'origine formatées. |
rows |
Type :
Array<DistanceMatrixResponseRow>Les lignes de la matrice, correspondant aux adresses d'origine. |
Interface DistanceMatrixResponseRow
Interface google.maps.DistanceMatrixResponseRow
Ligne de la réponse à une requête DistanceMatrixService, composée d'une séquence de DistanceMatrixResponseElement, une pour chaque adresse de destination correspondante.
Propriétés | |
|---|---|
elements |
Type :
Array<DistanceMatrixResponseElement>Éléments de la ligne, correspondant aux adresses de destination. |
Interface DistanceMatrixResponseElement
Interface google.maps.DistanceMatrixResponseElement
Élément unique d'une réponse à une requête DistanceMatrixService, qui contient la durée et la distance entre un point de départ et une destination.
Propriétés | |
|---|---|
distance |
Type :
DistanceDistance pour cette paire origine-destination. Cette propriété peut être non définie, car la distance peut être inconnue. |
duration |
Type :
DurationDurée de cette paire origine-destination. Cette propriété peut être non définie, car la durée peut être inconnue. |
duration_in_traffic |
Type :
DurationDurée de cette paire origine-destination, en tenant compte des conditions de circulation indiquées par la propriété trafficModel. Cette propriété peut être undefined, car la durée peut être inconnue. Disponible uniquement pour les clients disposant de la formule Premium lorsque drivingOptions est défini lors de l'envoi de la demande. |
fare |
Type :
TransitFareTarif total pour cette paire origine-destination. Uniquement applicable aux demandes de transport en commun. |
status |
Type :
DistanceMatrixElementStatusÉtat de cette combinaison origine-destination spécifique. |
Constantes DistanceMatrixStatus
google.maps.DistanceMatrixStatus
constantes
État de premier niveau concernant la requête en général, renvoyé par DistanceMatrixService à la fin d'une requête de matrice des distances. Spécifiez-les par valeur ou en utilisant le nom de la constante. Par exemple, 'OK' ou google.maps.DistanceMatrixStatus.OK.
Accédez-y en appelant le const {DistanceMatrixStatus} = await google.maps.importLibrary("routes").
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
|---|---|
INVALID_REQUEST |
La requête fournie n'était pas valide. |
MAX_DIMENSIONS_EXCEEDED |
La requête contient plus de 25 points de départ ou destinations. |
MAX_ELEMENTS_EXCEEDED |
Le produit du nombre de points de départ par le nombre de destinations dépasse la limite par requête. |
OK |
La réponse contient un résultat valide. |
OVER_QUERY_LIMIT |
Trop d'éléments ont été demandés au cours de la période autorisée. Si vous essayez à nouveau après un certain temps, la requête devrait aboutir. |
REQUEST_DENIED |
Le service a refusé l'utilisation du service Distance Matrix par votre page Web. |
UNKNOWN_ERROR |
Une requête Distance Matrix n'a pas pu être traitée en raison d'une erreur du serveur. Si vous essayez à nouveau, la requête pourrait aboutir. |
Constantes DistanceMatrixElementStatus
google.maps.DistanceMatrixElementStatus
constantes
État au niveau de l'élément concernant une paire origine/destination spécifique renvoyée par DistanceMatrixService à la fin d'une requête Distance Matrix. Ces valeurs sont spécifiées sous forme de chaînes (par exemple, 'OK').
Accédez-y en appelant le const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes").
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
|---|---|
NOT_FOUND |
Le point de départ et/ou la destination de cet élément n'ont pas pu être géocodés. |
OK |
La réponse contient un résultat valide. |
ZERO_RESULTS |
Aucun itinéraire n'a pu être identifié entre le point de départ et la destination. |