Page Summary
-
The Route Optimization API provides methods for optimizing vehicle routes, minimizing overall cost, and managing operations.
-
The service endpoint for the API is
https://routeoptimization.googleapis.com. -
You can interact with the API using Google-provided client libraries or by making requests to the REST resources documented.
-
The API supports both individual (
optimizeTours) and batch (batchOptimizeTours) optimization requests. -
Operations can be monitored and managed via the
v1.operationsandv1.projects.locations.operationsREST resources.
The Route Optimization API.
- REST Resource: v1.operations
- REST Resource: v1.projects
- REST Resource: v1.projects.locations
- REST Resource: v1.projects.locations.operations
Service: routeoptimization.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://routeoptimization.googleapis.com
REST Resource: v1.operations
| Methods | |
|---|---|
cancel
|
POST /v1/{name=operations/**}:cancel
Starts asynchronous cancellation on a long-running operation. |
delete
|
DELETE /v1/{name=operations/**}
Deletes a long-running operation. |
list
|
GET /v1/{name=operations}
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects
| Methods | |
|---|---|
batchOptimizeTours
|
POST /v1/{parent=projects/*}:batchOptimizeTours
Optimizes vehicle tours for one or more OptimizeToursRequest
messages as a batch. |
optimizeTours
|
POST /v1/{parent=projects/*}:optimizeTours
Sends an OptimizeToursRequest
containing a ShipmentModel
and returns an OptimizeToursResponse
containing ShipmentRoute
s, which are a set of routes to be performed by vehicles minimizing the overall cost. |
optimizeToursLongRunning
|
POST /v1/{parent=projects/*}:optimizeToursLongRunning
This is a variant of the OptimizeTours
method designed for optimizations with large timeout values. |
optimizeToursUri
|
POST /v1/{parent=projects/*}:OptimizeToursUri
This is a variant of the OptimizeToursLongRunning
method designed for optimizations with large timeout values and large input/output sizes. |
REST Resource: v1.projects.locations
| Methods | |
|---|---|
batchOptimizeTours
|
POST /v1/{parent=projects/*/locations/*}:batchOptimizeTours
Optimizes vehicle tours for one or more OptimizeToursRequest
messages as a batch. |
optimizeTours
|
POST /v1/{parent=projects/*/locations/*}:optimizeTours
Sends an OptimizeToursRequest
containing a ShipmentModel
and returns an OptimizeToursResponse
containing ShipmentRoute
s, which are a set of routes to be performed by vehicles minimizing the overall cost. |
optimizeToursLongRunning
|
POST /v1/{parent=projects/*/locations/*}:optimizeToursLongRunning
This is a variant of the OptimizeTours
method designed for optimizations with large timeout values. |
optimizeToursUri
|
POST /v1/{parent=projects/*/locations/*}:OptimizeToursUri
This is a variant of the OptimizeToursLongRunning
method designed for optimizations with large timeout values and large input/output sizes. |
REST Resource: v1.projects.locations.operations
| Methods | |
|---|---|
get
|
GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation. |
