Method: projects.locations.optimizeTours

Envoie un OptimizeToursRequest contenant un ShipmentModel et renvoie un OptimizeToursResponse contenant des ShipmentRoute, qui sont un ensemble d'itinéraires que les véhicules doivent effectuer en minimisant le coût global.

Un modèle ShipmentModel se compose principalement de Shipment à exécuter et de Vehicle pouvant être utilisés pour transporter les Shipment. Les ShipmentRoute attribuent des Shipment aux 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 cible pour passer un appel.

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

Si aucun lieu n'est spécifié, une région est choisie automatiquement.

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 est défini, le serveur renvoie une réponse avant l'expiration du délai ou avant que le délai du serveur pour les requêtes synchrones soit atteint, selon la première échéance atteinte.

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

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)

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

Le modèle est soumis à des contraintes lors de la création de la première solution. 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 satisfaire à quelques hypothèses de validité de base:

  • Pour toutes les routes, vehicleIndex doit être à portée et ne doit pas être dupliqué.
  • pour l'ensemble des visites, shipmentIndex et visitRequestIndex doivent être compris dans la plage.
  • une livraison ne peut être référencée que sur une route.
  • l'enlèvement d'un colis avec retrait en magasin 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 horaires augmentent vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime).
  • une livraison 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. À la place, une erreur indiquant une irrégularité peut être renvoyée.

injectedSolutionConstraint

object (InjectedSolutionConstraint)

Appliquez des contraintes à l'algorithme d'optimisation pour trouver une solution finale semblable à une solution précédente. Par exemple, vous pouvez les utiliser pour figer des portions de routes 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. À la place, une erreur indiquant une irrégularité peut être renvoyée.

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 2020/11, seules les polylignes d'itinéraires non vides sont remplies et populatePolylines doit être 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 pour tous les itinéraires non vides, que les livraisons 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. Vous pouvez l'utiliser lorsque les index de livraison ou de véhicule de la requête ont changé depuis la création de la solution (par exemple, lorsque des expéditions 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 dans la solution injectée ne correspond pas à un véhicule de la requête, l'itinéraire correspondant est supprimé de la solution ainsi que ses visites. Si un shipmentLabel dans la solution injectée ne correspond pas à une demande d'envoi, la visite correspondante est supprimée de la solution. Si un SkippedShipment.label dans la solution injectée ne correspond pas à l'envoi d'une demande, SkippedShipment est supprimé de la solution.

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

REMARQUE: L'appelant doit s'assurer que chaque Vehicle.label (correspondant 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 de l'unicité décrites ci-dessus ne suffisent pas à garantir cette exigence.

considerRoadTraffic

boolean

Tenir compte de l'estimation du trafic pour calculer les champs Transition.travel_duration, Visit.start_time et vehicleEndTime de ShipmentRoute. pour définir le champ ShipmentRoute.has_traffic_infeasibilities et calculer le champ OptimizeToursResponse.total_cost.

populatePolylines

boolean

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

populateTransitionPolylines

boolean

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

allowLargeDeadlineDespiteInterruptionRisk

boolean

Si cet attribut est défini, la requête peut avoir un délai (voir https://grpc.io/blog/deadlines) de 60 minutes maximum. Sinon, le délai maximal n'est que de 30 minutes. Notez que les requêtes de longue durée présentent un risque d'interruption nettement plus important (mais tout de même faible).

useGeodesicDistances

boolean

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

label

string

Libellé pouvant servir à identifier cette demande, signalé dans le 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 de l'erreur BadRequest (https://cloud.google.com/apis/design/errors#error_details), sauf si resolveMode=VALIDATE_ONLY: voir le champ OptimizeToursResponse.validation_errors. La valeur par défaut est 100,mais elle est limité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.