Cette page a été traduite par l'API Cloud Translation.

Vérifiez la réponse à l'itinéraire

Lorsque l'API Routes calcule un itinéraire, elle utilise les points de cheminement et les paramètres de configuration que vous fournissez en tant qu'entrées. L'API renvoie ensuite une réponse contenant la route default et une ou plusieurs routes alternatives.

Votre réponse peut inclure différents types d'itinéraires et d'autres données en fonction des champs que vous demandez:

Pour l'inclure dans la réponse	Consulter cette documentation
L'itinéraire le plus économe en carburant ou en énergie selon le type de moteur du véhicule.	Configurer des itinéraires économes en carburant
Jusqu'à trois itinéraires alternatifs	Demander d'autres itinéraires
Polyligne d'un itinéraire complet, pour chaque section et pour chaque étape d'une section.	Demander des polylignes d'itinéraire
Estimation des péages, en tenant compte des remises ou des forfaits dont disposent le conducteur ou le véhicule.	Calculer les frais de péage
Réponses localisées par code de langue et unité de mesure (impériale ou métrique).	Demander des valeurs localisées
Pour mettre en forme les instructions de navigation en tant que chaîne de texte HTML, ajoutez `HTML_FORMATTED_NAVIGATION_INSTRUCTIONS` à `extraComputations`.	Calculs supplémentaires

Pour obtenir la liste complète des options d'entrée, consultez les sections Options d'itinéraire disponibles et Corps de la requête.

À l'aide de cette réponse, vous pouvez fournir à vos clients les informations nécessaires pour qu'ils puissent sélectionner l'itinéraire adapté à leurs besoins.

À propos des masques de champ

Lorsque vous appelez une méthode pour calculer un itinéraire, vous devez spécifier un masque de champ qui définit les champs à renvoyer dans la réponse. Il n'existe pas de liste par défaut des champs renvoyés. Si vous omettez cette liste, les méthodes renvoient une erreur.

Les exemples de ce document montrent l'objet de réponse dans son intégralité sans tenir compte des masques de champ. Dans un environnement de production, votre réponse n'inclut que les champs que vous spécifiez explicitement dans le masque de champ.

Pour en savoir plus, consultez Choisir les informations à renvoyer.

À propos de l'affichage des droits d'auteur

Vous devez inclure la déclaration de droits d'auteur suivante lorsque vous présentez les résultats à vos utilisateurs:

Powered by Google, ©YEAR Google

Exemple :

À propos des itinéraires, des étapes et des pas

Avant d'examiner la réponse renvoyée par l'API Routes, vous devez comprendre les composants qui composent une route:

L'itinéraire, la section et l'étape.

Votre réponse peut contenir des informations sur chacun de ces composants de route:

Route (Itinéraire) : trajet complet depuis le point de cheminement d'origine jusqu'au point de cheminement de destination en passant par les points de cheminement intermédiaires. Une route comprend une ou plusieurs tronçons.
Section: chemin entre un point de cheminement d'un itinéraire et le point de cheminement suivant sur l'itinéraire. Chaque étape se compose d'une ou de plusieurs étapes distinctes.

Un itinéraire contient une section distincte reliant chaque point de cheminement au suivant. Par exemple, si l'itinéraire contient un seul point de cheminement de départ et un seul point de cheminement de destination, il ne comporte qu'une seule section. Pour chaque point de cheminement supplémentaire que vous ajoutez à l'itinéraire après le point de départ et la destination (appelé point de cheminement intermédiaire), l'API ajoute une section distincte.

L'API n'ajoute pas de section pour un point de cheminement intermédiaire pass-through. Par exemple, un itinéraire contenant un point de cheminement de départ, un point de cheminement intermédiaire de type passthrough et un point de cheminement de destination ne contient qu'une section du point de départ à la destination, lorsqu'il passe par le point de cheminement. Pour en savoir plus sur les points de cheminement de type passthrough, consultez la section Définir un point de cheminement passthrough.
Pas: instruction unique sur la section d'un itinéraire. Une étape est l'unité la plus atomique d'une route. Par exemple, une étape peut indiquer "Tourner à gauche sur Rue principale".

Contenu de la réponse

L'objet JSON représentant la réponse de l'API contient les propriétés de premier niveau suivantes:

routes, un tableau d'éléments de type Route. Le tableau routes contient un élément pour chaque itinéraire renvoyé par l'API. Le tableau peut contenir jusqu'à cinq éléments: l'itinéraire par défaut, l'itinéraire économe en carburant et jusqu'à trois itinéraires alternatifs.
geocodingResults, un tableau d'éléments de type GeocodingResults. Pour chaque emplacement de la requête (point de départ, destination ou point de cheminement intermédiaire) que vous avez spécifié en tant que chaîne d'adresse ou Plus code, l'API effectue une recherche d'ID de lieu. Chaque élément de ce tableau contient l'ID de lieu correspondant à un établissement. Les lieux spécifiés dans la requête en tant qu'ID de lieu ou en tant que coordonnées de latitude/longitude ne sont pas inclus. Si vous avez spécifié tous les lieux à l'aide d'ID de lieu ou de coordonnées de latitude et de longitude, ce tableau n'est pas fourni.
fallbackInfo, de type FallbackInfo. Si l'API n'est pas en mesure de calculer une route à partir de toutes les propriétés d'entrée, elle peut utiliser une autre méthode 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.

La réponse se présente sous la forme suivante:

{
  // The routes array.
  "routes": [
    {
      object (Route)
    }
  ],
  // The place ID lookup results.
  "geocodingResults": [
    {
      object (GeocodedWaypoint)
    }
  ],
  // The fallback property.
  "fallbackInfo": {
    object (FallbackInfo)
  }
}

Déchiffrer le tableau des routes

La réponse contient le tableau routes, où chaque élément du tableau est de type Route. Chaque élément du tableau représente un itinéraire complet entre le point de départ et la destination. L'API renvoie toujours au moins une route, appelée route par défaut.

Vous pouvez demander des itinéraires supplémentaires. Si vous demandez un itinéraire économe en carburant, le tableau peut contenir deux éléments: l'itinéraire par défaut et l'itinéraire économe en carburant. Vous pouvez également définir computeAlternativeRoutes sur true dans la requête pour ajouter jusqu'à trois routes alternatives à la réponse.

Chaque itinéraire du tableau est identifié par la propriété de tableau routeLabels:

Valeur	Description
`DEFAULT_ROUTE`	Identifie la route par défaut.
`FUEL_EFFICIENT`	Identifie l'itinéraire économe en carburant.
`DEFAULT_ROUTE_ALTERNATE`	Indique un itinéraire alternatif.

Le tableau legs contient la définition de chaque section de l'itinéraire. Les propriétés restantes, telles que distanceMeters, duration et polyline,, contiennent des informations sur l'itinéraire dans son ensemble:

{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "routeLabels": [string],
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  }
  "routeToken": string
}

En raison des conditions de conduite actuelles et d'autres facteurs, l'itinéraire par défaut et l'itinéraire économe en carburant peuvent être identiques. Dans ce cas, le tableau routeLabels contient les deux étiquettes: DEFAULT_ROUTE et FUEL_EFFICIENT.

{
  "routes": [
    {
      "routeLabels": [
        "DEFAULT_ROUTE",
        "FUEL_EFFICIENT"
      ],
     …
    }
  ]
}

Comprendre le tableau "jams"

Chaque route de la réponse contient un tableau legs, où chaque élément de tableau legs est de type RouteLeg. Chaque section du tableau définit le chemin entre un point de cheminement et le point de cheminement suivant sur l'itinéraire. Un itinéraire comporte toujours au moins une section.

La propriété legs contient la définition de chaque étape de la section dans le tableau steps. Les propriétés restantes, telles que distanceMeters, duration et polyline, contiennent des informations sur la section.

{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  }
}

Comprendre le tableau steps

Chaque section de la réponse contient un tableau steps, où chaque élément de tableau steps est de type RouteLegStep. Une étape correspond à une seule instruction le long de la jambe. Une jambe contient toujours au moins un pas.

Chaque élément du tableau steps inclut la propriété navigationInstruction, de type NavigationInstruction, qui contient l'instruction d'étape. Exemple :

"navigationInstruction": {
  "maneuver": "TURN_LEFT",
  "instructions": "Turn left toward Frontage Rd"
}

instructions peut contenir des informations supplémentaires sur l'étape. Exemple :

"navigationInstruction": {
  "maneuver": "TURN_SLIGHT_LEFT",
  "instructions": "Slight left (signs for I-90 W/Worcester)nParts of this road may be closed at certain times or days"
}

Les autres propriétés de l'étape décrivent des informations sur l'étape, telles que distanceMeters, duration et polyline:

{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  }
}

Spécifiez la langue des instructions de l'étape

L'API renvoie des informations sur l'itinéraire dans la langue locale, qui sont translittérées en un script que l'utilisateur peut lire, si nécessaire, tout en tenant compte de la langue préférée. Les composants d'adresse sont tous renvoyés dans la même langue.

Utilisez le paramètre languageCode d'une requête pour définir explicitement la langue de route à partir de la liste des langues compatibles. Google met souvent à jour les langues acceptées. Cette liste n'est donc peut-être pas exhaustive.
Si un nom n'est pas disponible dans la langue spécifiée, l'API utilise la correspondance la plus proche.
La langue spécifiée peut influencer l'ensemble des résultats que l'API choisit de renvoyer et l'ordre dans lequel ils sont renvoyés. Le geocoder interprète les abréviations différemment selon la langue. Il peut s'agir, par exemple, des abréviations correspondant aux types de rues ou des synonymes qui peuvent être valides dans une langue, mais pas dans une autre. Par exemple, utca et tér sont des synonymes de rue en hongrois.

Comprendre le tableau geocodingResults

Pour chaque emplacement de la requête (point de départ, destination ou point de cheminement intermédiaire) spécifié en tant que chaîne d'adresse ou Plus code, l'API tente de trouver le lieu le plus pertinent, avec un ID de lieu correspondant. Chaque élément du tableau geocodingResults contient le champ placeID contenant l'emplacement en tant qu'ID de lieu et un champ type spécifiant le type d'emplacement, tel que street_address, premise ou airport.

Le tableau geocodingResults contient trois champs:

origin: ID de lieu de l'origine (s'il a été spécifié en tant que chaîne d'adresse ou en tant que Plus code). Sinon, ce champ est omis de la réponse.
destination: si elle a été spécifiée en tant que chaîne d'adresse ou en tant que Plus code, ID de lieu de la destination. Sinon, ce champ est omis de la réponse.
intermediates: tableau contenant l'ID de lieu de tous les points de cheminement intermédiaires spécifiés sous forme de chaîne d'adresse ou de Plus code. Si vous spécifiez un point de cheminement intermédiaire à l'aide d'un ID de lieu ou de coordonnées de latitude et de longitude, il est omis de la réponse. Utilisez la propriété intermediateWaypointRequestIndex dans la réponse pour déterminer quel point de cheminement intermédiaire de la requête correspond à l'ID de lieu dans la réponse.

"geocodingResults": {
    "origin": {
        "geocoderStatus": {},
        "type": [
             enum (Type)
        ],
        "placeId": string
    },
    "destination": {
        "geocoderStatus": {},
        "type": [
            enum (Type)
        ],
        "placeId": string
    },
    "intermediates": [
        {
            "geocoderStatus": {},
            "intermediateWaypointRequestIndex": integer,
            "type": [
                enum (Type)
            ],
            "placeId": string
        },
        {
           "geocoderStatus": {},
           "intermediateWaypointRequestIndex": integer,
            "type": [
                enum (Type)
            ],
            "placeId": string
        }
    ]
}

Comprendre les valeurs des réponses localisées

Les valeurs de réponse localisées sont un champ de réponse supplémentaire qui fournit un texte localisé pour les valeurs de paramètre renvoyées. Le texte localisé est fourni pour la durée du trajet, la distance et le système d'unités (métrique ou impérial). Vous demandez des valeurs localisées à l'aide d'un masque de champ. Vous pouvez spécifier la langue et le système d'unités, ou utiliser les valeurs inférées par l'API. Pour en savoir plus, consultez LocalizedValues.

Par exemple, si vous spécifiez un code de langue pour l'allemand (de) et l'unité impériale, vous obtenez une valeur pour distanceMeters de 49889,7, mais également un texte localisé fournissant cette mesure de distance en unités allemandes et impériales, par exemple "31 Meile".

Voici un exemple de ce que vous verriez pour les valeurs localisées:

{ "localized_values":
  {
    "distance": { "text": "31,0 Meile/n" },
    "duration": { "text": 38 Minuten}.
    "static_duration": { "text": 36 Minuten}.
  }
}

Remarque : Vous obtenez deux valeurs pour la durée prévue. duration utilise le modèle de trafic que vous spécifiez et static_duration ne tient pas compte du trafic. Ainsi, si le modèle de trafic demandé est TRAFFIC_UNAWARE, ces heures sont identiques.

Si vous ne spécifiez pas de langue ou de système d'unités, l'API déduit la langue et les unités de la manière suivante:

La méthode ComputeRoutes déduit l'emplacement et les unités de distance du point de cheminement de départ. Ainsi, pour une requête de routage aux États-Unis, l'API déduit la langue en-US et les unités IMPERIAL.
La méthode ComputeRouteMatrix utilise par défaut la langue "en-US" et les unités METRIC.