Method: projects.locations.optimizeTours

Invia un OptimizeToursRequest contenente un ShipmentModel e restituisce un OptimizeToursResponse contenente ShipmentRoute, ovvero un insieme di percorsi da eseguire con i veicoli riducendo al minimo il costo complessivo.

Un modello ShipmentModel è costituito principalmente da Shipment da eseguire e Vehicle da utilizzare per trasportare i Shipment. I ShipmentRoute assegnano Shipment a Vehicle. Più nello specifico, assegnano una serie di Visit a ogni veicolo, dove un Visit corrisponde a un VisitRequest, ovvero un ritiro o una consegna per un Shipment.

L'obiettivo è fornire un'assegnazione di ShipmentRoute a Vehicle che riduca al minimo il costo totale, dove il costo ha molti componenti definiti in ShipmentModel.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Progetto o posizione di destinazione per effettuare una chiamata.

Formato:

  • projects/{project-id}
  • projects/{project-id}/locations/{location-id}

Se non viene specificata alcuna località, viene scelta automaticamente una regione.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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
}
Campi
timeout

string (Duration format)

Se questo timeout è impostato, il server restituisce una risposta prima che sia trascorso il periodo di timeout o che sia stata raggiunta la scadenza del server per le richieste sincrone, a seconda di quale si verifica per prima.

Per le richieste asincrone, il server genererà una soluzione (se possibile) prima che scada il timeout.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

model

object (ShipmentModel)

Modello di spedizione da risolvere.

solvingMode

enum (SolvingMode)

Per impostazione predefinita, la modalità di risoluzione è DEFAULT_SOLVE (0).

searchMode

enum (SearchMode)

Modalità di ricerca utilizzata per risolvere la richiesta.

injectedFirstSolutionRoutes[]

object (ShipmentRoute)

Guida l'algoritmo di ottimizzazione a trovare una prima soluzione simile a una precedente.

Il modello viene vincolato quando viene creata la prima soluzione. Le spedizioni non eseguite su un percorso vengono saltate implicitamente nella prima soluzione, ma potrebbero essere eseguite nelle soluzioni successive.

La soluzione deve soddisfare alcuni presupposti di validità di base:

  • Per tutti i percorsi, vehicleIndex deve essere compreso nell'intervallo e non essere duplicato.
  • Per tutte le visite, shipmentIndex e visitRequestIndex devono essere compresi nell'intervallo.
  • una spedizione può essere indicata in un solo percorso.
  • il ritiro di una spedizione con ritiro e consegna deve essere eseguito prima della consegna.
  • non è possibile eseguire più di un'alternativa di ritiro o di consegna di una spedizione.
  • per tutti i percorsi, i tempi aumentano (ad es. vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime).
  • una spedizione può essere eseguita solo su un veicolo consentito. Un veicolo è consentito se Shipment.allowed_vehicle_indices è vuoto o se il suo vehicleIndex è incluso in Shipment.allowed_vehicle_indices.

Se la soluzione inserita non è fattibile, non viene necessariamente restituito un errore di convalida e potrebbe essere restituito un errore che indica l'impossibilità.

injectedSolutionConstraint

object (InjectedSolutionConstraint)

Vincola l'algoritmo di ottimizzazione a trovare una soluzione finale simile a una precedente. Ad esempio, può essere utilizzato per bloccare parti di percorsi già completati o da completare, ma che non devono essere modificati.

Se la soluzione inserita non è fattibile, non viene necessariamente restituito un errore di convalida e potrebbe essere restituito un errore che indica l'impossibilità.

refreshDetailsRoutes[]

object (ShipmentRoute)

Se non è vuoto, i percorsi specificati verranno aggiornati senza modificare la sequenza sottostante di visite o i tempi di percorrenza: verranno aggiornati solo gli altri dettagli. Questo non risolve il modello.

A partire da novembre 2020, questo campo viene compilato solo con le polilinee dei percorsi non vuoti e richiede che populatePolylines sia true.

I campi routePolyline delle route trasmesse potrebbero non essere coerenti con la route transitions.

Questo campo non deve essere utilizzato insieme a injectedFirstSolutionRoutes o injectedSolutionConstraint.

Shipment.ignore e Vehicle.ignore non hanno alcun effetto sul comportamento. Le polilinee vengono comunque compilate tra tutte le visite in tutti i percorsi non vuoti, indipendentemente dal fatto che le spedizioni o i veicoli correlati vengano ignorati.

interpretInjectedSolutionsUsingLabels

boolean

Se è true:

Questa interpretazione si applica ai campi injectedFirstSolutionRoutes, injectedSolutionConstraint e refreshDetailsRoutes. Può essere utilizzato quando gli indici di spedizione o dei veicoli nella richiesta sono cambiati dalla creazione della soluzione, ad esempio perché le spedizioni o i veicoli sono stati rimossi dalla richiesta o aggiunti.

Se true, le etichette nelle seguenti categorie devono essere visualizzate al massimo una volta nella rispettiva categoria:

Se un vehicleLabel nella soluzione inserita non corrisponde a un veicolo di richiesta, il percorso corrispondente viene rimosso dalla soluzione insieme alle relative visite. Se un shipmentLabel nella soluzione inserita non corrisponde a una spedizione della richiesta, la visita corrispondente viene rimossa dalla soluzione. Se un SkippedShipment.label nella soluzione inserita non corrisponde a una spedizione di richiesta, il SkippedShipment viene rimosso dalla soluzione.

La rimozione di visite di route o di interi itinerari da una soluzione inserita può influire sui vincoli impliciti, il che può comportare modifiche alla soluzione, errori di convalida o impossibilità di trovare una soluzione.

NOTA: il chiamante deve assicurarsi che ogni Vehicle.label (risp. Shipment.label) identifica in modo univoco un'entità veicolo (risp. spedizione) utilizzata nelle due richieste pertinenti: la richiesta precedente che ha prodotto OptimizeToursResponse utilizzato nella soluzione inserita e la richiesta attuale che include la soluzione inserita. I controlli di unicità descritti sopra non sono sufficienti a garantire questo requisito.

considerRoadTraffic

boolean

Prendi in considerazione la stima del traffico nel calcolo dei campi ShipmentRoute Transition.travel_duration, Visit.start_time e vehicleEndTime, nell'impostazione del campo ShipmentRoute.has_traffic_infeasibilities e nel calcolo del campo OptimizeToursResponse.total_cost.

populatePolylines

boolean

Se è true, le polilinee verranno inserite nelle risposte ShipmentRoute.

populateTransitionPolylines

boolean

Se true, le polilinee e i token di percorso verranno inseriti nella risposta ShipmentRoute.transitions.

allowLargeDeadlineDespiteInterruptionRisk

boolean

Se questo valore è impostato, la richiesta può avere una scadenza (vedi https://grpc.io/blog/deadlines) fino a 60 minuti. In caso contrario, il termine massimo è di soli 30 minuti. Tieni presente che le richieste di lunga durata hanno un rischio di interruzione significativamente maggiore (ma comunque basso).

useGeodesicDistances

boolean

Se è true, le distanze di viaggio verranno calcolate utilizzando le distanze geodetiche anziché quelle di Google Maps e i tempi di viaggio verranno calcolati utilizzando le distanze geodetiche con una velocità definita da geodesicMetersPerSecond.

label

string

Etichetta che può essere utilizzata per identificare questa richiesta, riportata in OptimizeToursResponse.request_label.

geodesicMetersPerSecond

number

Quando useGeodesicDistances è true, questo campo deve essere impostato e definisce la velocità applicata per calcolare i tempi di percorrenza. Il suo valore deve essere almeno pari a 1,0 metri/secondo.

maxValidationErrors

integer

Tronca il numero di errori di convalida restituiti. Questi errori vengono in genere allegati a un payload di errore INVALID_ARGUMENT come dettaglio dell'errore BadRequest (https://cloud.google.com/apis/design/errors#error_details), a meno che solvingMode=VALIDATE_ONLY: vedi il campo OptimizeToursResponse.validation_errors. Il valore predefinito è 100 e il limite massimo è 10.000.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di OptimizeToursResponse.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • routeoptimization.locations.use

Per saperne di più, consulta la documentazione di IAM.