Route Matrix

Classe RouteMatrix

classe google.maps.routes.RouteMatrix
bibliothèque "routes"

Matrice d'itinéraires calculée pour un ensemble de paires point de départ/destination par RouteMatrix.computeRouteMatrix

const {RouteMatrix} = await google.maps.importLibrary("routes");
computeRouteMatrix
computeRouteMatrix(request)
Paramètres :
Valeur renvoyée : Promise<{matrix:RouteMatrix}>
Prend en compte une liste de points de départ et de destinations, et renvoie une matrice contenant des informations sur l'itinéraire pour chaque combinaison de point de départ et de destination.

Remarque : Cette méthode nécessite que vous spécifiiez un masque de champ de réponse dans la requête en définissant la propriété ComputeRouteMatrixRequest.fields. La valeur est une liste de chemins de champ.

Par exemple :
  • Masque de champ de tous les champs disponibles : fields: ['*']
  • Masque de champ de la durée et de la distance au niveau de l'itinéraire : fields: ['durationMillis', 'distanceMeters']

L'utilisation du masque de champ de réponse générique fields: ['*'] est déconseillée pour les raisons suivantes :
  • En ne sélectionnant que les champs dont vous avez besoin, vous aidez notre serveur à économiser des cycles de calcul, ce qui nous permet de vous renvoyer le résultat avec une latence plus faible.
  • En ne sélectionnant que les champs dont vous avez besoin dans votre job de production, vous garantissez des performances de latence stables. Nous pourrons ajouter d'autres champs de réponse à l'avenir, et ces nouveaux champs pourront nécessiter un temps de calcul supplémentaire. Si vous sélectionnez tous les champs ou tous les champs au niveau supérieur, vous risquez de constater une dégradation des performances, car tout nouveau champ que nous ajouterons sera automatiquement inclus dans la réponse.
  • En ne sélectionnant que les champs dont vous avez besoin, vous obtenez une réponse plus petite et donc un chargement plus rapide sur le réseau.
rows
readonly
Lignes de la matrice. Chaque ligne correspond à un point de départ et contient un tableau d'éléments RouteMatrixItem, chacun représentant un itinéraire vers une destination.
Hérité : toJSON

Classe RouteMatrixRow

classe google.maps.routes.RouteMatrixRow
bibliothèque "routes"

Correspond à une origine transmise à RouteMatrix.computeRouteMatrix. Contient une liste de RouteMatrixItem, chaque élément représentant un itinéraire vers une destination.

const {RouteMatrixRow} = await google.maps.importLibrary("routes");
items
readonly
Les informations sur l'itinéraire pour chaque destination.
Hérité : toJSON

Classe RouteMatrixItem

classe google.maps.routes.RouteMatrixItem
bibliothèque "routes"

Contient les informations d'itinéraire calculées pour une paire point de départ/destination transmise à RouteMatrix.computeRouteMatrix.

const {RouteMatrixItem} = await google.maps.importLibrary("routes");
condition
readonly
Type : RouteMatrixItemCondition optional
Indique si l'itinéraire a été trouvé ou non.
distanceMeters
readonly
Type : number optional
Distance de l'itinéraire en mètres.
durationMillis
readonly
Type : number optional
Durée nécessaire pour parcourir l'itinéraire, en millisecondes. Si vous définissez ComputeRouteMatrixRequest.routingPreference sur TRAFFIC_UNAWARE, cette valeur est identique à RouteMatrixItem.staticDurationMillis. Si vous définissez ComputeRouteMatrixRequest.routingPreference sur TRAFFIC_AWARE ou TRAFFIC_AWARE_OPTIMAL, cette valeur est calculée en tenant compte des conditions de circulation.

Remarque : Si la durée dépasse 2^53 millisecondes, cette valeur est Number.POSITIVE_INFINITY.
error
readonly
Type : RouteMatrixItemError optional
Erreur survenue lors du calcul de l'itinéraire.
fallbackInfo
readonly
Type : FallbackInfo optional
Dans certains cas, lorsque le serveur ne peut pas calculer l'itinéraire avec les préférences données pour cette paire de points de départ et de destination, il peut utiliser un autre mode de calcul. Lorsqu'un remplacement est utilisé, ce champ contient des informations détaillées sur la réponse de remplacement. Sinon, ce champ n'est pas défini.
localizedValues
readonly
Représentations textuelles des propriétés de RouteMatrixItem.
staticDurationMillis
readonly
Type : number optional
Durée du trajet sans tenir compte des conditions de circulation.

Remarque : Si la durée dépasse 2^53 millisecondes, cette valeur est Number.POSITIVE_INFINITY.
travelAdvisory
readonly
Type : RouteTravelAdvisory optional
Informations supplémentaires sur l'itinéraire.

ComputeRouteMatrixRequest

interface google.maps.routes.ComputeRouteMatrixRequest

Requête pour une matrice d'itinéraires.
destinations
Tableau de destinations, qui détermine les colonnes de la matrice de réponse. Une valeur transmise sous forme de chaîne peut être une adresse, un Plus Code ou un nom de ressource Place. Les valeurs d'altitude ne sont pas prises en compte.
fields
Type : Iterable<string>
Ensemble de champs à récupérer. Spécifiez ["*"] pour tous les champs.
origins
Tableau d'origines, qui détermine les lignes de la matrice de réponse. Une valeur transmise sous forme de chaîne peut être une adresse, un Plus Code ou un nom de ressource Place. Les valeurs d'altitude ne sont pas prises en compte.

Plusieurs restrictions de taille s'appliquent à la cardinalité des points de départ et d'arrivée :
  • Le nombre total de points de départ et de destinations spécifiés en tant que string ou Place ne doit pas dépasser 50.
  • Le produit du nombre de points de départ par le nombre de destinations ne doit pas dépasser 625.
  • Le produit du nombre de points de départ par le nombre de destinations ne doit pas dépasser 100 si ComputeRouteMatrixRequest.routingPreference est défini sur TRAFFIC_AWARE_OPTIMAL.
  • Le produit du nombre de points de départ par le nombre de destinations ne doit pas dépasser 100 si ComputeRouteMatrixRequest.travelMode est défini sur TRANSIT.
arrivalTime
facultatif
Type : Date optional
Heure d'arrivée.

Remarque : Ne peut être défini que si ComputeRouteMatrixRequest.travelMode est défini sur TRANSIT. Vous pouvez spécifier ComputeRouteMatrixRequest.departureTime ou ComputeRouteMatrixRequest.arrivalTime, mais pas les deux. Les trajets en transports en commun sont disponibles jusqu'à sept jours dans le passé ou 100 jours dans le futur.
departureTime
facultatif
Type : Date optional
Heure de départ. Si vous ne définissez pas cette valeur, elle est définie par défaut sur l'heure à laquelle vous avez effectué la requête.

Remarque : Vous ne pouvez spécifier une heure dans le passé que si ComputeRouteMatrixRequest.travelMode est défini sur TRANSIT. Les trajets en transports en commun sont disponibles jusqu'à sept jours dans le passé ou 100 jours dans le futur.
extraComputations
facultatif
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. Ces champs supplémentaires doivent également être spécifiés dans ComputeRouteMatrixRequest.fields pour être renvoyés dans la réponse.
internalUsageAttributionIds
facultatif
Type : Iterable<string> optional
Identifiants utilisés pour attribuer les appels à des packages ou des bibliothèques OSS spécifiques.
language
facultatif
Type : string optional
Le code de langue BCP-47, tel que "en-US" ou "sr-Latn". Pour en savoir plus, consultez Unicode Locale Identifier. Consultez la section Langues acceptées pour obtenir la liste des langues disponibles. Si vous ne fournissez pas cette valeur, la langue est déduite des paramètres de localisation de l'API Google Maps JavaScript. Sinon, la langue est déduite de l'emplacement de la première origine.
region
facultatif
Type : string optional
Code régional, spécifié sous la forme d'une valeur ccTLD (TLD pour top-level domain, domaine de premier niveau) à deux caractères. Pour en savoir plus, consultez Domaines nationaux de premier niveau. Si vous ne fournissez pas cette valeur, la région est déduite des paramètres de localisation de l'API Google Maps JavaScript. Sinon, la région est déduite de l'emplacement de la première origine.
routingPreference
facultatif
Type : RoutingPreference optional
Spécifie comment calculer la matrice de routes. Le serveur tente d'utiliser la préférence de routage sélectionnée pour calculer la matrice de routes. Si la préférence de routage entraîne une erreur ou une latence très longue, une erreur est renvoyée. Vous ne pouvez spécifier cette option que lorsque ComputeRouteMatrixRequest.travelMode est défini sur DRIVING ou TWO_WHEELER. Sinon, la requête échoue.
trafficModel
facultatif
Type : TrafficModel optional
Spécifie les hypothèses à utiliser pour calculer le temps de trajet selon le trafic. Ce paramètre influe sur la valeur renvoyée dans RouteMatrixItem.durationMillis, qui contient le temps de trajet prévu en fonction des moyennes historiques. ComputeRouteMatrixRequest.trafficModel n'est disponible que pour les requêtes dont le paramètre ComputeRouteMatrixRequest.routingPreference est défini sur TRAFFIC_AWARE_OPTIMAL et le paramètre ComputeRouteMatrixRequest.travelMode sur DRIVING. La valeur par défaut est BEST_GUESS.
transitPreference
facultatif
Type : TransitPreference optional
Spécifie les préférences qui influencent l'itinéraire renvoyé pour les itinéraires TRANSIT.

Remarque : Ne peut être spécifié que si ComputeRouteMatrixRequest.travelMode est défini sur TRANSIT.
travelMode
facultatif
Type : TravelMode optional
Spécifie le mode de transport.
units
facultatif
Type : UnitSystem optional
Spécifie les unités de mesure des champs d'affichage. Si vous ne fournissez pas cette valeur, les unités d'affichage sont déduites de l'emplacement du premier point de départ.

ComputeRouteMatrixExtraComputation constants

google.maps.routes.ComputeRouteMatrixExtraComputation
bibliothèque "routes"

Calculs supplémentaires à effectuer lors de l'exécution de la requête. Pour en savoir plus, consultez la documentation sur les services Web.

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

const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes");
TOLLS Informations sur les péages pour les éléments de la matrice. Pour en savoir plus, consultez la documentation sur les services Web.

Constantes RouteMatrixItemCondition

google.maps.routes.RouteMatrixItemCondition
bibliothèque "routes"

État de la route renvoyée. Pour en savoir plus, consultez la documentation sur les services Web.

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

const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes");
ROUTE_EXISTS Un itinéraire a été trouvé, et les informations correspondantes ont été renseignées pour l'élément. Pour en savoir plus, consultez la documentation sur les services Web.
ROUTE_NOT_FOUND Aucun itinéraire n'a été trouvé. Pour en savoir plus, consultez la documentation sur les services Web.

Classe RouteMatrixItemError

class google.maps.routes.RouteMatrixItemError extends Error
library "routes"

Erreur survenue lors de RouteMatrix.computeRouteMatrix pour une paire origine/destination spécifique.

const {RouteMatrixItemError} = await google.maps.importLibrary("routes");
Hérité : toJSON

Classe RouteMatrixItemLocalizedValues

classe google.maps.routes.RouteMatrixItemLocalizedValues
bibliothèque "routes"

Représentations textuelles de RouteMatrixItem.

const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
Type : string optional
Distance de l'élément de la matrice de distance, sous forme de texte.
distanceLanguage
readonly
Type : string optional
Code de langue BCP-47 du texte de la distance, tel que "en-US" ou "sr-Latn".

Pour en savoir plus, consultez http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
readonly
Type : string optional
Durée, représentée sous forme de texte et localisée dans la région de la requête. Prend en compte les conditions de circulation.

Remarque : Si vous n'avez pas demandé d'informations sur le trafic, cette valeur est identique à RouteMatrixItemLocalizedValues.staticDuration.
durationLanguage
readonly
Type : string optional
Code de langue BCP-47 du texte de la durée, tel que "en-US" ou "sr-Latn".

Pour en savoir plus, consultez http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
readonly
Type : string optional
Durée sans tenir compte des conditions de circulation, représentée sous forme de texte.
staticDurationLanguage
readonly
Type : string optional
Code de langue BCP-47 du texte de durée statique, tel que "en-US" ou "sr-Latn".
transitFare
readonly
Type : string optional
Tarif du transport en commun, représenté sous forme de texte.
transitFareLanguage
readonly
Type : string optional
Code de langue BCP-47 du texte du tarif de transport en commun, tel que "en-US" ou "sr-Latn".

Pour en savoir plus, consultez http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Hérité : toJSON

Interface RouteMatrixOrigin

interface google.maps.routes.RouteMatrixOrigin

Une seule origine pour un ComputeRouteMatrixRequest.
waypoint
Emplacement de l'origine. Une valeur transmise sous forme de chaîne peut être une adresse ou un Plus Code. Les valeurs d'altitude ne sont pas prises en compte.
routeModifiers
facultatif
Type : RouteModifiers optional
Modificateurs pour chaque itinéraire qui utilise ce point de départ.