Cloud Fleet Routing service is under specific service terms. See Service specific terms.

Method: projects.locations.optimizeTours

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoutes, which are a set of routes to be performed by vehicles minimizing the overall cost.

A ShipmentModel model consists mainly of Shipments that need to be carried out and Vehicles that can be used to transport the Shipments. The ShipmentRoutes assign Shipments to Vehicles. More specifically, they assign a series of Visits to each vehicle, where a Visit corresponds to a VisitRequest, which is a pickup or delivery for a Shipment.

The goal is to provide an assignment of ShipmentRoutes to Vehicles that minimizes the total cost where cost has many components defined in the ShipmentModel.

HTTP request

POST https://cloudoptimization.googleapis.com/v1/{parent}:optimizeTours

Path parameters

Parameters
parent

string

Required. Target project and location to make a call.

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

If no location is specified, a region will be chosen automatically.

Request body

The request body contains data with the following structure:

JSON representation
{
  "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,
  "populateTravelStepPolylines": boolean,
  "maxValidationErrors": integer,
  "geodesicMetersPerSecond": number
}
Fields
timeout

string (Duration format)

If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.

For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

model

object (ShipmentModel)

Shipment model to solve.

solvingMode

enum (SolvingMode)

By default, the solving mode is DEFAULT_SOLVE (0).

searchMode

enum (SearchMode)

Search mode used to solve the request.

injectedFirstSolutionRoutes[]

object (ShipmentRoute)

Guide the optimization algorithm in finding a first solution that is similar to a previous solution.

The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions.

The solution must satisfy some basic validity assumptions:

  • for all routes, vehicleIndex must be in range and not be duplicated.
  • for all visits, shipmentIndex and visitRequestIndex must be in range.
  • a shipment may only be referenced on one route.
  • the pickup of a pickup-delivery shipment must be performed before the delivery.
  • no more than one pickup alternative or delivery alternative of a shipment may be performed.
  • for all routes, times are increasing (i.e., vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime).
  • a shipment may only be performed on a vehicle that is allowed. A vehicle is allowed if Shipment.allowed_vehicle_indices is empty or its vehicleIndex is included in Shipment.allowed_vehicle_indices.

If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

injectedSolutionConstraint

object (InjectedSolutionConstraint)

Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified.

If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

refreshDetailsRoutes[]

object (ShipmentRoute)

If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model.

As of 2020/11, this only populates the polylines of non-empty routes and requires that populatePolylines is true.

The routePolyline fields of the passed-in routes may be inconsistent with route transitions.

This field must not be used together with injectedFirstSolutionRoutes or injectedSolutionConstraint.

Shipment.ignore and Vehicle.ignore have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored.

interpretInjectedSolutionsUsingLabels

boolean

If true:

This interpretation applies to the injectedFirstSolutionRoutes, injectedSolutionConstraint, and refreshDetailsRoutes fields. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or vehicles have been removed from or added to the request.

If true, labels in the following categories must appear at most once in their category:

If a vehicleLabel in the injected solution does not correspond to a request vehicle, the corresponding route is removed from the solution along with its visits. If a shipmentLabel in the injected solution does not correspond to a request shipment, the corresponding visit is removed from the solution. If a SkippedShipment.label in the injected solution does not correspond to a request shipment, the SkippedShipment is removed from the solution.

Removing route visits or entire routes from an injected solution may have an effect on the implied constraints, which may lead to change in solution, validation errors, or infeasibility.

NOTE: The caller must ensure that each Vehicle.label (resp. Shipment.label) uniquely identifies a vehicle (resp. shipment) entity used across the two relevant requests: the past request that produced the OptimizeToursResponse used in the injected solution and the current request that includes the injected solution. The uniqueness checks described above are not enough to guarantee this requirement.

considerRoadTraffic

boolean

Consider traffic estimation in calculating ShipmentRoute fields Transition.travel_duration, Visit.start_time, and vehicleEndTime; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field.

populatePolylines

boolean

If true, polylines will be populated in response ShipmentRoutes.

populateTransitionPolylines

boolean

If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travelSteps.

allowLargeDeadlineDespiteInterruptionRisk

boolean

If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption.

useGeodesicDistances

boolean

If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by geodesicMetersPerSecond.

label

string

Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

populateTravelStepPolylines
(deprecated)

boolean

Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travelSteps.

maxValidationErrors

integer

Truncates the number of validation errors returned. These errors are typically attached to an INVALID_ARGUMENT error payload as a BadRequest error detail (https://cloud.google.com/apis/design/errors#error_details), unless solvingMode=VALIDATE_ONLY: see the OptimizeToursResponse.validation_errors field. This defaults to 100 and is capped at 10,000.

geodesicMetersPerSecond

number

When useGeodesicDistances is true, this field must be set and defines the speed applied to compute travel times. Its value must be at least 1.0 meters/seconds.

Response body

If successful, the response body contains an instance of OptimizeToursResponse.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.