Method: projects.locations.optimizeTours

Envoie un OptimizeToursRequest contenant un ShipmentModel et renvoie un OptimizeToursResponse contenant des ShipmentRoute, qui sont un ensemble d'itinéraires à effectuer par les véhicules afin de minimiser le coût global.

Un modèle ShipmentModel se compose principalement de Shipment à effectuer et de Vehicle pouvant être utilisés pour transporter les Shipment. Les ShipmentRoute attribuent des Shipment à des Vehicle. Plus précisément, ils attribuent une série de Visit à chaque véhicule, où un Visit correspond à un VisitRequest, qui est un retrait ou une livraison pour un Shipment.

L'objectif est d'attribuer des ShipmentRoute à des Vehicle de manière à minimiser le coût total, où le coût comporte de nombreux composants définis dans le ShipmentModel.

Requête HTTP

POST https://routeoptimization.googleapis.com/v1/{parent=projects/*/locations/*}:optimizeTours

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Projet ou emplacement cibles pour passer un appel.

Format: * projects/{project-id} * projects/{project-id}/locations/{location-id}

Si aucun emplacement n'est spécifié, une région est automatiquement sélectionnée.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "timeout": string,
  "model": {
    object (ShipmentModel)
  },
  "solvingMode": enum (SolvingMode),
  "searchMode": enum (SearchMode),
  "injectedFirstSolutionRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "injectedSolutionConstraint": {
    object (InjectedSolutionConstraint)
  },
  "refreshDetailsRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "interpretInjectedSolutionsUsingLabels": boolean,
  "considerRoadTraffic": boolean,
  "populatePolylines": boolean,
  "populateTransitionPolylines": boolean,
  "allowLargeDeadlineDespiteInterruptionRisk": boolean,
  "useGeodesicDistances": boolean,
  "label": string,
  "geodesicMetersPerSecond": number,
  "maxValidationErrors": integer
}
Champs
timeout

string (Duration format)

Si ce délai avant expiration est défini, le serveur renvoie une réponse avant l'expiration du délai avant expiration ou avant l'expiration du délai avant expiration du serveur pour les requêtes synchrones, selon la première éventualité.

Pour les requêtes asynchrones, le serveur génère une solution (si possible) avant l'expiration du délai avant expiration.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
model

object (ShipmentModel)

Modèle d'expédition à résoudre.
solvingMode

enum (SolvingMode)

Par défaut, le mode de résolution est DEFAULT_SOLVE (0).
searchMode

enum (SearchMode)

Mode de recherche utilisé pour résoudre la requête.
injectedFirstSolutionRoutes[]

object (ShipmentRoute)

Guidez l'algorithme d'optimisation pour qu'il trouve une première solution semblable à une solution précédente.

Le modèle est contraint lorsque la première solution est créée. Les expéditions qui ne sont pas effectuées sur un itinéraire sont implicitement ignorées dans la première solution, mais elles peuvent être effectuées dans des solutions successives.

La solution doit répondre à certaines hypothèses de validité de base:

  • Pour tous les parcours, vehicleIndex doit être à portée et ne pas être en double.
  • Pour toutes les visites, shipmentIndex et visitRequestIndex doivent être compris dans la plage.
  • une expédition ne peut être référencée que sur un seul itinéraire.
  • Le retrait d'un colis avec retrait et livraison doit être effectué avant la livraison.
  • Vous ne pouvez pas choisir plus d'une option de retrait ou de livraison pour un envoi.
  • Pour tous les itinéraires, les temps augmentent (c'est-à-dire vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime).
  • une expédition ne peut être effectuée que sur un véhicule autorisé. Un véhicule est autorisé si Shipment.allowed_vehicle_indices est vide ou si son vehicleIndex est inclus dans Shipment.allowed_vehicle_indices.

Si la solution injectée n'est pas réalisable, une erreur de validation n'est pas nécessairement renvoyée. Une erreur indiquant l'impossibilité de la solution peut être renvoyée à la place.
injectedSolutionConstraint

object (InjectedSolutionConstraint)

Contraignez l'algorithme d'optimisation à trouver une solution finale semblable à une solution précédente. Par exemple, vous pouvez utiliser cette fonctionnalité pour congeler des parties de parcours déjà terminées ou qui doivent l'être, mais qui ne doivent pas être modifiées.

Si la solution injectée n'est pas réalisable, une erreur de validation n'est pas nécessairement renvoyée. Une erreur indiquant l'impossibilité de la solution peut être renvoyée à la place.
refreshDetailsRoutes[]

object (ShipmentRoute)

Si ce n'est pas le cas, les itinéraires donnés seront actualisés, sans modifier leur séquence de visites sous-jacente ni les temps de trajet. Seuls d'autres détails seront mis à jour. Cela ne résout pas le modèle.

Depuis le 11/11/2020, cette valeur ne renseigne que les polylignes des itinéraires non vides et nécessite que populatePolylines soit défini sur "true".

Les champs routePolyline des itinéraires transmis peuvent être incohérents avec l'itinéraire transitions.

Ce champ ne doit pas être utilisé avec injectedFirstSolutionRoutes ou injectedSolutionConstraint.

Shipment.ignore et Vehicle.ignore n'ont aucun effet sur le comportement. Les polylignes sont toujours renseignées entre toutes les visites de tous les itinéraires non vides, que les expéditions ou les véhicules associés soient ignorés ou non.
interpretInjectedSolutionsUsingLabels

boolean

Si la condition est vraie:

Cette interprétation s'applique aux champs injectedFirstSolutionRoutes, injectedSolutionConstraint et refreshDetailsRoutes. Il peut être utilisé lorsque les indices de livraison ou de véhicule de la requête ont changé depuis la création de la solution, par exemple si des livraisons ou des véhicules ont été supprimés ou ajoutés à la requête.

Si la valeur est "true", les libellés des catégories suivantes ne doivent apparaître qu'une seule fois dans leur catégorie:

Si un vehicleLabel de la solution injectée ne correspond pas à un véhicule de la requête, le parcours correspondant est supprimé de la solution, ainsi que ses visites. Si un shipmentLabel de la solution injectée ne correspond pas à un envoi de requête, la visite correspondante est supprimée de la solution. Si un SkippedShipment.label de la solution injectée ne correspond pas à un envoi de requête, il est supprimé de la solution.SkippedShipment

Supprimer des visites de parcours ou des parcours entiers d'une solution injectée peut avoir un impact sur les contraintes implicites, ce qui peut entraîner un changement de la solution, des erreurs de validation ou une infeasibility.

REMARQUE: L'appelant doit s'assurer que chaque Vehicle.label (resp. Shipment.label) identifie de manière unique une entité de véhicule (resp. d'envoi) utilisée dans les deux requêtes pertinentes: la requête précédente qui a généré le OptimizeToursResponse utilisé dans la solution injectée et la requête actuelle qui inclut la solution injectée. Les vérifications d'unicité décrites ci-dessus ne suffisent pas à garantir cette exigence.
considerRoadTraffic

boolean

Tenez compte de l'estimation du trafic lors du calcul des champs ShipmentRoute Transition.travel_duration, Visit.start_time et vehicleEndTime, lors de la configuration du champ ShipmentRoute.has_traffic_infeasibilities et lors du calcul du champ OptimizeToursResponse.total_cost.
populatePolylines

boolean

Si la valeur est "true", les polylignes sont renseignées dans les ShipmentRoute de réponse.
populateTransitionPolylines

boolean

Si la valeur est "true", les polylignes et les jetons de parcours sont renseignés dans la réponse ShipmentRoute.transitions.
allowLargeDeadlineDespiteInterruptionRisk

boolean

Si cette valeur est définie, la requête peut avoir un délai (voir https://grpc.io/blog/deadlines) maximal de 60 minutes. Sinon, le délai maximal est de 30 minutes. Notez que les requêtes de longue durée présentent un risque d'interruption nettement plus élevé (mais toujours faible).
useGeodesicDistances

boolean

Si la valeur est "true", les distances de trajet seront calculées à l'aide de distances géodésiques au lieu de distances Google Maps, et les temps de trajet seront calculés à l'aide de distances géodésiques avec une vitesse définie par geodesicMetersPerSecond.
label

string

Libellé pouvant être utilisé pour identifier cette requête, indiqué dans OptimizeToursResponse.request_label.
geodesicMetersPerSecond

number

Lorsque useGeodesicDistances est défini sur "true", ce champ doit être défini et définit la vitesse appliquée pour calculer les temps de trajet. Sa valeur doit être d'au moins 1,0 m/s.
maxValidationErrors

integer

Tronque le nombre d'erreurs de validation renvoyées. Ces erreurs sont généralement associées à une charge utile d'erreur INVALID_ARGUMENT en tant que détails d'erreur BadRequest (https://cloud.google.com/apis/design/errors#error_details), sauf si solvingMode=VALIDATE_ONLY: consultez le champ OptimizeToursResponse.validation_errors. La valeur par défaut est 100,et la limite est fixée à 10 000.

Corps de la réponse

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • routeoptimization.locations.use

Pour en savoir plus, consultez la documentation IAM.