Cloud Optimization API

Cloud Optimization API provides a portfolio of solvers to address common optimization use cases starting with optimal route planning for vehicle fleets.

Service: cloudoptimization.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://cloudoptimization.googleapis.com

REST Resource: v1.projects

Methods
batchOptimizeTours POST /v1/{parent}:batchOptimizeTours
Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.
optimizeTours POST /v1/{parent}: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.

REST Resource: v1.projects.locations

Methods
batchOptimizeTours POST /v1/{parent}:batchOptimizeTours
Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.
optimizeTours POST /v1/{parent}: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.

REST Resource: v1.projects.locations.operations

Methods
get GET /v1/{name}
Gets the latest state of a long-running operation.

REST Resource: v1.projects.locations.workspaces

Methods
create POST /v1/{parent}/workspaces
Creates a workspace to manage a group of resources.
delete DELETE /v1/{name}
Deletes a workspace.
list GET /v1/{parent}/workspaces
Lists all the workspaces under the project within a cloud location.
patch PATCH /v1/{workspace.name}
Updates a workspace.

REST Resource: v1.projects.locations.workspaces.optimizers

Methods
create POST /v1/{parent}/optimizers
Creates an optimizer .
delete DELETE /v1/{name}
Deletes an optimizer.
get GET /v1/{name}
Gets an optimizer.
list GET /v1/{parent}/optimizers
Lists the optimizers within a workspace.
patch PATCH /v1/{optimizer.name}
Updates an optimizer.
run POST /v1/{name}:run
Run the optimizer to generate a solution based on updated entities (e.g.

REST Resource: v1.projects.locations.workspaces.shipments

Methods
create POST /v1/{parent}/shipments
Creates a shipment.
delete DELETE /v1/{name}
Deletes a shipment.
get GET /v1/{name}
Gets a shipment.
list GET /v1/{parent}/shipments
Lists the shipments within a workspace.
patch PATCH /v1/{shipment.name}
Updates a shipment.

REST Resource: v1.projects.locations.workspaces.solutions

Methods
delete DELETE /v1/{name}
Deletes a solution.
get GET /v1/{name}
Gets a solution.
list GET /v1/{parent}/solutions
List the solutions based on certain conditions.
retrieveInput GET /v1/{name}:retrieveInput
Retrieves the OptimizeToursRequest that corresponds to the solution.

REST Resource: v1.projects.locations.workspaces.vehicles

Methods
create POST /v1/{parent}/vehicles
Creates a vehicle.
delete DELETE /v1/{name}
Deletes a vehicle.
get GET /v1/{name}
Gets a vehicle.
list GET /v1/{parent}/vehicles
Lists the vehicles within a workspace.
patch PATCH /v1/{vehicle.name}
Updates a vehicle.

REST Resource: v1.projects.operations

Methods
get GET /v1/{name}
Gets the latest state of a long-running operation.