Method: computeCustomRoutes

À partir d'un ensemble de points de cheminement terminaux et intermédiaires, et d'un objectif d'itinéraire, calcule le meilleur itinéraire pour l'objectif de l'itinéraire. Renvoie également l'itinéraire le plus rapide et l'itinéraire le plus court en tant qu'itinéraires de référence.

REMARQUE:Cette méthode nécessite que vous spécifiiez 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 à l'aide de l'en-tête HTTP/gRPC X-Goog-FieldMask (voir les paramètres et en-têtes d'URL disponibles). La valeur est une liste de chemins de champ séparés par une virgule. Consultez cette documentation détaillée pour savoir comment créer les chemins d'accès aux champs.

Par exemple, dans cette méthode :

  • Masque de champ de tous les champs disponibles (pour inspection manuelle): X-Goog-FieldMask: *
  • Masque de champ des distances, durées, jetons et informations sur les péages de l'itinéraire : X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

Google déconseille d'utiliser le masque de champ de réponse avec caractère générique (*) ou de spécifier le masque de champ au niveau supérieur (routes), 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.
  • Sélectionner uniquement les champs dont vous avez besoin dans votre job de production garantit des performances de latence stables. Nous pourrons ajouter d'autres champs de réponse à l'avenir, et ces nouveaux champs pourraient 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 tous 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, la taille de la réponse sera plus petite, ce qui augmentera le débit réseau.

Requête HTTP

POST https://routespreferred.googleapis.com/v1:computeCustomRoutes

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 
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "routeObjective": {
    object (RouteObjective)
  },
  "languageCode": string,
  "units": enum (Units)
}
Champs
origin

object (Waypoint)

Obligatoire. Point d'intérêt de départ.
destination

object (Waypoint)

Obligatoire. Point de cheminement de destination.
intermediates[]

object (Waypoint)

Facultatif. Ensemble de points de cheminement sur l'itinéraire (à l'exclusion des terminaux) permettant de s'arrêter à ou de passer. Vous pouvez ajouter jusqu'à 25 points de cheminement intermédiaires.
travelMode

enum (RouteTravelMode)

Facultatif. Spécifie le mode de transport. Seuls DRIVE et "TWO_WHEELER" sont acceptés.
routingPreference

enum (RoutingPreference)

Facultatif. Spécifie comment calculer l'itinéraire. Le serveur tente d'utiliser la préférence de routage sélectionnée pour calculer l'itinéraire. 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 travelMode est DRIVE ou TWO_WHEELER. Sinon, la requête échoue.
polylineQuality

enum (PolylineQuality)

Facultatif. Spécifie votre préférence pour la qualité de la polyligne.
polylineEncoding

enum (PolylineEncoding)

Facultatif. Spécifie l'encodage à privilégier pour la polyligne.
departureTime

string (Timestamp format)

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. Si vous définissez cette valeur sur une heure qui s'est déjà produite, la requête échoue.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
routeModifiers

object (RouteModifiers)

Facultatif. Ensemble de conditions à remplir qui affectent la façon dont les itinéraires sont calculés.
routeObjective

object (RouteObjective)

Obligatoire. Objectif d'itinéraire à optimiser.
languageCode

string

Facultatif. Le code de langue BCP-47, tel que "en-US" ou "sr-Latn". Pour en savoir plus, consultez Identifiant de paramètres régionaux Unicode. Consultez la page Langues acceptées pour obtenir la liste des langues disponibles. Si vous ne fournissez pas cette valeur, la langue d'affichage est déduite de l'emplacement de la requête d'itinéraire.
units

enum (Units)

Facultatif. Spécifie les unités de mesure des champs d'affichage. Cela inclut le champ instruction dans NavigationInstruction. Les unités de mesure utilisées pour l'itinéraire, la section, la distance de pas et la durée ne sont pas affectées par cette valeur. Si vous n'indiquez pas cette valeur, les unités d'affichage sont déduites de l'emplacement de la requête.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ComputeCustomRoutesResponse.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/maps-platform.routespreferred

Pour en savoir plus, consultez la présentation d'OAuth 2.0.