Routes Preferred API is currently available only to select customers.
Contact sales to learn more.
ComputeRoutesRequest
Stay organized with collections
Save and categorize content based on your preferences.
ComputeRoutes request message.
| JSON representation |
{
"origin": {
object (Waypoint)
},
"destination": {
object (Waypoint)
},
"intermediates": [
{
object (Waypoint)
}
],
"travelMode": enum (RouteTravelMode),
"routingPreference": enum (RoutingPreference),
"polylineQuality": enum (PolylineQuality),
"polylineEncoding": enum (PolylineEncoding),
"departureTime": string,
"computeAlternativeRoutes": boolean,
"routeModifiers": {
object (RouteModifiers)
},
"languageCode": string,
"units": enum (Units),
"optimizeWaypointOrder": boolean
} |
| Fields |
origin |
object (Waypoint)
Required. Origin waypoint.
|
destination |
object (Waypoint)
Required. Destination waypoint.
|
intermediates[] |
object (Waypoint)
Optional. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported.
|
travelMode |
enum (RouteTravelMode)
Optional. Specifies the mode of transportation.
|
routingPreference |
enum (RoutingPreference)
Optional. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. You can specify this option only when the travelMode is DRIVE or TWO_WHEELER, otherwise the request fails.
|
polylineQuality |
enum (PolylineQuality)
Optional. Specifies your preference for the quality of the polyline.
|
polylineEncoding |
enum (PolylineEncoding)
Optional. Specifies the preferred encoding for the polyline.
|
departureTime |
string (Timestamp format)
Optional. The departure time. If you don't set this value, then this value defaults to the time that you made the request. If you set this value to a time that has already occurred, then the request fails. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
computeAlternativeRoutes |
boolean
Optional. Specifies whether to calculate alternate routes in addition to the route. No alternative routes are returned for requests that have intermediate waypoints.
|
routeModifiers |
object (RouteModifiers)
Optional. A set of conditions to satisfy that affect the way routes are calculated.
|
languageCode |
string
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Unicode Locale Identifier. See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the route request.
|
units |
enum (Units)
Optional. Specifies the units of measure for the display fields. This includes the instruction field in NavigationInstruction. The units of measure used for the route, leg, step distance, and duration are not affected by this value. If you don't provide this value, then the display units are inferred from the location of the request.
|
optimizeWaypointOrder |
boolean
If optimizeWaypointOrder is set to true, an attempt is made to re-order the specified intermediate waypoints to minimize the overall cost of the route. If any of the intermediate waypoints is via waypoint the request fails. Use ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index to find the new ordering. If routes.optimized_intermediate_waypoint_index is not requested in the X-Goog-FieldMask header, the request fails. If optimizeWaypointOrder is set to false, ComputeRoutesResponse.optimized_intermediate_waypoint_index is empty.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-23 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-23 UTC."],[[["The `ComputeRoutes` request message defines the parameters for calculating routes between an origin and a destination, potentially including intermediate waypoints."],["You can customize route calculations by specifying travel mode, routing preferences, departure time, and whether to compute alternative routes."],["The request allows for tailoring the response by choosing polyline quality and encoding, language, units of measure, and waypoint optimization."],["Fields such as `origin`, `destination` are required while others like `intermediates`, `travelMode`, `routingPreference` are optional and offer flexibility in route planning."],["The response to a `ComputeRoutes` request provides detailed route information including optimized waypoint order, if requested, and various display options."]]],["The `ComputeRoutes` request defines a route calculation. Key actions include specifying `origin` and `destination` waypoints, with optional `intermediates`. The request can set `travelMode`, `routingPreference`, and `polylineQuality`. Users can define `departureTime`, request `computeAlternativeRoutes`, and use `routeModifiers`. Other settings are available, such as `languageCode`, display `units`, `polylineEncoding`. Finally, it permits `optimizeWaypointOrder` to rearrange `intermediate` waypoints.\n"]]
