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 entrée. L'API renvoie ensuite une réponse contenant le parcours par défaut et un ou plusieurs autres itinéraires.

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

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 que vous souhaitez 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'inclura 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 :

Powered by Google, ©2023 Google

À 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:

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

• Route (Itinéraire) : trajet complet depuis le point de cheminement de départ jusqu'au point de cheminement de destination en passant par les points de cheminement intermédiaires. Un itinéraire se compose d'une ou de plusieurs sections.

• Trajet : chemin entre un point de cheminement d'un itinéraire et le point de cheminement suivant. Chaque étape comprend une ou plusieurs étapes distinctes.

  Un itinéraire contient une section distincte pour le chemin entre chaque point de cheminement et le suivant. Par exemple, si le parcours ne comporte qu'un seul point de cheminement de départ et un seul point de cheminement de destination, il ne comporte qu'une seule étape. Pour chaque point de cheminement supplémentaire que vous ajoutez à l'itinéraire après l'origine et la destination, appelé point de cheminement intermédiaire, l'API ajoute un tronçon distinct.

  L'API n'ajoute pas d'étape pour un point de cheminement intermédiaire de transit. Par exemple, un itinéraire contenant un point de cheminement de départ, un point de cheminement intermédiaire de passage et un point de cheminement de destination ne contient qu'une seule section entre le point de départ et la destination, en passant par le point de cheminement. Pour en savoir plus sur les points de cheminement de passage, consultez la section Définir un point de cheminement de passage.

• Étape : instruction unique sur un tronçon 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 niveau supérieur suivantes :

• routes, 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 au maximum cinq éléments : la route par défaut, la route écologique 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 emplacement. 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 itinéraires alternatifs à la réponse.

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

Le tableau legs contient la définition de chaque section de l'itinéraire. Les autres propriétés, 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 libellés : 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 segment du tableau définit le chemin d'un point de cheminement au suivant le long de 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 autres propriétés, 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 d'étapes

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

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écifier la langue des instructions par étape

L'API renvoie des informations sur l'itinéraire dans la langue locale, translitérées dans un script lisible par l'utilisateur, si nécessaire, tout en respectant la langue préférée. Les composants de l'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 de résultats que l'API choisit de renvoyer et l'ordre dans lequel ils sont renvoyés. Le géocodeur interprète les abréviations différemment selon la langue, par exemple les abréviations des types de rues ou les synonymes pouvant ê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 l'adresse a été spécifiée sous forme de chaîne d'adresse ou de 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 code Plus. 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 de réponse localisées

Les valeurs de réponse localisées sont un champ de réponse supplémentaire qui fournit du 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}.
  }
}

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 à partir du point d'itinéraire d'origine. Par conséquent, pour une requête de calcul d'itinéraire 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.