- Requête HTTP
- Corps de la requête
- Corps de la réponse
- RouteMatrixOrigin
- RouteMatrixDestination
- ExtraComputation
- RouteMatrixElementCondition
- LocalizedValues
Se base sur une liste de points de départ et d'arrivée, et renvoie un flux contenant les informations sur l'itinéraire pour chaque combinaison de points de départ et d'arrivée.
REMARQUE:Cette méthode nécessite la spécification d'un masque de champ de réponse dans l'entrée. Vous pouvez fournir le masque de champ de réponse à l'aide du paramètre d'URL $fields
ou fields
, ou de l'en-tête HTTP/gRPC X-Goog-FieldMask
(voir les en-têtes et paramètres d'URL disponibles). La valeur est une liste de chemins d'accès de champs séparés par une virgule. Consultez cette documentation détaillée pour savoir comment construire les chemins d'accès aux champs.
Par exemple, dans cette méthode:
- Masque de champ de tous les champs disponibles (pour l'inspection manuelle):
X-Goog-FieldMask: *
- Masque de champ contenant la durée de l'itinéraire, les distances, l'état des éléments, l'état et les index des éléments (exemple de configuration de production):
X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration
Il est essentiel d'inclure status
dans votre masque de champ, sinon tous les messages s'afficheront correctement. Google déconseille l'utilisation du masque de champ de réponse utilisant le caractère générique (*
) pour les raisons suivantes:
- En sélectionnant uniquement les champs dont vous avez besoin, vous aidez notre serveur à économiser les cycles de calcul, ce qui nous permet de vous renvoyer le résultat avec une latence plus faible.
- Le fait de ne sélectionner que les champs dont vous avez besoin pour votre job de production garantit des performances de latence stables. Nous ajouterons peut-être d'autres champs de réponse à l'avenir, et ces nouveaux champs pourraient nécessiter du temps de calcul supplémentaire. Si vous sélectionnez tous les champs, ou tous les champs du premier niveau, vous risquez de constater une dégradation des performances. En effet, les nouveaux champs que nous ajoutons seront automatiquement inclus dans la réponse.
- Si vous ne sélectionnez que les champs dont vous avez besoin, vous réduirez la taille des réponses et, par conséquent, le débit du réseau.
Requête HTTP
POST https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "origins": [ { object ( |
Champs | |
---|---|
origins[] |
Obligatoire. Tableau des origines, qui détermine les lignes de la matrice de réponse. Plusieurs restrictions de taille s'appliquent à la cardinalité des points de départ et des destinations:
|
destinations[] |
Obligatoire. Tableau de destinations, qui détermine les colonnes de la matrice de réponse. |
travelMode |
Facultatif. Spécifie le mode de transport. |
routingPreference |
Facultatif. Spécifie le mode de calcul de la route. Le serveur tente d'utiliser la préférence de routage sélectionnée pour calculer la route. Si la préférence de routage entraîne une erreur ou une latence extra longue, une erreur est renvoyée. Vous ne pouvez spécifier cette option que si |
departureTime |
Facultatif. 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 Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: |
arrivalTime |
Facultatif. Heure d'arrivée. REMARQUE: Ne peut être défini que lorsque Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: |
languageCode |
Facultatif. Le code de langue BCP-47, tel que "en-US" ou "sr-Latn". Pour en savoir plus, consultez Identifiant des paramètres régionaux Unicode. Consultez la page Langues acceptées pour obtenir la liste des langues acceptées. Si vous ne fournissez pas cette valeur, la langue d'affichage est déduite de la position du premier point de départ. |
regionCode |
Facultatif. Code régional, spécifié sous la forme d'une valeur ccTLD ("domaine de premier niveau") à deux caractères. Pour en savoir plus, consultez Domaines de premier niveau avec code pays. |
units |
Facultatif. Spécifie les unités de mesure pour les champs d'affichage. |
extraComputations[] |
Facultatif. Une liste des calculs supplémentaires qui peuvent être utilisés pour terminer la requête. Remarque: Ces calculs supplémentaires peuvent renvoyer des champs supplémentaires sur la réponse. Ces champs supplémentaires doivent également être spécifiés dans le masque de champ à renvoyer dans la réponse. |
trafficModel |
Facultatif. Spécifie les hypothèses à utiliser pour calculer le temps de trajet. Ce paramètre affecte la valeur renvoyée dans le champ de durée du |
transitPreferences |
Facultatif. Spécifie les préférences qui influencent l'itinéraire renvoyé pour les routes |
Corps de la réponse
Contient des informations sur l'itinéraire calculées pour une paire point de départ-destination dans l'API v2.computeRouteMatrix. Ce proto peut être transmis au client.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{ "status": { object ( |
Champs | |
---|---|
status |
Code d'état d'erreur pour cet élément. |
condition |
Indique si l'itinéraire a été trouvé ou non. Indépendant de son statut |
distanceMeters |
Distance de l'itinéraire, en mètres. |
duration |
Durée nécessaire pour parcourir l'itinéraire. Si vous définissez Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par " |
staticDuration |
la durée de l'itinéraire sans tenir compte des conditions de circulation ; Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par " |
travelAdvisory |
Informations supplémentaires sur l'itinéraire. Par exemple: les restrictions et les informations sur les péages |
fallbackInfo |
Dans certains cas, lorsque le serveur n'est pas en mesure de calculer l'itinéraire avec les préférences définies pour cette paire point de départ-destination spécifique, il peut utiliser un autre mode de calcul. Lorsque le mode de 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 |
Représentations textuelles des propriétés de |
originIndex |
Index basé sur zéro de l'origine dans la requête. |
destinationIndex |
Index basé sur zéro de la destination dans la requête. |
RouteMatrixOrigin
Une seule origine pour ComputeRouteMatrixRequest
Représentation JSON |
---|
{ "waypoint": { object ( |
Champs | |
---|---|
waypoint |
Obligatoire. Point de cheminement de départ |
routeModifiers |
Facultatif. Modificateurs de chaque route qui l'utilise comme point de départ |
RouteMatrixDestination
Une destination unique pour ComputeRouteMatrixRequest
Représentation JSON |
---|
{
"waypoint": {
object ( |
Champs | |
---|---|
waypoint |
Obligatoire. Point de cheminement de destination |
ExtraComputation
Calculs supplémentaires à effectuer lors du traitement de la requête.
Enums | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Non utilisé. Les requêtes contenant cette valeur échoueront. |
TOLLS |
Informations sur le péage pour le ou les éléments de la matrice. |
RouteMatrixElementCondition
État de l'itinéraire renvoyé.
Enums | |
---|---|
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED |
Utilisé uniquement lorsque la status de l'élément n'est pas correcte. |
ROUTE_EXISTS |
Un itinéraire a été trouvé et les informations correspondantes ont été renseignées pour l'élément. |
ROUTE_NOT_FOUND |
Aucun itinéraire n'a été trouvé. Les champs contenant des informations sur l'itinéraire, tels que distanceMeters ou duration , ne seront pas renseignés dans l'élément. |
LocalizedValues
Représentations textuelles de certaines propriétés.
Représentation JSON |
---|
{ "distance": { object ( |
Champs | |
---|---|
distance |
Distance de trajet représentée sous forme de texte. |
duration |
Durée représentée sous forme de texte en tenant compte des conditions de circulation. Remarque: Si aucune information sur le trafic n'a été demandée, cette valeur est identique à "staticDuration. |
staticDuration |
Durée représentée au format texte sans tenir compte des conditions de circulation. |
transitFare |
Tarif de transports en commun représenté sous forme de texte. |